From 57dcb94ba9728def667799d3e81f59235259b33d Mon Sep 17 00:00:00 2001 From: Jonas Smedegaard Date: Tue, 18 Mar 2025 09:40:24 +0100 Subject: rename file markdown -> formats, and expand content --- _formats.qmd | 75 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ _markdown.qmd | 48 -------------------------------------- report.qmd | 2 +- 3 files changed, 76 insertions(+), 49 deletions(-) create mode 100644 _formats.qmd delete mode 100644 _markdown.qmd diff --git a/_formats.qmd b/_formats.qmd new file mode 100644 index 0000000..dc88a61 --- /dev/null +++ b/_formats.qmd @@ -0,0 +1,75 @@ +This project mainly involves navigating in and altering data structures. +Main data structures are the document formats Markdown, HTML and PDF, +and the abstract data language RDF, +serialised as RDFa (embedded in HTML) and PDF (embedded in PDF). + +## Markdown + +Markdown is a text markup language +with an emphasis on being easy for humans to read +[@Gruber2004]. + +Compared to word processors like Microsoft Word and LibreOffice Writer, +Markdown authoring stores both content and markup together +in a human-readable tekst file. + +::: {#fig-formality} + +``` +informal /---------formatted text----------\ formal +<------v-------------v-------------v-----------------------v----> + plain text informal markup formal markup binary format + (Markdown) (HTML, XML, etc.) +``` + +Markdown is informal, ASCII-based markup +[@Leonard2016, p. 4] + +::: + +HTML is itself a plaintext format, +but is less human-readable. +Similarly the format LaTeX is also plaintext, +but its markdown arguably distracts the reading process +[@Mailund2019chap2, p. 9]. + +### Alternatives + +Other human-readable document source formats exists. + +FIXME reStructuredText. +FIXME Org-mode. +FIXME AsciiDoc. + +### Integration + +Markdown is in widespread use. + +Major source forges use Markdown by default for `README` files +[@Github2025; @GitLab2025; @Codeberg2024]. +Some major programming languages +natively support Markdown in embedded docstrings +in core tools +[@Microsoft2023; @Oracle2025; @RustTeam2024]; +others offer optional support e.g. through plugins +[@Heesch2025; @Sphinx2025; @JSDoc2023]. + +## HTML + +*TODO* + +## PDF + +*TODO* + +## RDF + +*TODO* + +### RDFa + +*TODO* + +### XMP + +*TODO* diff --git a/_markdown.qmd b/_markdown.qmd deleted file mode 100644 index 56d4c76..0000000 --- a/_markdown.qmd +++ /dev/null @@ -1,48 +0,0 @@ -Markdown is a text markup language -with an emphasis on being easy for humans to read -[@Gruber2004]. - -Compared to word processors like Microsoft Word and LibreOffice Writer, -Markdown authoring stores both content and markup together -in a human-readable tekst file. - -::: {#fig-formality} - -``` -informal /---------formatted text----------\ formal -<------v-------------v-------------v-----------------------v----> - plain text informal markup formal markup binary format - (Markdown) (HTML, XML, etc.) -``` - -Markdown is informal, ASCII-based markup -[@Leonard2016, p. 4] - -::: - -HTML is itself a plaintext format, -but is less human-readable. -Similarly the format LaTeX is also plaintext, -but its markdown arguably distracts the reading process -[@Mailund2019chap2, p. 9]. - -## Alternatives - -Other human-readable document source formats exists. - -FIXME reStructuredText. -FIXME Org-mode. -FIXME AsciiDoc. - -## Integration - -Markdown is in widespread use. - -Major source forges use Markdown by default for `README` files -[@Github2025; @GitLab2025; @Codeberg2024]. -Some major programming languages -natively support Markdown in embedded docstrings -in core tools -[@Microsoft2023; @Oracle2025; @RustTeam2024]; -others offer optional support e.g. through plugins -[@Heesch2025; @Sphinx2025; @JSDoc2023]. diff --git a/report.qmd b/report.qmd index fae00ef..1284007 100644 --- a/report.qmd +++ b/report.qmd @@ -63,7 +63,7 @@ TODO ## Data formats -{{< include _markdown.qmd >}} +{{< include _formats.qmd >}} ## Authoring workflow -- cgit v1.2.3