Update manual

openatlas/static/manual/examples/artifacts.html

@@ -104,7 +104,7 @@ <h1>Artifacts<a class="headerlink" href="#artifacts" title="Permalink to this he
 The following elements are involved:</p>
 <ul class="simple">
 <li><p><a class="reference internal" href="../entity/artifact.html"><span class="doc">Artifact</span></a>: A physical object, made by humans – e.g. a coin,
-a letter or a tool</p></li>
+a letter, or a tool</p></li>
 <li><p><a class="reference internal" href="../entity/actor.html"><span class="doc">Actor</span></a>: As creator and/or owner of the artifact</p></li>
 <li><p><a class="reference internal" href="../entity/event.html"><span class="doc">Event</span></a>: Creation of the artifact</p></li>
 <li><p><a class="reference internal" href="../entity/file.html"><span class="doc">File</span></a>: You can upload an image file connected to the artifact</p></li>
@@ -119,56 +119,54 @@ <h2>Add a new artifact<a class="headerlink" href="#add-a-new-artifact" title="Pe
 <li><p>Choose a descriptive <strong>name</strong></p></li>
 <li><p>Select an appropriate <a class="reference internal" href="../entity/type.html"><span class="doc">Type</span></a> from the list</p></li>
 <li><p><strong>Owned by</strong>: If applicable, choose an owner of the artifact, e.g. a museum
-it is stored at</p></li>
-<li><p>Add further information e.g. <strong>date</strong> or <strong>description</strong> or choose option
+it is stored at or a person who possesses the artifact</p></li>
+<li><p>Add further information such as <strong>date</strong> or <strong>description</strong> or choose options
 from type trees</p></li>
 <li><p>Press <strong>Insert</strong> to save the entry</p></li>
 </ul>
 <p>Regarding date: the begin date represents the creation of the artifact and can
-be entered as a time span. Regarding the description field:  this can be used
-to record  information that is not covered by the several types you can choose
-from above. Keep in mind, it has several advantages to cover as much information
-as possible by using types over free text in the description field. If there is
-no fitting type, please follow this <a class="reference internal" href="types.html"><span class="doc">instructions</span></a>
-to add new types to the list. Please note, that “owned by” is not used to link
-a creator of an artifact. You can link a creator by adding a creation event
-(see below).</p>
+be entered as a time span.
+Regarding the description field: this can be used to record information
+that is not covered by the various types. Keep in mind, using types
+has advantages over free text in the description field (Especially for the
+presentation of an artifact on the presentation site).
+If there is no fitting type, please follow this
+<a class="reference internal" href="types.html"><span class="doc">instruction</span></a> to add new types to the list. Please
+note, that “owned by” is not used to link a creator of an artifact. You can
+link a creator by adding a creation event (see below).</p>
 </section>
 <section id="add-a-reference-to-the-artifact">
 <h2>Add a reference to the artifact<a class="headerlink" href="#add-a-reference-to-the-artifact" title="Permalink to this heading"></a></h2>
-<p>To link a reference to the newly created artifact, choose
+<p>To link a reference to a newly created artifact, choose
 <a class="reference internal" href="../entity/reference.html"><span class="doc">Reference</span></a> from the tabs</p>
 <a class="reference internal image-reference" href="../_images/reference_tab.png"><img alt="../_images/reference_tab.png" src="../_images/reference_tab.png" style="width: 400px;" /></a>
 <p>Then choose from the following options:</p>
 <ul class="simple">
 <li><p>Link the artifact to an already existing reference by using the <strong>Link</strong>
 button</p></li>
-<li><p>Create a new <a class="reference internal" href="../entity/reference.html"><span class="doc">Reference</span></a> by using the <strong>+Bibliography</strong> or
-<strong>+Edition</strong> button</p></li>
+<li><p>Create a new <a class="reference internal" href="../entity/reference.html"><span class="doc">Reference</span></a> by using the <strong>+ Bibliography</strong> or
+<strong>+ Edition</strong> button</p></li>
 <li><p>Create a new <a class="reference internal" href="../entity/reference.html"><span class="doc">external reference</span></a> by using the
