Manual compiled

acdh-oeaw · Dec 28, 2024 · ad55438 · ad55438
1 parent 397b82a
commit ad55438
Show file tree

Hide file tree

Showing 19 changed files with 218 additions and 15 deletions.
diff --git a/openatlas/static/manual/.doctrees/entity/source.doctree b/openatlas/static/manual/.doctrees/entity/source.doctree
diff --git a/openatlas/static/manual/.doctrees/environment.pickle b/openatlas/static/manual/.doctrees/environment.pickle
diff --git a/openatlas/static/manual/.doctrees/features.doctree b/openatlas/static/manual/.doctrees/features.doctree
diff --git a/openatlas/static/manual/.doctrees/model/cidoc_crm.doctree b/openatlas/static/manual/.doctrees/model/cidoc_crm.doctree
diff --git a/openatlas/static/manual/.doctrees/model/openatlas_classes.doctree b/openatlas/static/manual/.doctrees/model/openatlas_classes.doctree
diff --git a/openatlas/static/manual/.doctrees/tools/index.doctree b/openatlas/static/manual/.doctrees/tools/index.doctree
diff --git a/openatlas/static/manual/.doctrees/tools/text_annotation.doctree b/openatlas/static/manual/.doctrees/tools/text_annotation.doctree
diff --git a/openatlas/static/manual/entity/source.html b/openatlas/static/manual/entity/source.html
@@ -126,7 +126,8 @@ <h2>Form fields<a class="headerlink" href="#form-fields" title="Permalink to thi
 <li><p><a class="reference internal" href="../ui/name.html"><span class="doc">Name</span></a></p></li>
 <li><p><a class="reference internal" href="type.html"><span class="doc">Type</span></a></p></li>
 <li><p><a class="reference internal" href="artifact.html"><span class="doc">Artifact</span></a> - use if the source is part of an artifact</p></li>
-<li><p><strong>Content</strong> - a summary or the whole text of the source</p></li>
+<li><p><strong>Content</strong> - a summary or the whole text of the source.
+<a class="reference internal" href="../tools/text_annotation.html"><span class="doc">Text annotation</span></a> can be used.</p></li>
 </ul>
 </section>
 <section id="can-be-linked-via-tabs-to">
@@ -136,10 +137,13 @@ <h2>Can be linked via tabs to<a class="headerlink" href="#can-be-linked-via-tabs
 references</p></li>
 <li><p><a class="reference internal" href="reference.html"><span class="doc">Reference</span></a> - link to the literature the source is documented in, e.g.
 editions of charters or secondary sources</p></li>
-<li><p><strong>Translation</strong> - add translations of the source or a comment</p></li>
+<li><p><strong>Text</strong> - add translations or similar to the source</p></li>
 <li><p><a class="reference internal" href="file.html"><span class="doc">File</span></a></p></li>
 </ul>
 </section>
+<section id="text-annotation">
+<h2>Text annotation<a class="headerlink" href="#text-annotation" title="Permalink to this heading"></a></h2>
+</section>
 </section>
 
 

diff --git a/openatlas/static/manual/examples/archaeological_data.html b/openatlas/static/manual/examples/archaeological_data.html
@@ -18,7 +18,7 @@
         <script src="../_static/sphinx_highlight.js"></script>
     <script src="../_static/js/theme.js"></script>
     <link rel="search" title="Search" href="../search.html" />
-    <link rel="next" title="Adding actors" href="journey.html" />
+    <link rel="next" title="Journey" href="journey.html" />
     <link rel="prev" title="Types" href="types.html" /> 
 </head>
 
@@ -265,7 +265,7 @@ <h2>Adding human remains to the stratigraphic unit<a class="headerlink" href="#a
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
         <a href="types.html" class="btn btn-neutral float-left" title="Types" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
-        <a href="journey.html" class="btn btn-neutral float-right" title="Adding actors" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+        <a href="journey.html" class="btn btn-neutral float-right" title="Journey" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 
   <hr/>

diff --git a/openatlas/static/manual/examples/letters.html b/openatlas/static/manual/examples/letters.html
@@ -19,7 +19,7 @@
     <script src="../_static/js/theme.js"></script>
     <link rel="search" title="Search" href="../search.html" />
     <link rel="next" title="Profession" href="profession.html" />
-    <link rel="prev" title="Adding actors" href="journey.html" /> 
+    <link rel="prev" title="Journey" href="journey.html" /> 
 </head>
 
 <body class="wy-body-for-nav"> 
@@ -180,7 +180,7 @@ <h2>Adding sender and recipient<a class="headerlink" href="#adding-sender-and-re
            </div>
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
-        <a href="journey.html" class="btn btn-neutral float-left" title="Adding actors" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="journey.html" class="btn btn-neutral float-left" title="Journey" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
         <a href="profession.html" class="btn btn-neutral float-right" title="Profession" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 

