asciidoctor-diagram 2.2.8 → 2.2.10

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

@@ -0,0 +1,17 @@
+= 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

@@ -0,0 +1,27 @@
+= 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

@@ -0,0 +1,21 @@
+= 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

@@ -0,0 +1,27 @@
+= 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

@@ -0,0 +1,34 @@
+= 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

@@ -0,0 +1,28 @@
+= 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

@@ -0,0 +1,23 @@
+= 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

@@ -0,0 +1,16 @@
+= 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

@@ -0,0 +1,22 @@
+= 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

@@ -0,0 +1,50 @@
+= 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

@@ -0,0 +1,16 @@
+= 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

@@ -0,0 +1,24 @@
+= 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

@@ -0,0 +1,18 @@
+= 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

@@ -0,0 +1,18 @@
+= 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

@@ -0,0 +1,18 @@
+= 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

@@ -0,0 +1,29 @@
+= 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

@@ -0,0 +1,21 @@
+= 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

@@ -0,0 +1,19 @@
+= 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
+|===

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

@@ -0,0 +1,28 @@
+= Syntrax / JSyntrax
+include::partial$uris.adoc[]
+
+{uri-syntrax}[Syntrax] is a railroad diagram generator.
+It creates a visual illustration of the grammar used for programming languages.
+A specification file describes the syntax as a hierarchy of basic elements.
+This is processed into an image representing the same syntax with interconnected nodes.
+
+{uri-jsyntrax}[JSyntrax] is a reimplementation of Syntrax in Java in order to simplify installation, get rid of required libraries and make it easily portable to any operating system.
+
+== Supported Image Formats
+
+- PDF
+- PNG
+- SVG
+
+== Attributes
+
+[cols=">,<,<",options="header"]
+|===
+|Name          |Default value   |Description
+|syntrax       |syntrax         |The path to the `syntrax` executable. This attribute is used for the {uri-syntrax}[Syntrax] implementation.
+|java          |java            |The path to the `java` executable. This attribute is used for the {uri-jsyntrax}[JSyntrax] implementation. The `DIAGRAM_JSYNTRAX_HOME` environment variable should then also be defined and point to the JSyntrax installation directory. The installation directory can also be specified using the `diagram.jsyntrax.home` Java system property.
+|heading       |unspecified     |Diagram title
+|scale         |1               |A scale factor that is applied to the image.
+|style-file    |unspecified     |Path to a style config file to pass to Syntrax.
+|transparent   |false           |Makes the background of the image transparent instead of opaque white.
+|===

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

@@ -0,0 +1,21 @@
+= TikZ
+include::partial$uris.adoc[]
+
+{uri-tikz}[TikZ] is a graphics drawing environment for TeX.
+
+TikZ requires a TeX distribution that supports the {uri-tikz}[TikZ] package.
+
+== Supported Image Formats
+
+- PDF
+- SVG
+
+== Attributes
+
+[cols=">,<,<",options="header"]
+|===
+|Name          |Default value   |Description
+|pdflatex      |pdflatex        |The path to the `pdflatex` executable
+|pdf2svg       |pdf2svg         |The path to the `pdf2svg` executable
+|preamble      |unspecified     |Code definitions to pass to TikZ.
+|===

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

@@ -0,0 +1,19 @@
+= UMLet
+include::partial$uris.adoc[]
+
+{uri-umlet}[UMLet] is a free, open-source UML tool with a simple user interface: draw UML diagrams fast, create sequence and activity diagrams from plain text, share via exports to eps, pdf, jpg, svg, and clipboard, and develop new, custom UML elements.
+
+== Supported Image Formats
+
+- GIF
+- PDF
+- PNG
+- SVG
+
+== Attributes
+
+[cols=">,<,<",options="header"]
+|===
+|Name          |Default value   |Description
+|umlet         |umlet           |The path to the `umlet` executable
+|===

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

@@ -0,0 +1,28 @@
+= Vega / Vega-Lite
+include::partial$uris.adoc[]
+
+{uri-vega}[Vega] and {uri-vegalite}[Vega-Lite] are declarative language for creating, saving, and sharing interactive visualization designs.
+
+Vega provides basic building blocks for a wide variety of visualization designs: data loading and transformation, scales, map projections, axes, legends, and graphical marks such as rectangles, lines, plotting symbols, etc.
+
+Vega-Lite provides a more concise and convenient form to author common visualizations. As Vega-Lite can compile its specifications to Vega specifications, users may use Vega-Lite as the primary visualization tool and, if needed, transition to use the lower-level Vega for advanced use cases.
+
+== Supported Image Formats
+
+- PNG
+- SVG
+
+== Attributes
+
+|vega         |{uri-vega}[vg2png] and/or {uri-vega}[vg2png]                          |`vg2png` and `vg2svg`
+|vegalite     |{uri-vegalite}[vl2vg] and {uri-vega}[vg2png] and/or {uri-vega}[vg2svg]|`vl2vg`, `vg2png` and `vg2svg`
+
+[cols=">,<,<",options="header"]
+|===
+|Name          |Default value   |Description
+|vg2png        |vg2png          |The path to the `vg2png` executable. This attribute is used for PNG output.
+|vg2svg        |vg2svg          |The path to the `vg2svg` executable This attribute is used for SVG output.
+|vl2vg         |vl2vg           |The path to the `vl2vg` executable. This attribute is used for Vega-Lite diagrams.
+|===
+
+None

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

@@ -0,0 +1,17 @@
+= WaveDrom
+include::partial$uris.adoc[]
+
+{uri-wavedrom}[WaveDrom] draws your Timing Diagram or Waveform from simple textual description.
+
+== Supported Image Formats
+
+- PNG
+- SVG
+
+== Attributes
+
+[cols=">,<,<",options="header"]
+|===
+|Name          |Default value   |Description
+|wavedrom      |wavedrom        |The path to the `wavedrom` executable
+|===

