diff --git a/docs/.vuepress/sidebar.js b/docs/.vuepress/sidebar.js index 919a0c5..69b7f70 100644 --- a/docs/.vuepress/sidebar.js +++ b/docs/.vuepress/sidebar.js @@ -4,7 +4,12 @@ export default [ collapsible: true, children: [ '/user/guide', - '/user/data' + '/user/thesaurex', + '/user/data-model', + '/user/entity-type', + '/user/attribute-types', + '/user/attribute', + '/user/data-importer' ] }, { diff --git a/docs/user/attribute-types.md b/docs/user/attribute-types.md new file mode 100644 index 0000000..fbb7afc --- /dev/null +++ b/docs/user/attribute-types.md @@ -0,0 +1,32 @@ +# Attribute Types + +The Spacialist provides a big variety of different attribute types that can be used inside your [Data Model](/user/data-model). +Named versions of those *Attribute Types* are used to populate the [Entity Types](./entity-type). + +In the next section we'll introduce all available attribute types, what they are used for and how the import data has to be formatted. + + +## Boolean + +Used for single checkbox to represent the binary values `true`and `false`. + +### Import Format + +When importing only truthy values will be considered. When cells are empty those are considered as `false`. + +The values that are considered true are: + +- `x` +- `t` or `true` +- `w` or `wahr` +- [numeric values](https://www.php.net/manual/de/function.is-numeric.php) > 0 + +### Date + +Represents a single date attribute, that is rendered with a default calender input field in the application. + +## Import Format + +It only accepts dates in the format `YYYY-MM-DD`: e.g. `2024-10-30` + + diff --git a/docs/user/attribute.md b/docs/user/attribute.md new file mode 100644 index 0000000..113d25a --- /dev/null +++ b/docs/user/attribute.md @@ -0,0 +1,3 @@ +# Attribute + +An attribute is a certain implementation of an Attribute in combination with a [Dictionary Label](./thesaurex). diff --git a/docs/user/data-importer.md b/docs/user/data-importer.md new file mode 100644 index 0000000..0affaaf --- /dev/null +++ b/docs/user/data-importer.md @@ -0,0 +1,5 @@ +# Data Importer + +The data importer is used to import already existing data to the spacialist software using CSV files. +As there are many different non-trivial [Attribute Types](./attribute-types) supported, which require the data to be formatted properly +Visit the [Attribute Types](./attribute-types) page to get an overview of all attribute types and their respective import format. \ No newline at end of file diff --git a/docs/user/data-model.md b/docs/user/data-model.md new file mode 100644 index 0000000..e3ad264 --- /dev/null +++ b/docs/user/data-model.md @@ -0,0 +1,3 @@ +# Data Model + +The *Data Model* is contains all the _blueprints_ (in Spacialist: [Entity Types](/data/entity-type.md)) for the data you want to collect. diff --git a/docs/user/data.md b/docs/user/data.md deleted file mode 100644 index 5b9cdbc..0000000 --- a/docs/user/data.md +++ /dev/null @@ -1,3 +0,0 @@ -# Data Importer - -The data importer is used to import already existing data to the spacialist software using csv files. \ No newline at end of file diff --git a/docs/user/entity-type.md b/docs/user/entity-type.md new file mode 100644 index 0000000..28a3154 --- /dev/null +++ b/docs/user/entity-type.md @@ -0,0 +1,3 @@ +# Entity Type + +An *Entity Type* is like the blueprint of one of your data objects. In the [Data Model Editor](./data-model) you design multiple *Entity Types* to fit your projects needs. You should make sure to include all relevant [Attributes](./attribute) \ No newline at end of file diff --git a/docs/user/guide.md b/docs/user/guide.md index c4407ae..7329a7e 100644 --- a/docs/user/guide.md +++ b/docs/user/guide.md @@ -2,7 +2,3 @@ Here will be more informations for Spacialist users soon. - -# Data Importer - -Here you find informations about the data importer \ No newline at end of file diff --git a/docs/user/thesaurex.md b/docs/user/thesaurex.md new file mode 100644 index 0000000..3bf9e9f --- /dev/null +++ b/docs/user/thesaurex.md @@ -0,0 +1,5 @@ +# Dictionary (Thesaurus) + +Spacialist comes with a companion software - Thesaurex - which is responsible for managing a project-driven, centralized, standardized, multilingual, hierarchical vocabulary. + +This vocabulary is used for [attribute labels](./attribute) and dropdown lists. \ No newline at end of file