Skip to content

Commit

Permalink
Manual adaptions and corrections for Entity
Browse files Browse the repository at this point in the history
  • Loading branch information
NinaBrundke committed Nov 6, 2024
1 parent c099303 commit 0277318
Show file tree
Hide file tree
Showing 14 changed files with 294 additions and 252 deletions.
34 changes: 20 additions & 14 deletions sphinx/source/entity/actor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,10 @@ Actor
CIDOC documentation: :cidoc_entity:`E21 Person<e21-person>` and
:cidoc_entity:`E74 Group<e74-group>`

* **Person** (:cidoc_entity:`E21 Person<e21-person>`)
* **Group** (:cidoc_entity:`E74 Group<e74-group>`) - e
.g. a family, a tribe, Greenpeace or the National Museum of
* **Person** (:cidoc_entity:`E21 Person<e21-person>`) - A single person,
such as Albert Einstein or Queen Victoria
* **Group** (:cidoc_entity:`E74 Group<e74-group>`) - A group of people,
e.g. a family, a tribe, Greenpeace or the National Museum of
Denmark

.. include:: navigation.rst
Expand All @@ -19,18 +20,23 @@ Form fields
* :doc:`/ui/alias`
* :doc:`/ui/date`
* :doc:`/ui/description`
* **Residence** - a :doc:`place`, e.g. the location of an institute or the main residence of an actor
* **Born in / Begins in** - the :doc:`place` where a person was born or a group began
* **Died in / Ends in** - the :doc:`place` where a person died or a group ended
* **Residence** - A :doc:`place`, for a group this might be the location of an
institute, for a person for example the main residence
* **Born in / Begins in** - The :doc:`place` where a person was born or a
group came into existence
* **Died in / Ends in** - The :doc:`place` where a person died or a group ended
* :doc:`reference_system`

Can be linked via tabs to
-------------------------
* :doc:`source` - when it is referenced there
* :doc:`event` - for participation
* **Relation** - to other actors
* **Member of** - the groups it is member of
* **Member** - to actors who are members (only available for groups)
* :doc:`artifact` - owned artifacts and human remains by that actor
* :doc:`reference`
* :doc:`file`
* :doc:`source` - Use, if an actor is mentioned in a source
* :doc:`event` - Use, if an actor participated in an event
* **Relation** - Use to specify relations to other actors such as mother of
or married to
* **Member of** - Use to specify a group an actor is a member of
* **Member** - Link to actors to specify who was a member in a group (only
available for groups)
* :doc:`artifact` - Use to specify which artifacts and/or human remains are
owned by an actor (e.g. human remains that are kept in a museum)
* :doc:`reference` - Use to add citation
* :doc:`file` - Add a file, e.g. a picture of a person or group
25 changes: 13 additions & 12 deletions sphinx/source/entity/artifact.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Artifact
CIDOC documentation:
:cidoc_entity:`E22 Human-Made Object<e22-human-made-object>`

Artifact can be entered here, e.g. a coin
Artifact such as coins or pottery can be entered in this form.

.. include:: navigation.rst

Expand All @@ -18,18 +18,19 @@ Form fields
* :doc:`/ui/description`
* :doc:`/tools/map`
* :doc:`reference_system`
* **Super** - a :doc:`place`, :doc:`feature`, :doc:`stratigraphic_unit` or
artifact, which it is a part of
* **Owned by** - the :doc:`actor` who owns the artifact
* **Super** - A :doc:`place`, :doc:`feature`, :doc:`stratigraphic_unit`, or
artifact, which the entered artifact is a part of
* **Owned by** - Link the artifact to an :doc:`actor` (person or group) who
owns it, such as a museum or a collector