diff --git a/openatlas/static/manual/examples/move_event.html b/openatlas/static/manual/examples/move_event.html
@@ -121,11 +121,11 @@ <h2>Create a new move event - general instruction<a class="headerlink" href="#cr
 occur simultaneously. Examples are a music festival with parallel concerts
 or a war with overlapping battles at different locations. To represent a
 temporal sequence, use <strong>preceding event</strong> (for a short introduction see
-the <a class="reference internal" href="journey.html"><span class="doc">Adding actors</span></a> tutorial). You can select the event from a list of
+the <a class="reference internal" href="journey.html"><span class="doc">Journey</span></a> tutorial). You can select the event from a list of
 already entered events. If the event you are looking for cannot be found
 in this list, please add it via <strong>Event</strong> in the menu and then link it</p></li>
 <li><p>You can add a <strong>preceding event</strong>, for more information see
-above or the <a class="reference internal" href="journey.html"><span class="doc">Adding actors</span></a> tutorial</p></li>
+above or the <a class="reference internal" href="journey.html"><span class="doc">Journey</span></a> tutorial</p></li>
 <li><p>Via <strong>from</strong> you can add a location from where the move event started,
 think of the starting point of a journey or the place a letter was sent from.
 You can choose a location from a list of already added locations. If the
@@ -141,7 +141,7 @@ <h2>Create a new move event - general instruction<a class="headerlink" href="#cr
 of already entered actors. If the actor is not entered into the database
 already, use the <strong>Actor</strong> tab in the menu to create an entry and link it
 here. More information about how to add actors is available at the
-<a class="reference internal" href="journey.html"><span class="doc">Adding actors</span></a> tutorial.</p></li>
+<a class="reference internal" href="journey.html"><span class="doc">Journey</span></a> tutorial.</p></li>
 <li><p>It is possible to link the move event by using external references (find
 more information <a class="reference internal" href="../entity/reference_system.html"><span class="doc">here</span></a>)</p></li>
 <li><p>Enter a start and end <strong>date</strong> of the move event if known</p></li>
@@ -153,7 +153,7 @@ <h2>Create a new move event - general instruction<a class="headerlink" href="#cr
 your new entry.</p>
 <p>For more information on move events including an artifact, please see the
 example on <a class="reference internal" href="letters.html"><span class="doc">Letters</span></a>. On how to enter a journey, please refer
-to the <a class="reference internal" href="journey.html"><span class="doc">Adding actors</span></a> tutorial.</p>
+to the <a class="reference internal" href="journey.html"><span class="doc">Journey</span></a> tutorial.</p>
 </section>
 </section>
 

diff --git a/openatlas/static/manual/features.html b/openatlas/static/manual/features.html
@@ -52,6 +52,7 @@
 <li class="toctree-l2"><a class="reference internal" href="#user-interface">User Interface</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#iiif-integration">IIIF Integration</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#image-annotation">Image Annotation</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#text-annotation">Text Annotation</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#data-exchange">Data Exchange</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#user-management">User Management</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#anthropological-analyses">Anthropological Analyses</a></li>
@@ -176,6 +177,11 @@ <h2>Image Annotation<a class="headerlink" href="#image-annotation" title="Permal
 <p>With enabled IIIF it is possible to annotate images and link the annotation to
 entities via the <a class="reference internal" href="tools/image_annotation.html"><span class="doc">Image annotation</span></a> feature.</p>
 </section>
+<section id="text-annotation">
+<h2>Text Annotation<a class="headerlink" href="#text-annotation" title="Permalink to this heading"></a></h2>
+<p>Text parts of sources can be annotated and linked to entities via the
+<a class="reference internal" href="tools/text_annotation.html"><span class="doc">Text annotation</span></a> feature.</p>
+</section>
 <section id="data-exchange">
 <h2>Data Exchange<a class="headerlink" href="#data-exchange" title="Permalink to this heading"></a></h2>
 <p>OpenAtlas offers various possibilities to exchange data with other systems or

diff --git a/openatlas/static/manual/index.html b/openatlas/static/manual/index.html
@@ -105,6 +105,7 @@ <h1>OpenAtlas manual<a class="headerlink" href="#openatlas-manual" title="Permal
 <li class="toctree-l2"><a class="reference internal" href="features.html#user-interface">User Interface</a></li>
 <li class="toctree-l2"><a class="reference internal" href="features.html#iiif-integration">IIIF Integration</a></li>
 <li class="toctree-l2"><a class="reference internal" href="features.html#image-annotation">Image Annotation</a></li>
+<li class="toctree-l2"><a class="reference internal" href="features.html#text-annotation">Text Annotation</a></li>
 <li class="toctree-l2"><a class="reference internal" href="features.html#data-exchange">Data Exchange</a></li>
 <li class="toctree-l2"><a class="reference internal" href="features.html#user-management">User Management</a></li>
 <li class="toctree-l2"><a class="reference internal" href="features.html#anthropological-analyses">Anthropological Analyses</a></li>
