Skip to content

Commit

Permalink
docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
dirkroorda committed Jan 23, 2024
1 parent 303ce99 commit c7282d6
Show file tree
Hide file tree
Showing 150 changed files with 3,277 additions and 1,792 deletions.
677 changes: 371 additions & 306 deletions index.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion tf/about/annotate.html
Original file line number Diff line number Diff line change
Expand Up @@ -293,7 +293,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/0521fcc1b2d8c2da4c26eb6dbd7262d494522679/tf/about/annotate.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/69c3f8c35133bfdd1e62af1d1705bac20abb14d0/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 @@ -260,7 +260,7 @@ <h1 id="programming">Programming</h1>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/0521fcc1b2d8c2da4c26eb6dbd7262d494522679/tf/about/annotateBrowser.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/69c3f8c35133bfdd1e62af1d1705bac20abb14d0/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 @@ -110,7 +110,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/0521fcc1b2d8c2da4c26eb6dbd7262d494522679/tf/about/apps.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/69c3f8c35133bfdd1e62af1d1705bac20abb14d0/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 @@ -150,7 +150,7 @@ <h2 id="history">History</h2>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/0521fcc1b2d8c2da4c26eb6dbd7262d494522679/tf/about/background.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/69c3f8c35133bfdd1e62af1d1705bac20abb14d0/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 @@ -169,7 +169,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/0521fcc1b2d8c2da4c26eb6dbd7262d494522679/tf/about/browser.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/69c3f8c35133bfdd1e62af1d1705bac20abb14d0/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
2 changes: 1 addition & 1 deletion tf/about/clientmanual.html
Original file line number Diff line number Diff line change
Expand Up @@ -560,7 +560,7 @@ <h1 id="credits">Credits</h1>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/0521fcc1b2d8c2da4c26eb6dbd7262d494522679/tf/about/clientmanual.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/69c3f8c35133bfdd1e62af1d1705bac20abb14d0/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 @@ -93,7 +93,7 @@ <h2 id="writing">Writing</h2>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/0521fcc1b2d8c2da4c26eb6dbd7262d494522679/tf/about/code.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/69c3f8c35133bfdd1e62af1d1705bac20abb14d0/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
2 changes: 1 addition & 1 deletion tf/about/corpora.html
Original file line number Diff line number Diff line change
Expand Up @@ -337,7 +337,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/0521fcc1b2d8c2da4c26eb6dbd7262d494522679/tf/about/corpora.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/69c3f8c35133bfdd1e62af1d1705bac20abb14d0/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
2 changes: 1 addition & 1 deletion tf/about/datamodel.html
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,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/0521fcc1b2d8c2da4c26eb6dbd7262d494522679/tf/about/datamodel.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/69c3f8c35133bfdd1e62af1d1705bac20abb14d0/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 @@ -356,7 +356,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/0521fcc1b2d8c2da4c26eb6dbd7262d494522679/tf/about/datasharing.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/69c3f8c35133bfdd1e62af1d1705bac20abb14d0/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
2 changes: 1 addition & 1 deletion tf/about/displaydesign.html
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ <h3 id="output">Output</h3>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/0521fcc1b2d8c2da4c26eb6dbd7262d494522679/tf/about/displaydesign.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/69c3f8c35133bfdd1e62af1d1705bac20abb14d0/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 @@ -156,7 +156,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/0521fcc1b2d8c2da4c26eb6dbd7262d494522679/tf/about/faq.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/69c3f8c35133bfdd1e62af1d1705bac20abb14d0/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 @@ -153,7 +153,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/0521fcc1b2d8c2da4c26eb6dbd7262d494522679/tf/about/fileformats.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/69c3f8c35133bfdd1e62af1d1705bac20abb14d0/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 @@ -28,7 +28,7 @@ <h1 id="documents">Documents</h1>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/0521fcc1b2d8c2da4c26eb6dbd7262d494522679/tf/about/__init__.py#L1-L5" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/69c3f8c35133bfdd1e62af1d1705bac20abb14d0/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 @@ -103,7 +103,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/0521fcc1b2d8c2da4c26eb6dbd7262d494522679/tf/about/install.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/69c3f8c35133bfdd1e62af1d1705bac20abb14d0/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 @@ -384,7 +384,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/0521fcc1b2d8c2da4c26eb6dbd7262d494522679/tf/about/manual.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/69c3f8c35133bfdd1e62af1d1705bac20abb14d0/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 @@ -182,7 +182,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/0521fcc1b2d8c2da4c26eb6dbd7262d494522679/tf/about/optimizations.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/69c3f8c35133bfdd1e62af1d1705bac20abb14d0/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
15 changes: 14 additions & 1 deletion tf/about/releases.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,18 @@ <h1 id="release-notes">Release notes</h1>
</code></pre>
<h2 id="12">12</h2>
<h3 id="122">12.2</h3>
<h4 id="1227">12.2.7</h4>
<p>2024-01-23</p>
<p>There were issues with starting up the Text-Fabric browser:</p>
<ul>
<li>If the system could not start the browser, the TF stopped the webserver. That is
not helpful, because one can always open a browser and enter the url in the
address bar. Now TF shows the url rather prominently when it does not open
a browser.</li>
<li>If debug mode is on, Flask reloads the whole process, and that might include
opening the browser as well. Now Flask only opens the browser after the startup of
the webserver, and not anymore after successive reloads.</li>
</ul>
<h4 id="1226">12.2.6</h4>
<p>2024-01-15</p>
<p>Somehow the express way of downloading data (via complete.zip attached to the latest
Expand Down Expand Up @@ -255,7 +267,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/0521fcc1b2d8c2da4c26eb6dbd7262d494522679/tf/about/releases.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/69c3f8c35133bfdd1e62af1d1705bac20abb14d0/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 Expand Up @@ -329,6 +341,7 @@ <h1>Index</h1>
<li><a href="#release-notes">Release notes</a><ul>
<li><a href="#12">12</a><ul>
<li><a href="#122">12.2</a><ul>
<li><a href="#1227">12.2.7</a></li>
<li><a href="#1226">12.2.6</a></li>
<li><a href="#1225">12.2.5</a></li>
<li><a href="#12234">12.2.3,4</a></li>
Expand Down
2 changes: 1 addition & 1 deletion tf/about/releasesold.html
Original file line number Diff line number Diff line change
Expand Up @@ -3419,7 +3419,7 @@ <h5 id="changed">Changed</h5>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/0521fcc1b2d8c2da4c26eb6dbd7262d494522679/tf/about/releasesold.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/69c3f8c35133bfdd1e62af1d1705bac20abb14d0/tf/about/releasesold.py#L1-L3" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
.. include:: ../docs/about/releasesold.md
Expand Down
2 changes: 1 addition & 1 deletion tf/about/searchdesign.html
Original file line number Diff line number Diff line change
Expand Up @@ -472,7 +472,7 @@ <h3 id="small-first-strategy">Small-first strategy</h3>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/0521fcc1b2d8c2da4c26eb6dbd7262d494522679/tf/about/searchdesign.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/69c3f8c35133bfdd1e62af1d1705bac20abb14d0/tf/about/searchdesign.py#L1-L3" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
.. include:: ../docs/about/searchdesign.md
Expand Down
2 changes: 1 addition & 1 deletion tf/about/searchusage.html
Original file line number Diff line number Diff line change
Expand Up @@ -770,7 +770,7 @@ <h5 id="implementation">Implementation</h5>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/0521fcc1b2d8c2da4c26eb6dbd7262d494522679/tf/about/searchusage.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/69c3f8c35133bfdd1e62af1d1705bac20abb14d0/tf/about/searchusage.py#L1-L3" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
.. include:: ../docs/about/searchusage.md
Expand Down
2 changes: 1 addition & 1 deletion tf/about/tests.html
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ <h2 id="relations">Relations</h2>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/0521fcc1b2d8c2da4c26eb6dbd7262d494522679/tf/about/tests.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/69c3f8c35133bfdd1e62af1d1705bac20abb14d0/tf/about/tests.py#L1-L3" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
.. include:: ../docs/about/tests.md
Expand Down
2 changes: 1 addition & 1 deletion tf/about/use.html
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ <h2 id="tf-api">TF API</h2>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/0521fcc1b2d8c2da4c26eb6dbd7262d494522679/tf/about/use.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/69c3f8c35133bfdd1e62af1d1705bac20abb14d0/tf/about/use.py#L1-L3" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
.. include:: ../docs/about/use.md
Expand Down
2 changes: 1 addition & 1 deletion tf/about/usefunc.html
Original file line number Diff line number Diff line change
Expand Up @@ -411,7 +411,7 @@ <h2 id="prevent-data-loading">Prevent data loading</h2>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/0521fcc1b2d8c2da4c26eb6dbd7262d494522679/tf/about/usefunc.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/69c3f8c35133bfdd1e62af1d1705bac20abb14d0/tf/about/usefunc.py#L1-L3" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
.. include:: ../docs/about/usefunc.md
Expand Down
2 changes: 1 addition & 1 deletion tf/about/variants.html
Original file line number Diff line number Diff line change
Expand Up @@ -433,7 +433,7 @@ <h3 id="the-stack">The stack</h3>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/0521fcc1b2d8c2da4c26eb6dbd7262d494522679/tf/about/variants.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/69c3f8c35133bfdd1e62af1d1705bac20abb14d0/tf/about/variants.py#L1-L3" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
.. include:: ../docs/about/variants.md
Expand Down
2 changes: 1 addition & 1 deletion tf/about/volumes.html
Original file line number Diff line number Diff line change
Expand Up @@ -318,7 +318,7 @@ <h2 id="reflection">Reflection</h2>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/0521fcc1b2d8c2da4c26eb6dbd7262d494522679/tf/about/volumes.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/69c3f8c35133bfdd1e62af1d1705bac20abb14d0/tf/about/volumes.py#L1-L3" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
.. include:: ../docs/about/volumes.md
Expand Down
6 changes: 3 additions & 3 deletions tf/advanced/annotate.html
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ <h1 class="title">Module <code>tf.advanced.annotate</code></h1>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/0521fcc1b2d8c2da4c26eb6dbd7262d494522679/tf/advanced/annotate.py#L1-L26" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/69c3f8c35133bfdd1e62af1d1705bac20abb14d0/tf/advanced/annotate.py#L1-L26" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
Enable manual annotation APIs.
Expand Down Expand Up @@ -79,7 +79,7 @@ <h2 id="parameters">Parameters</h2>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/0521fcc1b2d8c2da4c26eb6dbd7262d494522679/tf/advanced/annotate.py#L17-L26" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/69c3f8c35133bfdd1e62af1d1705bac20abb14d0/tf/advanced/annotate.py#L17-L26" class="git-link">Browse git</a>
</summary>
<pre><code class="python">def annotateApi(app):
&#34;&#34;&#34;Produce the interchange functions API.
Expand All @@ -101,7 +101,7 @@ <h2 id="parameters">Parameters</h2>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/0521fcc1b2d8c2da4c26eb6dbd7262d494522679/tf/advanced/annotate.py#L13-L14" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/69c3f8c35133bfdd1e62af1d1705bac20abb14d0/tf/advanced/annotate.py#L13-L14" class="git-link">Browse git</a>
</summary>
<pre><code class="python">def makeNer(app):
return NER(app)</code></pre>
Expand Down
Loading

0 comments on commit c7282d6

Please sign in to comment.