Skip to content

Commit

Permalink
started basic documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Severino committed Oct 2, 2024
1 parent 668000a commit 77e6deb
Show file tree
Hide file tree
Showing 9 changed files with 57 additions and 8 deletions.
7 changes: 6 additions & 1 deletion docs/.vuepress/sidebar.js
Original file line number Diff line number Diff line change
Expand Up @@ -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'
]
},
{
Expand Down
32 changes: 32 additions & 0 deletions docs/user/attribute-types.md
Original file line number Diff line number Diff line change
@@ -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`


3 changes: 3 additions & 0 deletions docs/user/attribute.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Attribute

An attribute is a certain implementation of an Attribute in combination with a [Dictionary Label](./thesaurex).
5 changes: 5 additions & 0 deletions docs/user/data-importer.md
Original file line number Diff line number Diff line change
@@ -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.
3 changes: 3 additions & 0 deletions docs/user/data-model.md
Original file line number Diff line number Diff line change
@@ -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.
3 changes: 0 additions & 3 deletions docs/user/data.md

This file was deleted.

3 changes: 3 additions & 0 deletions docs/user/entity-type.md
Original file line number Diff line number Diff line change
@@ -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)
4 changes: 0 additions & 4 deletions docs/user/guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,3 @@

Here will be more informations for Spacialist users soon.


# Data Importer

Here you find informations about the data importer
5 changes: 5 additions & 0 deletions docs/user/thesaurex.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 77e6deb

Please sign in to comment.