Enhance documentation and layout for user management and collaboratio…

…n features

docs/.vuepress/components/GridLayout.vue

@@ -116,4 +116,22 @@ a.vp-feature {
         filter: brightness(1);
     }
 }
+
+@media (min-width: 1200px){
+    .vp-feature {
+        max-width: 23%;
+        flex-basis: 23%;
+    }
+}
+
+@media (max-width: 920px){
+    .vp-feature {
+        max-width: 46%;
+        flex-basis: 46%;
+    }
+}
+
+
+
+
 </style>

docs/.vuepress/sidebar.ts

@@ -5,13 +5,21 @@ export default [
         prefix: '/user/',
         children: [
             'overview',
-            'geodata',
             'thesaurus',
-            'data-model',
-            'entity-type',
-            'attribute-types',
-            'attribute',
+            'user-and-role-management',
+            {
+                text: 'Data Model',
+                link: 'data-model',
+                children: [
+                    'entity-type',
+                    'attribute',
+                    'attribute-types',
+                ]
+            },
+            'entity',
+            'collaboration',
             'bibliography',
+            'geodata',
             'data-importer',
             'data-analysis',
         ]

docs/.vuepress/styles/index.scss

@@ -4,8 +4,8 @@
 
 .vp-hero-actions {
     justify-content: center;
-    
-    
+
+
 }
 
 .vp-hero-action-button {
@@ -14,4 +14,71 @@
     overflow: hidden;
     white-space: nowrap;
     text-overflow: ellipsis;
+}
+
+.theme-default-content {
+
+    img {
+        display: block;
+        border-radius: 5px;
+        margin: 3rem auto;
+    }
+
+    figure {
+        width: fit-content;
+        display: block;
+        margin: 3rem auto;
+        img {
+            margin: 0;
+        }
+
+        figcaption {
+            margin-top: 1rem;
+            font-style: italic;
+
+            &:before {
+                content: 'Figure';
+                margin-right: .5rem;
+                font-weight: bold;
+            }
+        }
+    }
+
+    table {
+        border-radius: 10px;
+        border-collapse: collapse;
+        border: 2px solid var(--vp-c-border-hard, #d1d4d7);
+
+        > thead > tr:first-child {
+            border-top: none;
+
+            th {
+                border-top: none;
+            }
+        }
+
+        > thead > tr > th:first-child {
+            border-left: none;
+        }
+
+        > thead > tr > th:last-child {
+            border-right: none;
+        }
+
+        > tbody > tr > td:first-child {
+            border-left: none;
+        }
+
+        > tbody > tr > td:last-child {
+            border-right: none;
+        }
+
+        > tbody > tr:last-child {
+            border-bottom: none;
+
+            td {
+                border-bottom: none;
+            }
+        }
+    }
 }

docs/user/attribute.md

@@ -1,3 +1,25 @@
 # Attribute
 
-An attribute is a certain implementation of an Attribute in combination with a [Dictionary Label](./thesaurus). 
+An attribute is a certain implementation of an Attribute in combination with a [Dictionary Label](./thesaurus). These attributes are applied to [_Entity Types_](./entity-type.md) to create Spacialists [_Data Model_](./data-model.md).
+
+## Dependencies
+
+
+_Attribute Dependencies_ are a feature to conditionally hide attributes. 
+When adding an attribute to an [_Entity Type_](./entity-type.md) you can specify a variety of conditions on when those attributes should be shown. 
+
+| Condition     | Effect                                                                           | Symbol  | Technical    |
+| ---           | ---                                                                              | ---     |---           |
+| set           | The attribute does contain a value, therefore is **not** empty                   | ?       | x != null    |
+| unset         | The attribute does **not** contain a value, therefore is empty                   | ?!      | x == null    |
+| equals        | The attribute equals the selected value _y_                                      | =       | x == y       |
+| not equal     | The attribute is **not** equal the selected value _y_                            | !=      | x != y       |
+| less          | The attribute is less than the selected value _y_                                | <       | x < y        |
+| less equal    | The attribute is less or equal the selected value _y_                            | <=      | x <= y       |
+| greater       | The attribute is greater than the selected value _y_                             | >       | x > y        |
+| greater equal | The attribute is greater or equal the selected value _y_                         | >=      | x >= y       |
+
+Furthermore, you can define multiple _Dependency Groups[1]_, to cover more complex cases.
+Inside the group you have one operand and over the other groups you have it's counterpart (e.g. in the groups _AND_ and inbetween groups _OR_). 
+
+[1] **First Released in 0.11**

docs/user/collaboration.md

@@ -0,0 +1,19 @@
+# Collaboration
+
+There are a growing number of features that allow the users to work collaboratively inside the _Spacialist_ software.
+
+## Comments
+
+User have the ability to leave comments on every entity and can discuss ideas or problems directly on the data itself.
+
+
+## Bibliography
+
+Users can reference Bibliography from the managed [_Bilbiography_](./bibliography.md) directly on every entity[1].
+
+[1]  First released in version 0.11
+
+
+## Attribute Comments, Bibliography & Certainty 
+
+Attributes are the most molecular data inside the _Spacialist_ software. The users can set attributes "Uncertain" when the data source is not reliable and needs discussion and/or further research. This uncertainty can be discussed by using comments and/or bibliography references directly at the respective attribute.

docs/user/entity.md

@@ -0,0 +1,8 @@
+# Entity
+
+An _Entity_ is a single data point in your research. To stick with the _Coin_ example, you can implement all different coins that you have found.
+
+## Entity Tree
+
+All entities are structured in a hierarchical way. This way you can keep all the entities organized and have can access the subtrees in a meaningful way.
+This is especially useful, if your project is using the [Working Group](user-and-role-management.md#working-groups)

docs/user/overview.md

@@ -18,8 +18,10 @@ grid:
     details: Basic bibliography management, allowing BibTex import and export.
   - icon: "/images/feature-icons/user.svg"
     title: User & Role Management
+    link: "./user-and-role-management.md"
     details: Manages user accounts and assign them specific roles with fully customizable rights and permissions.
   - icon: "/images/feature-icons/collab.svg"
+    link: "./collaboration"
     title: Collaboration
     details: Working on the same dataset as a team, managing certainty, literature and commenting on the data directly.
   - icon: "/images/feature-icons/plugins.svg"

docs/user/user-and-role-management.md

@@ -0,0 +1,29 @@
+# User And Role Management
+
+Spacialist supports a sophisticated user and role management system, that allows for a fine-grained access for users to prevent data-loss due to malicious activities.
+
+## User
+
+Every member of your team or additional external participants can be invited to access the project via an individual user account, as known from other online platforms. 
+
+
+::: tip
+Users can upload an avatar for easier recognition, and better collaboration in the software.
+:::
+
+## Roles
+
+Users by default do not have any user-permissions. Permissions are managed by roles, that bundle the permission into easy managable sets.
+
+<figure>
+    <img src="./images/user/role-permissions-guest.png" alt="Image of the permission matrix of a role." >
+    <figcaption>
+    Example of a set permission matrix for a 'guest' user.
+    </figcaption>
+</figure>
+
+## Working Groups
+
+The _Working Groups_ are an extension on the premission system provided by the [_Role & Permission_](../user/permission) system. 
+This allows the creation of groups, users can be assigned to. Access to certain [Entities](../entity.md) can be managed for the whole
+groups using this feature.