asciidoctor-diagram 2.2.11 → 2.2.12

Sign up to get free protection for your applications and to get access to all the features.
Files changed (99) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.adoc +7 -0
  3. data/lib/asciidoctor-diagram/plantuml/converter.rb +1 -0
  4. data/lib/asciidoctor-diagram/structurizr/renderers.rb +5 -0
  5. data/lib/asciidoctor-diagram/version.rb +1 -1
  6. metadata +3 -130
  7. data/Rakefile +0 -9
  8. data/docs/antora.yml +0 -5
  9. data/docs/modules/ROOT/images/a2s.svg +0 -44
  10. data/docs/modules/ROOT/images/actdiag.png +0 -0
  11. data/docs/modules/ROOT/images/asciidoctor-diagram-classes.png +0 -0
  12. data/docs/modules/ROOT/images/asciidoctor-diagram-process.png +0 -0
  13. data/docs/modules/ROOT/images/barcode.png +0 -0
  14. data/docs/modules/ROOT/images/barcode2.png +0 -0
  15. data/docs/modules/ROOT/images/blockdiag.png +0 -0
  16. data/docs/modules/ROOT/images/d2.png +0 -0
  17. data/docs/modules/ROOT/images/lilypond.png +0 -0
  18. data/docs/modules/ROOT/images/penrose.png +0 -0
  19. data/docs/modules/ROOT/nav.adoc +0 -41
  20. data/docs/modules/ROOT/pages/blocks.adoc +0 -140
  21. data/docs/modules/ROOT/pages/diagram_types/a2s.adoc +0 -47
  22. data/docs/modules/ROOT/pages/diagram_types/actdiag.adoc +0 -46
  23. data/docs/modules/ROOT/pages/diagram_types/barcode.adoc +0 -72
  24. data/docs/modules/ROOT/pages/diagram_types/blockdiag.adoc +0 -38
  25. data/docs/modules/ROOT/pages/diagram_types/bpmn.adoc +0 -21
  26. data/docs/modules/ROOT/pages/diagram_types/bytefield.adoc +0 -16
  27. data/docs/modules/ROOT/pages/diagram_types/d2.adoc +0 -43
  28. data/docs/modules/ROOT/pages/diagram_types/dbml.adoc +0 -16
  29. data/docs/modules/ROOT/pages/diagram_types/diagrams.adoc +0 -20
  30. data/docs/modules/ROOT/pages/diagram_types/ditaa.adoc +0 -31
  31. data/docs/modules/ROOT/pages/diagram_types/dpic.adoc +0 -16
  32. data/docs/modules/ROOT/pages/diagram_types/erd.adoc +0 -17
  33. data/docs/modules/ROOT/pages/diagram_types/gnuplot.adoc +0 -27
  34. data/docs/modules/ROOT/pages/diagram_types/graphviz.adoc +0 -21
  35. data/docs/modules/ROOT/pages/diagram_types/lilypond.adoc +0 -27
  36. data/docs/modules/ROOT/pages/diagram_types/meme.adoc +0 -34
  37. data/docs/modules/ROOT/pages/diagram_types/mermaid.adoc +0 -28
  38. data/docs/modules/ROOT/pages/diagram_types/msc.adoc +0 -23
  39. data/docs/modules/ROOT/pages/diagram_types/nomnoml.adoc +0 -16
  40. data/docs/modules/ROOT/pages/diagram_types/nwdiag.adoc +0 -22
  41. data/docs/modules/ROOT/pages/diagram_types/penrose.adoc +0 -50
  42. data/docs/modules/ROOT/pages/diagram_types/pikchr.adoc +0 -16
  43. data/docs/modules/ROOT/pages/diagram_types/plantuml.adoc +0 -24
  44. data/docs/modules/ROOT/pages/diagram_types/seqdiag.adoc +0 -18
  45. data/docs/modules/ROOT/pages/diagram_types/shaape.adoc +0 -18
  46. data/docs/modules/ROOT/pages/diagram_types/smcat.adoc +0 -18
  47. data/docs/modules/ROOT/pages/diagram_types/structurizr.adoc +0 -29
  48. data/docs/modules/ROOT/pages/diagram_types/svgbob.adoc +0 -21
  49. data/docs/modules/ROOT/pages/diagram_types/symbolator.adoc +0 -19
  50. data/docs/modules/ROOT/pages/diagram_types/syntrax.adoc +0 -28
  51. data/docs/modules/ROOT/pages/diagram_types/tikz.adoc +0 -21
  52. data/docs/modules/ROOT/pages/diagram_types/umlet.adoc +0 -19
  53. data/docs/modules/ROOT/pages/diagram_types/vega.adoc +0 -28
  54. data/docs/modules/ROOT/pages/diagram_types/wavedrom.adoc +0 -17
  55. data/docs/modules/ROOT/pages/enabling.adoc +0 -25
  56. data/docs/modules/ROOT/pages/generate.adoc +0 -15
  57. data/docs/modules/ROOT/pages/index.adoc +0 -12
  58. data/docs/modules/ROOT/pages/installation.adoc +0 -32
  59. data/docs/modules/ROOT/pages/output.adoc +0 -19
  60. data/docs/modules/ROOT/partials/shared-attrs.adoc +0 -12
  61. data/docs/modules/ROOT/partials/uris.adoc +0 -48
  62. data/examples/Gemfile +0 -3
  63. data/examples/README.adoc +0 -18
  64. data/examples/design.adoc +0 -78
  65. data/examples/features.adoc +0 -189
  66. data/spec/a2s_spec.rb +0 -33
  67. data/spec/barcode_spec.rb +0 -176
  68. data/spec/blockdiag_spec.rb +0 -20
  69. data/spec/bpmn_spec.rb +0 -60
  70. data/spec/bytefield_spec.rb +0 -96
  71. data/spec/d2_spec.rb +0 -87
  72. data/spec/dbml_spec.rb +0 -32
  73. data/spec/diagrams_spec.rb +0 -27
  74. data/spec/ditaa_spec.rb +0 -191
  75. data/spec/dpic_spec.rb +0 -23
  76. data/spec/erd_spec.rb +0 -96
  77. data/spec/gnuplot_spec.rb +0 -229
  78. data/spec/graphviz_py_spec.rb +0 -33
  79. data/spec/graphviz_spec.rb +0 -24
  80. data/spec/lilypond_spec.rb +0 -17
  81. data/spec/man.jpg +0 -0
  82. data/spec/meme_spec.rb +0 -67
  83. data/spec/mermaid_spec.rb +0 -161
  84. data/spec/msc_spec.rb +0 -37
  85. data/spec/nomnoml_spec.rb +0 -36
  86. data/spec/pikchr_spec.rb +0 -73
  87. data/spec/plantuml_spec.rb +0 -800
  88. data/spec/shaape_spec.rb +0 -20
  89. data/spec/shared_examples.rb +0 -766
  90. data/spec/smcat_spec.rb +0 -30
  91. data/spec/structurizr_spec.rb +0 -41
  92. data/spec/svgbob_spec.rb +0 -33
  93. data/spec/symbolator_spec.rb +0 -27
  94. data/spec/syntrax_spec.rb +0 -22
  95. data/spec/test_helper_methods.rb +0 -118
  96. data/spec/tikz_spec.rb +0 -181
  97. data/spec/umlet_spec.rb +0 -32
  98. data/spec/vega_spec.rb +0 -133
  99. data/spec/wavedrom_spec.rb +0 -21
