Skip to content

Commit

Permalink
docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
dirkroorda committed Oct 2, 2024
1 parent 095f04c commit 909d4d7
Show file tree
Hide file tree
Showing 151 changed files with 287 additions and 272 deletions.
2 changes: 1 addition & 1 deletion index.js

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions tf/about/annotate.html
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ <h2 id="supported-corpora">Supported corpora</h2>
And where that is not sufficient, details are put in <code>ner/config.yaml</code>, which
can be put next to the corpus.</p>
<p>I have tested it for the
<a href="https://github.com/ETCBC/bhsa"><code>ETCBC/bhsa</code> (Hebrew Bible) corpus</a>, and the
<a href="https://github.com/ETCBC/bhsa">ETCBC/bhsa (Hebrew Bible) corpus</a>, and the
machinery works.
But it remains to be seen whether the tools is sufficiently <em>ergonomic</em> for that
corpus.</p>
Expand Down Expand Up @@ -298,7 +298,7 @@ <h3 id="recommended-practice">Recommended practice</h3>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/0d8a411038811d054fb14fcd21d104325cb45d52/tf/about/annotate.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/57f429578f811e68000d50034a8bbf4565ea36c7/tf/about/annotate.py#L1-L3" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
.. include:: ../docs/about/annotate.md
Expand Down
2 changes: 1 addition & 1 deletion tf/about/annotateBrowser.html
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,7 @@ <h1 id="programming">Programming</h1>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/0d8a411038811d054fb14fcd21d104325cb45d52/tf/about/annotateBrowser.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/57f429578f811e68000d50034a8bbf4565ea36c7/tf/about/annotateBrowser.py#L1-L3" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
.. include:: ../docs/about/annotateBrowser.md
Expand Down
2 changes: 1 addition & 1 deletion tf/about/apps.html
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ <h3 id="two-contexts">Two contexts</h3>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/0d8a411038811d054fb14fcd21d104325cb45d52/tf/about/apps.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/57f429578f811e68000d50034a8bbf4565ea36c7/tf/about/apps.py#L1-L3" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
.. include:: ../docs/about/apps.md
Expand Down
2 changes: 1 addition & 1 deletion tf/about/background.html
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ <h2 id="history">History</h2>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/0d8a411038811d054fb14fcd21d104325cb45d52/tf/about/background.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/57f429578f811e68000d50034a8bbf4565ea36c7/tf/about/background.py#L1-L3" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
.. include:: ../docs/about/background.md
Expand Down
2 changes: 1 addition & 1 deletion tf/about/browser.html
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ <h3 id="unicode-in-excel-csvs">UNICODE in Excel CSVs</h3>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/0d8a411038811d054fb14fcd21d104325cb45d52/tf/about/browser.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/57f429578f811e68000d50034a8bbf4565ea36c7/tf/about/browser.py#L1-L3" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
.. include:: ../docs/about/browser.md
Expand Down
6 changes: 3 additions & 3 deletions tf/about/clientmanual.html
Original file line number Diff line number Diff line change
Expand Up @@ -528,7 +528,7 @@ <h1 id="the-search-interface-as-app">The search interface as app</h1>
</ul>
<p>When the browser remembers your previous jobs,
it does not use cookies for it but
<a href="https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage"><code>localStorage</code></a>,
<a href="https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage">localStorage</a>,
which other sites cannot read.</p>
<h1 id="making-this-app">Making this app</h1>
<p>The construction of this app relies very much of the organization of the corpus
Expand All @@ -539,7 +539,7 @@ <h1 id="making-this-app">Making this app</h1>
and write a small piece of code to generate the data for the layers
from the corresponding TF dataset.</p>
<p>See e.g.
<a href="https://github.com/CambridgeSemiticsLab/nena_tf/tree/master/app"><code>app-nena/layeredsearch</code></a>.</p>
<a href="https://github.com/CambridgeSemiticsLab/nena_tf/tree/master/app">app-nena/layeredsearch</a>.</p>
<p>All the rest (building, shipping, and deploying the app) is then automatic,
See <code><a title="tf.client.make.build" href="../client/make/build.html">tf.client.make.build</a></code>.</p>
<p>The first layered search interface created this way is one for the
Expand All @@ -565,7 +565,7 @@ <h1 id="credits">Credits</h1>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/0d8a411038811d054fb14fcd21d104325cb45d52/tf/about/clientmanual.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/57f429578f811e68000d50034a8bbf4565ea36c7/tf/about/clientmanual.py#L1-L3" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
.. include:: ../docs/about/clientmanual.md
Expand Down
2 changes: 1 addition & 1 deletion tf/about/code.html
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ <h2 id="writing">Writing</h2>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/0d8a411038811d054fb14fcd21d104325cb45d52/tf/about/code.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/57f429578f811e68000d50034a8bbf4565ea36c7/tf/about/code.py#L1-L3" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
.. include:: ../docs/about/code.md
Expand Down
18 changes: 4 additions & 14 deletions tf/about/corpora.html
Original file line number Diff line number Diff line change
Expand Up @@ -275,9 +275,9 @@ <h2 id="nino-cuneiform"><a href="https://github.com/Nino-cunei">NINO Cuneiform</
</dl>
<h2 id="protestant-theological-university"><a href="https://github.com/pthu">Protestant Theological University</a></h2>
<dl>
<dt><a href="https://nbviewer.jupyter.org/github/pthu/greek_literature/blob/master/tutorial/start.ipynb">Greek Literature</a></dt>
<dt><a href="https://github.com/pthu/greek_literature">Greek Literature</a></dt>
<dd><em>Greek</em>
<a href="https://github.com/pthu/greek_literature">Literature, -400 - +400</a>,
Literature, -400 - +400,
<a href="https://github.com/PerseusDL/canonical-greekLit">Perseus Digital Library</a> and
<a href="https://github.com/OpenGreekAndLatin/First1KGreek">Open Greek and Latin Project</a>
The result of a massive conversion effort by Ernst Boogert.</dd>
Expand All @@ -304,13 +304,6 @@ <h2 id="university-of-utrecht-cornelis-van-lit"><a href="https://github.com/amon
<strong>editions (Lakhnawi and Afifi) of Ibn Arabi's Fusus plus commentaries in the centuries thereafter</strong>,
Cornelis van Lit, Dirk Roorda</dd>
</dl>
<h3 id="intentions">Intentions</h3>
<dl>
<dt>Old Royal</dt>
<dd><em>Akkadian-Sumerian cuneiform</em>
Bilingual royal inscriptions, 2000 - 1600,
<strong>more info to come</strong>, Martijn Kokken, Dirk Roorda</dd>
</dl>
<h2 id="get-corpora">Get corpora</h2>
<h3 id="automatically">Automatically</h3>
<p>TF downloads corpus data and apps from GitHub / GitLab on demand.</p>
Expand Down Expand Up @@ -355,7 +348,7 @@ <h3 id="extra-data">Extra data</h3>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/0d8a411038811d054fb14fcd21d104325cb45d52/tf/about/corpora.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/57f429578f811e68000d50034a8bbf4565ea36c7/tf/about/corpora.py#L1-L3" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
.. include:: ../docs/about/corpora.md
Expand Down Expand Up @@ -437,10 +430,7 @@ <h1>Index</h1>
<li><a href="#nino-cuneiform">NINO Cuneiform</a></li>
<li><a href="#protestant-theological-university">Protestant Theological University</a></li>
<li><a href="#quran">Quran</a></li>
<li><a href="#university-of-utrecht-cornelis-van-lit">University of Utrecht: Cornelis van Lit</a><ul>
<li><a href="#intentions">Intentions</a></li>
</ul>
</li>
<li><a href="#university-of-utrecht-cornelis-van-lit">University of Utrecht: Cornelis van Lit</a></li>
<li><a href="#get-corpora">Get corpora</a><ul>
<li><a href="#automatically">Automatically</a></li>
<li><a href="#manually">Manually</a></li>
Expand Down
4 changes: 2 additions & 2 deletions tf/about/datamodel.html
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ <h2 id="at-a-glance">At a glance</h2>
to the set of slots that have an occurrence of that lexeme.</p>
<h2 id="fabric-metaphor">Fabric metaphor</h2>
<p><img alt="Loom" src="../images/loom.png">
<a href="http://www.nuernberger-hausbuecher.de/75-Amb-2-317-4-v/data">AD 1425 Hausbücher der Nürnberger Zwölfbrüderstiftungen</a></p>
<a href="https://online-service.nuernberg.de/viewer/hausbuecher/">AD 1425 Hausbücher der Nürnberger Zwölfbrüderstiftungen</a></p>
<p>Before we go on, we invite you to look at a few basic terms in the craft of
<a href="https://en.wikipedia.org/wiki/Weaving">weaving</a>.</p>
<p>A weaver sets up a set of fixed, parallel threads, the <em>warp</em>. He then picks a
Expand Down Expand Up @@ -265,7 +265,7 @@ <h2 id="serializing-and-pre-computing">Serializing and pre-computing</h2>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/0d8a411038811d054fb14fcd21d104325cb45d52/tf/about/datamodel.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/57f429578f811e68000d50034a8bbf4565ea36c7/tf/about/datamodel.py#L1-L3" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
.. include:: ../docs/about/datamodel.md
Expand Down
2 changes: 1 addition & 1 deletion tf/about/datasharing.html
Original file line number Diff line number Diff line change
Expand Up @@ -362,7 +362,7 @@ <h3 id="more-modules-at-the-same-time">More modules at the same time</h3>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/0d8a411038811d054fb14fcd21d104325cb45d52/tf/about/datasharing.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/57f429578f811e68000d50034a8bbf4565ea36c7/tf/about/datasharing.py#L1-L3" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
.. include:: ../docs/about/datasharing.md
Expand Down
8 changes: 4 additions & 4 deletions tf/about/displaydesign.html
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ <h2 id="discontinuity-and-chunking">Discontinuity and chunking</h2>
<p><img alt="discontinuity" src="../images/DisplayDesign/DisplayDesign.002.png"></p>
<blockquote>
<p><a href="https://shebanq.ancient-data.org/hebrew/text?book=Genesis&amp;chapter=4&amp;verse=14&amp;version=c&amp;mr=m&amp;qw=q&amp;tp=txt_p&amp;tr=hb&amp;wget=v&amp;qget=v&amp;nget=vt">Genesis 4:14</a>,
example taken from this <a href="https://nbviewer.jupyter.org/github/annotation/tutorials/blob/master/zz_test/030-bhsa.ipynb">notebook</a>.</p>
How to find gaps is explained in this <a href="https://nbviewer.org/github/ETCBC/bhsa/blob/master/tutorial/searchGaps.ipynb">tutorial</a>.</p>
</blockquote>
<p>You see a sentence fragment with two clauses, of which the second is engulfed by the first
one, while remaining completely disjoint.</p>
Expand All @@ -100,8 +100,8 @@ <h2 id="overlapping-hierarchy-and-fragmenting">Overlapping hierarchy and fragmen
<p>Here is an example from a corpus of Old Babylonian letters (cuneiform):</p>
<p><img alt="overlap" src="../images/DisplayDesign/DisplayDesign.004.png"></p>
<blockquote>
<p><a href="https://cdli.ucla.edu/search/search_results.php?SearchMode=Text&amp;ObjectID=P509373"><code>Tablet P509373 reverse:6'</code></a>,
example taken from <a href="https://nbviewer.jupyter.org/github/annotation/tutorials/blob/master/zz_test/062-obb-clusters.ipynb">notebook</a>.</p>
<p><a href="https://cdli.ucla.edu/search/search_results.php?SearchMode=Text&amp;ObjectID=P509373">Tablet P509373 reverse:6'</a>,
See more examples in this <a href="https://nbviewer.org/github/Nino-cunei/oldbabylonian/blob/master/tutorial/display.ipynb">tutorial</a>.</p>
</blockquote>
<p>Here you see a cluster that does not respect a word boundary.</p>
<p><img alt="fragmenting" src="../images/DisplayDesign/DisplayDesign.005.png"></p>
Expand Down Expand Up @@ -151,7 +151,7 @@ <h3 id="output">Output</h3>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/0d8a411038811d054fb14fcd21d104325cb45d52/tf/about/displaydesign.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/57f429578f811e68000d50034a8bbf4565ea36c7/tf/about/displaydesign.py#L1-L3" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
.. include:: ../docs/about/displaydesign.md
Expand Down
2 changes: 1 addition & 1 deletion tf/about/faq.html
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ <h3 id="github-rate-limit-exceeded">GitHub Rate Limit Exceeded!</h3>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/0d8a411038811d054fb14fcd21d104325cb45d52/tf/about/faq.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/57f429578f811e68000d50034a8bbf4565ea36c7/tf/about/faq.py#L1-L3" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
.. include:: ../docs/about/faq.md
Expand Down
2 changes: 1 addition & 1 deletion tf/about/fileformats.html
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ <h3 id="single-values">Single values</h3>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/0d8a411038811d054fb14fcd21d104325cb45d52/tf/about/fileformats.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/57f429578f811e68000d50034a8bbf4565ea36c7/tf/about/fileformats.py#L1-L3" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
.. include:: ../docs/about/fileformats.md
Expand Down
2 changes: 1 addition & 1 deletion tf/about/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ <h1 id="documents">Documents</h1>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/0d8a411038811d054fb14fcd21d104325cb45d52/tf/about/__init__.py#L1-L5" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/57f429578f811e68000d50034a8bbf4565ea36c7/tf/about/__init__.py#L1-L5" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
# Documents
Expand Down
2 changes: 1 addition & 1 deletion tf/about/install.html
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ <h4 id="note-for-linux-users">Note for Linux users</h4>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/0d8a411038811d054fb14fcd21d104325cb45d52/tf/about/install.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/57f429578f811e68000d50034a8bbf4565ea36c7/tf/about/install.py#L1-L3" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
.. include:: ../docs/about/install.md
Expand Down
2 changes: 1 addition & 1 deletion tf/about/manual.html
Original file line number Diff line number Diff line change
Expand Up @@ -390,7 +390,7 @@ <h2 id="keyboard-shortcuts">Keyboard shortcuts</h2>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/0d8a411038811d054fb14fcd21d104325cb45d52/tf/about/manual.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/57f429578f811e68000d50034a8bbf4565ea36c7/tf/about/manual.py#L1-L3" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
.. include:: ../docs/about/manual.md
Expand Down
2 changes: 1 addition & 1 deletion tf/about/optimizations.html
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ <h3 id="edge-features">Edge features</h3>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/0d8a411038811d054fb14fcd21d104325cb45d52/tf/about/optimizations.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/57f429578f811e68000d50034a8bbf4565ea36c7/tf/about/optimizations.py#L1-L3" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
.. include:: ../docs/about/optimizations.md
Expand Down
8 changes: 4 additions & 4 deletions tf/about/releases.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ <h4 id="1253">12.5.3</h4>
<p><strong>WATM</strong></p>
<p>Further development in converting TF data to WATM (see <code><a title="tf.convert.watm" href="../convert/watm.html">tf.convert.watm</a></code>), including
generating IIIF manifests for page scans.
This is work in progress and the documentation is lagging behind.
This is work in progress.
The work is targeted at the
<a href="https://annotation.github.io/text-fabric/tf/about/corpora.html#knawhuygensing-and-gitlabhucknawnl">Suriano Letters</a>.</p>
<p><strong>NB:</strong> The docs are lagging behind on this point.</p>
Expand Down Expand Up @@ -254,7 +254,7 @@ <h4 id="1235">12.3.5</h4>
This is a bit of a limited and ad hoc extension of the functionality of this function.
I needed a quick fix to add nodes for entities and entity occurrences at the same time
and link them with edges. This is for the corpus
<a href="https://github.com/CLARIAH/wp6-missieven"><code>CLARIAH/wp6-missieven</code></a>.</p>
<a href="https://github.com/CLARIAH/wp6-missieven">CLARIAH/wp6-missieven</a>.</p>
</li>
<li>
<p>fix: the express download of a dataset (complete.zip) was nit triggered in all
Expand Down Expand Up @@ -489,7 +489,7 @@ <h4 id="12067">12.0.6,7</h4>
the browser to do the expensive rendering of content that is not visible on the screen.
That makes it possible to load a lot of content in a single page without tripping up
the browser. You also need the
<a href="https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API"><code>IntersectionObserver</code> API</a>,
<a href="https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API">IntersectionObserver API</a>,
but that is generally supported by browsers. With the help of that API you can
restrict the binding of event listeners to elements that are visible on the screen.</p>
<p>So, you can open the TF browser in Chrome by passing the option <code>--chrome</code>.
Expand Down Expand Up @@ -543,7 +543,7 @@ <h2 id="older-releases">Older releases</h2>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/0d8a411038811d054fb14fcd21d104325cb45d52/tf/about/releases.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/57f429578f811e68000d50034a8bbf4565ea36c7/tf/about/releases.py#L1-L3" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
.. include:: ../docs/about/releases.md
Expand Down
Loading

0 comments on commit 909d4d7

Please sign in to comment.