-<strong>+External</strong> reference button</p></li>
+<strong>+ External reference</strong> button</p></li>
 </ul>
 </section>
 <section id="add-a-file-to-the-artifact">
 <h2>Add a file to the artifact<a class="headerlink" href="#add-a-file-to-the-artifact" title="Permalink to this heading"></a></h2>
-<p>To add an image file to the artifact, choose <strong>File</strong> from the tabs. Then choose
-from the following options:</p>
+<p>To add an image file (or any other sort of file, really) to the artifact,
+choose <strong>File</strong> from the tabs. Then choose from the following options:</p>
 <ul class="simple">
 <li><p>Link the artifact to an already uploaded file</p></li>
-<li><p>Upload a new file by using the <strong>+File</strong> button, you can add information and
+<li><p>Upload a new file by using the <strong>+ File</strong> button, you can add information and
 choose a file here</p></li>
 </ul>
 </section>
 <section id="link-a-creation-event">
 <h2>Link a creation event<a class="headerlink" href="#link-a-creation-event" title="Permalink to this heading"></a></h2>
-<p>To do so, click the <strong>Event</strong> tab. Here you can choose between a move event
-(<strong>+Move button</strong>) and a creation event (<strong>+Production button</strong>). Tab the
-+Production button (to learn how a move event can be used, please see the
-tutorial on <a class="reference internal" href="letters.html"><span class="doc">Letters</span></a>).</p>
+<p>To do so, click the <strong>Event</strong> tab. Here click the <strong>+ Production button</strong>.</p>
 <ul class="simple">
 <li><p>Choose a descriptive <strong>name</strong> for the creation event</p></li>
 <li><p>Select an appropriate <a class="reference internal" href="../entity/type.html"><span class="doc">Type</span></a> from the list</p></li>
-<li><p>Add other information as needed, e.g. a date or add free text in the
+<li><p>Add other information as needed such as a date or add free text in the
 description field</p></li>
 <li><p>Press <strong>Insert</strong> to save the entry</p></li>
 </ul>
@@ -190,10 +188,10 @@ <h2>Add a creator to the creation event<a class="headerlink" href="#add-a-creato
 actor, go back to the event page, choose actor - link again and follow the steps
 below). You can now add the following information:</p>
 <ul class="simple">
-<li><p>Type of the actor, in this case choose creator</p></li>
+<li><p>Type of actor, in this case choose creator</p></li>
 <li><p>Actor: choose the creator of the artifact from a list of already added actors</p></li>
 <li><p>Change activity “<strong>from participated</strong>” in to “<strong>performed</strong>”</p></li>
-<li><p>if wanted, add a date and/or description</p></li>
+<li><p>if known, add a date for the creation of an artifact and/or add a description</p></li>
 </ul>
 <p>With the above steps you have created an artifact connected to a creation event
 and actor as creator.</p>
@@ -204,22 +202,23 @@ <h2>Add multiple locations to an artifact<a class="headerlink" href="#add-multip
 <a class="reference internal" href="../entity/feature.html"><span class="doc">Feature</span></a> is not possible. If an artifact has a link to multiple
 locations, it is possible to keep track of that in the following way:</p>
 <ul class="simple">
-<li><p>Choose the <a class="reference internal" href="../entity/place.html"><span class="doc">Place</span></a> the artifact has it’s first occurrence at -
-e.g. the production site or a place an artifact was found at during
+<li><p>Choose the <a class="reference internal" href="../entity/place.html"><span class="doc">Place</span></a> the artifact has it’s first occurrence at,
+for example its production site or a place an artifact was found at during
 archaeological excavation.</p></li>
-<li><p>link any other place the artifact is linked to by adding a move event
-- e.g. when an artifact is transfered to a place where it is later found
-during an archaeological excavation after the production event or when it is
-moved to a museum or sold to a new owner. Click here to see a short tutorial
+<li><p>link any other place by adding a move event - for example when an artifact
+is moved from an excavation site to a museum or from a production site to
+a buyer’s house. Click here to see a short tutorial
 on adding a <a class="reference internal" href="move_event.html"><span class="doc">Move events</span></a></p></li>
 </ul>
 <p><strong>Example:</strong> Leonardo painted the Mona Lisa in his workshop in Florence,
 therefore Florence would be linked to the artifact as place. It was then
 acquired by King Francis of France and exhibited in Château d’Amboise. This
 change of location can also be tracked in the database by a <a class="reference internal" href="move_event.html"><span class="doc">Move events</span></a>.
 Another <a class="reference internal" href="move_event.html"><span class="doc">Move events</span></a> maps the transfer of the image to Fountainebleau.