@@ -1,38 +0,0 @@
1
- = BlockDiag
2
- include::partial$uris.adoc[]
3
-
4
- {uri-blockdiag}[BlockDiag] and its family generate diagram images from simple text files.
5
-
6
- == Example
7
-
8
- ----
9
- [blockdiag]
10
- ....
11
- blockdiag {
12
- A -> B -> C -> D;
13
- A -> E -> F -> G;
14
- }
15
- ....
16
- ----
17
-
18
- image::blockdiag.png[]
19
-
20
- == Installation
21
-
22
- - A Python runtime is required
23
- - Follow the http://blockdiag.com/en/blockdiag/introduction.html#setup[blockdiag installation instructions]
24
-
25
- == Supported Image Formats
26
-
27
- - PDF
28
- - PNG (default)
29
- - SVG
30
-
31
- == Attributes
32
-
33
- [cols=">,<,<",options="header"]
34
- |===
35
- |Name |Default value |Description
36
- |blockdiag |blockdiag |The path to the `blockdiag` executable
37
- |fontpath |unspecified |The path to the font that should be used by blockdiag
38
- |===
@@ -1,21 +0,0 @@
1
- = BPMN
2
- include::partial$uris.adoc[]
3
-
4
- Business Process Model and Notation (BPMN) is a graphical representation for specifying business processes in a business process model.
5
- This extension uses {uri-bpmn}[bpmn-js-cmd] to render diagrams
6
-
7
- == Supported Image Formats
8
-
9
- - PDF
10
- - PNG (default)
11
- - SVG
12
-
13
- == Attributes
14
-
15
- [cols=">,<,<",options="header"]
16
- |===
17
- |Name |Default value |Description
18
- |bpmn |bpmn |The path to the `bpmn` executable
19
- |height |786 |The target height of the diagram. Does not apply for output type `svg`.
20
- |width |1024 |The target width of the diagram. Does not apply for output type `svg`.
21
- |===
@@ -1,16 +0,0 @@
1
- = Bytefield-SVG
2
- include::partial$uris.adoc[]
3
-
4
- {uri-bytefield}[Bytefield-SVG] is a Node module for generating byte field diagrams like this one. Inspired by the LaTeX bytefield package.
5
-
6
- == Supported Image Formats
7
-
8
- - SVG
9
-
10
- == Attributes
11
-
12
- [cols=">,<,<",options="header"]
13
- |===
14
- |Name |Default value |Description
15
- |bytefield-svg|bytefield-svg |The path to the `bytefield-svg` executable
16
- |===
@@ -1,43 +0,0 @@
1
- = D2
2
- include::partial$uris.adoc[]
3
-
4
- {uri-D2}[D2] is a diagram scripting language that turns text to diagrams.
5
- It stands for Declarative Diagramming.
6
- Declarative, as in, you describe what you want diagrammed, it generates the image.
7
-
8
- == Example
9
-
10
- ----
11
- [d2]
12
- ....
13
- donut: {shape: circle}
14
- database.shape: cylinder
15
- you: {
16
- shape: person
17
- }
18
- ....
19
- ----
20
-
21
- image::d2.png[]
22
-
23
- == Supported Image Formats
24
-
25
- - PDF
26
- - PNG
27
- - SVG
28
-
29
- == Attributes
30
-
31
- [cols=">,<,<",options="header"]
32
- |===
33
- |Name |Default value |Description
34
- |d2 |d2 |The path to the `d2` executable
35
- |layout |dagre |Set the diagram layout engine
36
- |theme |0 |Set the diagram theme ID
37
- |pad |100 |Pixels padded around the rendered diagram
38
- |animate-interval| |If given, multiple boards are packaged as 1 SVG which transitions through each board at the interval (in milliseconds). Can only be used with SVG exports.
39
- |sketch |false |Renders the diagram to look like it was sketched by hand
40
- |font-regular |Source Sans Pro Regular |Path to .ttf file to use for the regular font
41
- |font-italic |Source Sans Pro Regular-Italic|Path to .ttf file to use for the italic font
42
- |font-bol |Source Sans Pro Bold |Path to .ttf file to use for the bold font
43
- |===
@@ -1,16 +0,0 @@
1
- = DBML
2
- include::partial$uris.adoc[]
3
-
4
- {uri-dbml}[dbml-renderer] renders https://dbml.dbdiagram.io/home/#intro[DBML] files to SVG images.
5
-
6
- == Supported Image Formats
7
-
8
- - SVG
9
-
10
- == Attributes
11
-
12
- [cols=">,<,<",options="header"]
13
- |===
14
- |Name |Default value |Description
15
- |dbml-renderer |dbml-renderer |The path to the `dbml-renderer` executable
16
- |===
@@ -1,20 +0,0 @@
1
- = Diagrams
2
- include::partial$uris.adoc[]
3
-
4
- {uri-diagrams}[Diagrams] lets you draw the cloud system architecture in Python code.
5
- It was born for prototyping a new system architecture without any design tools.
6
- You can also describe or visualize the existing system architecture as well.
7
-
8
- == Supported Image Formats
9
-
10
- - PDF
11
- - PNG (default)
12
- - SVG
13
-
14
- == Attributes
15
-
16
- [cols=">,<,<",options="header"]
17
- |===
18
- |Name |Default value |Description
19
- |diagrams-python|diagrams-python |The path to the `diagrams-python` executable
20
- |===
@@ -1,31 +0,0 @@
1
- = Ditaa
2
- include::partial$uris.adoc[]
3
-
4
- {uri-ditaa}[ditaa] is a small command-line utility written in Java, that can convert diagrams drawn using ascii art ('drawings' that contain characters that resemble lines like | / - ), into proper bitmap graphics.
5
-
6
- A https://github.com/pepijnve/ditaa[fork of the ditaa] project is bundled with the asciidoctor-diagram gem.
7
-
8
- == Supported Image Formats
9
-
10
- - PNG (default)
11
- - SVG
12
- - TXT
13
-
14
- == Attributes
15
-
16
- [cols=">,<,<",options="header"]
17
- |===
18
- |Name |Default value |Description
19
- |java |java |The path to the `java` executable
20
- |scale |1 |A scale factor that is applied to the image.
21
- |tabs |8 |An integer value that specifies the tab size as a number of spaces.
22
- |background |FFFFFF |The background colour of the image. The format should be a six-digit hexadecimal number (as in HTML, FF0000 for red). Pass an eight-digit hex to define transparency.
23
- |antialias |true |Enables or disables anti-aliasing.
24
- |separation |true |Prevents the separation of common edges of shapes.
25
- |round-corners|false |Causes all corners to be rendered as round corners.
26
- |shadows |true |Enables or disable drop shadows.
27
- |debug |false |Renders the debug grid over the resulting image.
28
- |fixed-slope |false |Makes sides of parallelograms and trapezoids fixed slope instead of fixed width.
29
- |transparent |false |Makes the background of the image transparent instead of using the background color.
30
- |bullet-characters|*o |The characters to recognize as bullets
31
- |===
@@ -1,16 +0,0 @@
1
- = Dpic
2
- include::partial$uris.adoc[]
3
-
4
- {uri-dpic}[dpic] is an implementation of the https://en.wikipedia.org/wiki/PIC_(markup_language)[pic] DSL.
5
-
6
- == Supported Image Formats
7
-
8
- - SVG
9
-
10
- == Attributes
11
-
12
- [cols=">,<,<",options="header"]
13
- |===
14
- |Name |Default value |Description
15
- |dpic |dpic |The path to the `dpic` executable
16
- |===
@@ -1,17 +0,0 @@
1
- = ERD
2
- include::partial$uris.adoc[]
3
-
4
- {uri-erd}[erd] is a utility takes a plain text description of entities, their attributes and the relationships between entities and produces a visual diagram modeling the description.
5
-
6
- == Supported Image Formats
7
-
8
- - PNG (default)
9
- - SVG
10
-
11
- == Attributes
12
-
13
- [cols=">,<,<",options="header"]
14
- |===
15
- |Name |Default value |Description
16
- |erd |erd |The path to the `erd` executable
17
- |===
@@ -1,27 +0,0 @@
1
- = Gnuplot
2
- include::partial$uris.adoc[]
3
-
4
- {uri-gnuplot}[Gnuplot] is a command-driven plotting program.
5
- It can be used interactively to plot functions and data points in both two- and three-dimensional plots in many different styles.
6
-
7
- == Supported Image Formats
8
-
9
- - GIF
10
- - PNG (default)
11
- - SVG
12
- - TXT
13
-
14
- == Attributes
15
-
16
- [cols=">,<,<",options="header"]
17
- |===
18
- |Name |Default value |Description
19
- |gnuplot |gnuplot |The path to the `gnuplot` binary
20
- |background |unspecified |Background color, e.g. `red`, `#FF0000`. Does not work with `txt`.
21
- |height |unspecified |The height of the plot. Must be specified together with `width`.
22
- |width |unspecified |The width of the plot. Must be specified together with `height`.
23
- |crop |unspecified |Trims blank space from the edges of the completed plot (true/false). Does not work with `svg`, `pdf`.
24
- |transparent |unspecified |Generate transparent background (true/false). Does not work with `svg`, `pdf`, `txt`.
25
- |font |unspecified |The font face with optional font size to use for the text, e.g. `font="Arial"`, `font="Arial,11"`. Does not work with `txt`.
26
- |fontscale |unspecified |Scales all label for given factor. Does not work with `txt`.
27
- |===
@@ -1,21 +0,0 @@
1
- = Graphviz
2
- include::partial$uris.adoc[]
3
-
4
- {uri-graphviz}[Graphviz] takes descriptions of graphs in a simple text language, and makes diagrams in useful formats, such as images and SVG for web pages; PDF or Postscript for inclusion in other documents; or display in an interactive graph browser.
5
- Graphviz has many useful features for concrete diagrams, such as options for colors, fonts, tabular node layouts, line styles, hyperlinks, and custom shapes.
6
-
7
- == Supported Image Formats
8
-
9
- - GIF
10
- - PNG (default)
11
- - SVG
12
-
13
- == Attributes
14
-
15
- [cols=">,<,<",options="header"]
16
- |===
17
- |Name |Default value |Description
18
- |dot |dot |The path to the `dot` executable
19
- |graphvizdot |dot |This attribute is an alias for the `dot` attribute
20
- |layout |unspecified |The graphviz layout engine to use (dot -K option).
21
- |===
@@ -1,27 +0,0 @@
1
- = LilyPond
2
- include::partial$uris.adoc[]
3
-
4
- {uri-lilypond}[LilyPond] is a music engraving program, devoted to producing the highest-quality sheet music possible. It brings the aesthetics of traditionally engraved music to computer printouts.
5
-
6
- ----
7
- [lilypond]
8
- ....
9
- \\relative c' { f d f a d f e d cis a cis e a g f e }
10
- ....
11
- ----
12
-
13
- image::lilypond.png[]
14
-
15
- == Supported Image Formats
16
-
17
- - PDF
18
- - PNG (default)
19
-
20
- == Attributes
21
-
22
- [cols=">,<,<",options="header"]
23
- |===
24
- |Name |Default value |Description
25
- |lilypond |lilypond |The path to the `lilypond` executable
26
- |resolution |unspecified |The DPI at which to render
27
- |===
@@ -1,34 +0,0 @@
1
- = Meme
2
- include::partial$uris.adoc[]
3
-
4
- The meme extension provides a basic '`Advice Animal`' style image generator.
5
- Its usage is easiest to explain with an example.
6
-
7
- ----
8
- meme::yunoguy.jpg[Doc writers,Y U NO // AsciiDoc]
9
- ----
10
-
11
- The target of the block macro tells the extension which image to use as background.
12
- The first two positional attributes are `top` and `bottom` and are used for the top and bottom label.
13
- Occurrences of `//` surrounded by whitespace are interpreted as line breaks.
14
-
15
- The meme extension requires https://imagemagick.org[ImageMagick].
16
-
17
- == Supported Image Formats
18
-
19
- - GIF
20
- - PNG (default)
21
-
22
- == Attributes
23
-
24
- [cols=">,<,<",options="header"]
25
- |===
26
- |Name |Default value |Description
27
- |convert |convert |The path to the ImageMagick `convert` executable
28
- |identify |identify |The path to the ImageMagick `identify` executable
29
- |fill-color |white |The fill color for the text.
30
- |stroke-color |black |The outline color for the text
31
- |stroke-width |2 |The width of the text outline.
32
- |font |Impact |The font face to use for the text.
33
- |options |unspecified |a comma separate list of flags that modify the image rendering. Currently only `noupcase` is supported which disable upper casing the labels.
34
- |===
@@ -1,28 +0,0 @@
1
- = Mermaid
2
- include::partial$uris.adoc[]
3
-
4
- {uri-mermaid}[Mermaid] is a JavaScript-based diagramming and charting tool that uses Markdown-inspired text definitions and a renderer to create and modify complex diagrams.
5
- The main purpose of Mermaid is to help documentation catch up with development.
6
-
7
- == Supported Image Formats
8
-
9
- - PDF
10
- - PNG
11
- - SVG
12
-
13
- == Attributes
14
-
15
- [cols=">,<,<",options="header"]
16
- |===
17
- |Name |Default value |Description
18
- |mmdc |mmdc |The path to the `mmdc` executable
19
- |background |FFFFFF |The background colour of the image. The format should be a six-digit hexadecimal number (as in HTML, FF0000 for red). Pass an eight-digit hex to define transparency.
20
- |css |unspecified |Path to a CSS file to pass to mermaid.
21
- |config |unspecified |Path to a JSON config file to pass to mermaid.
22
- |gantt-config |unspecified |Path to a gantt config file to pass to mermaid.
23
- |puppeteer-config|unspecified |Path to a puppeteer config file to pass to mermaid.
24
- |sequence-config |unspecified |Path to a sequence config file to pass to mermaid.
25
- |theme |unspecified |Theme of the chart, could be default, forest, dark or neutral.
26
- |width |unspecified |Width of the page.
27
- |height |unspecified |Height of the page.
28
- |===
@@ -1,23 +0,0 @@
1
- = MscGen
2
- include::partial$uris.adoc[]
3
-
4
- {uri-mscgen}[MscGen] is a small program that converts Message Sequence Chart descriptions to images.
5
- Message Sequence Charts (MSCs) are a way of representing entities and interactions over some time period and are often used in combination with SDL.
6
- MSCs are popular in Telecoms to specify how protocols operate although MSCs need not be complicated to create or use.
7
- Mscgen aims to provide a simple text language that is clear to create, edit and understand, which can also be transformed into common image formats for display or printing.
8
-
9
- This diagram type requires either {uri-mscgen}[Mscgen] or {uri-mscgen-js}[mscgen.js].
10
-
11
- == Supported Image Formats
12
-
13
- - PNG
14
- - SVG
15
-
16
- == Attributes
17
-
18
- [cols=">,<,<",options="header"]
19
- |===
20
- |Name |Default value |Description
21
- |mscgen |mscgen |The path to the `mscgen` executable
22
- |font |unspecified |The name of the font that should be used by mscgen
23
- |===
@@ -1,16 +0,0 @@
1
- = Nomnoml
2
- include::partial$uris.adoc[]
3
-
4
- {uri-nomnoml}[Nomnoml] is a tool for drawing UML diagrams based on a simple syntax.
5
-
6
- == Supported Image Formats
7
-
8
- - SVG
9
-
10
- == Attributes
11
-
12
- [cols=">,<,<",options="header"]
13
- |===
14
- |Name |Default value |Description
15
- |nomnoml |nomnoml |The path to the `nomnoml` binary
16
- |===
@@ -1,22 +0,0 @@
1
- = NwDiag / RackDiag / PacketDiag
2
- include::partial$uris.adoc[]
3
-
4
- {uri-nwdiag}[NwDiag] generates network-diagram images from .diag files (similar to graphviz’s DOT files).
5
-
6
- The `rackdiag` and `packetdiag` tools that are part of the `nwdiag` package are also supported.
7
-
8
- == Supported Image Formats
9
-
10
- - PDF
11
- - PNG (default)
12
- - SVG
13
-
14
- == Attributes
15
-
16
- [cols=">,<,<",options="header"]
17
- |===
18
- |Name |Default value |Description
19
- |nwdiag |nwdiag |The path to the `nwdiag` binary
20
- |packetdiag |packetdiag |The path to the `packetdiag` binary
21
- |rackdiag |rackdiag |The path to the `rackdiag` binary
22
- |===
@@ -1,50 +0,0 @@
1
- = Penrose
2
- include::partial$uris.adoc[]
3
-
4
- {uri-penrose}[Penrose] is a platform that enables people to create beautiful diagrams just by typing notation in plain text.
5
-
6
- Penrose diagrams consist of three parts:
7
-
8
- - .domain file that defines the language specific to the domain.
9
- - .substance file that creates substances of mathematical content.
10
- - .style file that specifies the style of the visual representation.
11
-
12
- The domain and style files are specified using attributes.
13
- The substance of the diagram is the block contents.
14
-
15
- ----
16
- [penrose, domain=sets.domain, style=sets.style]
17
- ....
18
- Set A, B, C, D, E, F, G
19
-
20
- IsSubset(B, A)
21
- IsSubset(C, A)
22
- IsSubset(D, B)
23
- IsSubset(E, B)
24
- IsSubset(F, C)
25
- IsSubset(G, C)
26
-
27
- Not(Intersecting(E, D))
28
- Not(Intersecting(F, G))
29
- Not(Intersecting(B, C))
30
-
31
- AutoLabel All
32
- ....
33
- ----
34
-
35
- image::penrose.png[]
36
-
37
- == Supported Image Formats
38
-
39
- - SVG (default)
40
-
41
- == Attributes
42
-
43
- [cols=">,<,<",options="header"]
44
- |===
45
- |Name |Default value |Description
46
- |roger |roger |The path to the `roger` executable
47
- |domain |unspecified |The domain file to use
48
- |style |unspecified |The style file to use
49
- |variation |unspecified |The diagram variation to render
50
- |===
@@ -1,16 +0,0 @@
1
- = Pikchr
2
- include::partial$uris.adoc[]
3
-
4
- {uri-pikchr}[Pikchr] (pronounced "picture") is a PIC-like markup language for diagrams in technical documentation.
5
-
6
- == Supported Image Formats
7
-
8
- - SVG
9
-
10
- == Attributes
11
-
12
- [cols=">,<,<",options="header"]
13
- |===
14
- |Name |Default value |Description
15
- |pikchr |pikchr |The path to the `pikchr` binary
16
- |===
@@ -1,24 +0,0 @@
1
- = PlantUML
2
- include::partial$uris.adoc[]
3
-
4
- {uri-plantuml}[PlantUML] is a syntax and tool to draw UML diagrams, using a simple and human readable text description.
5
- It is particularly well-suited for users who prefer a simple, text-based approach to creating diagrams, and who want a tool that can automatically handle the layout and appearance of their diagrams.
6
-
7
- == Supported Image Formats
8
-
9
- - PNG
10
- - SVG
11
- - TXT
12
-
13
- == Attributes
14
-
15
- [cols=">,<,<",options="header"]
16
- |===
17
- |Name |Default value |Description
18
- |java |java |The path to the `java` executable
19
- |config |unspecified |Path to a config file to pass to PlantUML.
20
- |theme |unspecified |PlantUML theme to use.
21
- |size-limit |4096 |The maximum dimensions (width and height) of generated diagrams.
22
- |includedir |unspecified |sets a common directory for puml includes (plantuml.include.path)
23
- |preprocess |true |Preprocess PlantUML code before rendering the diagram.
24
- |===
@@ -1,18 +0,0 @@
1
- = SeqDiag
2
- include::partial$uris.adoc[]
3
-
4
- {uri-seqdiag}[SeqDiag] seqdiag generates sequence-diagram images from .diag files (similar to graphviz’s DOT files).
5
-
6
- == Supported Image Formats
7
-
8
- - PDF
9
- - PNG (default)
10
- - SVG
11
-
12
- == Attributes
13
-
14
- [cols=">,<,<",options="header"]
15
- |===
16
- |Name |Default value |Description
17
- |seqdiag |seqdiag |The path to the `seqdiag` binary
18
- |===
@@ -1,18 +0,0 @@
1
- = Shaape
2
- include::partial$uris.adoc[]
3
-
4
- {uri-shaape}[Shaape] processes ascii drawings of diagrams and converts them to pixel or vector graphics.
5
- The word Shaape itself is a neologism from shape and ascii art.
6
-
7
- == Supported Image Formats
8
-
9
- - PNG
10
- - SVG
11
-
12
- == Attributes
13
-
14
- [cols=">,<,<",options="header"]
15
- |===
16
- |Name |Default value |Description
17
- |shaape |shaape |The path to the `shaape` binary
18
- |===
@@ -1,18 +0,0 @@
1
- = State Machine Cat
2
- include::partial$uris.adoc[]
3
-
4
- {uri-smcat}[State Machine Cat] is syntax and tool that converts plain text descriptions of state machines into state diagrams.
5
-
6
- == Supported Image Formats
7
-
8
- - SVG
9
-
10
- == State Machine Cat Attributes
11
-
12
- [cols=">,<,<",options="header"]
13
- |===
14
- |Name |Default value |Description
15
- |smcat |smcat |The path to the `smcat` binary
16
- |direction |unspecified |The direction of the state machine diagram. One of `top-down`, `bottom-top`, `left-right` or `right-left`.
17
- |engine |unspecified |The layout engine to use. One of `dot`, `circo`, `fdp`, `neato`, `osage`, or `twopi`
18
- |===
@@ -1,29 +0,0 @@
1
- = Structurizr
2
- include::partial$uris.adoc[]
3
-
4
- {uri-structurizr}[Structurizr] builds upon "diagrams as code", allowing you to create multiple software architecture diagrams from a single model.
5
- There are a number of tools for creating Structurizr compatible workspaces, with the Structurizr DSL being the recommended option for most teams.
6
-
7
- The Structurizr extension allows individual views from a Structurizr DSL workspace to be included in Asciidoc documents.
8
- This is the inverse use case of https://structurizr.com/help/documentation[Structurizr's documentation] support which lets you embed Asciidoc in the Structurizr DSL.
9
-
10
- This extension uses the https://structurizr.com/help/cli[Structurizr CLI] tool to convert Structurizr DSL files into the input for a renderer.
11
- The chosen renderer is then used to generate the final image.
12
-
13
- The installation location of Structurizr CLI needs to be passed to asciidoctor-diagram using the `DIAGRAM_STRUCTURIZRCLI_HOME`.
14
- When running Asciidoctor with JRuby or when using AsciidoctorJ the installation location can also be specified using the `diagram.structurizrcli.home` Java system property.
15
- In both cases it should be set to the absolute directory containing the extracted Structurizr CLI archive.
16
-
17
- == Supported Image Formats
18
-
19
- - PNG
20
- - SVG
21
-
22
- == Attributes
23
-
24
- [cols=">,<,<",options="header"]
25
- |===
26
- |Name |Default value |Description
27
- |renderer |plantuml-c4 |The rendering backend to use. One of `d2`, `graphviz`, `mermaid`, `plantuml`, or `plantuml-c4`
28
- |view |unspecified |The key of the view to render
29
- |===
@@ -1,21 +0,0 @@
1
- = SvgBob
2
- include::partial$uris.adoc[]
3
-
4
- {uri-svgbob}[SvgBob] can create a nice graphical representation of your text diagrams.
5
-
6
- == Supported Image Formats
7
-
8
- - SVG
9
- - TXT
10
-
11
- == Attributes
12
-
13
- [cols=">,<,<",options="header"]
14
- |===
15
- |Name |Default value |Description
16
- |svgbob |svgbob |The path to the `svgbob` executable
17
- |font-family |arial |text will be rendered with this font
18
- |font-size |14 |text will be rendered with this font size
19
- |scale |1 |scale the entire svg (dimensions, font size, stroke width) by this factor
20
- |stroke-width |2 |stroke width for all lines
21
- |===
@@ -1,19 +0,0 @@
1
- = Symbolator
2
- include::partial$uris.adoc[]
3
-
4
- {uri-symbolator}[Symbolator] is a component diagramming tool for VHDL and Verilog.
5
- It will parse HDL source files, extract components or modules and render them as an image.
6
-
7
- == Supported Image Formats
8
-
9
- - PDF
10
- - PNG
11
- - SVG
12
-
13
- == Attributes
14
-
15
- [cols=">,<,<",options="header"]
16
- |===
17
- |Name |Default value |Description
18
- |symbolator |symbolator |The path to the `symbolator` executable
19
- |===