From 358b4c7ac81d4cb71406b55851e6eac0a272f2c0 Mon Sep 17 00:00:00 2001 From: Daniel Silverstone Date: Fri, 9 Apr 2021 18:29:44 +0100 Subject: subplot.md: Use subplot metadata over sp-meta Signed-off-by: Daniel Silverstone --- subplot.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/subplot.md b/subplot.md index bc744b1..095aad5 100644 --- a/subplot.md +++ b/subplot.md @@ -74,7 +74,7 @@ input file itself. Subplot actually consists mainly of two separate programs: **subplot docgen** for generating output documents, and **subplot codegen** for generating the test program. There are a couple of additional tools -(**sp-meta** for reporting meta data about a Subplot document, and +(**subplot metadata** for reporting meta data about a Subplot document, and **sp-filter** for doing the document generation as a Pandoc filter). Thus a more detailed architecture view is shown below. @@ -2092,11 +2092,11 @@ template: python ### Extracting metadata from a document -The **sp-meta** program extracts metadata from a document. It is +The **subplot metadata** program extracts metadata from a document. It is useful to see the scenarios, for example. For example, given a document like this: -sp-meta would extract this information from the **simple.md** example: +subplot metadata would extract this information from the **simple.md** example: ~~~ title: Test scenario @@ -2105,7 +2105,7 @@ functions: f.py scenario Simple ~~~ -This scenario check sp-meta works. Note that it requires the bindings +This scenario check subplot metadata works. Note that it requires the bindings or functions files. ~~~scenario @@ -2118,7 +2118,7 @@ and file foo.bib and file bar.bib and file expected.json and an installed subplot -when I run sp-meta images.md +when I run subplot metadata images.md then stdout contains "source: images.md" and stdout contains "source: b.yaml" and stdout contains "source: other.yaml" @@ -2130,7 +2130,7 @@ and stdout contains "source: image.gif" and stdout contains "bindings: b.yaml" and stdout contains "bindings: other.yaml" and stdout contains "functions: f.py" -when I run sp-meta images.md -o json +when I run subplot metadata images.md -o json then JSON output matches expected.json ~~~ @@ -2501,12 +2501,12 @@ then command fails ### List embedded files -The `sp-meta` command lists embedded files in its output. +The `subplot metadata` command lists embedded files in its output. ~~~scenario given file two-embedded.md and an installed subplot -when I run sp-meta two-embedded.md +when I run subplot metadata two-embedded.md then stdout contains "foo.txt" and stdout contains "bar.yaml" ~~~ -- cgit v1.2.1