Skip to content

Commit

Permalink
Manual update
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexanderWatzinger committed Nov 6, 2024
1 parent 0277318 commit 6e5ac06
Show file tree
Hide file tree
Showing 33 changed files with 336 additions and 286 deletions.
Binary file modified openatlas/static/manual/.doctrees/entity/actor.doctree
Binary file not shown.
Binary file modified openatlas/static/manual/.doctrees/entity/artifact.doctree
Binary file not shown.
Binary file modified openatlas/static/manual/.doctrees/entity/event.doctree
Binary file not shown.
Binary file modified openatlas/static/manual/.doctrees/entity/feature.doctree
Binary file not shown.
Binary file modified openatlas/static/manual/.doctrees/entity/file.doctree
Binary file not shown.
Binary file modified openatlas/static/manual/.doctrees/entity/human_remains.doctree
Binary file not shown.
Binary file modified openatlas/static/manual/.doctrees/entity/index.doctree
Binary file not shown.
Binary file modified openatlas/static/manual/.doctrees/entity/navigation.doctree
Binary file not shown.
Binary file modified openatlas/static/manual/.doctrees/entity/place.doctree
Binary file not shown.
Binary file modified openatlas/static/manual/.doctrees/entity/reference.doctree
Binary file not shown.
Binary file not shown.
Binary file modified openatlas/static/manual/.doctrees/entity/source.doctree
Binary file not shown.
Binary file modified openatlas/static/manual/.doctrees/entity/stratigraphic_unit.doctree
Binary file not shown.
Binary file modified openatlas/static/manual/.doctrees/entity/type.doctree
Binary file not shown.
Binary file modified openatlas/static/manual/.doctrees/environment.pickle
Binary file not shown.
43 changes: 25 additions & 18 deletions openatlas/static/manual/entity/actor.html
Original file line number Diff line number Diff line change
Expand Up @@ -112,16 +112,18 @@ <h1>Actor<a class="headerlink" href="#actor" title="Permalink to this heading">
<p>CIDOC documentation: <a class="reference external" href="https://www.cidoc-crm.org/Entity/e21-person/version-7.1">E21 Person</a> and
<a class="reference external" href="https://www.cidoc-crm.org/Entity/e74-group/version-7.1">E74 Group</a></p>
<ul class="simple">
<li><p><strong>Person</strong> (<a class="reference external" href="https://www.cidoc-crm.org/Entity/e21-person/version-7.1">E21 Person</a>)</p></li>
<li><p><strong>Group</strong> (<a class="reference external" href="https://www.cidoc-crm.org/Entity/e74-group/version-7.1">E74 Group</a>) - e
.g. a family, a tribe, Greenpeace or the National Museum of
<li><p><strong>Person</strong> (<a class="reference external" href="https://www.cidoc-crm.org/Entity/e21-person/version-7.1">E21 Person</a>) - A single person,
such as Albert Einstein or Queen Victoria</p></li>
<li><p><strong>Group</strong> (<a class="reference external" href="https://www.cidoc-crm.org/Entity/e74-group/version-7.1">E74 Group</a>) - A group of people,
e.g. a family, a tribe, Greenpeace or the National Museum of
Denmark</p></li>
</ul>
<p>On the index page already entered entities are listed in a <a class="reference internal" href="../ui/table.html"><span class="doc">Table</span></a>.</p>
<p>At the index page already entered entities are listed in a <a class="reference internal" href="../ui/table.html"><span class="doc">Table</span></a>.</p>
<ul class="simple">
<li><p>Click on the <strong>+</strong> button to enter a new one.</p></li>
<li><p>Click on the <strong>name</strong> of an entry in the list to access the <strong>detail view</strong>.</p></li>
<li><p>To edit or delete an entry click on the <strong>Edit</strong> button in the <strong>detail view.</strong></p></li>
<li><p>Click on the <strong>+</strong> button to enter a new one</p></li>
<li><p>Click on the <strong>name</strong> of an entry in the list to access the <strong>detail view</strong></p></li>
<li><p>To edit or delete an entry, click on the <strong>Edit</strong> button in the <strong>detail
view.</strong></p></li>
</ul>
<section id="form-fields">
<h2>Form fields<a class="headerlink" href="#form-fields" title="Permalink to this heading"></a></h2>
Expand All @@ -130,23 +132,28 @@ <h2>Form fields<a class="headerlink" href="#form-fields" title="Permalink to thi
<li><p><a class="reference internal" href="../ui/alias.html"><span class="doc">Alias</span></a></p></li>
<li><p><a class="reference internal" href="../ui/date.html"><span class="doc">Date</span></a></p></li>
<li><p><a class="reference internal" href="../ui/description.html"><span class="doc">Description</span></a></p></li>
<li><p><strong>Residence</strong> - a <a class="reference internal" href="place.html"><span class="doc">Place</span></a>, e.g. the location of an institute or the main residence of an actor</p></li>
<li><p><strong>Born in / Begins in</strong> - the <a class="reference internal" href="place.html"><span class="doc">Place</span></a> where a person was born or a group began</p></li>
<li><p><strong>Died in / Ends in</strong> - the <a class="reference internal" href="place.html"><span class="doc">Place</span></a> where a person died or a group ended</p></li>
<li><p><strong>Residence</strong> - A <a class="reference internal" href="place.html"><span class="doc">Place</span></a>, for a group this might be the location of an
institute, for a person for example the main residence</p></li>
<li><p><strong>Born in / Begins in</strong> - The <a class="reference internal" href="place.html"><span class="doc">Place</span></a> where a person was born or a
group came into existence</p></li>
<li><p><strong>Died in / Ends in</strong> - The <a class="reference internal" href="place.html"><span class="doc">Place</span></a> where a person died or a group ended</p></li>
<li><p><a class="reference internal" href="reference_system.html"><span class="doc">Reference System</span></a></p></li>
</ul>
</section>
<section id="can-be-linked-via-tabs-to">
<h2>Can be linked via tabs to<a class="headerlink" href="#can-be-linked-via-tabs-to" title="Permalink to this heading"></a></h2>
<ul class="simple">
<li><p><a class="reference internal" href="source.html"><span class="doc">Source</span></a> - when it is referenced there</p></li>
<li><p><a class="reference internal" href="event.html"><span class="doc">Event</span></a> - for participation</p></li>
<li><p><strong>Relation</strong> - to other actors</p></li>
<li><p><strong>Member of</strong> - the groups it is member of</p></li>
<li><p><strong>Member</strong> - to actors who are members (only available for groups)</p></li>
<li><p><a class="reference internal" href="artifact.html"><span class="doc">Artifact</span></a> - owned artifacts and human remains by that actor</p></li>
<li><p><a class="reference internal" href="reference.html"><span class="doc">Reference</span></a></p></li>
<li><p><a class="reference internal" href="file.html"><span class="doc">File</span></a></p></li>
<li><p><a class="reference internal" href="source.html"><span class="doc">Source</span></a> - Use, if an actor is mentioned in a source</p></li>
<li><p><a class="reference internal" href="event.html"><span class="doc">Event</span></a> - Use, if an actor participated in an event</p></li>
<li><p><strong>Relation</strong> - Use to specify relations to other actors such as mother of
or married to</p></li>
<li><p><strong>Member of</strong> - Use to specify a group an actor is a member of</p></li>
<li><p><strong>Member</strong> - Link to actors to specify who was a member in a group (only
available for groups)</p></li>
<li><p><a class="reference internal" href="artifact.html"><span class="doc">Artifact</span></a> - Use to specify which artifacts and/or human remains are
owned by an actor (e.g. human remains that are kept in a museum)</p></li>
<li><p><a class="reference internal" href="reference.html"><span class="doc">Reference</span></a> - Use to add citation</p></li>
<li><p><a class="reference internal" href="file.html"><span class="doc">File</span></a> - Add a file, e.g. a picture of a person or group</p></li>
</ul>
</section>
</section>
Expand Down
34 changes: 18 additions & 16 deletions openatlas/static/manual/entity/artifact.html
Original file line number Diff line number Diff line change
Expand Up @@ -111,12 +111,13 @@ <h1>Artifact<a class="headerlink" href="#artifact" title="Permalink to this head
</div>
<p>CIDOC documentation:
<a class="reference external" href="https://www.cidoc-crm.org/Entity/e22-human-made-object/version-7.1">E22 Human-Made Object</a></p>
<p>Artifact can be entered here, e.g. a coin</p>
<p>On the index page already entered entities are listed in a <a class="reference internal" href="../ui/table.html"><span class="doc">Table</span></a>.</p>
<p>Artifact such as coins or pottery can be entered in this form.</p>
<p>At the index page already entered entities are listed in a <a class="reference internal" href="../ui/table.html"><span class="doc">Table</span></a>.</p>
<ul class="simple">
<li><p>Click on the <strong>+</strong> button to enter a new one.</p></li>
<li><p>Click on the <strong>name</strong> of an entry in the list to access the <strong>detail view</strong>.</p></li>
<li><p>To edit or delete an entry click on the <strong>Edit</strong> button in the <strong>detail view.</strong></p></li>
<li><p>Click on the <strong>+</strong> button to enter a new one</p></li>
<li><p>Click on the <strong>name</strong> of an entry in the list to access the <strong>detail view</strong></p></li>
<li><p>To edit or delete an entry, click on the <strong>Edit</strong> button in the <strong>detail
view.</strong></p></li>
</ul>
<section id="form-fields">
<h2>Form fields<a class="headerlink" href="#form-fields" title="Permalink to this heading"></a></h2>
Expand All @@ -127,23 +128,24 @@ <h2>Form fields<a class="headerlink" href="#form-fields" title="Permalink to thi
<li><p><a class="reference internal" href="../ui/description.html"><span class="doc">Description</span></a></p></li>
<li><p><a class="reference internal" href="../tools/map.html"><span class="doc">Map</span></a></p></li>
<li><p><a class="reference internal" href="reference_system.html"><span class="doc">Reference System</span></a></p></li>
<li><p><strong>Super</strong> - a <a class="reference internal" href="place.html"><span class="doc">Place</span></a>, <a class="reference internal" href="feature.html"><span class="doc">Feature</span></a>, <a class="reference internal" href="stratigraphic_unit.html"><span class="doc">Stratigraphic unit</span></a> or
artifact, which it is a part of</p></li>
<li><p><strong>Owned by</strong> - the <a class="reference internal" href="actor.html"><span class="doc">Actor</span></a> who owns the artifact</p></li>
<li><p><strong>Super</strong> - A <a class="reference internal" href="place.html"><span class="doc">Place</span></a>, <a class="reference internal" href="feature.html"><span class="doc">Feature</span></a>, <a class="reference internal" href="stratigraphic_unit.html"><span class="doc">Stratigraphic unit</span></a>, or
artifact, which the entered artifact is a part of</p></li>
<li><p><strong>Owned by</strong> - Link the artifact to an <a class="reference internal" href="actor.html"><span class="doc">Actor</span></a> (person or group) who
owns it, such as a museum or a collector</p></li>
</ul>
</section>
<section id="can-be-linked-via-tabs-to">
<h2>Can be linked via tabs to<a class="headerlink" href="#can-be-linked-via-tabs-to" title="Permalink to this heading"></a></h2>
<ul class="simple">
<li><p><a class="reference internal" href="source.html"><span class="doc">Source</span></a> - when it is referenced there</p></li>
<li><p><a class="reference internal" href="event.html"><span class="doc">Event</span></a> - acquisition, modification, move or production</p></li>
<li><p><strong>Artifact</strong> - here sub artifacts or <a class="reference internal" href="human_remains.html"><span class="doc">Human remains</span></a> can be added</p></li>
<li><p><a class="reference internal" href="reference.html"><span class="doc">Reference</span></a></p></li>
<li><p><a class="reference internal" href="file.html"><span class="doc">File</span></a></p></li>
<li><p><a class="reference internal" href="source.html"><span class="doc">Source</span></a> - Use, if an artifact is mentioned in a source</p></li>
<li><p><a class="reference internal" href="event.html"><span class="doc">Event</span></a> - Use, if an artifact was part of an event such as its
production</p></li>
<li><p><strong>Artifact</strong> - Use, to add sub artifacts or <a class="reference internal" href="human_remains.html"><span class="doc">Human remains</span></a></p></li>
<li><p><a class="reference internal" href="reference.html"><span class="doc">Reference</span></a> - Use to add citation</p></li>
<li><p><a class="reference internal" href="file.html"><span class="doc">File</span></a> - Add a file, e.g. a picture of the artifact</p></li>
</ul>
<p>If the artifact is a carrier of information it can be linked to a source. For
this you would have to edit or create the source and choose the artifact within
the source form.</p>
<p>If an artifact is a carrier of information <strong>create or edit a source</strong> and
choose the artifact that carries the source <strong>within the source form</strong>.</p>
</section>
</section>

Expand Down
Loading

0 comments on commit 6e5ac06

Please sign in to comment.