diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8177718c641d3ab0d491195ea650001f156f76ac..d1159f05c47c28a2d58fd2c837e90cfa75c5d32a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -53,7 +53,7 @@ Make sure you have added an appropriate documentation for your changes. This includes necessary updates of present chapters. If your proposed changes include a new feature, do not forget to extend the -[feature list](FEATURELIST.md). +[feature list](docs/features.md). ## Pull requests (PR) Push all your changes to the fork you have created. diff --git a/docs/about.md b/docs/about.md index d23d095fd14a9f75e7a3f3fb4518326802e6fcef..8d1b9da2007f0822c954bd329703af234470b3db 100644 --- a/docs/about.md +++ b/docs/about.md @@ -19,36 +19,7 @@ infrastructure. Over the years a few components became obsolete, so the current version is a completely rewritten one. ## Features -- [faceted search](faceted-search.md) -- [TextGrid clients](tgclients.md) - - transfer data from the TextGrid Repository - - validation against RelaxNG schema on publish - - store data in the TextGrid Repository -- [fork/download SADE projects](forking.md) -- [preconfigured indexes](index-configuration.md) - - Lucene string analyzer - - configured for TEI - - easy (as in easy) configuration/maintenance of charmaps and synonyms - - Range Index -- frontend - - easy (as in easy) to configure menu bar - - professional template -- [wiki parser](wikiParser.md) - - synchronize selected wiki pages - - [Confluence](confluenceParser.md) - - [Dokuwiki](dokuwikiParser.md) -- multi-language support -- [prepared for optionally prerendering](prerendering.md) -- create [call graphs](callgraphs.md) of modules - -### Third party addons -- SemToNotes -- TEI stylesheets (XSLT) -- Markdown parser - -By default the eXist database offers a RESTful interface to all of your data, -but with the help of a little XQuery, you can provide on-the-fly transformations -via REST as well. +For a full overview see [SADE's feature list](features.md). ## TextGrid This version is prepared to present data transferred via the [TextGrid](https://textgrid.de/) diff --git a/docs/features.md b/docs/features.md new file mode 100644 index 0000000000000000000000000000000000000000..e5238f4cd94830a3348f230228f8c5ed89ec74ed --- /dev/null +++ b/docs/features.md @@ -0,0 +1,38 @@ +# Features + +## general +* professional template +* easy customizing +* multi-language support +* wiki parser + * synchronize selected wiki pages + * Confluence + * Dokuwiki +* all features from [exist-db](https://exist-db.org), e.g. REST interface + +## search +* faceted search +* preconfigured indexes +* Lucene string analyzer + * configured for TEI + * configuration and maintenance of charmaps and synonyms + * Range Index + +## TextGrid specific +* TextGrid clients + * pull data from the TextGrid Repository + * publish data from the TextGridLab with SADE-Publisher + * validation against RelaxNG schema on publish + * store data in the TextGrid Repository +* usage of IIIF image server from TextGrid +* completely compatible with [TextGrid Metadata Scheme](https://wiki.de.dariah.eu/display/TextGrid/Metadata) + +## development +* create call graphs of modules +* prepared for optional prerendering and caching of transformations +* fork/download SADE projects + +## Third party addons +* SemToNotes +* TEI stylesheets (XSLT) +* Markdown parser