Added feature overview

.vscode/settings.json

@@ -0,0 +1,32 @@
+{
+    "html.format.wrapAttributes": "force-expand-multiline",
+    //PHP
+    "intelephense.format.braces": "k&r",
+    "intelephense.format.enable": false,
+    //Typescript
+    "typescript.format.insertSpaceBeforeFunctionParenthesis": false,
+    // JavaScript
+    "javascript.format.enable": true,
+    "javascript.format.insertSpaceBeforeFunctionParenthesis": false,
+    "javascript.format.insertSpaceAfterKeywordsInControlFlowStatements": false,
+    // "javascript.format.insertSpaceAfterOpeningAndBeforeClosingNonemptyBraces": false,
+    // VUE
+    "vue.format.wrapAttributes": "force-expand-multiline",
+    "vue.format.script.initialIndent": true,
+    "vue.format.style.initialIndent": true,
+    "vue.format.template.initialIndent": true,
+    // Volar
+    "volar.format.initialIndent": {
+        "html": true,
+        "css": true,
+        "javascript": true
+    },
+    // General
+    "editor.trimAutoWhitespace": false,
+    // CSS
+    "css.format.spaceAroundSelectorSeparator": true,
+    //SCSS
+    "scss.format.spaceAroundSelectorSeparator": true,
+    // XML
+    "xml.format.splitAttributes": "splitNewLine"
+}

.vscode/tasks.json

@@ -0,0 +1,12 @@
+{
+    // See https://go.microsoft.com/fwlink/?LinkId=733558
+    // for the documentation about the tasks.json format
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "dev",
+            "type": "shell",
+            "command": "npm run docs:dev"
+        }
+    ]
+}

docs/.vuepress/client.ts

@@ -0,0 +1,8 @@
+import { defineClientConfig } from '@vuepress/client';
+import GridLayout from "./components/GridLayout.vue";
+
+export default defineClientConfig({
+    layouts: {
+        GridLayout
+    }
+})

docs/.vuepress/components/GridLayout.vue

@@ -0,0 +1,114 @@
+<!-- .vuepress/components/GridLayout.vue -->
+<template>
+    <Layout>
+        <template #page>
+            <main class="vp-page">
+                <div
+                    class="theme-default-content"
+                    vp-content
+                >
+                    <Content />
+
+                    <div
+                        class="vp-features"
+                        v-if="$frontmatter?.grid && $frontmatter.grid?.length > 0"
+                    >
+                        <component
+                            class="vp-feature"
+                            v-for="item in $frontmatter.grid"
+                            :is="item.link ? 'a' : 'div'"
+                            :href="hrefOf(item)"
+                            :key="item.title"
+                        >
+                            <div style="padding: 0.2rem 1rem;">
+                                <img
+                                    v-if="item.icon"
+                                    class="no-zoom"
+                                    :src="item.icon"
+                                    alt=""
+                                >
+                            </div>
+                            <header>
+                                <h2>{{ item.title }}</h2>
+                            </header>
+                            <p>{{ item.details }}</p>
+                        </component>
+                    </div>
+                </div>
+            </main>
+
+        </template>
+    </Layout>
+</template>
+
+<script lang="ts">
+    import Layout from '@vuepress/theme-default/lib/client/layouts/Layout.vue'
+    import { Content, resolveRoutePath } from 'vuepress/client';
+
+    export default {
+        components: {
+            Layout,
+        },
+        setup() {
+
+            const hrefOf = (item) => {
+                if (item.link) {
+                    return resolveRoutePath(item.link);
+                }
+                return '';
+            } 
+
+            return {
+                Content,
+                hrefOf,
+                resolveRoutePath,
+            }
+        }
+    }
+</script>
+
+<style lang="scss" scoped>
+
+.vp-features {
+    align-items: stretch;
+
+    img {
+        display: block;
+        max-width: 33vw;
+        margin: auto;
+    }
+}
+
+.vp-feature {
+    filter: brightness(0.7) grayscale(0.8);
+    padding: .5rem 1rem;
+    box-sizing: border-box;
+    margin-bottom: 1rem;
+
+    header {
+
+        display: flex;
+        flex-direction: column;
+        justify-content: flex-end;
+        min-height: 4rem;
+
+        h2 {
+            margin: 0;
+            padding-top: 0;
+        }
+    }
+}
+
+a.vp-feature {
+    color: inherit;
+    text-decoration: none;
+    border: 1px solid #eaecef;
+    border-radius: 1rem;
+    filter: brightness(0.85);
+    transition: all 0.1s;
+
+    &:hover {
+        filter: brightness(1);
+    }
+}
+</style>

docs/.vuepress/config.js → docs/.vuepress/config.ts

@@ -2,7 +2,6 @@ import { defaultTheme } from '@vuepress/theme-default'
 import { defineUserConfig } from 'vuepress/cli'
 import { viteBundler } from '@vuepress/bundler-vite'
 
-
 import navbar from './navbar'
 import plugins from './plugins'
 import sidebar from './sidebar'
