diff --git a/openatlas/static/manual/examples/artifacts.html b/openatlas/static/manual/examples/artifacts.html index 9b42ee298..ef015b552 100644 --- a/openatlas/static/manual/examples/artifacts.html +++ b/openatlas/static/manual/examples/artifacts.html @@ -104,7 +104,7 @@
Artifacts
Artifact: A physical object, made by humans – e.g. a coin,
-a letter or a tool
Actor: As creator and/or owner of the artifact
Event: Creation of the artifact
File: You can upload an image file connected to the artifact
Add a new artifactType from the list
Owned by: If applicable, choose an owner of the artifact, e.g. a museum
-it is stored at
Add further information e.g. date or description or choose option
+it is stored at or a person who possesses the artifact
Add further information such as date or description or choose options
from type trees
Press Insert to save the entry
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 instructions
-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).
+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
+instruction 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).
Add a reference to the artifact
-To link a reference to the newly created artifact, choose
+
To link a reference to a newly created artifact, choose
Reference from the tabs
Then choose from the following options:
Link the artifact to an already existing reference by using the Link
button
Create a new Reference by using the +Bibliography or
-+Edition button
Create a new Reference by using the + Bibliography or
++ Edition button
Create a new external reference by using the
-+External reference button
Add a file to the artifact
-To add an image file to the artifact, choose File from the tabs. Then choose
-from the following options:
+To add an image file (or any other sort of file, really) to the artifact,
+choose File from the tabs. Then choose from the following options:
Link the artifact to an already uploaded file
Upload a new file by using the +File button, you can add information and
+
Upload a new file by using the + File button, you can add information and
choose a file here
Link a creation event
-To do so, click the Event tab. Here you can choose between a move event
-(+Move button) and a creation event (+Production button). Tab the
-+Production button (to learn how a move event can be used, please see the
-tutorial on Letters).
+To do so, click the Event tab. Here click the + Production button.
Choose a descriptive name for the creation event
Select an appropriate Type from the list
Add other information as needed, e.g. a date or add free text in the
+
Add other information as needed such as a date or add free text in the
description field
Press Insert to save the entry
@@ -190,10 +188,10 @@ Add a creator to the creation event
-Type of the actor, in this case choose creator
Type of actor, in this case choose creator
Actor: choose the creator of the artifact from a list of already added actors
Change activity “from participated” in to “performed”
if wanted, add a date and/or description
if known, add a date for the creation of an artifact and/or add a description
With the above steps you have created an artifact connected to a creation event
and actor as creator.
@@ -204,13 +202,12 @@ Add multiple locations to an artifactFeature is not possible. If an artifact has a link to multiple
locations, it is possible to keep track of that in the following way:
-Choose the Place the artifact has it’s first occurrence at -
-e.g. the production site or a place an artifact was found at during
+
Choose the Place the artifact has it’s first occurrence at,
+for example its production site or a place an artifact was found at during
archaeological excavation.
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
+
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 Move events
Example: Leonardo painted the Mona Lisa in his workshop in Florence,
@@ -218,8 +215,10 @@
Add multiple locations to an artifactMove events.
Another Move events 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.
+By adding further move events the way of the artwork to its present
+location -the Louvre in Paris - can be documented.
+
To learn more on how to use a move event, please see the tutorial on
+Letters).
diff --git a/openatlas/static/manual/examples/index.html b/openatlas/static/manual/examples/index.html
index 6ac4074c0..fafaef162 100644
--- a/openatlas/static/manual/examples/index.html
+++ b/openatlas/static/manual/examples/index.html
@@ -97,10 +97,11 @@
Examples
-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.
+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.
General
diff --git a/openatlas/static/manual/examples/journey.html b/openatlas/static/manual/examples/journey.html
index 32b4c7601..3ec5c840d 100644
--- a/openatlas/static/manual/examples/journey.html
+++ b/openatlas/static/manual/examples/journey.html
@@ -100,32 +100,35 @@
Journey
-The following steps describe how to enter a journey as move event. For more
-information on move events in general see this tutorial.
+
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 tutorial.
On move events concerning artifacts, have a look at the
letter tutorial.
-These steps describe how to enter a journey as special case of a move
-event. To create a new move event following elements are involved in the
+
The following steps describe how to enter a journey as special case of a move
+events. To create a new move event the following elements are involved in the
procedure:
-Actor: the person/persons that went on a journey
Event: the Move of the letter from one place to another
Place: start or end point of the journey
Type: used for classification, can be extended by users
Actor: The person/persons that moved/went on a journey
Event: The Move of a letter or person from one place to
+another
Place: Start or end point of the move event
Type: Used for classification, list of types can be extended
+by users
Adding actors
If not all actors involved in the journey were
entered into the database already, add them via a click on the respective
tab in the menu. Here, click the + Person button to get to
-the form. As for all other forms, a name is required to save the data.
+the form. As for all other forms, at least a name is required to save the data.
Adding locations
-If not all locations involved in the journey were
-entered into the database already, add them via a click on the respective
-tab in the menu. Here, click the + Place button to get to
-the form. As for all other forms, a name is required to save the data.
+If not all locations involved in the journey were already
+entered into the database, add them via a click on the respective tab in the
+menu. Here, click the + Place button to get to
+the form. As for all other forms, at least a name is required to save the data.
Creating the move event
@@ -134,10 +137,10 @@ Creating the move eventClick on the Event tab in the menu then use the + Move button
Fill out the form, for more information see the
move event tutorial.
Link persons in this form who made the journey
Link one or more persons that went on the trip
Please also note: Use preceding event to document multiple
parts of a trip. Unlike sub events, these can be put in chronological
-order. Sub events are there to capture events that happen at the same time
+order. Use sub events to capture events that happen at the same time
(for more information see move event tutorial).
Click the Insert button to save the data or Insert and continue
button to save and start to enter another move event
Link actors to the journey
-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 types
-tutorial.
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
+types tutorial.
The actor can be changed afterwards via the Change button
The form of participation can be determined
In addition, dates for the participation (in case they differ from the
-event) and a free text description are possible
In addition, dates for a participation (in case they differ from the
+event) and a free text description can be added
diff --git a/openatlas/static/manual/examples/letters.html b/openatlas/static/manual/examples/letters.html
index f89c23939..4c770d254 100644
--- a/openatlas/static/manual/examples/letters.html
+++ b/openatlas/static/manual/examples/letters.html
@@ -19,7 +19,7 @@
-
+
@@ -100,28 +100,27 @@
Letters
-The following steps describe how to enter a letter exchange event.
+
The following step by step instruction describes how to enter a letter
+exchange event.
The following elements are involved in the procedure:
-Artifact: the physical presentation of the letter
Source: the content of the letter
Event: the Move of the letter from one place to another
Artifact: The physical presentation of the letter
Source: The content of the letter
Event: The Move of the letter from one place to another
Place: Start or end point of the letter exchange
Actor: Sender/recipient of the letter
Type: used for classification, can be extended by users
Type: Used for classification, can be extended by users
Adding an artifact
-The created artifact is the physical presentation of the letter and the
-following data concerns the object e.g. the begin date would be the creation of
-the letter, the description can be used to record e.g. the material of
-the object.
+The created artifact is the physical presentation of the letter. So the
+begin of the date field would be the creation of the letter, etc.
Click on Artifact in the Menu and create a new
entry by using the + Artifact button
Choose a descriptive name
Select an appropriate Type from the list, e.g. letter
Add further information as date or description if available
Select an appropriate Type from the list, such as letter
Add further information e.g. a date or description
Press Insert to save the entry
@@ -136,38 +135,40 @@ Adding a sourceType from the list
Click on Artifact and choose the before created letter from the list
Add more information as desired
Press Insert to save the entry
It is important to link the artifact to the source in this way to reflect that
-it is the source written on the letter.
+
Please note: It is important to link the artifact to the source in this way
+to reflect that it is the source written on the letter.
If you would link it using the tab Artifact it means the source refers to
the artifact instead.
Adding the move event
-This creates an entry concerning the movement of the letter.
+Now you can create a move event to track the sending of the letter from
+one location to the other:
After saving the source, you can see the linked artifact with its name in the
-source view and click on it
In the artifact view click on the Event tab in the menu and create a new
move with the + Move button
Choose a descriptive name
Select an appropriate Type from the list, e.g. letter exchange
With from and to you can choose the starting and ending location of the
+
With from and to you can choose the start and end location of the
move
The respective artifact should already be preset
The respective artifact should already be selected
If available, enter the dates for the letter exchange
Press Insert to save the entry
Adding sender and recipient
-Now you can link one actor at a time to the move event by the following steps.
+Now you can link one actor at by using the following steps:
Open the created event by clicking on it in the event tab of the move
Click on the Actor tab
Either link an already entered person with Link or create a new one with
-+ Person button
Either link an already exiting person from the list with Link or
+create a new one by using the + Person button
When entering the involvement information, choose the actor and add the
respective type (sender/recipient)
Press Insert to save the entry
Adding sender and recipient
- Previous
+ Previous
Next
diff --git a/openatlas/static/manual/examples/move_event.html b/openatlas/static/manual/examples/move_event.html
index f32950166..7cee7ff12 100644
--- a/openatlas/static/manual/examples/move_event.html
+++ b/openatlas/static/manual/examples/move_event.html
@@ -106,7 +106,7 @@ Move events
Artifact: A physical object, made by humans – e.g. a coin, -a letter or a tool
Actor: As creator and/or owner of the artifact
Event: Creation of the artifact
File: You can upload an image file connected to the artifact
Owned by: If applicable, choose an owner of the artifact, e.g. a museum -it is stored at
Add further information e.g. date or description or choose option +it is stored at or a person who possesses the artifact
Add further information such as date or description or choose options from type trees
Press Insert to save the entry
Add a reference to the artifact
-To link a reference to the newly created artifact, choose +
To link a reference to a newly created artifact, choose Reference from the tabs
Then choose from the following options:
Link the artifact to an already existing reference by using the Link button
-Create a new Reference by using the +Bibliography or -+Edition button
+Create a new Reference by using the + Bibliography or ++ Edition button
Create a new external reference by using the -+External reference button
++ External reference button
Add a file to the artifact
-To add an image file to the artifact, choose File from the tabs. Then choose -from the following options:
+To add an image file (or any other sort of file, really) to the artifact, +choose File from the tabs. Then choose from the following options:
Link the artifact to an already uploaded file
-Upload a new file by using the +File button, you can add information and +
Upload a new file by using the + File button, you can add information and choose a file here
Link a creation event
-To do so, click the Event tab. Here you can choose between a move event -(+Move button) and a creation event (+Production button). Tab the -+Production button (to learn how a move event can be used, please see the -tutorial on Letters).
+To do so, click the Event tab. Here click the + Production button.
Choose a descriptive name for the creation event
Select an appropriate Type from the list
-Add other information as needed, e.g. a date or add free text in the +
Add other information as needed such as a date or add free text in the description field
Press Insert to save the entry
Add a creator to the creation event
-Type of the actor, in this case choose creator
Type of actor, in this case choose creator
Actor: choose the creator of the artifact from a list of already added actors
Change activity “from participated” in to “performed”
if wanted, add a date and/or description
if known, add a date for the creation of an artifact and/or add a description
With the above steps you have created an artifact connected to a creation event
and actor as creator.
@@ -204,13 +202,12 @@ Add multiple locations to an artifactFeature is not possible. If an artifact has a link to multiple
locations, it is possible to keep track of that in the following way:
-Choose the Place the artifact has it’s first occurrence at -
-e.g. the production site or a place an artifact was found at during
+
Choose the Place the artifact has it’s first occurrence at,
+for example its production site or a place an artifact was found at during
archaeological excavation.
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
+
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 Move events
Example: Leonardo painted the Mona Lisa in his workshop in Florence,
@@ -218,8 +215,10 @@
Add multiple locations to an artifactMove events.
Another Move events 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.
+By adding further move events the way of the artwork to its present
+location -the Louvre in Paris - can be documented.
+
To learn more on how to use a move event, please see the tutorial on
+Letters).
Type of the actor, in this case choose creator
Type of actor, in this case choose creator
Actor: choose the creator of the artifact from a list of already added actors
Change activity “from participated” in to “performed”
if wanted, add a date and/or description
if known, add a date for the creation of an artifact and/or add a description
-
-
Choose the Place the artifact has it’s first occurrence at - -e.g. the production site or a place an artifact was found at during +
Choose the Place the artifact has it’s first occurrence at, +for example its production site or a place an artifact was found at during archaeological excavation.
-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 +
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 Move events
Examples
-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.
+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.
General
Journey
The following steps describe how to enter a journey as move event. For more -information on move events in general see this tutorial. +
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 tutorial. On move events concerning artifacts, have a look at the letter tutorial.
-These steps describe how to enter a journey as special case of a move -event. To create a new move event following elements are involved in the +
The following steps describe how to enter a journey as special case of a move +events. To create a new move event the following elements are involved in the procedure:
-
-
Actor: the person/persons that went on a journey
-Event: the Move of the letter from one place to another
-Place: start or end point of the journey
-Type: used for classification, can be extended by users
+Actor: The person/persons that moved/went on a journey
+Event: The Move of a letter or person from one place to +another
+Place: Start or end point of the move event
+Type: Used for classification, list of types can be extended +by users
Adding actors
If not all actors involved in the journey were entered into the database already, add them via a click on the respective tab in the menu. Here, click the + Person button to get to -the form. As for all other forms, a name is required to save the data.
+the form. As for all other forms, at least a name is required to save the data.Adding locations
-If not all locations involved in the journey were -entered into the database already, add them via a click on the respective -tab in the menu. Here, click the + Place button to get to -the form. As for all other forms, a name is required to save the data.
+If not all locations involved in the journey were already +entered into the database, add them via a click on the respective tab in the +menu. Here, click the + Place button to get to +the form. As for all other forms, at least a name is required to save the data.
Creating the move event
@@ -134,10 +137,10 @@Creating the move eventClick on the Event tab in the menu then use the + Move button
Fill out the form, for more information see the
move event tutorial.
Link persons in this form who made the journey
Link one or more persons that went on the trip
Please also note: Use preceding event to document multiple
parts of a trip. Unlike sub events, these can be put in chronological
-order. Sub events are there to capture events that happen at the same time
+order. Use sub events to capture events that happen at the same time
(for more information see move event tutorial).
Click the Insert button to save the data or Insert and continue
button to save and start to enter another move event
Link actors to the journey
-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 types
-tutorial.
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
+types tutorial.
The actor can be changed afterwards via the Change button
The form of participation can be determined
In addition, dates for the participation (in case they differ from the
-event) and a free text description are possible
In addition, dates for a participation (in case they differ from the
+event) and a free text description can be added
Fill out the form, for more information see the move event tutorial.
Link persons in this form who made the journey
Link one or more persons that went on the trip
Please also note: Use preceding event to document multiple parts of a trip. Unlike sub events, these can be put in chronological -order. Sub events are there to capture events that happen at the same time +order. Use sub events to capture events that happen at the same time (for more information see move event tutorial).
Click the Insert button to save the data or Insert and continue button to save and start to enter another move event
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 types -tutorial.
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 +types tutorial.
The actor can be changed afterwards via the Change button
The form of participation can be determined
In addition, dates for the participation (in case they differ from the -event) and a free text description are possible
In addition, dates for a participation (in case they differ from the +event) and a free text description can be added
Letters
The following steps describe how to enter a letter exchange event. +
The following step by step instruction describes how to enter a letter +exchange event. The following elements are involved in the procedure:
-
-
Artifact: the physical presentation of the letter
-Source: the content of the letter
-Event: the Move of the letter from one place to another
+Artifact: The physical presentation of the letter
+Source: The content of the letter
+Event: The Move of the letter from one place to another
Place: Start or end point of the letter exchange
Actor: Sender/recipient of the letter
-Type: used for classification, can be extended by users
+Type: Used for classification, can be extended by users
Adding an artifact
-The created artifact is the physical presentation of the letter and the -following data concerns the object e.g. the begin date would be the creation of -the letter, the description can be used to record e.g. the material of -the object.
+The created artifact is the physical presentation of the letter. So the +begin of the date field would be the creation of the letter, etc.
Click on Artifact in the Menu and create a new entry by using the + Artifact button
Choose a descriptive name
-Select an appropriate Type from the list, e.g. letter
-Add further information as date or description if available
+Select an appropriate Type from the list, such as letter
+Add further information e.g. a date or description
Press Insert to save the entry
Adding a sourceType from the list
Click on Artifact and choose the before created letter from the list
Add more information as desired
Press Insert to save the entry
It is important to link the artifact to the source in this way to reflect that -it is the source written on the letter. +
Please note: It is important to link the artifact to the source in this way +to reflect that it is the source written on the letter. If you would link it using the tab Artifact it means the source refers to the artifact instead.
Adding the move event
-This creates an entry concerning the movement of the letter.
+Now you can create a move event to track the sending of the letter from +one location to the other:
After saving the source, you can see the linked artifact with its name in the -source view and click on it
+source view. Click on it
In the artifact view click on the Event tab in the menu and create a new move with the + Move button
Choose a descriptive name
Select an appropriate Type from the list, e.g. letter exchange
-With from and to you can choose the starting and ending location of the +
With from and to you can choose the start and end location of the move
-The respective artifact should already be preset
+The respective artifact should already be selected
If available, enter the dates for the letter exchange
Press Insert to save the entry
Adding sender and recipient
-Now you can link one actor at a time to the move event by the following steps.
+Now you can link one actor at by using the following steps:
Open the created event by clicking on it in the event tab of the move
Click on the Actor tab
-Either link an already entered person with Link or create a new one with -+ Person button
+Either link an already exiting person from the list with Link or +create a new one by using the + Person button
When entering the involvement information, choose the actor and add the respective type (sender/recipient)
Press Insert to save the entry
@@ -179,7 +180,7 @@