@@ -134,6 +135,7 @@ <h1>OpenAtlas manual<a class="headerlink" href="#openatlas-manual" title="Permal
 <li class="toctree-l2"><a class="reference internal" href="tools/profile.html">Profile</a></li>
 <li class="toctree-l2"><a class="reference internal" href="tools/notes.html">Notes</a></li>
 <li class="toctree-l2"><a class="reference internal" href="tools/image_annotation.html">Image annotation</a></li>
+<li class="toctree-l2"><a class="reference internal" href="tools/text_annotation.html">Text annotation</a></li>
 <li class="toctree-l2"><a class="reference internal" href="tools/map.html">Map</a></li>
 <li class="toctree-l2"><a class="reference internal" href="tools/network.html">Network visualization</a></li>
 <li class="toctree-l2"><a class="reference internal" href="tools/anthropological_analyses.html">Anthropological Analyses</a></li>

diff --git a/openatlas/static/manual/model/cidoc_crm.html b/openatlas/static/manual/model/cidoc_crm.html
@@ -109,8 +109,8 @@ <h1>CIDOC CRM<a class="headerlink" href="#cidoc-crm" title="Permalink to this he
 in connection with the International Council of Museums
 (<a class="reference external" href="https://icom.museum/en/">ICOM</a>).</p>
 <p>In OpenAtlas its current version,
-<a class="reference external" href="https://cidoc-crm.org/Version/version-7.1.2">CIDOC CRM v7.1.2</a> published in
-May 2021, is used as underlying data model of the database.</p>
+<a class="reference external" href="https://cidoc-crm.org/Version/version-7.1.3">CIDOC CRM v7.1.3</a> published in
+February 2024, is used as underlying data model of the database.</p>
 <p>A script is used to parse the specification and import it into a
 <a class="reference external" href="https://www.postgresql.org/">PostgreSQL</a> database (more information is
 available on <a class="reference external" href="https://github.com/craws/OpenAtlas/tree/main/install">GitHub</a>).

diff --git a/openatlas/static/manual/model/openatlas_classes.html b/openatlas/static/manual/model/openatlas_classes.html
@@ -113,8 +113,8 @@ <h1>OpenAtlas classes<a class="headerlink" href="#openatlas-classes" title="Perm
 <a class="reference external" href="https://github.com/craws/OpenAtlas/tree/main/install/crm">here</a>.</p>
 <p>All of these so called OpenAtlas classes can be mapped directly to the
 corresponding CIDOC CRM class. For all available classes and properties of
-CIDOC CRM (version 7.1.2) see
-<a class="reference external" href="https://cidoc-crm.org/Version/version-7.1.2">the CIDOC CRM documentation</a>.</p>
+CIDOC CRM (version 7.1.3) see
+<a class="reference external" href="https://cidoc-crm.org/Version/version-7.1.3">the CIDOC CRM documentation</a>.</p>
 <p>Example:
 <a class="reference external" href="https://www.cidoc-crm.org/Entity/e18-physical-thing/version-7.1">E18 - Physical Thing</a> “comprises all
 persistent physical items with a relatively stable form, human-made or

diff --git a/openatlas/static/manual/objects.inv b/openatlas/static/manual/objects.inv
diff --git a/openatlas/static/manual/searchindex.js b/openatlas/static/manual/searchindex.js
diff --git a/openatlas/static/manual/tools/index.html b/openatlas/static/manual/tools/index.html
@@ -55,6 +55,7 @@
 <li class="toctree-l2"><a class="reference internal" href="profile.html">Profile</a></li>
 <li class="toctree-l2"><a class="reference internal" href="notes.html">Notes</a></li>
 <li class="toctree-l2"><a class="reference internal" href="image_annotation.html">Image annotation</a></li>
+<li class="toctree-l2"><a class="reference internal" href="text_annotation.html">Text annotation</a></li>
 <li class="toctree-l2"><a class="reference internal" href="map.html">Map</a></li>
 <li class="toctree-l2"><a class="reference internal" href="network.html">Network visualization</a></li>
 <li class="toctree-l2"><a class="reference internal" href="anthropological_analyses.html">Anthropological Analyses</a></li>
@@ -119,6 +120,11 @@ <h1>Tools<a class="headerlink" href="#tools" title="Permalink to this heading">
 <li class="toctree-l2"><a class="reference internal" href="image_annotation.html#usage">Usage</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="text_annotation.html">Text annotation</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="text_annotation.html#usage">Usage</a></li>
+<li class="toctree-l2"><a class="reference internal" href="text_annotation.html#limitations">Limitations</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="map.html">Map</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="map.html#navigation">Navigation</a></li>
 <li class="toctree-l2"><a class="reference internal" href="map.html#search">Search</a></li>