Skip to content

Commit

Permalink
Fix typo on OCR format name in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
piconti committed May 1, 2024
1 parent 999b06a commit dc2fee7
Show file tree
Hide file tree
Showing 21 changed files with 35 additions and 35 deletions.
Binary file modified docs/_build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/_build/doctrees/importers.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/importers/bcul.doctree
Binary file not shown.
4 changes: 2 additions & 2 deletions docs/_build/html/_sources/importers.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ The following importer CLI scripts are already available:
<https://www.bnf.fr/en/>`_ to encode and deliver its newspaper data.
- :py:mod:`text_importer.scripts.bnfen_importer`: importer for the *Mets/ALTO flavor* used by the `Bibliothèque nationale de France (BNF)
<https://www.bnf.fr/en/>`_ to encode and deliver its newspaper data for the Europeana collection.
- :py:mod:`text_importer.scripts.bcul_importer`: importer for the *ABBY format* used by the `Bibliothèque Cantonale Universitaire de Lausanne (BCUL)
<https://www.bcu-lausanne.ch/en/>`_ to encode and deliver the newspaper data which is on the `Scriptorium interface <https://scriptorium.bcu-lausanne.ch/page/home>`.
- :py:mod:`text_importer.scripts.bcul_importer`: importer for the *ABBYY format* used by the `Bibliothèque Cantonale Universitaire de Lausanne (BCUL)
<https://www.bcu-lausanne.ch/en/>`_ to encode and deliver the newspaper data which is on the `Scriptorium interface <https://scriptorium.bcu-lausanne.ch/page/home>`_.
- :py:mod:`text_importer.scripts.swaimporter`: *ALTO flavor* of the `Basel University Library`.
- :py:mod:`text_importer.scripts.blimporter`: importer for the *Mets/ALTO flavor* used by the `British Library (BL) <https://www.bl.uk/>`_
to encode and deliver its newspaper data.
Expand Down
6 changes: 3 additions & 3 deletions docs/_build/html/_sources/importers/bcul.rst.txt
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
BCUL ABBY importer
BCUL ABBYY importer
=========================

This importer is written to accomodate the ABBY OCR format.
This importer is written to accomodate the ABBYY OCR format.
It was developed to handle OCR newspaper data provided by the `Bibliothèque Cantonale Universitaire de Lausanne
(BCUL - Lausanne Cantonal University Library) <https://www.bcu-lausanne.ch/en/>`_, which are part of the `Scriptorium interface <https://scriptorium.bcu-lausanne.ch/page/home>` and collection.
(BCUL - Lausanne Cantonal University Library) <https://www.bcu-lausanne.ch/en/>`_, which are part of the `Scriptorium interface <https://scriptorium.bcu-lausanne.ch/page/home>`_ and collection.

