From 184108303939284b520f5474aa5c1df3ffba92e3 Mon Sep 17 00:00:00 2001 From: Sebastian Frank Date: Tue, 21 Feb 2023 14:59:14 +0000 Subject: [PATCH] docs in sub package --- .drone.yml | 18 +++-- .gitignore | 4 +- README.md | 21 ------ docker-compose-local.yml | 2 +- docs/README.md | 71 ++++++------------ docs/docpress.json | 4 +- docs/md/README.md | 50 ++++++++++++ .../admin-javascript-kontext/allgemeines.md | 0 .../collection.meta..eval.md | 0 .../field.meta..eval.md | 0 docs/{ => md}/begriffe.md | 0 docs/{ => md}/docpress.css | 0 docs/{ => md}/github-dark-dimmed.css | 0 docs/{ => md}/projektkonfig/api-ordner.png | Bin docs/{ => md}/projektkonfig/assets.md | 2 +- docs/{ => md}/projektkonfig/collections.md | 2 +- .../projektkonfig/collections/dependsOn.webm | Bin .../projektkonfig/collections/fields.md | 53 +++++++------ .../collections/fields/datentypen.md | 0 .../collections/fields/widgets.md | 0 .../widgets/contentbuilder-medialib.webm | Bin .../fields/widgets/contentbuilder-module.webm | Bin .../fields/widgets/contentbuilder.md | 6 +- .../projektkonfig/collections/hooks.md | 0 .../projektkonfig/collections/imageFilter.md | 2 +- .../projektkonfig/collections/indexes.md | 0 .../projektkonfig/collections/meta.md | 8 +- .../projektkonfig/collections/validator.webm | Bin docs/{ => md}/projektkonfig/config.yml.md | 8 +- docs/{ => md}/projektkonfig/jobs.md | 4 +- docs/{ => md}/projektkonfig/ordnerstruktur.md | 0 docs/{ => md}/restapi/assets.md | 0 docs/{ => md}/restapi/collection.md | 0 docs/{ => md}/restapi/login.md | 0 docs/{ => md}/restapi/project.md | 0 docs/{ => md}/restapi/user.md | 0 .../server-javascript-kontext/allgemeines.md | 0 .../server-javascript-kontext/hook.md | 0 .../{ => md}/server-javascript-kontext/job.md | 0 .../packages/bcrypt.md | 0 .../packages/charset.md | 0 .../packages/cookie.md | 0 .../server-javascript-kontext/packages/db.md | 0 .../packages/debug.md | 0 .../server-javascript-kontext/packages/fs.md | 0 .../packages/http.md | 0 .../packages/image.md | 0 .../server-javascript-kontext/packages/jwt.md | 0 .../server-javascript-kontext/packages/pdf.md | 0 .../packages/response.md | 0 .../packages/smtp.md | 0 .../server-javascript-kontext/packages/tpl.md | 0 .../packages/user.md | 0 .../server-javascript-kontext/packages/xml.md | 0 .../server-javascript-kontext/validator.md | 0 docs/{ => md}/servergrundlagen/entitaeten.md | 0 .../servergrundlagen/konfiguration.md | 0 docs/{ => md}/tibi-aufbau.svg | 0 58 files changed, 128 insertions(+), 127 deletions(-) delete mode 100644 README.md create mode 100644 docs/md/README.md rename docs/{ => md}/admin-javascript-kontext/allgemeines.md (100%) rename docs/{ => md}/admin-javascript-kontext/collection.meta..eval.md (100%) rename docs/{ => md}/admin-javascript-kontext/field.meta..eval.md (100%) rename docs/{ => md}/begriffe.md (100%) rename docs/{ => md}/docpress.css (100%) rename docs/{ => md}/github-dark-dimmed.css (100%) rename docs/{ => md}/projektkonfig/api-ordner.png (100%) rename docs/{ => md}/projektkonfig/assets.md (73%) rename docs/{ => md}/projektkonfig/collections.md (91%) rename docs/{ => md}/projektkonfig/collections/dependsOn.webm (100%) rename docs/{ => md}/projektkonfig/collections/fields.md (52%) rename docs/{ => md}/projektkonfig/collections/fields/datentypen.md (100%) rename docs/{ => md}/projektkonfig/collections/fields/widgets.md (100%) rename docs/{ => md}/projektkonfig/collections/fields/widgets/contentbuilder-medialib.webm (100%) rename docs/{ => md}/projektkonfig/collections/fields/widgets/contentbuilder-module.webm (100%) rename docs/{ => md}/projektkonfig/collections/fields/widgets/contentbuilder.md (93%) rename docs/{ => md}/projektkonfig/collections/hooks.md (100%) rename docs/{ => md}/projektkonfig/collections/imageFilter.md (95%) rename docs/{ => md}/projektkonfig/collections/indexes.md (100%) rename docs/{ => md}/projektkonfig/collections/meta.md (80%) rename docs/{ => md}/projektkonfig/collections/validator.webm (100%) rename docs/{ => md}/projektkonfig/config.yml.md (82%) rename docs/{ => md}/projektkonfig/jobs.md (91%) rename docs/{ => md}/projektkonfig/ordnerstruktur.md (100%) rename docs/{ => md}/restapi/assets.md (100%) rename docs/{ => md}/restapi/collection.md (100%) rename docs/{ => md}/restapi/login.md (100%) rename docs/{ => md}/restapi/project.md (100%) rename docs/{ => md}/restapi/user.md (100%) rename docs/{ => md}/server-javascript-kontext/allgemeines.md (100%) rename docs/{ => md}/server-javascript-kontext/hook.md (100%) rename docs/{ => md}/server-javascript-kontext/job.md (100%) rename docs/{ => md}/server-javascript-kontext/packages/bcrypt.md (100%) rename docs/{ => md}/server-javascript-kontext/packages/charset.md (100%) rename docs/{ => md}/server-javascript-kontext/packages/cookie.md (100%) rename docs/{ => md}/server-javascript-kontext/packages/db.md (100%) rename docs/{ => md}/server-javascript-kontext/packages/debug.md (100%) rename docs/{ => md}/server-javascript-kontext/packages/fs.md (100%) rename docs/{ => md}/server-javascript-kontext/packages/http.md (100%) rename docs/{ => md}/server-javascript-kontext/packages/image.md (100%) rename docs/{ => md}/server-javascript-kontext/packages/jwt.md (100%) rename docs/{ => md}/server-javascript-kontext/packages/pdf.md (100%) rename docs/{ => md}/server-javascript-kontext/packages/response.md (100%) rename docs/{ => md}/server-javascript-kontext/packages/smtp.md (100%) rename docs/{ => md}/server-javascript-kontext/packages/tpl.md (100%) rename docs/{ => md}/server-javascript-kontext/packages/user.md (100%) rename docs/{ => md}/server-javascript-kontext/packages/xml.md (100%) rename docs/{ => md}/server-javascript-kontext/validator.md (100%) rename docs/{ => md}/servergrundlagen/entitaeten.md (100%) rename docs/{ => md}/servergrundlagen/konfiguration.md (100%) rename docs/{ => md}/tibi-aufbau.svg (100%) diff --git a/.drone.yml b/.drone.yml index d60f86c..efd0add 100644 --- a/.drone.yml +++ b/.drone.yml @@ -3,14 +3,6 @@ type: docker name: default steps: - - name: yarn install - image: node:18 - pull: if-not-exists - environment: - FORCE_COLOR: "true" - commands: - - yarn install - ############################## # Build and deploy docs ############################## @@ -20,6 +12,8 @@ steps: environment: FORCE_COLOR: "true" commands: + - cd docs + - yarn install - yarn docpress:build when: branch: [master] @@ -48,6 +42,14 @@ steps: ############################## # Demo project ############################## + - name: yarn install + image: node:18 + pull: if-not-exists + environment: + FORCE_COLOR: "true" + commands: + - yarn install + - name: modify config image: alpine/git commands: diff --git a/.gitignore b/.gitignore index f7e842b..de23586 100644 --- a/.gitignore +++ b/.gitignore @@ -1,11 +1,11 @@ -_docpress +docs/_docpress +docs/node_modules api/hooks/lib/app.server* node_modules media tmp _temp frontend/dist -docs/node_modules yarn-error.log .yarn/* !.yarn/cache diff --git a/README.md b/README.md deleted file mode 100644 index c106f01..0000000 --- a/README.md +++ /dev/null @@ -1,21 +0,0 @@ -# TibiCMS Dokumentation - -![TibiCMS Aufbau](./docs/tibi-aufbau.svg) - -## Einleitung - -*TibiCMS* ist der Sammelbegriff für die Komponenten *tibi-server* und *tibi-admin*, welche einen Rest-API Server und eine Administrationsoberfläche zur Verfügung stellen. Auf Basis dieser beiden Komponenten und der *MongoDB* als Abhängigkeit lassen sich WebCMS Anwendungen abbilden. - -Das CMS ist multi-mandanten-fähig, d.h. es kann mehrer Projekte mit unterschiedlichen Zugriffsbeschränkungen verwalten. - -### tibi-server - -Der Server selbst kommt ohne grafische Oberfläche oder WebUI. Er ist ausschließlich nach außen über eine Rest-API erreichbar. - -Als einzige Abhängigkeit ist eine *MongoDB* zu erwähnen. Da der Server in Go geschrieben ist, sind keine externen Bibliotheken notwendig. Er lässt sich daher prima via Docker-Container verteilen. - -### tibi-admin - -Die Administrationsoberfläche ist wie jeder andere Service, der die Rest-API des Servers nutzt, nur ein Frontend. *tibi-admin* läuft vollständig im Browser und benötigt nur einen Webserver, der statischen Content ausliefert. - -Die Version des *tibi-admin* sollte synchron zur *tibi-server* Version gehalten werden, damit alle Datentypen bedient werden können. \ No newline at end of file diff --git a/docker-compose-local.yml b/docker-compose-local.yml index 8821752..b326858 100644 --- a/docker-compose-local.yml +++ b/docker-compose-local.yml @@ -10,7 +10,7 @@ services: - ./:/data - ./tmp:/tmp - ./tmp/nonexistent:/nonexistent - working_dir: /data + working_dir: /data/docs command: sh -c "yarn install && yarn docpress:serve" expose: - 3000 diff --git a/docs/README.md b/docs/README.md index b7db39e..f999706 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,50 +1,21 @@ -- [TibiCMS](../README.md) -- [Begriffe](begriffe.md) -- Servergrundlagen - - [Konfiguration](servergrundlagen/konfiguration.md) - - [Entitäten](servergrundlagen/entitaeten.md) -- RestAPI Endpunkte - - [/login](restapi/login.md) - - [/user](restapi/user.md) - - [/project](restapi/project.md) - - [/_/NS/COLLECTION](restapi/collection.md) - - [/_/NS/_/assets/ASSETSNAME](restapi/assets.md) -- Projekt Konfiguration - - [Ordnerstruktur](projektkonfig/ordnerstruktur.md) - - [config.yml](projektkonfig/config.yml.md) - - [collections](projektkonfig/collections.md) - - [fields](projektkonfig/collections/fields.md) - - [Datentypen](projektkonfig/collections/fields/datentypen.md) - - [Admin Widgets](projektkonfig/collections/fields/widgets.md) - - [· ContentBuilder](projektkonfig/collections/fields/widgets/contentbuilder.md) - - [indexes](projektkonfig/collections/indexes.md) - - [hooks](projektkonfig/collections/hooks.md) - - [imageFilter](projektkonfig/collections/imageFilter.md) - - [meta](projektkonfig/collections/meta.md) - - [jobs](projektkonfig/jobs.md) - - [assets](projektkonfig/assets.md) -- Admin Javascript Kontext - - [Allgemeines](admin-javascript-kontext/allgemeines.md) - - [collection.meta..eval](admin-javascript-kontext/collection.meta..eval.md) - - [field.meta..eval](admin-javascript-kontext/field.meta..eval.md) -- Server Javascript Kontext - - [Allgmeines](server-javascript-kontext/allgemeines.md) - - [hook](server-javascript-kontext/hook.md) - - [job](server-javascript-kontext/job.md) - - [validator](server-javascript-kontext/validator.md) - - Packages - - [user](server-javascript-kontext/packages/user.md) - - [response](server-javascript-kontext/packages/response.md) - - [cookie](server-javascript-kontext/packages/cookie.md) - - [db](server-javascript-kontext/packages/db.md) - - [http](server-javascript-kontext/packages/http.md) - - [smtp](server-javascript-kontext/packages/smtp.md) - - [fs](server-javascript-kontext/packages/fs.md) - - [tpl](server-javascript-kontext/packages/tpl.md) - - [jwt](server-javascript-kontext/packages/jwt.md) - - [image](server-javascript-kontext/packages/image.md) - - [bcrypt](server-javascript-kontext/packages/bcrypt.md) - - [xml](server-javascript-kontext/packages/xml.md) - - [charset](server-javascript-kontext/packages/charset.md) - - [pdf](server-javascript-kontext/packages/pdf.md) - - [debug](server-javascript-kontext/packages/debug.md) +# TibiCMS Dokumentation + +![TibiCMS Aufbau](./md/tibi-aufbau.svg) + +## Einleitung + +_TibiCMS_ ist der Sammelbegriff für die Komponenten _tibi-server_ und _tibi-admin_, welche einen Rest-API Server und eine Administrationsoberfläche zur Verfügung stellen. Auf Basis dieser beiden Komponenten und der _MongoDB_ als Abhängigkeit lassen sich WebCMS Anwendungen abbilden. + +Das CMS ist multi-mandanten-fähig, d.h. es kann mehrer Projekte mit unterschiedlichen Zugriffsbeschränkungen verwalten. + +### tibi-server + +Der Server selbst kommt ohne grafische Oberfläche oder WebUI. Er ist ausschließlich nach außen über eine Rest-API erreichbar. + +Als einzige Abhängigkeit ist eine _MongoDB_ zu erwähnen. Da der Server in Go geschrieben ist, sind keine externen Bibliotheken notwendig. Er lässt sich daher prima via Docker-Container verteilen. + +### tibi-admin + +Die Administrationsoberfläche ist wie jeder andere Service, der die Rest-API des Servers nutzt, nur ein Frontend. _tibi-admin_ läuft vollständig im Browser und benötigt nur einen Webserver, der statischen Content ausliefert. + +Die Version des _tibi-admin_ sollte synchron zur _tibi-server_ Version gehalten werden, damit alle Datentypen bedient werden können. diff --git a/docs/docpress.json b/docs/docpress.json index e891ae6..ddf47c2 100644 --- a/docs/docpress.json +++ b/docs/docpress.json @@ -1,9 +1,9 @@ { - "docs": "./", + "docs": "md", "markdown": { "plugins": { "code-include": {} } }, - "css": ["./docpress.css", "./github-dark-dimmed.css"] + "css": ["md/docpress.css", "md/github-dark-dimmed.css"] } diff --git a/docs/md/README.md b/docs/md/README.md new file mode 100644 index 0000000..b7db39e --- /dev/null +++ b/docs/md/README.md @@ -0,0 +1,50 @@ +- [TibiCMS](../README.md) +- [Begriffe](begriffe.md) +- Servergrundlagen + - [Konfiguration](servergrundlagen/konfiguration.md) + - [Entitäten](servergrundlagen/entitaeten.md) +- RestAPI Endpunkte + - [/login](restapi/login.md) + - [/user](restapi/user.md) + - [/project](restapi/project.md) + - [/_/NS/COLLECTION](restapi/collection.md) + - [/_/NS/_/assets/ASSETSNAME](restapi/assets.md) +- Projekt Konfiguration + - [Ordnerstruktur](projektkonfig/ordnerstruktur.md) + - [config.yml](projektkonfig/config.yml.md) + - [collections](projektkonfig/collections.md) + - [fields](projektkonfig/collections/fields.md) + - [Datentypen](projektkonfig/collections/fields/datentypen.md) + - [Admin Widgets](projektkonfig/collections/fields/widgets.md) + - [· ContentBuilder](projektkonfig/collections/fields/widgets/contentbuilder.md) + - [indexes](projektkonfig/collections/indexes.md) + - [hooks](projektkonfig/collections/hooks.md) + - [imageFilter](projektkonfig/collections/imageFilter.md) + - [meta](projektkonfig/collections/meta.md) + - [jobs](projektkonfig/jobs.md) + - [assets](projektkonfig/assets.md) +- Admin Javascript Kontext + - [Allgemeines](admin-javascript-kontext/allgemeines.md) + - [collection.meta..eval](admin-javascript-kontext/collection.meta..eval.md) + - [field.meta..eval](admin-javascript-kontext/field.meta..eval.md) +- Server Javascript Kontext + - [Allgmeines](server-javascript-kontext/allgemeines.md) + - [hook](server-javascript-kontext/hook.md) + - [job](server-javascript-kontext/job.md) + - [validator](server-javascript-kontext/validator.md) + - Packages + - [user](server-javascript-kontext/packages/user.md) + - [response](server-javascript-kontext/packages/response.md) + - [cookie](server-javascript-kontext/packages/cookie.md) + - [db](server-javascript-kontext/packages/db.md) + - [http](server-javascript-kontext/packages/http.md) + - [smtp](server-javascript-kontext/packages/smtp.md) + - [fs](server-javascript-kontext/packages/fs.md) + - [tpl](server-javascript-kontext/packages/tpl.md) + - [jwt](server-javascript-kontext/packages/jwt.md) + - [image](server-javascript-kontext/packages/image.md) + - [bcrypt](server-javascript-kontext/packages/bcrypt.md) + - [xml](server-javascript-kontext/packages/xml.md) + - [charset](server-javascript-kontext/packages/charset.md) + - [pdf](server-javascript-kontext/packages/pdf.md) + - [debug](server-javascript-kontext/packages/debug.md) diff --git a/docs/admin-javascript-kontext/allgemeines.md b/docs/md/admin-javascript-kontext/allgemeines.md similarity index 100% rename from docs/admin-javascript-kontext/allgemeines.md rename to docs/md/admin-javascript-kontext/allgemeines.md diff --git a/docs/admin-javascript-kontext/collection.meta..eval.md b/docs/md/admin-javascript-kontext/collection.meta..eval.md similarity index 100% rename from docs/admin-javascript-kontext/collection.meta..eval.md rename to docs/md/admin-javascript-kontext/collection.meta..eval.md diff --git a/docs/admin-javascript-kontext/field.meta..eval.md b/docs/md/admin-javascript-kontext/field.meta..eval.md similarity index 100% rename from docs/admin-javascript-kontext/field.meta..eval.md rename to docs/md/admin-javascript-kontext/field.meta..eval.md diff --git a/docs/begriffe.md b/docs/md/begriffe.md similarity index 100% rename from docs/begriffe.md rename to docs/md/begriffe.md diff --git a/docs/docpress.css b/docs/md/docpress.css similarity index 100% rename from docs/docpress.css rename to docs/md/docpress.css diff --git a/docs/github-dark-dimmed.css b/docs/md/github-dark-dimmed.css similarity index 100% rename from docs/github-dark-dimmed.css rename to docs/md/github-dark-dimmed.css diff --git a/docs/projektkonfig/api-ordner.png b/docs/md/projektkonfig/api-ordner.png similarity index 100% rename from docs/projektkonfig/api-ordner.png rename to docs/md/projektkonfig/api-ordner.png diff --git a/docs/projektkonfig/assets.md b/docs/md/projektkonfig/assets.md similarity index 73% rename from docs/projektkonfig/assets.md rename to docs/md/projektkonfig/assets.md index 00859fa..25d0b37 100644 --- a/docs/projektkonfig/assets.md +++ b/docs/md/projektkonfig/assets.md @@ -3,4 +3,4 @@ Folgende Angaben sind in der `assets`-Sektion der [config.yml](./config.yml.md) geführt als Liste möglich: -!!!include(api/assets/demoassets.yml)!!! \ No newline at end of file +!!!include(../api/assets/demoassets.yml)!!! \ No newline at end of file diff --git a/docs/projektkonfig/collections.md b/docs/md/projektkonfig/collections.md similarity index 91% rename from docs/projektkonfig/collections.md rename to docs/md/projektkonfig/collections.md index 79c8136..c1bc6bf 100644 --- a/docs/projektkonfig/collections.md +++ b/docs/md/projektkonfig/collections.md @@ -6,7 +6,7 @@ Die Konfiguration einer Kollektion sollte zur besseren Übersicht innerhalb eine Eine solche Datei hat folgenden Aufbau: -!!!include(api/collections/democol.yml)!!! +!!!include(../api/collections/democol.yml)!!! ### siehe diff --git a/docs/projektkonfig/collections/dependsOn.webm b/docs/md/projektkonfig/collections/dependsOn.webm similarity index 100% rename from docs/projektkonfig/collections/dependsOn.webm rename to docs/md/projektkonfig/collections/dependsOn.webm diff --git a/docs/projektkonfig/collections/fields.md b/docs/md/projektkonfig/collections/fields.md similarity index 52% rename from docs/projektkonfig/collections/fields.md rename to docs/md/projektkonfig/collections/fields.md index fd19b2a..875b93a 100644 --- a/docs/projektkonfig/collections/fields.md +++ b/docs/md/projektkonfig/collections/fields.md @@ -1,12 +1,12 @@ # fields -Felder im *tibi-server* müssen einen bestimmten Datentyp haben. Über den *tibi-admin* können die Felder über Widgets in unterschiedlichen Ausprägungen dargestellt werden (view-Widgets), bzw. dem Benutzer eine Eingabe abverlangen (input-Widgets). +Felder im _tibi-server_ müssen einen bestimmten Datentyp haben. Über den _tibi-admin_ können die Felder über Widgets in unterschiedlichen Ausprägungen dargestellt werden (view-Widgets), bzw. dem Benutzer eine Eingabe abverlangen (input-Widgets). -Es gibt grundlegende Angaben, die jedes Feld haben muss um vom *tibi-server* akzeptiert zu werden. Darüber hinaus kann auch jedes Feld ein `meta` Objekt haben, was dem *tibi-admin* mitteilt, wie er dieses Feld für Ausgabe und Eingabe behandel soll. +Es gibt grundlegende Angaben, die jedes Feld haben muss um vom _tibi-server_ akzeptiert zu werden. Darüber hinaus kann auch jedes Feld ein `meta` Objekt haben, was dem _tibi-admin_ mitteilt, wie er dieses Feld für Ausgabe und Eingabe behandel soll. Zunächst folgt der grundlegende Aufbau des Feld-Objektes: -!!!include(api/collections/fields/date.yml)!!! +!!!include(../api/collections/fields/date.yml)!!! ## validator Objekt @@ -16,36 +16,36 @@ Zunächst folgt der grundlegende Aufbau des Feld-Objektes: Wie im Beispiel von **fields/date.yml** unter `validator` zu sehen ist, wird dort ein Datum nach dem aktuellen erwartet. Wie der Validator sich auf die UI auswirkt, ist im obigen Video zu sehen. -Das `validator` Objekt wird *tibi-server* seitig genutzt um die Daten zu validieren. Da das `validator` Objekt dem *tibi-admin* ebenso zur Verfügung steht, kann vorab eine client-seitige Validierung zusätzlich durchgeführt werden. +Das `validator` Objekt wird _tibi-server_ seitig genutzt um die Daten zu validieren. Da das `validator` Objekt dem _tibi-admin_ ebenso zur Verfügung steht, kann vorab eine client-seitige Validierung zusätzlich durchgeführt werden. Attribute des Objektes: -| Attribut | Datentyp | Beschreibung | -| --- | --- | --- | -| `required` | boolean | wenn `true`, dann ist zwingend eine Eingabe zu diesem Feld nötig | -| `allowZero` | boolean | in Kombination mit `required: true`, wenn `true`, dann ist der jeweilige "Null"-Wert des Datentyps erlaubt