Can be linked via tabs to
-------------------------
* :doc:`source` - when it is referenced there
* :doc:`event` - acquisition, modification, move or production
* **Artifact** - here sub artifacts or :doc:`human_remains` can be added
* :doc:`reference`
* :doc:`file`
* :doc:`source` - Use, if an artifact is mentioned in a source
* :doc:`event` - Use, if an artifact was part of an event such as its
production
* **Artifact** - Use, to add sub artifacts or :doc:`human_remains`
* :doc:`reference` - Use to add citation
* :doc:`file` - Add a file, e.g. a picture of the artifact

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.
If an artifact is a carrier of information **create or edit a source** and
choose the artifact that carries the source **within the source form**.
96 changes: 50 additions & 46 deletions sphinx/source/entity/event.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,21 @@ CIDOC documentation:
:cidoc_entity:`E12 Production<e12-production>` and
:cidoc_entity:`E65 Creation<e65-creation>`

* **Activity** (:cidoc_entity:`E7 Activity<e7-activity>`)
- the most common, e.g. a battle, a meeting or a wedding
* **Acquisition** (:cidoc_entity:`E8 Acquisition<e8-acquisition>`)
- mapping a change of property
* **Creation** (:cidoc_entity:`E65 Creation<e65-creation>`)
- creation of documents (files)
* **Event** (:cidoc_entity:`E5 Event<e11-modification>`)
- used for events not performed by actors, e.g. a natural disaster
* **Modification** (:cidoc_entity:`E11 Event<e5-event>`)
- used for modification of artifacts, e.g. a conservation treatment
* **Move** (:cidoc_entity:`E9 Move<e9-move>`)
- movement of artifacts or persons
* **Production** (:cidoc_entity:`E12 Production<e12-production>`)
- creation of artifacts
* **Activity** (:cidoc_entity:`E7 Activity<e7-activity>`) - The most common
form of event, such as a battle, a meeting, or a wedding
* **Acquisition** (:cidoc_entity:`E8 Acquisition<e8-acquisition>`) - Maps a
change of property from one owner to another
* **Creation** (:cidoc_entity:`E65 Creation<e65-creation>`) - The creation
of a document (file; for the making of an artifact use production)
* **Event** (:cidoc_entity:`E5 Event<e11-modification>`) - Used for events
**without human involvement** such a natural disaster
* **Modification** (:cidoc_entity:`E11 Event<e5-event>`) - Used to track
the modification of artifacts, e.g. a conservation treatment or a change
of parts
* **Move** (:cidoc_entity:`E9 Move<e9-move>`) - Movement of artifacts or
a person
* **Production** (:cidoc_entity:`E12 Production<e12-production>`) - The
creation of artifacts

.. image:: event_hierarchy.png

Expand All @@ -40,65 +41,68 @@ Form fields
* :doc:`type`
* :doc:`/ui/date`
* :doc:`/ui/description`
* **Location** - a :doc:`place` where the event occurred
* **Sub event of** - events can be part of another event,
e.g. a battle as a sub event of a war.
* **Preceding event** - events can follow up other events, useful for e.g.
entering a journey
* **Location** - The :doc:`place` where an event happened
* **Sub event of** - As Events can be part of another event (e.g. a battle as
a sub event of a war), they can be linked here
* **Preceding event** - Events can follow up other events, useful for e.g.
entering a journey, link them here
* :doc:`reference_system`

Can be linked via tabs to
-------------------------
* :doc:`source` - when it is referenced there
* :doc:`actor` - to add participants, or recipient and donor for an acquisition
* :doc:`reference`
* :doc:`file`
* :doc:`source` - Use this way to link to a source if an event is refered to
in it
* :doc:`actor` - Add participants or recipient and donor in case of an
acquisition
* :doc:`reference` - Add a citation
* :doc:`file` - Add a file such as an image

For step by step instructions have a look at our :doc:`/examples/index`.
For a step by step instructions have a look at our :doc:`/examples/index`.

Acquisition
***********
* **Given place** - to select which :doc:`places <place>` changed ownership.
* **Given artifact** - to select which :doc:`artifacts <artifact>`
changed ownership.
* **Given place** - Select which :doc:`places <place>` changed ownership
* **Given artifact** - Select which :doc:`artifacts <artifact>`
changed ownership

To add **recipients** and **donors** go to the **Actor** tab, add actors and
To add **recipients** and **donors** use to the **Actor** tab, add actors and
select as activity:

* **acquired title through** for **recipients**
* **surrendered title through** for **donors**

Creation
********
* Document (:doc:`file`) - to select files that were created
* Document (:doc:`file`) - Select files that were created

The creators of the document can be added via the **Actor** tab and selecting
the **carried out by** activity while linking them.
The creators of the document can be added via the **Actor** tab; therefore,
select **carried out by** to link

Modification
************
* :doc:`artifact` - to select artifacts that were modified
* :doc:`artifact` - Select artifact(s) that were modified

The creators of the artifact can be added via the **Actor** tab and selecting
the **carried out by** activity while linking them.
The creators of an artifact can be added via the **Actor** tab; therefore,
select **carried out by** to link

Move
****

* **From** - a :doc:`place` as a start point
* **To** - a :doc:`place` as a destination point
* Moved :doc:`artifact` - to select moved artifacts
* Moved :doc:`Person <actor>` - to select moved persons
* **From** - :doc:`place` - as a starting point
* **To** - :doc:`place` - as a destination point
* Moved :doc:`artifact` - Select the artifact(s) moved in an event
* Moved :doc:`Person <actor>` - Select the people moved in an event

Unfortunately CIDOC CRM doesn't allows a **moved by** relation for groups. It
is still possible to "move" groups via the actor tab which in the background
creates a more general **participated at** relation between actor and move
event. For more information please take a look at :doc:`/examples/journey` or
:doc:`/examples/move_event` tutorial.
Unfortunately CIDOC CRM doesn't allow for a **moved by** relation for groups.
It is still possible to "move" groups via the actor tab, which in the
background creates a more general **participated at** relation between the
group and the move event. For more information please take a look at
:doc:`/examples/journey` or :doc:`/examples/move_event` tutorial.

Production
**********
* :doc:`artifact` - to select artifacts that were produced
* :doc:`artifact` - Select artifact(s) that was/were produced during the
production event

The creators of the artifact can be added via the **Actor** tab and selecting
the **carried out by** activity while linking them.
The creators of an artifact can be added via the **Actor** tab. Therefore,
select **carried out by** to link
18 changes: 10 additions & 8 deletions sphinx/source/entity/feature.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,27 @@ Feature
CIDOC documentation: :cidoc_entity:`E18 Physical Thing<e18-physical-thing>`

Features are subunit of a :doc:`place` and used in archaeological data
recording. E.g. graves or buildings of a site would be considered Features.
recording. E.g. graves or buildings of an archaeological site would be
considered features.

Form fields
-----------
* :doc:`/ui/name`
* :doc:`type`
* :doc:`/ui/date`
* :doc:`/ui/description`
* Super - a :doc:`place` which it is a part of
* Super - :doc:`place` the feature is a part of
* :doc:`/tools/map`

Can be linked via tabs to
-------------------------
* :doc:`source` - when it is referenced there
* :doc:`event` - only for new events. For existing the location at the event
itself can be edited.
* :doc:`reference`
* :doc:`stratigraphic_unit`
* :doc:`file`
* :doc:`source` - use, if a feature is referenced in it
* :doc:`event` - use only for new events. For already existing events link
the location in the event form
* :doc:`reference` can be used to add a citation
* :doc:`stratigraphic_unit` is used to link a subunit of a feature (e.g. a
skeleton (stratigraphic unit) in a grave (feature))
* :doc:`file` can be used to add files such as pictures

Super and subunits
------------------
Expand Down
65 changes: 35 additions & 30 deletions sphinx/source/entity/file.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,21 +10,23 @@ button to show all files.

.. include:: /entity/navigation.rst

If entities are linked to displayable files the first one is shown in the info
tab but can be changed to another one in the files tab of the entity.
If entities are linked to displayable files the first linked file is shown in
the info tab. If another image should be displayed it can be changed in the
files tab of each entity.

Files can be uploaded by editors if they don't exceed the upload size limit and
have an allowed extension. Both criteria are displayed at the upload form. It
is possible to upload multiple files in one go. They can either be selected in
the file field or drag and dropped into the specified area.
have one of the allowed extensions. Both criteria are displayed in the
upload form. It is possible to upload multiple files in one go. They can
either be selected via the file field or by drag and drop.