-By adding further move events the way of the picture to the Louvre in Paris
-can be documented.</p>
+By adding further move events the way of the artwork to its present
+location -the Louvre in Paris - can be documented.</p>
+<p>To learn more on how to use a move event, please see the tutorial on
+<a class="reference internal" href="letters.html"><span class="doc">Letters</span></a>).</p>
 </section>
 </section>
 

openatlas/static/manual/examples/index.html

@@ -97,10 +97,11 @@
 
   <section id="examples">
 <h1>Examples<a class="headerlink" href="#examples" title="Permalink to this heading"></a></h1>
-<p>Here, you can find step by step - examples for typical data entry scenarios, some of them are
-very project-specific. Please keep in mind, that there are different ways to enter the same
-set of data. The following examples are suggestions, but please discuss the best workflow for your project within
-your team.</p>
+<p>Here, you can find step by step - examples for typical data entry scenarios,
+some of them are very project-specific, others have a broader scope. Please
+keep in mind, that there are always several different ways to enter the same
+set of data. The following examples are suggestions, but please discuss the
+best workflow for your project within your team.</p>
 <section id="general">
 <h2>General<a class="headerlink" href="#general" title="Permalink to this heading"></a></h2>
 <div class="toctree-wrapper compound">

openatlas/static/manual/examples/journey.html

@@ -100,32 +100,35 @@
 <h1>Journey<a class="headerlink" href="#journey" title="Permalink to this heading"></a></h1>
 <div class="toctree-wrapper compound">
 </div>
-<p>The following steps describe how to enter a journey as move event. For more
-information on move events in general see this <a class="reference internal" href="move_event.html"><span class="doc">tutorial</span></a>.
+<p>A journey can be tracked in OpenAtlas as a series of move events as
+described in the following steps. For more information on move events in
+general see this <a class="reference internal" href="move_event.html"><span class="doc">tutorial</span></a>.
 On move events concerning artifacts, have a look at the
 <a class="reference internal" href="letters.html"><span class="doc">letter tutorial</span></a>.</p>
-<p>These steps describe how to enter a journey as special case of a <strong>move
-event</strong>. To create a new move event following elements are involved in the
+<p>The following steps describe how to enter a journey as special case of a <strong>move
+events</strong>. To create a new move event the following elements are involved in the
 procedure:</p>
 <ul class="simple">
-<li><p><a class="reference internal" href="../entity/actor.html"><span class="doc">Actor</span></a>: the person/persons that went on a journey</p></li>
-<li><p><a class="reference internal" href="../entity/event.html"><span class="doc">Event</span></a>: the <strong>Move</strong> of the letter from one place to another</p></li>
-<li><p><a class="reference internal" href="../entity/place.html"><span class="doc">Place</span></a>: start or end point of the journey</p></li>
-<li><p><a class="reference internal" href="../entity/type.html"><span class="doc">Type</span></a>: used for classification, can be extended by users</p></li>
+<li><p><a class="reference internal" href="../entity/actor.html"><span class="doc">Actor</span></a>: The person/persons that moved/went on a journey</p></li>
+<li><p><a class="reference internal" href="../entity/event.html"><span class="doc">Event</span></a>: The <strong>Move</strong> of a letter or person from one place to
+another</p></li>
+<li><p><a class="reference internal" href="../entity/place.html"><span class="doc">Place</span></a>: Start or end point of the move event</p></li>
+<li><p><a class="reference internal" href="../entity/type.html"><span class="doc">Type</span></a>: Used for classification, list of types can be extended
+by users</p></li>
 </ul>
 <section id="adding-actors">
 <h2>Adding actors<a class="headerlink" href="#adding-actors" title="Permalink to this heading"></a></h2>
 <p>If not all <a class="reference internal" href="../entity/actor.html"><span class="doc">actors</span></a> involved in the journey were
 entered into the database already, add them via a click on the respective
 tab in the <a class="reference internal" href="../ui/menu.html"><span class="doc">menu</span></a>. Here, click the <strong>+ Person</strong> button to get to
