From 52d847a7bbdb01bc0473a3a14a65cf1927cd48b1 Mon Sep 17 00:00:00 2001 From: Balduin Landolt <33053745+BalduinLandolt@users.noreply.github.com> Date: Tue, 7 Jan 2025 18:05:18 +0100 Subject: [PATCH] add minimal documentation --- docs/03-endpoints/api-v2/text/overview.md | 1 + docs/03-endpoints/api-v2/text/standard-standoff.md | 11 +++++++++++ 2 files changed, 12 insertions(+) diff --git a/docs/03-endpoints/api-v2/text/overview.md b/docs/03-endpoints/api-v2/text/overview.md index b1d9314562..7857d7348c 100644 --- a/docs/03-endpoints/api-v2/text/overview.md +++ b/docs/03-endpoints/api-v2/text/overview.md @@ -35,6 +35,7 @@ This allows for the following markup: - horizontal rules - code blocks - block quotes + - footnotes - typographical markup - italics - bold diff --git a/docs/03-endpoints/api-v2/text/standard-standoff.md b/docs/03-endpoints/api-v2/text/standard-standoff.md index 03a2ffffe7..26f49fa55f 100644 --- a/docs/03-endpoints/api-v2/text/standard-standoff.md +++ b/docs/03-endpoints/api-v2/text/standard-standoff.md @@ -41,6 +41,7 @@ that are mapped to standoff classes and properties defined in the ontology: - `` → `standoff:StandoffCiteTag` - `
` → `standoff:StandoffBlockquoteTag` - `` → `standoff:StandoffCodeTag` +- `` → `standoff:StandoffFootnoteTag` The HTML produced by CKEditor is wrapped in an XML doctype and a pair of root tags `...` and then sent to the DSP-API. @@ -48,3 +49,13 @@ The XML sent to the GUI by the DSP-API is unwrapped accordingly. Although the GUI supports HTML5, it is treated as if it was XHTML in strict XML notation. Text with standard standoff markup can be transformed to TEI XML as described [here](tei-xml.md). + +## Footnotes + +Footnote support is currently experimental and has some limitations: + +- CKE does not support footnotes out of the box. DSP-APP uses a custom build of CKE that supports footnotes. +- The content of footnotes is not covered by the full text search. +- The content of footnotes may contain further markup, but this will internally not be converted to standoff. + For that reason, markup in footnotes can not be searched for through gravsearch + and hence outgoing and incoming links will not be displayed in DSP-APP.