aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJonas Smedegaard <dr@jones.dk>2025-02-20 10:50:22 +0100
committerJonas Smedegaard <dr@jones.dk>2025-02-20 10:50:26 +0100
commit90d11f170f6c14e3c12b27068d45e2fed1149e49 (patch)
treeab749b7251442d8a8acdddced1d8bd807e60a921
parentc55ff28149d66575e35f6d029821fd1cb0b903f8 (diff)
add draft design notes
-rw-r--r--_design.qmd28
1 files changed, 27 insertions, 1 deletions
diff --git a/_design.qmd b/_design.qmd
index 1333ed7..b7a6b31 100644
--- a/_design.qmd
+++ b/_design.qmd
@@ -1 +1,27 @@
-TODO
+Collection of interrelated POSIX scripts and Pandoc extensions
+for enabling semantic annotations in Markdown-based authoring workflows.
+
+* filter extension to capture annotations
+ * identify semantic metadata in stylistic metadata part of Pandoc YAML header
+ * identify semantic metadata in content part of Pandoc document structure
+ * append semantic metadata to Pandoc YAML document header
+ * strip identified metadata from stylistic metadata and content
+* output format extension to generate PDF
+ * read semantic metadata from Pandoc YAML document header
+ * structure semantic metadata as RDF triples
+ * append RDF triples serialized as part of XMP metadata in PDF
+* output format extension to generate web page
+ * read semantic metadata from Pandoc YAML document header
+ * structure semantic metadata as RDF triples
+ * append RDF triples serialized as RDFa
+
+## Interfaces
+
+* Pandoc document object model (DOM)
+* Resource Description Framework (RDF)
+ * XMP
+ * RDFa
+* Markdown
+ * Semantic Markdown
+* CommonMark
+ * Semantic CommonMark