diff options
| author | Jonas Smedegaard <dr@jones.dk> | 2025-05-19 14:26:59 +0200 |
|---|---|---|
| committer | Jonas Smedegaard <dr@jones.dk> | 2025-05-19 14:28:12 +0200 |
| commit | 651fcfe553442965efbaec17891c4d205e0607a5 (patch) | |
| tree | 10936807cb890acd6d215945978010694fd224c7 | |
| parent | e7178ff33ddc9aebbcf8585e5f75b105850bd352 (diff) | |
merge sections contraints and design into markdown
| -rw-r--r-- | _constraints.qmd | 23 | ||||
| -rw-r--r-- | _design.qmd | 26 | ||||
| -rw-r--r-- | _intro.qmd | 10 | ||||
| -rw-r--r-- | _markdown.qmd | 61 | ||||
| -rw-r--r-- | report.qmd | 10 |
5 files changed, 72 insertions, 58 deletions
diff --git a/_constraints.qmd b/_constraints.qmd deleted file mode 100644 index be415d7..0000000 --- a/_constraints.qmd +++ /dev/null @@ -1,23 +0,0 @@ -*TODO* - -In the source format of Markdown with with annotations... - -* the syntax for annotation **should* be relatively human comprehensible - (in the same spirit as Markdown -- e.g. \*\*strong emphasis\*\*) -* annotation syntax **must not** conflict with core Markdown - (i.e. must not cause disambiguations) -* annotation syntaxt **should not** conflict with other Markdown extensions - -For syntactically correct and structurally supported annotations... - -* visual output **must** be identical to source without the annotation -* metadata of output **must** contain the annotation - -For syntactically incorrect or structurally unsupported annotations... - -* the annotation **must not** disappear from visual output -* visual output **should** include the annotation in source form - -## Plan - -*TODO* diff --git a/_design.qmd b/_design.qmd deleted file mode 100644 index 0c96016..0000000 --- a/_design.qmd +++ /dev/null @@ -1,26 +0,0 @@ -*TODO* - -## Readability - -## XMP, RDFa and RDF - -RDF is an abstract data model for knowledge graphs, -usable for domain-specific annotations: -Terminology for a domain is established by referencing a shared ontology, -and terms are composed as sets of subject-predicate-object triples. -RDF includes one language, Turtle, strives to be human readable, -and languages for embedding triples into other data structures, -notably XMP for PDF files and RDFa for HTML. - -RDF is an abstract data model for knowledge graphs. -Multiple RDF languages exist, -each covering all or subsets of the RDF model, -including human readability optimized Turtle, -RDFa for HTML embedding -and XMP for PDF embedding. -Each RDF language have different constraints, -e.g. the XMP language for storing RDF in media files -can express express one RDF graph in each XMP object -[@Adobe2012, p. 9]. - -*TODO* @@ -33,6 +33,8 @@ similarly unobtrusive as the widely adopted structural and hypermedia markup, by extending a common Markdown processor to handle semantic markup. +*FIXME: introduce Pandoc, treating it as a prerequisite for the task* + ## Problem formulation So, @@ -51,6 +53,8 @@ be extended to support semantic text annotations?** ## Levels of implementation +*FIXME: maybe move to section on expectations for processors* + The primary aim is to support authoring; enhancing renderings of the authored content is secondary. @@ -132,3 +136,9 @@ for the syntax of embedding ontological annotations in Markdown. The main challenge of this project is to implement that specification as extensions for the existing Pandoc tool and Quarto framework, and as part of that potentially also refine the draft specification. + +* Outline work +* definér hvad er semantisk textannotation +* analysér eksisterende værktøj +* forentet output +* implementering som filter... diff --git a/_markdown.qmd b/_markdown.qmd index ff7b346..948eda8 100644 --- a/_markdown.qmd +++ b/_markdown.qmd @@ -1,3 +1,9 @@ +*FIXME: introduce extensions and extension sets (dialects)* + +*FIXME: Pick Commonmark as reference dialect* + +## Syntax of Markdown dialect Commonmark + Markdown consists of blocks of content, optionally prepended a set of Metadata blocks. Visually, this can be described using a syntax diagram @@ -63,3 +69,58 @@ by extending the Markdown language with additional types of annotation. Syntax diagrams for additional Markdown components are included as [Appendix @sec-def-dia]. + +## Syntax of extension Semantic Markdown + +*FIXME: write this!* + +## Expectations of processors + +*FIXME: write this!* + +* hvad skal med +* hvad skal ikke med +* hvis PDF..., hvad så? + +Dette afsnit udgør "requirements" + +### Readability + +In the source format of Markdown with with annotations... + +* the syntax for annotation **should* be relatively human comprehensible + (in the same spirit as Markdown -- e.g. \*\*strong emphasis\*\*) +* annotation syntax **must not** conflict with core Markdown + (i.e. must not cause disambiguations) +* annotation syntaxt **should not** conflict with other Markdown extensions + +For syntactically correct and structurally supported annotations... + +* visual output **must** be identical to source without the annotation +* metadata of output **must** contain the annotation + +For syntactically incorrect or structurally unsupported annotations... + +* the annotation **must not** disappear from visual output +* visual output **should** include the annotation in source form + +### XMP, RDFa and RDF + +RDF is an abstract data model for knowledge graphs, +usable for domain-specific annotations: +Terminology for a domain is established by referencing a shared ontology, +and terms are composed as sets of subject-predicate-object triples. +RDF includes one language, Turtle, strives to be human readable, +and languages for embedding triples into other data structures, +notably XMP for PDF files and RDFa for HTML. + +RDF is an abstract data model for knowledge graphs. +Multiple RDF languages exist, +each covering all or subsets of the RDF model, +including human readability optimized Turtle, +RDFa for HTML embedding +and XMP for PDF embedding. +Each RDF language have different constraints, +e.g. the XMP language for storing RDF in media files +can express express one RDF graph in each XMP object +[@Adobe2012, p. 9]. @@ -67,7 +67,7 @@ are editorial notes not intented for inclusion in the final delivery.* {{< include _intro.qmd >}} -# Markdown and annotation +# Markdown syntax for annotations {{< include _markdown.qmd >}} @@ -75,14 +75,6 @@ are editorial notes not intented for inclusion in the final delivery.* {{< include _background.qmd >}} -# Product requirements - -{{< include _constraints.qmd >}} - -# Design choices - -{{< include _design.qmd >}} - # Usage {{< include _usage.qmd >}} |
