Sophora Schema Docs

+++ Coming Soon +++

Sophora Schema Docs Add-on

The module Sophora Schema Docs generates a documentation of the document model of your Sophora Repository.

For all those who want to provide all Sophora stakeholders with easily accessible documentation of their Sophora data model.

Features

  • Linked, browser-based documentation with the most relevant information
  • Dynamic mode: live updates based on the configured Sophora repository (ideally a test repository)
  • Static mode: generates self-sufficient HTML, documentation that can be pushed to a web server of your choice. An application server is not necessary
  • Documentation of all creatable document types
  • Documentation of all scripts
  • Document type: clear division via tabs - as in the Sophora DeskClient
  • Fields: important information at a glance: name, description, field type, mandatory field, read-only, restricted use, technical name
  • Fields: details about paragraph types, selection values, and restricted permissions
  • Logos and examples of document types optionally configurable
  • Naming of field types can be overridden and supplemented
  • Deep-link friendly URLs

Technology

Generator, stand-alone Java app:

  • Sophora Client API
  • Spring

Generated, static Documentation:

  • Static JSON
  • React
  • Tailwind UI
  • HTML

Details

ID
SODOC
Requirements
- Generator: Java. Access to the Sophora repository with the nodetypes
- Generated documentation: simple webserver. No application server (Tomcat, Node.js) necessary
Audience
All, Development, Administration, Editing
Is an Add-on
Yes
Categories
Browser, Business, Developer
Type
Standalone
Creator
subshell GmbH
Icon