-the form. As for all other forms, a name is required to save the data.</p>
+the form. As for all other forms, at least a name is required to save the data.</p>
 </section>
 <section id="adding-locations">
 <h2>Adding locations<a class="headerlink" href="#adding-locations" title="Permalink to this heading"></a></h2>
-<p>If not all <a class="reference internal" href="../entity/place.html"><span class="doc">locations</span></a> involved in the journey were
-entered into the database already, add them via a click on the respective
-tab in the <a class="reference internal" href="../ui/menu.html"><span class="doc">menu</span></a>. Here, click the <strong>+ Place</strong> button to get to
-the form. As for all other forms, a name is required to save the data.</p>
+<p>If not all <a class="reference internal" href="../entity/place.html"><span class="doc">locations</span></a> involved in the journey were already
+entered into the database, add them via a click on the respective tab in the
+<a class="reference internal" href="../ui/menu.html"><span class="doc">menu</span></a>. Here, click the <strong>+ Place</strong> button to get to
+the form. As for all other forms, at least a name is required to save the data.</p>
 </section>
 <section id="creating-the-move-event">
 <h2>Creating the move event<a class="headerlink" href="#creating-the-move-event" title="Permalink to this heading"></a></h2>
@@ -134,10 +137,10 @@ <h2>Creating the move event<a class="headerlink" href="#creating-the-move-event"
 <li><p>Click on the <strong>Event</strong> tab in the menu then use the <strong>+ Move</strong> button</p></li>
 <li><p>Fill out the form, for more information see the
 <a class="reference internal" href="move_event.html"><span class="doc">move event tutorial</span></a>.</p></li>
-<li><p>Link persons in this form who made the journey</p></li>
+<li><p>Link one or more persons that went on the trip</p></li>
 <li><p><strong>Please also note</strong>: Use <strong>preceding event</strong> to document multiple
 parts of a trip. Unlike <strong>sub events</strong>, these can be put in chronological
-order. Sub events are there to capture events that happen at the same time
+order. Use <strong>sub events</strong> to capture events that happen at the same time
 (for more information see <a class="reference internal" href="move_event.html"><span class="doc">move event tutorial</span></a>).</p></li>
 <li><p>Click the <strong>Insert</strong> button to save the data or <strong>Insert and continue</strong>
 button to save and start to enter another move event</p></li>
@@ -149,18 +152,18 @@ <h2>Link actors to the journey<a class="headerlink" href="#link-actors-to-the-jo
 creates a <strong>moved by</strong> relation to the event. Unfortunately this is not
 possible for groups in the current version of CIDOC CRM.</p>
 <p>Alternatively, actors (persons and groups) can be added via the actor tab where
-it is also possible to create new ones via the <strong>+ Person</strong> and <strong>+ Group</strong>
-button. In this case a more general <strong>participated at</strong> relation will be used
-between actors and event. It is also possible to add additional information:</p>
+it is also possible to create new actor entities via the <strong>+ Person</strong> and
+<strong>+ Group</strong> button. In this case a more general <strong>participated at</strong> relation
+will be created between actors and events. It is also possible to add additional
+information:</p>
 <ul class="simple">
-<li><p>At type you can define the role of the actor in the journey; if
-there is no suitable entry in the list, a new type can be created
-depending on the user’s authorization, see the <a class="reference internal" href="types.html"><span class="doc">types
-tutorial</span></a>.</p></li>
+<li><p>Via type you can define the role of an actor in a journey; if
+there is no suitable type in the list, a new one can be created
+depending on the user’s OpenAtlas status. For more see the
+<a class="reference internal" href="types.html"><span class="doc">types tutorial</span></a>.</p></li>
 <li><p>The actor can be changed afterwards via the <strong>Change</strong> button</p></li>
-<li><p>The form of participation can be determined</p></li>
-<li><p>In addition, dates for the participation (in case they differ from the
-event) and a free text description are possible</p></li>
+<li><p>In addition, dates for a participation (in case they differ from the
+event) and a free text description can be added</p></li>
 </ul>
 </section>
 </section>