diff options
Diffstat (limited to '_intro.qmd')
| -rw-r--r-- | _intro.qmd | 46 |
1 files changed, 32 insertions, 14 deletions
@@ -78,21 +78,19 @@ by the following early design decisions: * The current delivery is intentionally scoped as a minimum viable product, with additional features planned as separate future works. +* Newly introduced syntax is kept in line + with the core principles of Markdown. * Programming language and integration design are largely dictated by existing actively used systems, rather than convenience of personal familiarity or efficiency. * The project solely involves freely licensed tools and resources, and is itself licensed under Free licences that encourage collaboration. -### Scope limited to authoring +### Scope limited to use for authoring -The scope of this project is to enable authoring, -with a further aim of extending to more complex processing in the future. - -The primary aim is to enable authors to annotate semantics -as integral part of their creative writing process. -Future works may expand on this, -enhancing renderings of the authored content, +The scope of this project is to enable annotating while authoring. +Rendering that makes use of annotations is outside this scope, +but planned for future works as discussed in @sec-rdf. The idea is to introduce semantic text annotation to Markdown authoring @@ -104,6 +102,28 @@ as illustrated in @fig-phase1. {#fig-phase1} +### Added syntax in the spirit of Markdown {#sec-spirit} + +*FIXME: rewrite as more fluent prose* + +In the source format of Markdown with annotations... + +* the syntax for annotation **should** be relatively comprehensible to humans + (in the same spirit as Markdown -- for example, \*\*strong emphasis\*\*) +* annotation syntax **must not** conflict with core Markdown + (i.e. must not cause ambiguities) +* annotation syntax **should not** conflict with other Markdown extensions + +For syntactically correct and structurally supported annotations... + +* visual output **must** be identical to the 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 its source form + ### Improve accepted formats and tools {#sec-improve} Markdown is a widely adopted authoring format, @@ -143,8 +163,8 @@ under the Creative Commons crediting share-alike 4.0. ## Implementation plan -*FIXME: sharpen this end summary, -to better conclude the previous parts* +*FIXME: sharpen this chapter summary +to explicitly conclude the previous parts* * extention to existing widespread authoring language, not an alternative one @@ -158,9 +178,7 @@ Existing Markdown syntax is analysed in @sec-commonmark and proposed new coverage of annotation in @sec-semantic-markdown. (Eventual rendering of annotations is outside the scope of this paper and will only be briefly discussed later in @sec-rdf.) -Then existing Markdown parsing is described in @sec-pandoc, -and implementation of extending that to parse annotations +Then existing Markdown parsing with the tool Pandoc is analysed in @sec-pandoc, +and the implementation of a filter to parse annotations is described in @sec-filter, and evaluated and discussed in the later chapters. - -*TODO: Maybe rephrase Pandoc as being not "described" but "analysed"?* |