asciidoctor-diagram 2.2.11 → 2.2.12.next1

data/docs/modules/ROOT/pages/diagram_types/blockdiag.adoc

@@ -1,38 +0,0 @@
-= BlockDiag
-include::partial$uris.adoc[]
-
-{uri-blockdiag}[BlockDiag] and its family generate diagram images from simple text files.
-
-== Example
-
-----
-[blockdiag]
-....
-blockdiag {
-   A -> B -> C -> D;
-   A -> E -> F -> G;
-}
-....
-----
-
-image::blockdiag.png[]
-
-== Installation
-
-- A Python runtime is required
-- Follow the http://blockdiag.com/en/blockdiag/introduction.html#setup[blockdiag installation instructions]
-
-== Supported Image Formats
-
-- PDF
-- PNG (default)
-- SVG
-
-== Attributes
-
-[cols=">,<,<",options="header"]
-|===
-|Name         |Default value   |Description
-|blockdiag    |blockdiag       |The path to the `blockdiag` executable
-|fontpath     |unspecified     |The path to the font that should be used by blockdiag
-|===

data/docs/modules/ROOT/pages/diagram_types/bpmn.adoc

@@ -1,21 +0,0 @@
-= BPMN
-include::partial$uris.adoc[]
-
-Business Process Model and Notation (BPMN) is a graphical representation for specifying business processes in a business process model.
-This extension uses {uri-bpmn}[bpmn-js-cmd] to render diagrams
-
-== Supported Image Formats
-
-- PDF
-- PNG (default)
-- SVG
-
-== Attributes
-
-[cols=">,<,<",options="header"]
-|===
-|Name         |Default value   |Description
-|bpmn         |bpmn            |The path to the `bpmn` executable
-|height       |786             |The target height of the diagram. Does not apply for output type `svg`.
-|width        |1024            |The target width of the diagram. Does not apply for output type `svg`.
-|===

data/docs/modules/ROOT/pages/diagram_types/bytefield.adoc

@@ -1,16 +0,0 @@
-= Bytefield-SVG
-include::partial$uris.adoc[]
-
-{uri-bytefield}[Bytefield-SVG] is a Node module for generating byte field diagrams like this one. Inspired by the LaTeX bytefield package.
-
-== Supported Image Formats
-
-- SVG
-
-== Attributes
-
-[cols=">,<,<",options="header"]
-|===
-|Name         |Default value   |Description
-|bytefield-svg|bytefield-svg   |The path to the `bytefield-svg` executable
-|===

data/docs/modules/ROOT/pages/diagram_types/d2.adoc

@@ -1,43 +0,0 @@
-= D2
-include::partial$uris.adoc[]
-
-{uri-D2}[D2] is a diagram scripting language that turns text to diagrams.
-It stands for Declarative Diagramming.
-Declarative, as in, you describe what you want diagrammed, it generates the image.
-
-== Example
-
-----
-[d2]
-....
-donut: {shape: circle}
-database.shape: cylinder
-you: {
-  shape: person
-}
-....
-----
-
-image::d2.png[]
-
-== Supported Image Formats
-
-- PDF
-- PNG
-- SVG
-
-== Attributes
-
-[cols=">,<,<",options="header"]
-|===
-|Name            |Default value                 |Description
-|d2              |d2                            |The path to the `d2` executable
-|layout          |dagre                         |Set the diagram layout engine
-|theme           |0                             |Set the diagram theme ID
-|pad             |100                           |Pixels padded around the rendered diagram
-|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.
-|sketch          |false                         |Renders the diagram to look like it was sketched by hand
-|font-regular    |Source Sans Pro Regular       |Path to .ttf file to use for the regular font
-|font-italic     |Source Sans Pro Regular-Italic|Path to .ttf file to use for the italic font
-|font-bol        |Source Sans Pro Bold          |Path to .ttf file to use for the bold font
-|===

data/docs/modules/ROOT/pages/diagram_types/dbml.adoc

@@ -1,16 +0,0 @@
-= DBML
-include::partial$uris.adoc[]
-
-{uri-dbml}[dbml-renderer] renders https://dbml.dbdiagram.io/home/#intro[DBML] files to SVG images.
-
-== Supported Image Formats
-
-- SVG
-
-== Attributes
-
-[cols=">,<,<",options="header"]
-|===
-|Name            |Default value                 |Description
-|dbml-renderer   |dbml-renderer                 |The path to the `dbml-renderer` executable
-|===

data/docs/modules/ROOT/pages/diagram_types/diagrams.adoc