data/docs/modules/ROOT/pages/enabling.adoc

@@ -0,0 +1,25 @@
+= Enabling Extensions
+
+In your program, you can either load and register the entire set of diagram extensions
+
+[source,ruby]
+----
+require 'asciidoctor-diagram'
+----
+
+or load and register each extension individually.
+
+[source,ruby]
+----
+require 'asciidoctor-diagram/<extension_name>'
+----
+
+`<extension_name>` can be one of `a2s`, `blockdiag`, `bytefield`, `diagrams`, `ditaa`, `dpic`, `erd`, `gnuplot`, `graphviz`, `meme`, `mermaid`, `msc`, `pikchr`, `plantuml`, `shaape`, `smcat`, `svgbob`, `syntrax`, `umlet`, `vega` or `wavedrom`.
+
+Requiring one or more of these files will automatically register the extensions for all processed documents.
+
+If you need more fine-grained control over when the extensions are enabled, `asciidoctor-diagram/<extension_name>/extension` can be used instead.
+This loads the extensions but does not register it in the Asciidoctor extension registry.
+You can then manually register the extensions at the appropriate times using the `Asciidoctor::Extensions` API.
+
+This document explains the various features of asciidoctor-diagram blocks using ditaa diagrams as an example.

data/docs/modules/ROOT/{partials → pages}/generate.adoc

@@ -1,4 +1,4 @@
-== Generating a Diagram from a Terminal
+= Rendering Diagrams
 
 You can load Asciidoctor diagram in a terminal using the `-r` flag.
 

data/docs/modules/ROOT/pages/index.adoc

@@ -1,21 +1,12 @@
-= Asciidoctor Diagram
+= Overview
 Pepijn Van_Eeckhoudt <https://github.com/pepijnve[@pepijnve]>; Sarah White <https://github.com/graphitefriction[@graphitefriction]>
 :description: README for the Asciidoctor Diagram extension for Asciidoctor.
 include::partial$uris.adoc[]
 
-Asciidoctor Diagram is a set of Asciidoctor extensions that enable you to add diagrams, which you describe using plain text, to your AsciiDoc document.
+Asciidoctor Diagram is a set of Asciidoctor extensions that enable rendering of plain text diagrams that are embedded in your AsciiDoc document as part of the Asciidoctor conversion process.
 
-The extensions support the {uri-a2s}[AsciiToSVG], BlockDiag ({uri-blockdiag}[BlockDiag], {uri-seqdiag}[SeqDiag], {uri-actdiag}[ActDiag], {uri-nwdiag}[NwDiag]), {uri-bytefield}[Bytefield-SVG], {uri-dbml}[DBML], {uri-ditaa}[Ditaa], {uri-dpic}[dpic], {uri-erd}[Erd], {uri-gnuplot}[Gnuplot], {uri-dot}[GraphViz], {uri-mermaid}[Mermaid], {uri-mscgen}[Msc], {uri-nomnoml}[Nomnoml], {uri-pikchr}[Pikchr], {uri-plantuml}[PlantUML], {uri-shaape}[Shaape], {uri-smcat}[State Machine Cat], {uri-structurizr}[Structurizr], {uri-svgbob}[SvgBob], {uri-symbolator}[Symbolator], {uri-syntrax}[Syntrax] / {uri-jsyntrax}[JSyntrax], {uri-umlet}[UMLet], {uri-vega}[Vega], {uri-vegalite}[Vega-Lite] and {uri-wavedrom}[WaveDrom] syntax.
+Each extensions will invoke the necessary external diagram rendering tools to produce an image file which is inserted into your converted document.
 
-Each extension runs the diagram processor to generate an SVG, PNG, or TXT file from the input text.
-The generated file is then inserted into your converted document.
+The extensions support the xref:diagram_types/a2s.adoc[], BlockDiag (xref:diagram_types/blockdiag.adoc[], xref:diagram_types/seqdiag.adoc[], xref:diagram_types/actdiag.adoc[], xref:diagram_types/nwdiag.adoc[]), xref:diagram_types/bytefield.adoc[], xref:diagram_types/dbml.adoc[], xref:diagram_types/ditaa.adoc[], xref:diagram_types/dpic.adoc[], xref:diagram_types/erd.adoc[Erd], xref:diagram_types/gnuplot.adoc[], xref:diagram_types/graphviz.adoc[], xref:diagram_types/lilypond.adoc[], xref:diagram_types/mermaid.adoc[], xref:diagram_types/msc.adoc[], xref:diagram_types/nomnoml.adoc[], xref:diagram_types/penrose.adoc[], xref:diagram_types/pikchr.adoc[], xref:diagram_types/plantuml.adoc[], xref:diagram_types/shaape.adoc[], xref:diagram_types/smcat.adoc[], xref:diagram_types/structurizr.adoc[], xref:diagram_types/svgbob.adoc[], xref:diagram_types/symbolator.adoc[], xref:diagram_types/syntrax.adoc[], xref:diagram_types/umlet.adoc[], xref:diagram_types/vega.adoc[], and xref:diagram_types/wavedrom.adoc[] syntax.
 
-Asciidoctor Diagram was inspired by the {uri-py-plantuml}[AsciiDoc PlantUML filter].
-
-include::partial$installation.adoc[]
-
-include::partial$create_diagram.adoc[]
-
-include::partial$generate.adoc[]
-
-include::partial$advanced.adoc[]
+Asciidoctor Diagram was inspired by the {uri-py-plantuml}[AsciiDoc PlantUML filter].