BCUL Custom classes
---------------------
Expand Down
6 changes: 3 additions & 3 deletions docs/_build/html/importers.html
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
<li class="toctree-l3"><a class="reference internal" href="importers/bl.html">British Library Mets/Alto importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="importers/bnf.html">BNF Mets/Alto importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="importers/bnf-en.html">BNF-EN Mets/Alto importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="importers/bcul.html">BCUL ABBY importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="importers/bcul.html">BCUL ABBYY importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="importers/tetml.html">Generic TETML importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="importers/fedgaz.html">FedGaz TETML importer</a></li>
</ul>
Expand Down Expand Up @@ -121,7 +121,7 @@ <h2>Available importers<a class="headerlink" href="#available-importers" title="
<li><p><code class="xref py py-mod docutils literal notranslate"><span class="pre">text_importer.scripts.luximporter</span></code>: importer for the <em>Mets/ALTO flavor</em> used by the <a class="reference external" href="https://bnl.public.lu/">Bibliothèque nationale de Luxembourg (BNL)</a> to encode and deliver its newspaper data.</p></li>
<li><p><code class="xref py py-mod docutils literal notranslate"><span class="pre">text_importer.scripts.bnfimporter</span></code>: importer for the <em>Mets/ALTO flavor</em> used by the <a class="reference external" href="https://www.bnf.fr/en/">Bibliothèque nationale de France (BNF)</a> to encode and deliver its newspaper data.</p></li>
<li><p><code class="xref py py-mod docutils literal notranslate"><span class="pre">text_importer.scripts.bnfen_importer</span></code>: importer for the <em>Mets/ALTO flavor</em> used by the <a class="reference external" href="https://www.bnf.fr/en/">Bibliothèque nationale de France (BNF)</a> to encode and deliver its newspaper data for the Europeana collection.</p></li>
<li><p><code class="xref py py-mod docutils literal notranslate"><span class="pre">text_importer.scripts.bcul_importer</span></code>: importer for the <em>ABBY format</em> used by the <a class="reference external" href="https://www.bcu-lausanne.ch/en/">Bibliothèque Cantonale Universitaire de Lausanne (BCUL)</a> to encode and deliver the newspaper data which is on the <cite>Scriptorium interface &lt;https://scriptorium.bcu-lausanne.ch/page/home&gt;</cite>.</p></li>
<li><p><code class="xref py py-mod docutils literal notranslate"><span class="pre">text_importer.scripts.bcul_importer</span></code>: importer for the <em>ABBYY format</em> used by the <a class="reference external" href="https://www.bcu-lausanne.ch/en/">Bibliothèque Cantonale Universitaire de Lausanne (BCUL)</a> to encode and deliver the newspaper data which is on the <a class="reference external" href="https://scriptorium.bcu-lausanne.ch/page/home">Scriptorium interface</a>.</p></li>
<li><p><code class="xref py py-mod docutils literal notranslate"><span class="pre">text_importer.scripts.swaimporter</span></code>: <em>ALTO flavor</em> of the <cite>Basel University Library</cite>.</p></li>
<li><p><code class="xref py py-mod docutils literal notranslate"><span class="pre">text_importer.scripts.blimporter</span></code>: importer for the <em>Mets/ALTO flavor</em> used by the <a class="reference external" href="https://www.bl.uk/">British Library (BL)</a>
to encode and deliver its newspaper data.</p></li>
Expand All @@ -140,7 +140,7 @@ <h2>Available importers<a class="headerlink" href="#available-importers" title="
<li class="toctree-l1"><a class="reference internal" href="importers/bl.html">British Library Mets/Alto importer</a></li>
<li class="toctree-l1"><a class="reference internal" href="importers/bnf.html">BNF Mets/Alto importer</a></li>
<li class="toctree-l1"><a class="reference internal" href="importers/bnf-en.html">BNF-EN Mets/Alto importer</a></li>
<li class="toctree-l1"><a class="reference internal" href="importers/bcul.html">BCUL ABBY importer</a></li>
<li class="toctree-l1"><a class="reference internal" href="importers/bcul.html">BCUL ABBYY importer</a></li>
<li class="toctree-l1"><a class="reference internal" href="importers/tetml.html">Generic TETML importer</a></li>
<li class="toctree-l1"><a class="reference internal" href="importers/fedgaz.html">FedGaz TETML importer</a></li>
</ul>
Expand Down
14 changes: 7 additions & 7 deletions docs/_build/html/importers/bcul.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>BCUL ABBY importer &mdash; Impresso TextImporter documentation</title>
<title>BCUL ABBYY importer &mdash; Impresso TextImporter documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand Down Expand Up @@ -56,7 +56,7 @@
<li class="toctree-l3"><a class="reference internal" href="bl.html">British Library Mets/Alto importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="bnf.html">BNF Mets/Alto importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="bnf-en.html">BNF-EN Mets/Alto importer</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">BCUL ABBY importer</a><ul>
<li class="toctree-l3 current"><a class="current reference internal" href="#">BCUL ABBYY importer</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#module-text_importer.importers.bcul.classes">BCUL Custom classes</a></li>
<li class="toctree-l4"><a class="reference internal" href="#module-text_importer.importers.bcul.detect">BCUL Detect functions</a></li>
<li class="toctree-l4"><a class="reference internal" href="#module-text_importer.importers.bcul.helpers">BCUL Helper functions</a></li>
Expand Down Expand Up @@ -89,7 +89,7 @@
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="../importers.html">TextImporter</a></li>
<li class="breadcrumb-item active">BCUL ABBY importer</li>
<li class="breadcrumb-item active">BCUL ABBYY importer</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/importers/bcul.rst.txt" rel="nofollow"> View page source</a>
</li>
Expand All @@ -99,11 +99,11 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<section id="bcul-abby-importer">
<h1>BCUL ABBY importer<a class="headerlink" href="#bcul-abby-importer" title="Link to this heading"></a></h1>
<p>This importer is written to accomodate the ABBY OCR format.
<section id="bcul-abbyy-importer">
<h1>BCUL ABBYY importer<a class="headerlink" href="#bcul-abbyy-importer" title="Link to this heading"></a></h1>
<p>This importer is written to accomodate the ABBYY OCR format.
It was developed to handle OCR newspaper data provided by the <a class="reference external" href="https://www.bcu-lausanne.ch/en/">Bibliothèque Cantonale Universitaire de Lausanne
(BCUL - Lausanne Cantonal University Library)</a>, which are part of the <cite>Scriptorium interface &lt;https://scriptorium.bcu-lausanne.ch/page/home&gt;</cite> and collection.</p>
(BCUL - Lausanne Cantonal University Library)</a>, which are part of the <a class="reference external" href="https://scriptorium.bcu-lausanne.ch/page/home">Scriptorium interface</a> and collection.</p>
<section id="module-text_importer.importers.bcul.classes">
<span id="bcul-custom-classes"></span><h2>BCUL Custom classes<a class="headerlink" href="#module-text_importer.importers.bcul.classes" title="Link to this heading"></a></h2>
<p>This module contains the definition of the BCUL importer classes.</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/_build/html/importers/bl.html
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@
</li>
<li class="toctree-l3"><a class="reference internal" href="bnf.html">BNF Mets/Alto importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="bnf-en.html">BNF-EN Mets/Alto importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="bcul.html">BCUL ABBY importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="bcul.html">BCUL ABBYY importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="tetml.html">Generic TETML importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="fedgaz.html">FedGaz TETML importer</a></li>
</ul>
Expand Down
6 changes: 3 additions & 3 deletions docs/_build/html/importers/bnf-en.html
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="BCUL ABBY importer" href="bcul.html" />
<link rel="next" title="BCUL ABBYY importer" href="bcul.html" />
<link rel="prev" title="BNF Mets/Alto importer" href="bnf.html" />
</head>

