aboutsummaryrefslogtreecommitdiff
path: root/docs/share
diff options
context:
space:
mode:
authorlonkaars <loek@pipeframe.xyz>2024-04-20 16:12:22 +0200
committerlonkaars <loek@pipeframe.xyz>2024-04-20 16:12:22 +0200
commitd6eaa7a8a6e4332c473368230e0a0782a737bd39 (patch)
treef51eca26c36e92a15205e5a9f1d3654144f4a3cf /docs/share
parentebcc6e19d2fdddbbce6d3ac93ec9ac29663a1d7e (diff)
small refactor + create software design document
Diffstat (limited to 'docs/share')
-rw-r--r--docs/share/meta.adoc31
1 files changed, 24 insertions, 7 deletions
diff --git a/docs/share/meta.adoc b/docs/share/meta.adoc
index 0b6cb78..15d8d18 100644
--- a/docs/share/meta.adoc
+++ b/docs/share/meta.adoc
@@ -1,8 +1,13 @@
-:sectnums:
-:title-page:
-:toc:
-:toclevels: 4
-:pagenums:
+// (these files are included from the parent directory)
+:pdf-theme: ./theme.yml
+// :pdf-fontsdir: ./res/font
+:bibtex-file: ./share/refs.bib
+
+// document / project info
+ifndef::document[]
+:document: DOCUMENT TITLE
+endif::[]
+:project: Project Puzzlebox
:revnumber: 0.0
:revdate: 2024-04-01
:revremark: draft
@@ -10,7 +15,19 @@
:author_2: Loek Le Blansch
:author_3: Lars Faase
:author_4: Elwin Hammer
+
+// numbering / reference styles
+:sectnums:
+:toclevels: 4
+:pagenums:
:xrefstyle: short
-:project: Project Puzzlebox
-// see https://docs.asciidoctor.org/asciidoc/latest/attributes/document-attributes-ref
+// (set and display title)
+= {document}: {project}
+// start each document with a title page
+:title-page:
+// followed by a table of contents
+:toc:
+
+// also https://docs.asciidoctor.org/asciidoc/latest/attributes/document-attributes-ref
+