From: Mark Hansen Date: Sun, 31 May 2020 10:48:59 +0000 (+1000) Subject: Docs: Migrate header and footer into template X-Git-Tag: 2.44.1~48^2 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=be6c8ecdfa36e4846e72abcf9d0d953aaf39ffec;p=graphviz Docs: Migrate header and footer into template --- diff --git a/doc/infosrc/Makefile b/doc/infosrc/Makefile index 01ce342f4..6292983d1 100644 --- a/doc/infosrc/Makefile +++ b/doc/infosrc/Makefile @@ -148,10 +148,8 @@ colors.html : colors.1 colors.n ../../lib/common/color_names ../../lib/common/sv rm -rf colortmp -output.html : output.1 output.2 outputs mkoutput.py plugins.png jconvert.py schema.html templates/output.html.j2 - cat output.1 > output.html - ./mkoutput.py < outputs >> output.html - cat output.2 >> output.html +output.html : outputs mkoutput.py plugins.png schema.html templates/output.html.j2 + ./mkoutput.py < outputs > output.html schema.html : jconvert.py graphviz_json_schema.json ./jconvert.py graphviz_json_schema.json schema.html diff --git a/doc/infosrc/output.1 b/doc/infosrc/output.1 deleted file mode 100644 index d125ee002..000000000 --- a/doc/infosrc/output.1 +++ /dev/null @@ -1,39 +0,0 @@ - - - - -Output Formats - - - - - -

Output Formats

-The output format is specified with the -Tlang -flag on the command line, where lang -is one of the parameters listed below. -

-The formats actually available in a given Graphviz system depend on -how the system was built and the presence of additional libraries. -To see what formats dot supports, run dot -T?. -See the description of the -T -flag for additional information. -

-Note that the internal coordinate system has the origin -in the lower left corner. -Thus, positions in the -canon, -dot, -xdot, -plain, and -plain-ext -formats need to be interpreted in this manner. -

diff --git a/doc/infosrc/output.2 b/doc/infosrc/output.2 deleted file mode 100644 index 63e99323c..000000000 --- a/doc/infosrc/output.2 +++ /dev/null @@ -1,29 +0,0 @@ -

Image Formats

-The image and shapefile attributes specify an image file to be included -as part of the final diagram. Not all image formats can be read. In addition, -even if read, not all image formats can necessarily be used in a given -output format. -

-The graph below shows what image formats can be used in which output formats, -and the required plugins. On the left are the supported image formats. -On the right are the supported output formats. -In the middle are the plugins: image loaders, renderers, drivers, arranged by -plugin library. -This presents the most general case. A given installation may not provide -one of the plugins, in which case, that transformation is not possible. -
- -

Notes

-In the formats: -Tcmap, -Tcmapx, -Tsvg, -Tvml, the output generates -'id="node#"' properties for nodes, 'id="edge#"' properties for edges, and 'id="cluster#"' properties for clusters, with the '#' replaced by an internally assigned integer. These strings can be provided instead by an externally provided "id=xxx" attribute on the object. -Normal "\N" "\E" "\G" substitutions are applied. -Externally provided id values are not used internally, and it is the use's reponsibilty to ensure -that they are sufficiently unique for their intended downstream use. -Note, in particular, that "\E" is not a unique id for multiedges. -

- - diff --git a/doc/infosrc/templates/output.html.j2 b/doc/infosrc/templates/output.html.j2 index d82c71263..351f8708a 100644 --- a/doc/infosrc/templates/output.html.j2 +++ b/doc/infosrc/templates/output.html.j2 @@ -1,3 +1,42 @@ + + + + +Output Formats + + + + + +

Output Formats

+The output format is specified with the -Tlang +flag on the command line, where lang +is one of the parameters listed below. +

+The formats actually available in a given Graphviz system depend on +how the system was built and the presence of additional libraries. +To see what formats dot supports, run dot -T?. +See the description of the -T +flag for additional information. +

+Note that the internal coordinate system has the origin +in the lower left corner. +Thus, positions in the +canon, +dot, +xdot, +plain, and +plain-ext +formats need to be interpreted in this manner. +

{% for params, format in formats | dictsort %} @@ -28,3 +67,32 @@ {% endfor %}
+
Image Formats
+
+The image and shapefile attributes specify an image file to be included +as part of the final diagram. Not all image formats can be read. In addition, +even if read, not all image formats can necessarily be used in a given +output format. +
+The graph below shows what image formats can be used in which output formats, +and the required plugins. On the left are the supported image formats. +On the right are the supported output formats. +In the middle are the plugins: image loaders, renderers, drivers, arranged by +plugin library. +This presents the most general case. A given installation may not provide +one of the plugins, in which case, that transformation is not possible. +
+ +
+
Notes
+
+
+In the formats: -Tcmap, -Tcmapx, -Tsvg, -Tvml, the output generates +'id="node#"' properties for nodes, 'id="edge#"' properties for edges, and 'id="cluster#"' properties for clusters, with the '#' replaced by an internally assigned integer. These strings can be provided instead by an externally provided "id=xxx" attribute on the object. +Normal "\N" "\E" "\G" substitutions are applied. +Externally provided id values are not used internally, and it is the use's reponsibilty to ensure +that they are sufficiently unique for their intended downstream use. +Note, in particular, that "\E" is not a unique id for multiedges. +
+ +

Command-line
parameter Format