Expand Down Expand Up @@ -60,7 +60,7 @@
<li class="toctree-l4"><a class="reference internal" href="#module-text_importer.importers.bnf_en.detect">BNF-EN Detect functions</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="bcul.html">BCUL ABBY importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="bcul.html">BCUL ABBYY importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="tetml.html">Generic TETML importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="fedgaz.html">FedGaz TETML importer</a></li>
</ul>
Expand Down Expand Up @@ -611,7 +611,7 @@ <h1>BNF-EN Mets/Alto importer<a class="headerlink" href="#bnf-en-mets-alto-impor
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="bnf.html" class="btn btn-neutral float-left" title="BNF Mets/Alto importer" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="bcul.html" class="btn btn-neutral float-right" title="BCUL ABBY importer" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="bcul.html" class="btn btn-neutral float-right" title="BCUL ABBYY importer" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

<hr/>
Expand Down
2 changes: 1 addition & 1 deletion docs/_build/html/importers/bnf.html
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="bnf-en.html">BNF-EN Mets/Alto importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="bcul.html">BCUL ABBY importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="bcul.html">BCUL ABBYY importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="tetml.html">Generic TETML importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="fedgaz.html">FedGaz TETML importer</a></li>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion docs/_build/html/importers/fedgaz.html
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
<li class="toctree-l3"><a class="reference internal" href="bl.html">British Library Mets/Alto importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="bnf.html">BNF Mets/Alto importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="bnf-en.html">BNF-EN Mets/Alto importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="bcul.html">BCUL ABBY importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="bcul.html">BCUL ABBYY importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="tetml.html">Generic TETML importer</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">FedGaz TETML importer</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#module-text_importer.importers.fedgaz.classes">FedGaz Custom classes</a></li>
Expand Down
2 changes: 1 addition & 1 deletion docs/_build/html/importers/lux.html
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@
<li class="toctree-l3"><a class="reference internal" href="bl.html">British Library Mets/Alto importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="bnf.html">BNF Mets/Alto importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="bnf-en.html">BNF-EN Mets/Alto importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="bcul.html">BCUL ABBY importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="bcul.html">BCUL ABBYY importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="tetml.html">Generic TETML importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="fedgaz.html">FedGaz TETML importer</a></li>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion docs/_build/html/importers/mets-alto.html
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@
<li class="toctree-l3"><a class="reference internal" href="bl.html">British Library Mets/Alto importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="bnf.html">BNF Mets/Alto importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="bnf-en.html">BNF-EN Mets/Alto importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="bcul.html">BCUL ABBY importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="bcul.html">BCUL ABBYY importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="tetml.html">Generic TETML importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="fedgaz.html">FedGaz TETML importer</a></li>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion docs/_build/html/importers/olive.html
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@
<li class="toctree-l3"><a class="reference internal" href="bl.html">British Library Mets/Alto importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="bnf.html">BNF Mets/Alto importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="bnf-en.html">BNF-EN Mets/Alto importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="bcul.html">BCUL ABBY importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="bcul.html">BCUL ABBYY importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="tetml.html">Generic TETML importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="fedgaz.html">FedGaz TETML importer</a></li>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion docs/_build/html/importers/rero.html
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@
<li class="toctree-l3"><a class="reference internal" href="bl.html">British Library Mets/Alto importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="bnf.html">BNF Mets/Alto importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="bnf-en.html">BNF-EN Mets/Alto importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="bcul.html">BCUL ABBY importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="bcul.html">BCUL ABBYY importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="tetml.html">Generic TETML importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="fedgaz.html">FedGaz TETML importer</a></li>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion docs/_build/html/importers/swa.html
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@
<li class="toctree-l3"><a class="reference internal" href="bl.html">British Library Mets/Alto importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="bnf.html">BNF Mets/Alto importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="bnf-en.html">BNF-EN Mets/Alto importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="bcul.html">BCUL ABBY importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="bcul.html">BCUL ABBYY importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="tetml.html">Generic TETML importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="fedgaz.html">FedGaz TETML importer</a></li>
</ul>
Expand Down
6 changes: 3 additions & 3 deletions docs/_build/html/importers/tetml.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="FedGaz TETML importer" href="fedgaz.html" />
<link rel="prev" title="BCUL ABBY importer" href="bcul.html" />
<link rel="prev" title="BCUL ABBYY importer" href="bcul.html" />
</head>

