Added a more attribute-type descriptions

DH-Center-Tuebingen · Oct 4, 2024 · b8b238e · b8b238e
1 parent 77e6deb
commit b8b238e
Show file tree

Hide file tree

Showing 10 changed files with 103 additions and 2 deletions.
diff --git a/docs/user/attribute-types.md b/docs/user/attribute-types.md
@@ -21,12 +21,113 @@ The values that are considered true are:
 - `w` or `wahr` 
 - [numeric values](https://www.php.net/manual/de/function.is-numeric.php) > 0
 
-### Date
+## Date
+
+![Image of the date input](./images/attribute-types/date.png)
 
 Represents a single date attribute, that is rendered with a default calender input field in the application.
 
+### Import Format
+
+`YYYY-MM-DD` e.g. `2024-10-30`
+
+It only accepts dates in the format 
+
+## Date Range
+
+![Image of the date range input](./images/attribute-types/date-range.png)
+
+Represents a date range between two dates.
+
+### Import Format
+
+`YYYY-MM-DD;YYYY-MM-DD` e.g. `2024-10-25;2024-10-30`
+
+The range must have a `START` and `END` date with the format `YYY-MM-DD`separated by a semicolon. The start date **must** be earlier than the end date:
+`START;END`
+
+
+## Dimension
+
+![Image of the dimensions input](./images/attribute-types/dimensions.png)
+
+This attribute represents the extends of a three-dimensional object, with width, height, depth and an arbitraray unit (_Note: that this is not powered by the SI-Unit system_).
+
+### Import Format
+
+`W;H;D;UNIT` e.g `2.5;51.2;210.3;cm`
+
+The values `W`,`H` and `D` must be numeric values. And the `UNIT` value may be any string. Those values need to be separated by a semicolon `;`.
+
+
+## Double (Floating Point Number)
+
+![Image of the double input](./images/attribute-types/double.png)
+
+Represents a floating point number.
+
+### Import Format
+
+`N`
+
+Must be any valid floating point number representation using a `.` as a decimal separator. `234`, `-18`, `2.3`, `1.2e3` or `7E-10`.
+
+## Dropdown Multiple
+
+![Image of the dropdown multiple input](./images/attribute-types/multiple-dropdown.png)
+
+A dropdown that allows selelcting from a list of concepts from the thesaurus.
+
+### Import Format
+
+`CONCEPT_1;CONCEPT_2;CONCEPT_3;[...]` e.g. `Red;Green;Blue`
+
+A list of concepts that is separated with a semicolon `;`. For more infos see `Dropdown Single`
+
+## Dropdown Single
+
+![Image of the dropdown single input](./images/attribute-types/single-dropdown.png)
+
+A dropdown that is populated by thesaurus concepts and allows the selection of exactly one item. 
+
+### Import Format
+
+`CONCEPT_NAME` e.g. `Red`
+
+The concept name must match excactly the concept that you want to import. The concept can be in any language.
+
+## Entity
+
+![Image of the entity single input](./images/attribute-types/entity-single-dropdown.png)
+
+A dropdown for selecting a single entity. Can be limited to a specific entity type. 
+
 ## Import Format
 
-It only accepts dates in the format `YYYY-MM-DD`: e.g. `2024-10-30`
+`ENTITY_NAME`
+
+The entity name must match the entity (case-sensitive).
+
+## Entity Multiple
+
+![Image of the entity multiple input](./images/attribute-types/entity-multiple-dropdown.png)
+
+A dropdown for selecting multiple entites. Can be limited to a specific type.
+
+### Import Format
+
+`ENTITY_1;ENTITY_2`
+
+The entities to import. Must match the entity name (case-sensitive).
+
+## Epoch
+
+![Image of the epoch input](./images/attribute-types/epoch.png)
+
+Has two parts. A time span field and a thesaurus dropdown field to specify the epoch.
+
+## Import Format
 
+`START;END;EPOCH_CONCEPT` e.g. `-100;30;antiquity`
 
+A start year and a end year in the gregorian calendar as integer values. Optional can be an epoch thesaurus concept. If the year is a negative number, it refers to the time before christ.
diff --git a/docs/user/images/attribute-types/date-range.png b/docs/user/images/attribute-types/date-range.png
diff --git a/docs/user/images/attribute-types/date.png b/docs/user/images/attribute-types/date.png
diff --git a/docs/user/images/attribute-types/dimensions.png b/docs/user/images/attribute-types/dimensions.png
diff --git a/docs/user/images/attribute-types/double.png b/docs/user/images/attribute-types/double.png
diff --git a/docs/user/images/attribute-types/entity-multiple-dropdown.png b/docs/user/images/attribute-types/entity-multiple-dropdown.png
diff --git a/docs/user/images/attribute-types/entity-single-dropdown.png b/docs/user/images/attribute-types/entity-single-dropdown.png
diff --git a/docs/user/images/attribute-types/epoch.png b/docs/user/images/attribute-types/epoch.png
diff --git a/docs/user/images/attribute-types/multiple-dropdown.png b/docs/user/images/attribute-types/multiple-dropdown.png
diff --git a/docs/user/images/attribute-types/single-dropdown.png b/docs/user/images/attribute-types/single-dropdown.png