Form fields
-----------
* **File** - here you can chose a file from your computer
* :doc:`/ui/name` - if empty it will be prefilled after the file selection with
the filename
* **License** - which works like a :doc:`type`, it is a good practice to define
one
* **File** - choose a file from your computer
* :doc:`/ui/name` - a name is required; if field is left empty, it will be
filled with the file name after file selection
* **License** - files such as images can only be shown on a presentation
site and archived if a license is defined; furthermore it is just good
practice to define licence
* :doc:`/ui/description`

Form fields important for public sharing
Expand All @@ -35,7 +37,7 @@ More information is available at :ref:`public_sharing_label`

* **Public sharing allowed** - indicates if public sharing is allowed
* **Creator** - the creator of the file, e.g. the designer of a logo
* **License holder** - if not the same as creator
* **License holder** - mention if different from creator

Can be linked via tabs to
-------------------------
Expand All @@ -47,10 +49,13 @@ Can be linked via tabs to

Settings
--------
* **Maximum file size in MB** - this limits also the total size of multiple
file upload
File settings can be accessed via the Files menu item. Not all users can
change the settings; Options provided are:

* **Maximum file size in MB** limits the maximum file size; also limits the
total size when multiple files are uploaded together
* **Profile image width in pixel** - related to the layout of info tabs
* **Allowed file extensions**
* **Allowed file extensions** - e.g. pdf, jpg, jpeg, svg

Images that can be displayed in the browser are defined through their
extensions and can be changed in the configuration file
Expand All @@ -62,45 +67,45 @@ extensions and can be changed in the configuration file
Logo
----
You can chose a custom logo. The file has to be uploaded before and has to have
a display file extension. The displayed logo has a max-height of 120 px. If you
selected a larger one the browser will try to scale it.
You can chose a custom logo. To do so chose an already uploaded file with a
displayable file extension. The displayed logo has a max-height of 120 px.
If you have selected a larger image your browser will try to scale it.

Image preview
-------------
If image processing is enabled (default=on, configurable by admins) and user
have **Show icons in tables** in their :doc:`/tools/profile` activated, small
images of files are shown in tables.

Please be aware with many files and large tables this can impact performance.
**Please be aware many files and large tables can impact performance.**

How to make files available for the public
------------------------------------------
In case it is planned to share files with the public, e.g. at a presentation
In case files are supposed to be shared with the public, e.g. on a presentation
site or a public archive, several criteria have to be met.

Criteria checked by the software
********************************
* The file must exist
* A license has to be specified
* It has to be marked with **public sharing allowed**
* **Public sharing allowed** has to be marked

In case these criteria aren't met, a file won't be:
* Shared via the :doc:`/technical/api`
* Won't show up on presentation sites developed by the OpenAtlas team
* Won't be included in case the long time archiving
system `ARCHE <https://arche.acdh.oeaw.ac.at/>`_ is used
* Won't be included in long time archiving if
`ARCHE <https://arche.acdh.oeaw.ac.at/>`_ is used

Criteria checked by managers and users
**************************************
* The linked license is the correct one and allows public sharing
* The linked license is correct and allows public sharing
* Other license specific criteria, e.g. specifying the creator, are met

There are many licenses with many different criteria, e.g. a
CC-BY 4.0 license requires the attribution to the creator. Because it is not
possible to check these automatically, it is the responsibility of
the project management to ensure that all necessary requirements
are met and to indicated it via setting the **public sharing allowed** flag.
A automatic check for those specifics is not possible as there are many
licenses with numerous different criteria. Therefore it is the
responsibility of the project management to ensure that all necessary
requirements are met. To indicate this use the **public sharing
allowed** flag.

Be aware that licenses can be linked to an external reference (e.g. an URL)
which might be informative for other users or viewers.
**Used licenses should linked to an external reference (e.g. an URL) were
possible as it is informative for other users and viewers.**
Loading

0 comments on commit 0277318

Please sign in to comment.