summaryrefslogtreecommitdiff
path: root/subplot.md
diff options
context:
space:
mode:
authorLars Wirzenius <liw@liw.fi>2023-02-14 18:32:15 +0200
committerLars Wirzenius <liw@liw.fi>2023-02-14 18:38:56 +0200
commit1072d934d5409398cca548125a5ab22a922d6038 (patch)
tree651f7de6aaf11a3cdf0040295647479f7b7a268f /subplot.md
parent69d025ab976d91b4074162eb20cc7861f25c231b (diff)
downloadsubplot-1072d934d5409398cca548125a5ab22a922d6038.tar.gz
feat! drop support for producing PDF output
We may add this back later, but for now, it's not wanted. Sponsored-by: author
Diffstat (limited to 'subplot.md')
-rw-r--r--subplot.md84
1 files changed, 33 insertions, 51 deletions
diff --git a/subplot.md b/subplot.md
index d64b93b..a294573 100644
--- a/subplot.md
+++ b/subplot.md
@@ -63,7 +63,7 @@ technical text that's aimed at all your stakeholders.
## Subplot architecture
Subplot reads an input document, in Markdown, and generates a typeset
-output document, as PDF or HTML, for all stakeholders to understand.
+output document, as HTML, for all stakeholders to understand.
Subplot also generates a test program, in Python, that verifies the
acceptance criteria are met, for developers and testers and auditors
to verify the system under test meets its acceptance criteria. The
@@ -85,9 +85,6 @@ impl [shape=box];
subplot [label="Subplot"];
subplot [shape=ellipse];
-pdf [label="foo.pdf \n PDF (generated)"]
-pdf [shape=note];
-
html [label="foo.html \n HTML (generated)"]
html [shape=note];
@@ -100,7 +97,6 @@ report [shape=note];
md -> subplot;
bindings -> subplot;
impl -> subplot;
-subplot -> pdf;
subplot -> html;
subplot -> testprog;
testprog -> report;
@@ -109,7 +105,7 @@ testprog -> report;
[Pandoc]: https://pandoc.org/
-Subplot uses the [Pandoc][] software for generating PDF and HTML
+Subplot uses the [Pandoc][] software for generating HTML
output documents. In fact, any output format supported by Pandoc can
be requested by the user. Depending on the output format, Pandoc may
use, for example, LaTeX. Subplot interprets parts of the Markdown
@@ -140,9 +136,6 @@ docgen [shape=ellipse];
codegen [label="subplot codegen"];
codegen [shape=ellipse];
-pdf [label="foo.pdf \n PDF (generated)"]
-pdf [shape=note];
-
html [label="foo.html \n HTML (generated)"]
html [shape=note];
@@ -157,7 +150,6 @@ bindings -> docgen;
md -> codegen;
bindings -> codegen;
impl -> codegen;
-docgen -> pdf;
docgen -> html;
codegen -> testprog;
testprog -> report;
@@ -772,7 +764,7 @@ will emit a warning if the file is not found, and subplot codegen will emit an e
Bindings can contain an `impl` map which connects the binding with zero or more
language templates. If a binding has no `impl` entries then it can still be
-used to `docgen` a PDF or HTML document from a subplot document. This permits a
+used to `docgen` a HTML document from a subplot document. This permits a
workflow where requirements owners / architects design the validations for a
project and then engineers implement the step functions to permit the
validations to work.
@@ -802,8 +794,6 @@ given file badfilename.md
and file b.yaml
and file f.py
and an installed subplot
-when I run subplot docgen --merciful badfilename.subplot -o foo.pdf
-then file foo.pdf exists
when I try to run subplot codegen --run badfilename.md -o test.py
then command fails
```
@@ -1074,7 +1064,7 @@ def foobar_was_done(ctx):
### Smoke test
The scenario below uses the input files defined above to run some tests
-to verify that Subplot can build a PDF and an HTML document, and
+to verify that Subplot can build an HTML document, and
execute a simple scenario successfully. The test is based on
generating the test program from an input file, running the test
program, and examining the output.
@@ -1085,8 +1075,6 @@ given file simple.md
and file b.yaml
and file f.py
and an installed subplot
-when I run subplot docgen simple.subplot -o simple.pdf
-then file simple.pdf exists
when I run subplot docgen simple.subplot -o simple.html
then file simple.html exists
when I run subplot codegen --run simple.subplot -o test.py
@@ -1174,8 +1162,6 @@ given file allkeywords.md
and file b.yaml
and file f.py
and an installed subplot
-when I run subplot docgen allkeywords.subplot -o foo.pdf
-then file foo.pdf exists
when I run subplot codegen --run allkeywords.subplot -o test.py
then scenario "All keywords" was run
and step "given precondition foo" was run
@@ -1262,8 +1248,6 @@ given file continuationmisuse.md
and file b.yaml
and file f.py
and an installed subplot
-when I run subplot docgen continuationmisuse.subplot -o foo.pdf
-then file foo.pdf exists
when I try to run subplot codegen --run continuationmisuse.subplot -o test.py
then command fails
~~~
@@ -1300,8 +1284,8 @@ section. This scenario verifies that all markup works.
given file title-markup.subplot
given file title-markup.md
given an installed subplot
-when I run subplot docgen title-markup.subplot -o foo.pdf
-then file foo.pdf exists
+when I run subplot docgen title-markup.subplot -o foo.html
+then file foo.html exists
~~~
~~~~{#title-markup.subplot .file .yaml .numberLines}
@@ -1325,8 +1309,6 @@ given file emptylines.md
and file b.yaml
and file f.py
and an installed subplot
-when I run subplot docgen emptylines.subplot -o emptylines.pdf
-then file emptylines.pdf exists
when I run subplot docgen emptylines.subplot -o emptylines.html
then file emptylines.html exists
when I run subplot codegen --run emptylines.subplot -o test.py
@@ -1957,13 +1939,13 @@ given file simple.md
and file b.yaml
and file f.py
and an installed subplot
-when I run subplot docgen simple.subplot -o simple.pdf
-then file simple.pdf exists
-when I remember metadata for file simple.pdf
+when I run subplot docgen simple.subplot -o simple.html
+then file simple.html exists
+when I remember metadata for file simple.html
and I wait until 1 second has passed
-and I run subplot docgen simple.subplot -o simple.pdf
-then file simple.pdf has same metadata as before
-and only files simple.subplot, simple.md, b.yaml, f.py, simple.pdf exist
+and I run subplot docgen simple.subplot -o simple.html
+then file simple.html has same metadata as before
+and only files simple.subplot, simple.md, b.yaml, f.py, simple.html exist
~~~
### Do typeset if output is older than subplot
@@ -1974,13 +1956,13 @@ given file simple.md
and file b.yaml
and file f.py
and an installed subplot
-when I run subplot docgen simple.subplot -o simple.pdf
-then file simple.pdf exists
-when I remember metadata for file simple.pdf
+when I run subplot docgen simple.subplot -o simple.html
+then file simple.html exists
+when I remember metadata for file simple.html
and I wait until 1 second has passed
and I touch file simple.subplot
-and I run subplot docgen simple.subplot -o simple.pdf
-then file simple.pdf has changed from before
+and I run subplot docgen simple.subplot -o simple.html
+then file simple.html has changed from before
~~~
### Do typeset if output is older than markdown
@@ -1991,13 +1973,13 @@ given file simple.md
and file b.yaml
and file f.py
and an installed subplot
-when I run subplot docgen simple.subplot -o simple.pdf
-then file simple.pdf exists
-when I remember metadata for file simple.pdf
+when I run subplot docgen simple.subplot -o simple.html
+then file simple.html exists
+when I remember metadata for file simple.html
and I wait until 1 second has passed
and I touch file simple.md
-and I run subplot docgen simple.subplot -o simple.pdf
-then file simple.pdf has changed from before
+and I run subplot docgen simple.subplot -o simple.html
+then file simple.html has changed from before
~~~
### Do typeset if output is older than functions
@@ -2008,13 +1990,13 @@ given file simple.md
and file b.yaml
and file f.py
and an installed subplot
-when I run subplot docgen simple.subplot -o simple.pdf
-then file simple.pdf exists
-when I remember metadata for file simple.pdf
+when I run subplot docgen simple.subplot -o simple.html
+then file simple.html exists
+when I remember metadata for file simple.html
and I wait until 1 second has passed
and I touch file f.py
-and I run subplot docgen simple.subplot -o simple.pdf
-then file simple.pdf has changed from before
+and I run subplot docgen simple.subplot -o simple.html
+then file simple.html has changed from before
~~~
### Do typeset if output is older than bindings
@@ -2025,13 +2007,13 @@ given file simple.md
and file b.yaml
and file f.py
and an installed subplot
-when I run subplot docgen simple.subplot -o simple.pdf
-then file simple.pdf exists
-when I remember metadata for file simple.pdf
+when I run subplot docgen simple.subplot -o simple.html
+then file simple.html exists
+when I remember metadata for file simple.html
and I wait until 1 second has passed
and I touch file b.yaml
-and I run subplot docgen simple.subplot -o simple.pdf
-then file simple.pdf has changed from before
+and I run subplot docgen simple.subplot -o simple.html
+then file simple.html has changed from before
~~~
## Document structure
@@ -3188,7 +3170,7 @@ into SVGs such as this one.
~~~pikchr
arrow right 200% "Markdown" "Source"
box rad 10px "Subplot" "Document Generator" "(subplot docgen)" fit
-arrow right 200% "HTML+SVG/PDF" "Output"
+arrow right 200% "HTML+SVG" "Output"
arrow <-> down 70% from last box.s
box same "Pikchr" "Formatter" "(docs.rs/pikchr)" fit
~~~