Sophora Schema Docs

Sophora Schema Docs Add-on

Das Modul Sophora Schema Docs generiert eine Dokumentation des Dokumentenmodells deines Sophora Repositorys.

Sophora Schema Docs: Screenshot der Startseite mit der Liste der Dokumententypen
Sophora Schema Docs: Screenshot der Startseite mit der Liste der Dokumententypen (Bild: subshell/CC BY)

Für alle, die allen Sophora-Stakeholdern eine leicht zugängliche Dokumentation ihres Sophora-Datenmodells bereitstellen möchten.

Sophora Schema Docs: Screenshot einer Seite zu einem Dokumententyp
Sophora Schema Docs: Screenshot einer Seite zu einem Dokumententyp (Bild: subshell/CC BY)

Features

  • Verlinkte, browser-basierte Dokumentation mit den wichtigsten Informationen
  • Dynamischer Modus: Live-Aktualisierung auf Basis des konfigurierten Sophora-Repository (idealerweise ein Test-Repository)
  • Statischer Modus: Generiert autarke HTML, Dokumentation, die auf einen Webserver der Wahl geschoben werden kann. Ein Application-Server ist nicht notwendig
  • Dokumentation aller anlegbaren ("creatable") Dokumententypen
  • Dokumentation aller Skripte
  • Dokumententyp: Übersichtliche Aufteilung per Tabs - wie im Sophora DeskClient
  • Felder: Wichtige Informationen auf einen Blick: Name, Beschreibung, Feldtyp, Pflichtfeld, Nur-Lesbar, Eingeschränkt nutzbar, technischer Name
  • Felder: Detailinformationen zu Absatztypen, Auswahlwerten und eingeschränkten Berechtigungen
  • Logos und Beispiele für Dokumenttypen optional konfigurierbar
  • Benennung von Feldtypen überschreibbar und ergänzbar
  • Deep-Link-freundliche URLs
Sophora Schema Docs: Screenshot mit der Liste der Skripte
Sophora Schema Docs: Screenshot mit der Liste der Skripte (Bild: subshell/CC BY)

Technologie

Generator, eine Stand-alone-Java-Anwendung:

  • Sophora Client API
  • Spring

Generierte, statische Doku:

  • Statisches JSON als Datenbasis
  • React
  • Tailwind UI
  • HTML

Details

ID
SODOC
Doku
Dokumentation
Anforderungen
- Generator: Java. Access to the Sophora repository with the nodetypes
- Generierte Dokumentation: Einfacher Webserver. Nicht nötig: Application-Server (Tomcat, Node.js)
Zielgruppe
Jeder, Entwicklung, Administration, Redaktion
Add-on
Ja
Kategorien
Browser, Geschäftlich, Entwickler
Typ
Standalone
Hersteller
subshell GmbH
Icon