z.B. `type: string` erlaubt den leeren String und `type: number` erlaubt `0` | -| `eval` | string | Javascript-Code der zu true evaluieren muss um den Wert des Feldes als gültig zu definieren | +| Attribut | Datentyp | Beschreibung | +| ----------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `required` | boolean | wenn `true`, dann ist zwingend eine Eingabe zu diesem Feld nötig | +| `allowZero` | boolean | in Kombination mit `required: true`, wenn `true`, dann ist der jeweilige "Null"-Wert des Datentyps erlaubt

z.B. `type: string` erlaubt den leeren String und `type: number` erlaubt `0` | +| `eval` | string | Javascript-Code der zu true evaluieren muss um den Wert des Feldes als gültig zu definieren | ### eval-Attribut Der Javascript-Code in diesem Attribut kann folgende Rückgabe-Werte haben: -| Wert | Bedeutung | -| --- | --- | -| `true` | Der Wert des Feldes ist gültig | -| `false` | Der Wert des Feldes ist ungültig | +| Wert | Bedeutung | +| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `true` | Der Wert des Feldes ist gültig | +| `false` | Der Wert des Feldes ist ungültig | | `"Text"` | Wird ein String zurückgegeben ist, wird der Wert es Feldes ebenso als ungültig erachtet und der String selbst ist eine benutzerdefinierte Fehlermeldung, die in der Serverantwort gelesen werden kann. | Da der `eval` Code serverseitig immer ausgeführt wird und ein Fehlschlag zwangsläufig zum Abbruch der Serveraktion führt, ist es wichtig, dass der [serverseitige Javascript-Kontext](./../../server-javascript-kontext/validator.md) berücksichtigt wird. -Optional kann der Code auch zusätzlich über eine Lauffähigkeit ohne Fehler (z.B. keine Verwendung nicht vorhandender Kontext-Variablen oder Verwendung von `try ... catch`) im *tibi-admin* verfügen. Das hat den Vorteil, dass eine Vorab-Validierung stattfindet, bevor der Datensatz an der Server gesendet wird. +Optional kann der Code auch zusätzlich über eine Lauffähigkeit ohne Fehler (z.B. keine Verwendung nicht vorhandender Kontext-Variablen oder Verwendung von `try ... catch`) im _tibi-admin_ verfügen. Das hat den Vorteil, dass eine Vorab-Validierung stattfindet, bevor der Datensatz an der Server gesendet wird. -Sollte der `eval` Code im *tibi-admin* nicht lauffähig sein (nicht abgefangene Exception), wird der Validator clientseitig ingoriert und nur die serverseitige Prüfung beeinflusst die Aktion. +Sollte der `eval` Code im _tibi-admin_ nicht lauffähig sein (nicht abgefangene Exception), wird der Validator clientseitig ingoriert und nur die serverseitige Prüfung beeinflusst die Aktion. #### siehe -- [Server Javascript Kontext](./../../server-javascript-kontext/allgemeines.md) -- [Validator Javascript Kontext](./../../server-javascript-kontext/validator.md) +- [Server Javascript Kontext](./../../server-javascript-kontext/allgemeines.md) +- [Validator Javascript Kontext](./../../server-javascript-kontext/validator.md) ## dependsOn @@ -66,11 +66,11 @@ fields: en: Type widget: select choices: - - name: + - name: de: Standardseite en: Standard page id: page - - name: + - name: de: News en: News id: news @@ -102,17 +102,16 @@ Wird der Feldname verwendet wird nur geprüft, ob das Feld belegt ist. TODO Die `eval` Variante verwendet als Javascript-Kontext Variablen die auf folgenden Seite beschrieben werden: -- [Admin Javascript Kontext](./../../admin-javascript-kontext/allgemeines.md) -- [collection.meta..eval](./../../admin-javascript-kontext/collection.meta..eval.md) -- [field.meta..eval](./../../admin-javascript-kontext/field.meta..eval.md) +- [Admin Javascript Kontext](./../../admin-javascript-kontext/allgemeines.md) +- [collection.meta..eval](./../../admin-javascript-kontext/collection.meta..eval.md) +- [field.meta..eval](./../../admin-javascript-kontext/field.meta..eval.md) Die Rückgabe des Javascript-Codes beeinflusst die Einblendung des betroffenen Feldes in folgender Weise: -| Rückgabe | Bedeutung | -| --- | --- | -| `true` | Das Feld wird angezeigt | -| `false` | Das Feld wird ausgeblendet | - +| Rückgabe | Bedeutung | +| -------- | -------------------------- | +| `true` | Das Feld wird angezeigt | +| `false` | Das Feld wird ausgeblendet | ## defaultValue diff --git a/docs/projektkonfig/collections/fields/datentypen.md b/docs/md/projektkonfig/collections/fields/datentypen.md similarity index 100% rename from docs/projektkonfig/collections/fields/datentypen.md rename to docs/md/projektkonfig/collections/fields/datentypen.md diff --git a/docs/projektkonfig/collections/fields/widgets.md b/docs/md/projektkonfig/collections/fields/widgets.md similarity index 100% rename from docs/projektkonfig/collections/fields/widgets.md rename to docs/md/projektkonfig/collections/fields/widgets.md diff --git a/docs/projektkonfig/collections/fields/widgets/contentbuilder-medialib.webm b/docs/md/projektkonfig/collections/fields/widgets/contentbuilder-medialib.webm similarity index 100% rename from docs/projektkonfig/collections/fields/widgets/contentbuilder-medialib.webm rename to docs/md/projektkonfig/collections/fields/widgets/contentbuilder-medialib.webm diff --git a/docs/projektkonfig/collections/fields/widgets/contentbuilder-module.webm b/docs/md/projektkonfig/collections/fields/widgets/contentbuilder-module.webm similarity index 100% rename from docs/projektkonfig/collections/fields/widgets/contentbuilder-module.webm rename to docs/md/projektkonfig/collections/fields/widgets/contentbuilder-module.webm diff --git a/docs/projektkonfig/collections/fields/widgets/contentbuilder.md b/docs/md/projektkonfig/collections/fields/widgets/contentbuilder.md similarity index 93% rename from docs/projektkonfig/collections/fields/widgets/contentbuilder.md rename to docs/md/projektkonfig/collections/fields/widgets/contentbuilder.md index 75fd335..e2e2e11 100644 --- a/docs/projektkonfig/collections/fields/widgets/contentbuilder.md +++ b/docs/md/projektkonfig/collections/fields/widgets/contentbuilder.md @@ -6,7 +6,7 @@ Für die Gestaltung von HTML-Inhalten ist der ContentBuilder eine einfache und i Wie der ContentBuilder an einem Feld konfiguriert wird verdeutlicht folgendes Beispiel: -!!!include(api/collections/fields/content.yml)!!! +!!!include(../api/collections/fields/content.yml)!!! ## Mediathek Kollektion @@ -18,7 +18,7 @@ Wie aus der obigen Definition unterhalb von z.B. "imageSelect" zu lesen, bedarf > Die Bedeutung der hier nicht beschriebenen Eigenschaften ist unter [collections](./../../../collections.md) zu finden. -!!!include(api/collections/medialib.yml)!!! +!!!include(../api/collections/medialib.yml)!!! ## Module (customTags) @@ -32,4 +32,4 @@ Wie oben schon erwähnt, sind die `placeholder` frei wählbar. Eine HTML5-Schrei In unserem Beispiel hier wurden zusättzlich zum eigentlichen Modul-Tag noch Attribute (`title` und `description`) definiert. Diese können dann im Frontend das eigentliche Modul beeinflussen. -Im Frontend könnte ein Modul dann später als "Custom Element" implementiert werden oder es wird ein HTML-Parser verwendet, der die Tags durch eigene Komponenten ersetzt, wie er im Anhang [TODO] zu finden ist. \ No newline at end of file +Im Frontend könnte ein Modul dann später als "Custom Element" implementiert werden oder es wird ein HTML-Parser verwendet, der die Tags durch eigene Komponenten ersetzt, wie er im Anhang [TODO] zu finden ist. diff --git a/docs/projektkonfig/collections/hooks.md b/docs/md/projektkonfig/collections/hooks.md similarity index 100% rename from docs/projektkonfig/collections/hooks.md rename to docs/md/projektkonfig/collections/hooks.md diff --git a/docs/projektkonfig/collections/imageFilter.md b/docs/md/projektkonfig/collections/imageFilter.md similarity index 95% rename from docs/projektkonfig/collections/imageFilter.md rename to docs/md/projektkonfig/collections/imageFilter.md index 9a97324..267aef4 100644 --- a/docs/projektkonfig/collections/imageFilter.md +++ b/docs/md/projektkonfig/collections/imageFilter.md @@ -7,7 +7,7 @@ Der Prozess selbst erfolgt beim ersten Abruf des Bildes und wird zwischengespeic Eine beispielhafte Konfiguration, die die Bilder nur verkleinert sieht so aus: -!!!include(api/collections/democol/imageFilter.yml)!!! +!!!include(../api/collections/democol/imageFilter.yml)!!! Folgende Attribute können Filter-Eintrage haben, wobei `fit` und `fill` exklusiv sind: diff --git a/docs/projektkonfig/collections/indexes.md b/docs/md/projektkonfig/collections/indexes.md similarity index 100% rename from docs/projektkonfig/collections/indexes.md rename to docs/md/projektkonfig/collections/indexes.md diff --git a/docs/projektkonfig/collections/meta.md b/docs/md/projektkonfig/collections/meta.md similarity index 80% rename from docs/projektkonfig/collections/meta.md rename to docs/md/projektkonfig/collections/meta.md index 11053c2..f03a88f 100644 --- a/docs/projektkonfig/collections/meta.md +++ b/docs/md/projektkonfig/collections/meta.md @@ -4,7 +4,7 @@ Wie bereits an anderer Stelle beschrieben, dient das `meta` Objekt zur Definitio Folgende Angaben sind möglich: -!!!include(api/collections/democol/meta.yml)!!! +!!!include(../api/collections/democol/meta.yml)!!! ## views Liste @@ -16,14 +16,14 @@ Folgende möglche Einträge für `views` gibt es derzeit: ### simpleList -!!!include(api/collections/democol/simpleList.yml)!!! +!!!include(../api/collections/democol/simpleList.yml)!!! ### table -!!!include(api/collections/democol/table.yml)!!! +!!!include(../api/collections/democol/table.yml)!!! ## tablist Wird die `tablist` verwendet, ist sicher zu stellen, dass alle Felder in der Definition aufgenommen werden. Werden Felder nicht in die `tablist` aufgenommen, sind diese weiterhin in einer Gesamtliste unterhalb der Tabs und bringen das Layout durcheinander. -!!!include(api/collections/democol/tablist.yml)!!! +!!!include(../api/collections/democol/tablist.yml)!!! diff --git a/docs/projektkonfig/collections/validator.webm b/docs/md/projektkonfig/collections/validator.webm similarity index 100% rename from docs/projektkonfig/collections/validator.webm rename to docs/md/projektkonfig/collections/validator.webm diff --git a/docs/projektkonfig/config.yml.md b/docs/md/projektkonfig/config.yml.md similarity index 82% rename from docs/projektkonfig/config.yml.md rename to docs/md/projektkonfig/config.yml.md index 5660c2c..a326f0c 100644 --- a/docs/projektkonfig/config.yml.md +++ b/docs/md/projektkonfig/config.yml.md @@ -6,10 +6,10 @@ Es hat sich jedoch als günstig erwiesen bei Webprojekten die Datei und alle and ## Aufbau -!!!include(api/config.yml)!!! +!!!include(../api/config.yml)!!! ### siehe -- [collections](./collections.md) -- [jobs](./jobs.md) -- [assets](./assets.md) \ No newline at end of file +- [collections](./collections.md) +- [jobs](./jobs.md) +- [assets](./assets.md) diff --git a/docs/projektkonfig/jobs.md b/docs/md/projektkonfig/jobs.md similarity index 91% rename from docs/projektkonfig/jobs.md rename to docs/md/projektkonfig/jobs.md index f19d3b8..e6094a3 100644 --- a/docs/projektkonfig/jobs.md +++ b/docs/md/projektkonfig/jobs.md @@ -6,6 +6,6 @@ Wie in allen YAML-Definitionen können auch die Jobs via `!include` ausgelagert Der Aufbau eines Jobs ausgelagert in einer Datei sieht beispielsweise folgendermaßen aus: -!!!include(api/jobs/demojob.yml)!!! +!!!include(../api/jobs/demojob.yml)!!! -Die Möglichkeiten innerhalb der Javascript-Datei werden im Kapitel [Javascript Kontext](./../server-javascript-kontext/job.md) beschrieben. \ No newline at end of file +Die Möglichkeiten innerhalb der Javascript-Datei werden im Kapitel [Javascript Kontext](./../server-javascript-kontext/job.md) beschrieben. diff --git a/docs/projektkonfig/ordnerstruktur.md b/docs/md/projektkonfig/ordnerstruktur.md similarity index 100% rename from docs/projektkonfig/ordnerstruktur.md rename to docs/md/projektkonfig/ordnerstruktur.md diff --git a/docs/restapi/assets.md b/docs/md/restapi/assets.md similarity index 100% rename from docs/restapi/assets.md rename to docs/md/restapi/assets.md diff --git a/docs/restapi/collection.md b/docs/md/restapi/collection.md similarity index 100% rename from docs/restapi/collection.md rename to docs/md/restapi/collection.md diff --git a/docs/restapi/login.md b/docs/md/restapi/login.md similarity index 100% rename from docs/restapi/login.md rename to docs/md/restapi/login.md diff --git a/docs/restapi/project.md b/docs/md/restapi/project.md similarity index 100% rename from docs/restapi/project.md rename to docs/md/restapi/project.md diff --git a/docs/restapi/user.md b/docs/md/restapi/user.md similarity index 100% rename from docs/restapi/user.md rename to docs/md/restapi/user.md diff --git a/docs/server-javascript-kontext/allgemeines.md b/docs/md/server-javascript-kontext/allgemeines.md similarity index 100% rename from docs/server-javascript-kontext/allgemeines.md rename to docs/md/server-javascript-kontext/allgemeines.md diff --git a/docs/server-javascript-kontext/hook.md b/docs/md/server-javascript-kontext/hook.md similarity index 100% rename from docs/server-javascript-kontext/hook.md rename to docs/md/server-javascript-kontext/hook.md diff --git a/docs/server-javascript-kontext/job.md b/docs/md/server-javascript-kontext/job.md similarity index 100% rename from docs/server-javascript-kontext/job.md rename to docs/md/server-javascript-kontext/job.md diff --git a/docs/server-javascript-kontext/packages/bcrypt.md b/docs/md/server-javascript-kontext/packages/bcrypt.md similarity index 100% rename from docs/server-javascript-kontext/packages/bcrypt.md rename to docs/md/server-javascript-kontext/packages/bcrypt.md diff --git a/docs/server-javascript-kontext/packages/charset.md b/docs/md/server-javascript-kontext/packages/charset.md similarity index 100% rename from docs/server-javascript-kontext/packages/charset.md rename to docs/md/server-javascript-kontext/packages/charset.md diff --git a/docs/server-javascript-kontext/packages/cookie.md b/docs/md/server-javascript-kontext/packages/cookie.md similarity index 100% rename from docs/server-javascript-kontext/packages/cookie.md rename to docs/md/server-javascript-kontext/packages/cookie.md diff --git a/docs/server-javascript-kontext/packages/db.md b/docs/md/server-javascript-kontext/packages/db.md similarity index 100% rename from docs/server-javascript-kontext/packages/db.md rename to docs/md/server-javascript-kontext/packages/db.md diff --git a/docs/server-javascript-kontext/packages/debug.md b/docs/md/server-javascript-kontext/packages/debug.md similarity index 100% rename from docs/server-javascript-kontext/packages/debug.md rename to docs/md/server-javascript-kontext/packages/debug.md diff --git a/docs/server-javascript-kontext/packages/fs.md b/docs/md/server-javascript-kontext/packages/fs.md similarity index 100% rename from docs/server-javascript-kontext/packages/fs.md rename to docs/md/server-javascript-kontext/packages/fs.md diff --git a/docs/server-javascript-kontext/packages/http.md b/docs/md/server-javascript-kontext/packages/http.md similarity index 100% rename from docs/server-javascript-kontext/packages/http.md rename to docs/md/server-javascript-kontext/packages/http.md diff --git a/docs/server-javascript-kontext/packages/image.md b/docs/md/server-javascript-kontext/packages/image.md similarity index 100% rename from docs/server-javascript-kontext/packages/image.md rename to docs/md/server-javascript-kontext/packages/image.md diff --git a/docs/server-javascript-kontext/packages/jwt.md b/docs/md/server-javascript-kontext/packages/jwt.md similarity index 100% rename from docs/server-javascript-kontext/packages/jwt.md rename to docs/md/server-javascript-kontext/packages/jwt.md diff --git a/docs/server-javascript-kontext/packages/pdf.md b/docs/md/server-javascript-kontext/packages/pdf.md similarity index 100% rename from docs/server-javascript-kontext/packages/pdf.md rename to docs/md/server-javascript-kontext/packages/pdf.md diff --git a/docs/server-javascript-kontext/packages/response.md b/docs/md/server-javascript-kontext/packages/response.md similarity index 100% rename from docs/server-javascript-kontext/packages/response.md rename to docs/md/server-javascript-kontext/packages/response.md diff --git a/docs/server-javascript-kontext/packages/smtp.md b/docs/md/server-javascript-kontext/packages/smtp.md similarity index 100% rename from docs/server-javascript-kontext/packages/smtp.md rename to docs/md/server-javascript-kontext/packages/smtp.md diff --git a/docs/server-javascript-kontext/packages/tpl.md b/docs/md/server-javascript-kontext/packages/tpl.md similarity index 100% rename from docs/server-javascript-kontext/packages/tpl.md rename to docs/md/server-javascript-kontext/packages/tpl.md diff --git a/docs/server-javascript-kontext/packages/user.md b/docs/md/server-javascript-kontext/packages/user.md similarity index 100% rename from docs/server-javascript-kontext/packages/user.md rename to docs/md/server-javascript-kontext/packages/user.md diff --git a/docs/server-javascript-kontext/packages/xml.md b/docs/md/server-javascript-kontext/packages/xml.md similarity index 100% rename from docs/server-javascript-kontext/packages/xml.md rename to docs/md/server-javascript-kontext/packages/xml.md diff --git a/docs/server-javascript-kontext/validator.md b/docs/md/server-javascript-kontext/validator.md similarity index 100% rename from docs/server-javascript-kontext/validator.md rename to docs/md/server-javascript-kontext/validator.md diff --git a/docs/servergrundlagen/entitaeten.md b/docs/md/servergrundlagen/entitaeten.md similarity index 100% rename from docs/servergrundlagen/entitaeten.md rename to docs/md/servergrundlagen/entitaeten.md diff --git a/docs/servergrundlagen/konfiguration.md b/docs/md/servergrundlagen/konfiguration.md similarity index 100% rename from docs/servergrundlagen/konfiguration.md rename to docs/md/servergrundlagen/konfiguration.md diff --git a/docs/tibi-aufbau.svg b/docs/md/tibi-aufbau.svg similarity index 100% rename from docs/tibi-aufbau.svg rename to docs/md/tibi-aufbau.svg