<body class="wy-body-for-nav">
Expand Down Expand Up @@ -56,7 +56,7 @@
<li class="toctree-l3"><a class="reference internal" href="bl.html">British Library Mets/Alto importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="bnf.html">BNF Mets/Alto importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="bnf-en.html">BNF-EN Mets/Alto importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="bcul.html">BCUL ABBY importer</a></li>
<li class="toctree-l3"><a class="reference internal" href="bcul.html">BCUL ABBYY importer</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">Generic TETML importer</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#module-text_importer.importers.tetml.classes">Tetml Custom classes</a></li>
<li class="toctree-l4"><a class="reference internal" href="#module-text_importer.importers.tetml.detect">Tetml Detect functions</a></li>
Expand Down Expand Up @@ -485,7 +485,7 @@ <h1>Generic TETML importer<a class="headerlink" href="#generic-tetml-importer" t
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="bcul.html" class="btn btn-neutral float-left" title="BCUL ABBY importer" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="bcul.html" class="btn btn-neutral float-left" title="BCUL ABBYY importer" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="fedgaz.html" class="btn btn-neutral float-right" title="FedGaz TETML importer" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

Expand Down
Binary file modified docs/_build/html/objects.inv
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/_build/html/searchindex.js

Large diffs are not rendered by default.

Loading

0 comments on commit dc2fee7

Please sign in to comment.