@@ -1,20 +0,0 @@
-= Diagrams
-include::partial$uris.adoc[]
-
-{uri-diagrams}[Diagrams] lets you draw the cloud system architecture in Python code.
-It was born for prototyping a new system architecture without any design tools.
-You can also describe or visualize the existing system architecture as well.
-
-== Supported Image Formats
-
-- PDF
-- PNG (default)
-- SVG
-
-== Attributes
-
-[cols=">,<,<",options="header"]
-|===
-|Name           |Default value   |Description
-|diagrams-python|diagrams-python |The path to the `diagrams-python` executable
-|===

data/docs/modules/ROOT/pages/diagram_types/ditaa.adoc

@@ -1,31 +0,0 @@
-= Ditaa
-include::partial$uris.adoc[]
-
-{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.
-
-A https://github.com/pepijnve/ditaa[fork of the ditaa] project is bundled with the asciidoctor-diagram gem.
-
-== Supported Image Formats
-
-- PNG (default)
-- SVG
-- TXT
-
-== Attributes
-
-[cols=">,<,<",options="header"]
-|===
-|Name         |Default value   |Description
-|java         |java            |The path to the `java` executable
-|scale        |1               |A scale factor that is applied to the image.
-|tabs         |8               |An integer value that specifies the tab size as a number of spaces.
-|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.
-|antialias    |true            |Enables or disables anti-aliasing.
-|separation   |true            |Prevents the separation of common edges of shapes.
-|round-corners|false           |Causes all corners to be rendered as round corners.
-|shadows      |true            |Enables or disable drop shadows.
-|debug        |false           |Renders the debug grid over the resulting image.
-|fixed-slope  |false           |Makes sides of parallelograms and trapezoids fixed slope instead of fixed width.
-|transparent  |false           |Makes the background of the image transparent instead of using the background color.
-|bullet-characters|*o          |The characters to recognize as bullets
-|===

data/docs/modules/ROOT/pages/diagram_types/dpic.adoc

@@ -1,16 +0,0 @@
-= Dpic
-include::partial$uris.adoc[]
-
-{uri-dpic}[dpic] is an implementation of the https://en.wikipedia.org/wiki/PIC_(markup_language)[pic] DSL.
-
-== Supported Image Formats
-
-- SVG
-
-== Attributes
-
-[cols=">,<,<",options="header"]
-|===
-|Name           |Default value   |Description
-|dpic           |dpic            |The path to the `dpic` executable
-|===

data/docs/modules/ROOT/pages/diagram_types/erd.adoc

@@ -1,17 +0,0 @@
-= ERD
-include::partial$uris.adoc[]
-
-{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.
-
-== Supported Image Formats
-
-- PNG (default)
-- SVG
-
-== Attributes
-
-[cols=">,<,<",options="header"]
-|===
-|Name           |Default value   |Description
-|erd           |erd            |The path to the `erd` executable
-|===

data/docs/modules/ROOT/pages/diagram_types/gnuplot.adoc

@@ -1,27 +0,0 @@
-= Gnuplot
-include::partial$uris.adoc[]
-
-{uri-gnuplot}[Gnuplot] is a command-driven plotting program.
-It can be used interactively to plot functions and data points in both two- and three-dimensional plots in many different styles.
-
-== Supported Image Formats
-
-- GIF
-- PNG (default)
-- SVG
-- TXT
-
-== Attributes
-
-[cols=">,<,<",options="header"]
-|===
-|Name         |Default value   |Description
-|gnuplot      |gnuplot         |The path to the `gnuplot` binary
-|background   |unspecified     |Background color, e.g. `red`, `#FF0000`. Does not work with `txt`.
-|height       |unspecified     |The height of the plot. Must be specified together with `width`.
-|width        |unspecified     |The width of the plot. Must be specified together with `height`.
-|crop         |unspecified     |Trims blank space from the edges of the completed plot (true/false). Does not work with `svg`, `pdf`.
-|transparent  |unspecified     |Generate transparent background (true/false). Does not work with `svg`, `pdf`, `txt`.
-|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`.
-|fontscale    |unspecified     |Scales all label for given factor. Does not work with `txt`.
-|===

data/docs/modules/ROOT/pages/diagram_types/graphviz.adoc

@@ -1,21 +0,0 @@
-= Graphviz
-include::partial$uris.adoc[]
-
-{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.
-Graphviz has many useful features for concrete diagrams, such as options for colors, fonts, tabular node layouts, line styles, hyperlinks, and custom shapes.
-
-== Supported Image Formats
-
-- GIF
-- PNG (default)
-- SVG
-
-== Attributes
-
-[cols=">,<,<",options="header"]
-|===
-|Name         |Default value   |Description
-|dot          |dot             |The path to the `dot` executable
-|graphvizdot  |dot             |This attribute is an alias for the `dot` attribute
-|layout       |unspecified     |The graphviz layout engine to use (dot -K option).
-|===

data/docs/modules/ROOT/pages/diagram_types/lilypond.adoc

@@ -1,27 +0,0 @@
-= LilyPond
-include::partial$uris.adoc[]
-
-{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.
-
-----
-[lilypond]
-....
-\\relative c' { f d f a d f e d cis a cis e a g f e }
-....
-----
-
-image::lilypond.png[]
-
-== Supported Image Formats
-
-- PDF
-- PNG (default)
-
-== Attributes
-
-[cols=">,<,<",options="header"]
-|===
-|Name         |Default value   |Description
-|lilypond     |lilypond        |The path to the `lilypond` executable
-|resolution   |unspecified     |The DPI at which to render
-|===

data/docs/modules/ROOT/pages/diagram_types/meme.adoc

@@ -1,34 +0,0 @@
-= Meme
-include::partial$uris.adoc[]
-
-The meme extension provides a basic '`Advice Animal`' style image generator.
-Its usage is easiest to explain with an example.
-
-----
-meme::yunoguy.jpg[Doc writers,Y U NO // AsciiDoc]
-----
-
-The target of the block macro tells the extension which image to use as background.
-The first two positional attributes are `top` and `bottom` and are used for the top and bottom label.
-Occurrences of `//` surrounded by whitespace are interpreted as line breaks.
-
-The meme extension requires https://imagemagick.org[ImageMagick].
-
-== Supported Image Formats
-
-- GIF
-- PNG (default)
-
-== Attributes
-
-[cols=">,<,<",options="header"]
-|===
-|Name          |Default value |Description
-|convert       |convert       |The path to the ImageMagick `convert` executable
-|identify      |identify       |The path to the ImageMagick `identify` executable
-|fill-color    |white         |The fill color for the text.
-|stroke-color  |black         |The outline color for the text
-|stroke-width  |2             |The width of the text outline.
-|font          |Impact        |The font face to use for the text.
-|options       |unspecified   |a comma separate list of flags that modify the image rendering. Currently only `noupcase` is supported which disable upper casing the labels.
-|===

data/docs/modules/ROOT/pages/diagram_types/mermaid.adoc

@@ -1,28 +0,0 @@
-= Mermaid
-include::partial$uris.adoc[]
-
-{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.
-The main purpose of Mermaid is to help documentation catch up with development.
-
-== Supported Image Formats
-
-- PDF
-- PNG
-- SVG
-
-== Attributes
-
-[cols=">,<,<",options="header"]
-|===
-|Name            |Default value   |Description
-|mmdc            |mmdc            |The path to the `mmdc` executable
-|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.
-|css             |unspecified     |Path to a CSS file to pass to mermaid.
-|config          |unspecified     |Path to a JSON config file to pass to mermaid.
-|gantt-config    |unspecified     |Path to a gantt config file to pass to mermaid.
-|puppeteer-config|unspecified     |Path to a puppeteer config file to pass to mermaid.
-|sequence-config |unspecified     |Path to a sequence config file to pass to mermaid.
-|theme           |unspecified     |Theme of the chart, could be default, forest, dark or neutral.
-|width           |unspecified     |Width of the page.
-|height          |unspecified     |Height of the page.
-|===

data/docs/modules/ROOT/pages/diagram_types/msc.adoc

@@ -1,23 +0,0 @@
-= MscGen
-include::partial$uris.adoc[]
-
-{uri-mscgen}[MscGen] is a small program that converts Message Sequence Chart descriptions to images.
-Message Sequence Charts (MSCs) are a way of representing entities and interactions over some time period and are often used in combination with SDL.
-MSCs are popular in Telecoms to specify how protocols operate although MSCs need not be complicated to create or use.
-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.
-
-This diagram type requires either {uri-mscgen}[Mscgen] or {uri-mscgen-js}[mscgen.js].
-
-== Supported Image Formats
-
-- PNG
-- SVG
-
-== Attributes
-
-[cols=">,<,<",options="header"]
-|===
-|Name         |Default value   |Description
-|mscgen       |mscgen          |The path to the `mscgen` executable
-|font         |unspecified     |The name of the font that should be used by mscgen
-|===

data/docs/modules/ROOT/pages/diagram_types/nomnoml.adoc

@@ -1,16 +0,0 @@
-= Nomnoml
-include::partial$uris.adoc[]
-
-{uri-nomnoml}[Nomnoml] is a tool for drawing UML diagrams based on a simple syntax.
-
-== Supported Image Formats
-
-- SVG
-
-== Attributes
-
-[cols=">,<,<",options="header"]
-|===
-|Name         |Default value   |Description
-|nomnoml      |nomnoml         |The path to the `nomnoml` binary
-|===

data/docs/modules/ROOT/pages/diagram_types/nwdiag.adoc

@@ -1,22 +0,0 @@
-= NwDiag / RackDiag / PacketDiag
-include::partial$uris.adoc[]
-
-{uri-nwdiag}[NwDiag] generates network-diagram images from .diag files (similar to graphviz’s DOT files).
-
-The `rackdiag` and `packetdiag` tools that are part of the `nwdiag` package are also supported.
-
-== Supported Image Formats
-
-- PDF
-- PNG (default)
-- SVG
-
-== Attributes
-
-[cols=">,<,<",options="header"]
-|===
-|Name         |Default value   |Description
-|nwdiag       |nwdiag          |The path to the `nwdiag` binary
-|packetdiag   |packetdiag      |The path to the `packetdiag` binary
-|rackdiag     |rackdiag        |The path to the `rackdiag` binary
-|===

data/docs/modules/ROOT/pages/diagram_types/penrose.adoc

@@ -1,50 +0,0 @@
-= Penrose
-include::partial$uris.adoc[]
-
-{uri-penrose}[Penrose] is a platform that enables people to create beautiful diagrams just by typing notation in plain text.
-
-Penrose diagrams consist of three parts:
-
-- .domain file that defines the language specific to the domain.
-- .substance file that creates substances of mathematical content.
-- .style file that specifies the style of the visual representation.
-
-The domain and style files are specified using attributes.
-The substance of the diagram is the block contents.
-
-----
-[penrose, domain=sets.domain, style=sets.style]
-....
-Set A, B, C, D, E, F, G
-
-IsSubset(B, A)
-IsSubset(C, A)
-IsSubset(D, B)
-IsSubset(E, B)
-IsSubset(F, C)
-IsSubset(G, C)
-
-Not(Intersecting(E, D))
-Not(Intersecting(F, G))
-Not(Intersecting(B, C))
-
-AutoLabel All
-....
-----
-
-image::penrose.png[]
-
-== Supported Image Formats
-
-- SVG (default)
-
-== Attributes
-
-[cols=">,<,<",options="header"]
-|===
-|Name         |Default value   |Description
-|roger        |roger           |The path to the `roger` executable
-|domain       |unspecified     |The domain file to use
-|style        |unspecified     |The style file to use
-|variation    |unspecified     |The diagram variation to render
-|===

data/docs/modules/ROOT/pages/diagram_types/pikchr.adoc

@@ -1,16 +0,0 @@
-= Pikchr
-include::partial$uris.adoc[]
-
-{uri-pikchr}[Pikchr] (pronounced "picture") is a PIC-like markup language for diagrams in technical documentation.
-
-== Supported Image Formats
-
-- SVG
-
-== Attributes
-
-[cols=">,<,<",options="header"]
-|===
-|Name         |Default value   |Description
-|pikchr       |pikchr          |The path to the `pikchr` binary
-|===

data/docs/modules/ROOT/pages/diagram_types/plantuml.adoc

@@ -1,24 +0,0 @@
-= PlantUML
-include::partial$uris.adoc[]
-
-{uri-plantuml}[PlantUML] is a syntax and tool to draw UML diagrams, using a simple and human readable text description.
-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.
-
-== Supported Image Formats
-
-- PNG
-- SVG
-- TXT
-
-== Attributes
-
-[cols=">,<,<",options="header"]
-|===
-|Name            |Default value   |Description
-|java            |java            |The path to the `java` executable
-|config          |unspecified     |Path to a config file to pass to PlantUML.
-|theme           |unspecified     |PlantUML theme to use.
-|size-limit      |4096            |The maximum dimensions (width and height) of generated diagrams.
-|includedir      |unspecified     |sets a common directory for puml includes (plantuml.include.path)
-|preprocess      |true            |Preprocess PlantUML code before rendering the diagram.
-|===

data/docs/modules/ROOT/pages/diagram_types/seqdiag.adoc

@@ -1,18 +0,0 @@
-= SeqDiag
-include::partial$uris.adoc[]
-
-{uri-seqdiag}[SeqDiag] seqdiag generates sequence-diagram images from .diag files (similar to graphviz’s DOT files).
-
-== Supported Image Formats
-
-- PDF
-- PNG (default)
-- SVG
-
-== Attributes
-
-[cols=">,<,<",options="header"]
-|===
-|Name         |Default value   |Description
-|seqdiag      |seqdiag         |The path to the `seqdiag` binary
-|===

data/docs/modules/ROOT/pages/diagram_types/shaape.adoc

@@ -1,18 +0,0 @@
-= Shaape
-include::partial$uris.adoc[]
-
-{uri-shaape}[Shaape] processes ascii drawings of diagrams and converts them to pixel or vector graphics.
-The word Shaape itself is a neologism from shape and ascii art.
-
-== Supported Image Formats
-
-- PNG
-- SVG
-
-== Attributes
-
-[cols=">,<,<",options="header"]
-|===
-|Name         |Default value   |Description
-|shaape       |shaape          |The path to the `shaape` binary
-|===

data/docs/modules/ROOT/pages/diagram_types/smcat.adoc

@@ -1,18 +0,0 @@
-= State Machine Cat
-include::partial$uris.adoc[]
-
-{uri-smcat}[State Machine Cat] is syntax and tool that converts plain text descriptions of state machines into state diagrams.
-
-== Supported Image Formats
-
-- SVG
-
-== State Machine Cat Attributes
-
-[cols=">,<,<",options="header"]
-|===
-|Name          |Default value   |Description
-|smcat         |smcat           |The path to the `smcat` binary
-|direction     |unspecified     |The direction of the state machine diagram. One of `top-down`, `bottom-top`, `left-right` or `right-left`.
-|engine        |unspecified     |The layout engine to use. One of `dot`, `circo`, `fdp`, `neato`, `osage`, or `twopi`
-|===

data/docs/modules/ROOT/pages/diagram_types/structurizr.adoc

@@ -1,29 +0,0 @@
-= Structurizr
-include::partial$uris.adoc[]
-
-{uri-structurizr}[Structurizr] builds upon "diagrams as code", allowing you to create multiple software architecture diagrams from a single model.
-There are a number of tools for creating Structurizr compatible workspaces, with the Structurizr DSL being the recommended option for most teams.
-
-The Structurizr extension allows individual views from a Structurizr DSL workspace to be included in Asciidoc documents.
-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.
-
-This extension uses the https://structurizr.com/help/cli[Structurizr CLI] tool to convert Structurizr DSL files into the input for a renderer.
-The chosen renderer is then used to generate the final image.
-
-The installation location of Structurizr CLI needs to be passed to asciidoctor-diagram using the `DIAGRAM_STRUCTURIZRCLI_HOME`.
-When running Asciidoctor with JRuby or when using AsciidoctorJ the installation location can also be specified using the `diagram.structurizrcli.home` Java system property.
-In both cases it should be set to the absolute directory containing the extracted Structurizr CLI archive.
-
-== Supported Image Formats
-
-- PNG
-- SVG
-
-== Attributes
-
-[cols=">,<,<",options="header"]
-|===
-|Name          |Default value   |Description
-|renderer      |plantuml-c4     |The rendering backend to use. One of `d2`, `graphviz`, `mermaid`, `plantuml`, or `plantuml-c4`
-|view          |unspecified     |The key of the view to render
-|===

data/docs/modules/ROOT/pages/diagram_types/svgbob.adoc

@@ -1,21 +0,0 @@
-= SvgBob
-include::partial$uris.adoc[]
-
-{uri-svgbob}[SvgBob] can create a nice graphical representation of your text diagrams.
-
-== Supported Image Formats
-
-- SVG
-- TXT
-
-== Attributes
-
-[cols=">,<,<",options="header"]
-|===
-|Name          |Default value   |Description
-|svgbob        |svgbob          |The path to the `svgbob` executable
-|font-family   |arial           |text will be rendered with this font
-|font-size     |14              |text will be rendered with this font size
-|scale         |1               |scale the entire svg (dimensions, font size, stroke width) by this factor
-|stroke-width  |2               |stroke width for all lines
-|===

data/docs/modules/ROOT/pages/diagram_types/symbolator.adoc

@@ -1,19 +0,0 @@
-= Symbolator
-include::partial$uris.adoc[]
-
-{uri-symbolator}[Symbolator] is a component diagramming tool for VHDL and Verilog.
-It will parse HDL source files, extract components or modules and render them as an image.
-
-== Supported Image Formats
-
-- PDF
-- PNG
-- SVG
-
-== Attributes
-
-[cols=">,<,<",options="header"]
-|===
-|Name          |Default value   |Description
-|symbolator    |symbolator      |The path to the `symbolator` executable
-|===