Skip to content

Commit

Permalink
Merge branch 'main' into develop
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexanderWatzinger committed Jan 1, 2025
2 parents ea1d648 + 01858a3 commit 13cabca
Show file tree
Hide file tree
Showing 13 changed files with 23 additions and 19 deletions.
Binary file modified openatlas/static/manual/.doctrees/environment.pickle
Binary file not shown.
Binary file modified openatlas/static/manual/.doctrees/tools/text_annotation.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion openatlas/static/manual/searchindex.js

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -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 current"><a class="current reference internal" href="#">Anthropological Analyses</a></li>
Expand Down
5 changes: 3 additions & 2 deletions openatlas/static/manual/tools/image_annotation.html
Original file line number Diff line number Diff line change
Expand Up @@ -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="Map" href="map.html" />
<link rel="next" title="Text annotation" href="text_annotation.html" />
<link rel="prev" title="Notes" href="notes.html" />
</head>

Expand Down Expand Up @@ -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 current"><a class="current reference internal" href="#">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>
Expand Down Expand Up @@ -138,7 +139,7 @@ <h2>Usage<a class="headerlink" href="#usage" title="Permalink to this heading">
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="notes.html" class="btn btn-neutral float-left" title="Notes" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="map.html" class="btn btn-neutral float-right" title="Map" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="text_annotation.html" class="btn btn-neutral float-right" title="Text annotation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

<hr/>
Expand Down
5 changes: 3 additions & 2 deletions openatlas/static/manual/tools/map.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="search" title="Search" href="../search.html" />
<link rel="next" title="Network visualization" href="network.html" />
<link rel="prev" title="Image annotation" href="image_annotation.html" />
<link rel="prev" title="Text annotation" href="text_annotation.html" />
</head>

<body class="wy-body-for-nav">
Expand Down Expand Up @@ -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 current"><a class="current reference internal" href="#">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>
Expand Down Expand Up @@ -186,7 +187,7 @@ <h2>Map Overlay<a class="headerlink" href="#map-overlay" title="Permalink to thi
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="image_annotation.html" class="btn btn-neutral float-left" title="Image annotation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="text_annotation.html" class="btn btn-neutral float-left" title="Text annotation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="network.html" class="btn btn-neutral float-right" title="Network visualization" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

Expand Down
1 change: 1 addition & 0 deletions openatlas/static/manual/tools/network.html
Original file line number Diff line number Diff line change
Expand Up @@ -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 current"><a class="current reference internal" href="#">Network visualization</a></li>
<li class="toctree-l2"><a class="reference internal" href="anthropological_analyses.html">Anthropological Analyses</a></li>
Expand Down
1 change: 1 addition & 0 deletions openatlas/static/manual/tools/notes.html
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@
<li class="toctree-l2"><a class="reference internal" href="profile.html">Profile</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">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>
Expand Down
1 change: 1 addition & 0 deletions openatlas/static/manual/tools/profile.html
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@
<li class="toctree-l2 current"><a class="current reference internal" href="#">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>
Expand Down
1 change: 1 addition & 0 deletions openatlas/static/manual/tools/radiocarbon_dating.html
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
1 change: 1 addition & 0 deletions openatlas/static/manual/tools/search.html
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
12 changes: 5 additions & 7 deletions openatlas/static/manual/tools/text_annotation.html
Original file line number Diff line number Diff line change
Expand Up @@ -109,21 +109,19 @@ <h1>Text annotation<a class="headerlink" href="#text-annotation" title="Permalin
<p>The text annotation feature allows for marking text in a
<a class="reference internal" href="../entity/source.html"><span class="doc">Source</span></a> (or source text) adding a comment and/or link to an
entity. In that way the mention of a person, place, event … can be linked to
entity in OpenAtlas.</p>
an entity in OpenAtlas.</p>
<section id="usage">
<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this heading"></a></h2>
<p>A text can be annotated when when adding or updating a <a class="reference internal" href="../entity/source.html"><span class="doc">Source</span></a>
<p>A text can be annotated when adding or updating a <a class="reference internal" href="../entity/source.html"><span class="doc">Source</span></a>
(or source text) with following steps:</p>
<ul class="simple">
<li><p>Mark the specific text part in the source with the left mouse button</p></li>
<li><p>Click on the <strong>Annotate</strong> button above the text field</p></li>
<li><p>Select the entity which is releated to the annotation and/or</p></li>
<li><p>Add a comment</p></li>
<li><p>Click the <strong>Annotate</strong> button above the text field</p></li>
<li><p>Select the entity which is releated to the annotation and/or add a comment</p></li>
<li><p>Click on add</p></li>
<li><p>Press the save button of the form to submit it</p></li>
</ul>
<p>After that the text annotations should already be visible in the source detail
view:</p>
<p>After that the text annotations is also visible in the source detail view:</p>
<ul class="simple">
<li><p>Links to other entities are displayed</p></li>
<li><p>With mouse over you can read the comments</p></li>
Expand Down
12 changes: 5 additions & 7 deletions sphinx/source/tools/text_annotation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,20 @@ Text annotation
The text annotation feature allows for marking text in a
:doc:`/entity/source` (or source text) adding a comment and/or link to an
entity. In that way the mention of a person, place, event ... can be linked to
entity in OpenAtlas.
an entity in OpenAtlas.

Usage
-----
A text can be annotated when when adding or updating a :doc:`/entity/source`
A text can be annotated when adding or updating a :doc:`/entity/source`
(or source text) with following steps:

* Mark the specific text part in the source with the left mouse button
* Click on the **Annotate** button above the text field
* Select the entity which is releated to the annotation and/or
* Add a comment
* Click the **Annotate** button above the text field
* Select the entity which is releated to the annotation and/or add a comment
* Click on add
* Press the save button of the form to submit it

After that the text annotations should already be visible in the source detail
view:
After that the text annotations is also visible in the source detail view:

* Links to other entities are displayed
* With mouse over you can read the comments
Expand Down

0 comments on commit 13cabca

Please sign in to comment.