From 7e8217ca7b9033e98d10e0751d141b377b85cc67 Mon Sep 17 00:00:00 2001 From: Jonas Smedegaard Date: Tue, 11 Feb 2025 22:59:40 +0100 Subject: draft report structure --- _actors.yml | 57 ++++++++++++++++++++++++++++++++++++ _background.qmd | 17 ----------- _code.qmd | 1 + _conclusion.qmd | 1 + _design.qmd | 1 + _discussion.qmd | 1 + _intro.qmd | 1 + _markdown.qmd | 17 +++++++++++ _perspectives.qmd | 1 + _quarto.yml | 11 +++++++ _test.qmd | 1 + _use.qmd | 1 + report.qmd | 86 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 13 files changed, 179 insertions(+), 17 deletions(-) create mode 100644 _actors.yml delete mode 100644 _background.qmd create mode 100644 _code.qmd create mode 100644 _conclusion.qmd create mode 100644 _design.qmd create mode 100644 _discussion.qmd create mode 100644 _intro.qmd create mode 100644 _markdown.qmd create mode 100644 _perspectives.qmd create mode 100644 _quarto.yml create mode 100644 _test.qmd create mode 100644 _use.qmd create mode 100644 report.qmd diff --git a/_actors.yml b/_actors.yml new file mode 100644 index 0000000..867fa48 --- /dev/null +++ b/_actors.yml @@ -0,0 +1,57 @@ +author: +- name: Jonas Smedegaard + orcid: 0009-0009-1037-0180 + url: https://dr.jones.dk/info + email: stud-jonasj@ruc.dk + affiliation: + - ref: team + - ref: imt + roles: writing +- name: Léandre Gervais Camille Godet + orcid: 0009-0003-7177-8805 + url: https://github.com/Leandre17 + email: stud-lgcg@ruc.dk + affiliation: + - ref: team +# - ref: imt + roles: writing +- name: Sabin Ghimire +# orcid: + url: https://github.com/sabinghimire + email: stud-sabin@ruc.dk + affiliation: + - ref: team + - ref: dse + roles: writing +- name: Abdul Halim Bin Abdul Rahman + orcid: 0000-0002-0208-2754 + url: https://forskning.ruc.dk/da/persons/ahrahman + email: ahrahman@ruc.dk + affiliation: + - ref: imt + roles: supervision +affiliations: +- id: team + name: Projekt group XXX +- id: dse + name: Roskilde Universitet + department: Department of Science and Environment + city: Roskilde + postal-code: 4000 + country: Denmark + url: https://ruc.dk/en/department-science-and-environment + isni: 0000 0001 0672 1325 + ror: 014axpa37 +- id: imt + name: Roskilde Universitet + department: Department of People and Technology + city: Roskilde + postal-code: 4000 + country: Denmark + url: https://ruc.dk/en/department-people-and-technology + isni: 0000 0001 0672 1325 + ror: 014axpa37 +copyright: + holder: Jonas Smedegaard and Léandre Godet and Sabin Ghimire + year: 2025 +license: "CC BY-SA" diff --git a/_background.qmd b/_background.qmd deleted file mode 100644 index ac9da22..0000000 --- a/_background.qmd +++ /dev/null @@ -1,17 +0,0 @@ -An authoring style that has grown popular, -especially among some programmers, -is to write in a format called Markdown, -and then compile the final document. - -Compared to word processors like Microsoft Word and LibreOffice Writer, -Markdown authoring stores both content and markup together -in a human-readable tekst file. - -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. - -Other human-readable document source formats exists. -FIXME Org-mode. -FIXME AsciiDoc. diff --git a/_code.qmd b/_code.qmd new file mode 100644 index 0000000..1333ed7 --- /dev/null +++ b/_code.qmd @@ -0,0 +1 @@ +TODO diff --git a/_conclusion.qmd b/_conclusion.qmd new file mode 100644 index 0000000..1333ed7 --- /dev/null +++ b/_conclusion.qmd @@ -0,0 +1 @@ +TODO diff --git a/_design.qmd b/_design.qmd new file mode 100644 index 0000000..1333ed7 --- /dev/null +++ b/_design.qmd @@ -0,0 +1 @@ +TODO diff --git a/_discussion.qmd b/_discussion.qmd new file mode 100644 index 0000000..1333ed7 --- /dev/null +++ b/_discussion.qmd @@ -0,0 +1 @@ +TODO diff --git a/_intro.qmd b/_intro.qmd new file mode 100644 index 0000000..1333ed7 --- /dev/null +++ b/_intro.qmd @@ -0,0 +1 @@ +TODO diff --git a/_markdown.qmd b/_markdown.qmd new file mode 100644 index 0000000..ac9da22 --- /dev/null +++ b/_markdown.qmd @@ -0,0 +1,17 @@ +An authoring style that has grown popular, +especially among some programmers, +is to write in a format called Markdown, +and then compile the final document. + +Compared to word processors like Microsoft Word and LibreOffice Writer, +Markdown authoring stores both content and markup together +in a human-readable tekst file. + +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. + +Other human-readable document source formats exists. +FIXME Org-mode. +FIXME AsciiDoc. diff --git a/_perspectives.qmd b/_perspectives.qmd new file mode 100644 index 0000000..1333ed7 --- /dev/null +++ b/_perspectives.qmd @@ -0,0 +1 @@ +TODO diff --git a/_quarto.yml b/_quarto.yml new file mode 100644 index 0000000..b96a8af --- /dev/null +++ b/_quarto.yml @@ -0,0 +1,11 @@ +project: + type: website + +website: + title: "Overview" + navbar: + left: + - text: Report + href: report.qmd + +lang: en-GB diff --git a/_test.qmd b/_test.qmd new file mode 100644 index 0000000..1333ed7 --- /dev/null +++ b/_test.qmd @@ -0,0 +1 @@ +TODO diff --git a/_use.qmd b/_use.qmd new file mode 100644 index 0000000..1333ed7 --- /dev/null +++ b/_use.qmd @@ -0,0 +1 @@ +TODO diff --git a/report.qmd b/report.qmd new file mode 100644 index 0000000..b0f443f --- /dev/null +++ b/report.qmd @@ -0,0 +1,86 @@ +--- +title: Making Markdown authoring better +subtitle: Extensions to Quarto for authoring semantic markdown + +date: 2025-05-27 + +toc-depth: 2 + +format: + stylish-report-pdf: + pdfversion: "2.0" + pdfstandard: [A-4f, UA-2] + +# generate Well-Tagged PDF using latest testphase components +# +# requires TeX Live 2024.20250114 +# pdftestphase: latest +# else generate Well-Tagged PDF using specific testphase components +# requires TeX Live 2024.20240829 (maybe older) +# pdftestphase: ["phase-III", "title", "math", "table", "firstaid"] + +# fail on error generating Well-Tagged PDF +# pdftestphasestrict: true + +# debugging of Well-Tagged PDF +# pdfdebug: ["para"] + +metadata-files: + - _actors.yml +keywords: + - Markdown + - Commonmark + - Lua + - Quarto + - plaintext text editing + +#keep-tex: true +--- + +# Abstract + +TODO + +# Introduction + +{{< include _intro.qmd >}} + +# Project Planning + +{{< include _plan.qmd >}} + +# Analysis and Design + +## Markdown + +{{< include _markdown.qmd >}} + +## Design + +{{< include _design.qmd >}} + +# Description of the Program + +{{< include _code.qmd >}} + +# User Guide + +{{< include _use.qmd >}} + +# Testing + +{{< include _test.qmd >}} + +# Discussion + +{{< include _discussion.qmd >}} + +# Conclusion + +{{< include _conclusion.qmd >}} + +# Perspektives + +{{< include _perspectives.qmd >}} + +# Bibliography {.appendix} -- cgit v1.2.3