From ee3480311933fa75abe93036b431b85adc307d9f Mon Sep 17 00:00:00 2001 From: Lars Wirzenius Date: Thu, 11 Feb 2021 08:33:13 +0200 Subject: doc(subplot.md): move section on metadata after general markup one It seems more logical to discuss markup in general first and the YAML metadata detail later. --- subplot.md | 60 ++++++++++++++++++++++++++++++------------------------------ 1 file changed, 30 insertions(+), 30 deletions(-) diff --git a/subplot.md b/subplot.md index ce26488..3a7d9d7 100644 --- a/subplot.md +++ b/subplot.md @@ -307,36 +307,6 @@ understood by Subplot. We will not specify Pandoc's dialect of Markdown here, only the parts Subplot pays attention to. -## Document metadata - -Pandoc supports, and Subplot makes use of, a [YAML metadata block][] in a -Markdown document. This can and should be used to set the document -title, authors, date (version), and can be used to control some of the -typesetting. Crucially for Subplot, the bindings and functions files -are named in the metadata block, rather than Subplot deriving them -from the input file name. - -[YAML metadata block]: https://pandoc.org/MANUAL.html#extension-yaml_metadata_block - -As an example, the metadata block for the Subplot document might look -as follows. The `---` before and `...` after the block are mandatory: -they are how Pandoc recongizes the block. - -~~~{.yaml .numberLines} ---- -title: "Subplot" -author: The Subplot project -date: work in progress -template: python -bindings: subplot.yaml -functions: subplot.py -... -~~~ - -There can be more than one bindings or functions file: use a YAML -list. - - ## Document markup [Pandoc]: https://pandoc.org/ @@ -427,6 +397,36 @@ This is still line number three, but would it be obvious? [roadmap]: https://crates.io/search?q=roadmap +## Document metadata + +Pandoc supports, and Subplot makes use of, a [YAML metadata block][] in a +Markdown document. This can and should be used to set the document +title, authors, date (version), and can be used to control some of the +typesetting. Crucially for Subplot, the bindings and functions files +are named in the metadata block, rather than Subplot deriving them +from the input file name. + +[YAML metadata block]: https://pandoc.org/MANUAL.html#extension-yaml_metadata_block + +As an example, the metadata block for the Subplot document might look +as follows. The `---` before and `...` after the block are mandatory: +they are how Pandoc recongizes the block. + +~~~{.yaml .numberLines} +--- +title: "Subplot" +author: The Subplot project +date: work in progress +template: python +bindings: subplot.yaml +functions: subplot.py +... +~~~ + +There can be more than one bindings or functions file: use a YAML +list. + + ## Bindings file The bindings file binds scenario steps to code functions that -- cgit v1.2.1