1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
|
---
title: pandoc-filter-diagram
subtitle: Acceptance criteria
author: Lars Wirzenius
template: rust
bindings:
- lib/files.yaml
- lib/runcmd.yaml
- subplot/subplot.yaml
functions:
- subplot/subplot.rs
...
# Introduction
This document specifies the acceptance criteria for
`pandoc-filter-diagram`, and how they are verified. It's meant to be
processed with the [Subplot](https://subplot.liw.fi/) tool. The
`build.rs` script makes sure the verification scenarios defined here
are run when `cargo test` is run.
The code in `pandoc-filter-diagram` was originally part of Subplot. It
was extracted into its own crate for use in the [Sequoia][] sq user guide.
[Sequoia]: https://sequoia-pgp.org/
# Pikchr
[Pikchr]: https://pikchr.org/
[Pikchr] is a diagramming library which implements a Pic-like diagram language.
It allows the conversion of textual descriptions of arbitrarily complex diagrams
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 <-> down 70% from last box.s
box same "Pikchr" "Formatter" "(docs.rs/pikchr)" fit
~~~
This scenario checks that an image is generated and embedded into the HTML output,
and is not referenced as an external image.
~~~scenario
given an installed Rust program pandoc-filter-diagram
given file pikchr.md
when I run pandoc --filter pandoc-filter-diagram pikchr.md -o pikchr.html
then file pikchr.html matches regex /img src="data:image/svg\+xml;base64,/
~~~
~~~~~~~~{#pikchr.md .file .markdown .numberLines}
This is an example markdown file that embeds a simple Pikchr diagram.
~~~pikchr
arrow right 200% "Markdown" "Source"
box rad 10px "Markdown" "Formatter" "(docs.rs/markdown)" fit
arrow right 200% "HTML+SVG" "Output"
arrow <-> down 70% from last box.s
box same "Pikchr" "Formatter" "(docs.rs/pikchr)" fit
~~~
~~~~~~~~
# Graphviz Dot
[Graphviz]: http://www.graphviz.org/
Dot is a program from the [Graphviz][] suite to generate directed
graphs, such as this one.
~~~dot
digraph "example" {
thing -> other
}
~~~
The scenario checks that an image is generated and embedded into the
HTML output, not referenced as an external image.
~~~scenario
given an installed Rust program pandoc-filter-diagram
given file dot.md
when I run pandoc --filter pandoc-filter-diagram dot.md -o dot.html
then file dot.html matches regex /img src="data:image/svg\+xml;base64,/
~~~
~~~~~~~~{#dot.md .file .markdown .numberLines}
This is an example Markdown file, which embeds a graph using dot markup.
~~~dot
digraph "example" {
thing -> other
}
~~~
~~~~~~~~
# PlantUML
[PlantUML]: https://plantuml.com/
[PlantUML][] is a program to generate various kinds of UML diagrams
for describing software, such as this one:
~~~plantuml
@startuml
Alice -> Bob: Authentication Request
Bob --> Alice: Authentication Response
Alice -> Bob: Another authentication Request
Alice <-- Bob: Another authentication Response
@enduml
~~~
The scenario below checks that an image is generated and embedded into
the HTML output, not referenced as an external image.
~~~scenario
given an installed Rust program pandoc-filter-diagram
given file plantuml.md
when I run pandoc --filter subplot-filter plantuml.md -o plantuml.html
then file plantuml.html matches regex /img src="data:image/svg\+xml;base64,/
~~~
~~~~~~~~{#plantuml.md .file .markdown .numberLines}
This is an example Markdown file, which embeds a diagram using
PlantUML markup.
~~~plantuml
@startuml
Alice -> Bob: Authentication Request
Bob --> Alice: Authentication Response
Alice -> Bob: Another authentication Request
Alice <-- Bob: Another authentication Response
@enduml
~~~
~~~~~~~~
# Roadmap
[roadmap]: https://crates.io/crates/roadmap
The [roadmap][] Rust library supports visual roadmaps using a YAML
based markup language.
An example:
~~~roadmap
goal:
label: |
This is the end goal:
if we reach here, there
is nothing more to be
done in the project
depends:
- finished
- blocked
finished:
status: finished
label: |
This task is finished;
the arrow indicates what
follows this task (unless
it's blocked)
ready:
status: ready
label: |
This task is ready
to be done: it is not
blocked by anything
next:
status: next
label: |
This task is chosen
to be done next
blocked:
status: blocked
label: |
This task is blocked
and can't be done until
something happens
depends:
- ready
- next
~~~
This scenario checks that an image is generated and embedded into the
HTML output, not referenced as an external image.
~~~scenario
given an installed Rust program pandoc-filter-diagram
given file roadmap.md
when I run pandoc --filter pandoc-filter-diagram roadmap.md -o roadmap.html
then file roadmap.html matches regex /img src="data:image/svg\+xml;base64,/
~~~
~~~~~~~~{#roadmap.md .file .markdown .numberLines}
This is an example Markdown file, which embeds a roadmap.
~~~roadmap
goal:
label: |
This is the end goal:
if we reach here, there
is nothing more to be
done in the project
depends:
- finished
- blocked
finished:
status: finished
label: |
This task is finished;
the arrow indicates what
follows this task (unless
it's blocked)
ready:
status: ready
label: |
This task is ready
to be done: it is not
blocked by anything
next:
status: next
label: |
This task is chosen
to be done next
blocked:
status: blocked
label: |
This task is blocked
and can't be done until
something happens
depends:
- ready
- next
~~~
~~~~~~~~
|