@@ -20,13 +19,13 @@ export default defineUserConfig({
     ['link', { rel: 'icon', href: './favicon-white.ico', media: '(prefers-color-scheme: dark)' }],
 
   ],
+  plugins,
 
   theme: defaultTheme({
     logo: '/images/logos/spacialist_logo_lines_tiny_pad.svg',
     logoDark: './images/logos/spacialist_logo_lines_tiny_pad_white.svg',
     navbar,
     sidebar,
-    plugins,
   }),
 
   bundler: viteBundler(),

docs/.vuepress/plugins.js → docs/.vuepress/plugins.ts

@@ -1,8 +1,10 @@
 import { searchPlugin } from '@vuepress/plugin-search'
-
-console.log(searchPlugin())
+import { mediumZoomPlugin } from '@vuepress/plugin-medium-zoom'
 
 export default [
+    mediumZoomPlugin({
+        selector: '[vp-content] :not(a) > img:not(.no-zoom)'
+    }),
     // This seems not to be working. The search bar is not displayed.
     searchPlugin({
         locales: {

docs/.vuepress/sidebar.js → docs/.vuepress/sidebar.ts

@@ -5,7 +5,7 @@ export default [
         children: [
             '/user/guide',
             '/user/geodata',
-            '/user/thesaurex',
+            '/user/thesaurus',
             '/user/data-model',
             '/user/entity-type',
             '/user/attribute-types',

docs/user/attribute-types.md

@@ -3,7 +3,11 @@
 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.
+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. Note the following special symbols that may be used in the formatting, which will not be typed and have only semantic meaning.
+
++ ... - is a placeholder for various content
++ \[...\] - Stand for optional syntax, the squared brackets should be ignored
++ [... ⟳] - Stands for an expression that can be repeated indefinetly
 
 
 ## Boolean
@@ -143,3 +147,38 @@ Adds a geographical attribute to the entity. Currently they cannot be linked on
 `WKT_STRING` e.g. `POINT(1 1)`
 
 Any valid WKT string, a good overview of these strings can be found on [Wikipedia](https://en.wikipedia.org/wiki/Well-known_text_representation_of_geometry).
+
+## Iconclass
+
+![Image of the iconclass input](./images/attribute-types/iconclass.png)
+
+Can be used to collect data as Iconclass objects, as specified at [https://iconclass.org/](https://iconclass.org/).
+
+## Import Format
+
+`ICONCLASS_STRING` e.g. `22A311`
+
+Any iconclass string as defined at [https://iconclass.org/](https://iconclass.org/).
+
+## Integer
+
+![Image of the integer input](./images/attribute-types/integer.png)
+
+Field for integer values
+
+## Import Format
+
+`INT_VAL` e.g. `5`
+
+Can be any integer number `x` that is in the valid range of [PHP_INT_MIN](https://www.php.net/manual/en/reserved.constants.php#constant.php-int-min)  < x <[PHP_INT_MAX](https://www.php.net/manual/en/reserved.constants.php#constant.php-int-max).
+
+## List attribute
+
+![Image of list input](./images/attribute-types/list.png)
+
+Field for a list of text values.
+
+## Import Format
+
+`TEXT[;TEXT ⟳]`
+

docs/user/attribute.md

@@ -1,3 +1,3 @@
 # Attribute
 
-An attribute is a certain implementation of an Attribute in combination with a [Dictionary Label](./thesaurex). 
+An attribute is a certain implementation of an Attribute in combination with a [Dictionary Label](./thesaurus). 

docs/user/geodata.md

@@ -9,4 +9,4 @@ This will likely change in the future and is more a workaround for the time bein
 When you want to base your imported entities on spatial data, that should be included on the map, then you should follow these steps:
 
 1. Import your data file using the GeoData importer. This generates all required entities.
-2. Import the data again using the Data Importer and update the created entities.
+2. Import the data again using the Data Importer and update the created entities. 

docs/user/guide.md

@@ -1,4 +1,40 @@
+---
+layout: GridLayout
+grid:
+  - icon: "./images/feature-icons/web-based.svg"
+    title: Web-based Software
+    details: The client can be accessed on any computer using a standard browser.
+  - icon: "./images/feature-icons/custom.svg"
+    link: "./data-model.md"
+    title: Customizable Data Model
+    details: Highly flexible project-specific data models with a wide range of attribute types.
+  - icon: "./images/feature-icons/thesaurus.svg"
+    link: "./thesaurus.md"
+    title: Thesaurus
+    details:  Multilingual and centrally controlled vocabulary for compliant with the SKOS standard.
+  - icon: "./images/feature-icons/bib.svg"
+    title: Bibliography
+    details: Basic bibliography management, allowing BibTex import and export.
+  - icon: "./images/feature-icons/user.svg"
+    title: User & Role Management
+    details: Manages user accounts and assign them specific roles with fully customizable rights and permissions.
+  - icon: "./images/feature-icons/collab.svg"
+    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"
+    title: Plugins
+    details: Application is extensible through a plugin system. Adding existing functionality or writing custom plugins.
+  - icon: "./images/feature-icons/import.svg"
+    title: Files
+    details: The file plugin enables a file system, where files can be linked to single entities.
+  - icon: "./images/feature-icons/map.svg"
+    title: Map
+    details: The map plugin provides a light-weight GIS interface to visualize the data on maps.
+  - icon: "./images/feature-icons/analysis.svg"
+    title: Analysis
+    details: User-Interface to run elaborate queries without the need to write SQL.
+---
 # User Guide
 
-Here will be more informations for Spacialist users soon.
+Spacialist is a versatile, highly customizable, user-friendly database management solution for the sciences and the digital humanities in peticular. The application has a wide variety of features.