Commit 81b00f57 authored by Mark Hansen's avatar Mark Hansen
Browse files

Introduce per-attribute pages

This should give us more room to add more examples and more information to the attributes pages.

I retain the one-page attribute index too.

I'm also using {{< ref "foo.md" >}} which errors if the file doesn't exist:
it's nice to get an error when you have a dead link.
parent 5ded9296
......@@ -5,7 +5,7 @@ flags:
- neato
minimums:
- '0.0'
name: Damping
title: Damping
types:
- double
used_by: G
......
......@@ -6,7 +6,7 @@ flags:
- sfdp
minimums:
- '0'
name: K
title: K
types:
- double
used_by: GC
......@@ -15,5 +15,5 @@ Spring constant used in virtual physical model. It roughly corresponds
to an ideal edge length (in inches), in that increasing `K` tends to
increase the distance between nodes.
Note that the edge attribute [`len`](#d:len) can be used to
Note that the edge attribute [`len`]({{< ref "len.md" >}}) can be used to
override this value for adjacent nodes.
......@@ -6,7 +6,7 @@ flags:
- postscript
- svg
minimums: []
name: URL
title: URL
types:
- escString
used_by: ENGC
......@@ -31,9 +31,9 @@ overlap the related node, and the edge URL dominates.
If the edge has a label, this will also be active.
Finally, if the edge has a head or tail label, this will also be active.
For edges, the attributes [`headURL`](#d:headURL),
[`tailURL`](#d:tailURL), [`labelURL`](#d:labelURL) and
[`edgeURL`](#d:edgeURL) allow control of various parts of an
For edges, the attributes [`headURL`]({{< ref "headURL.md" >}}),
[`tailURL`]({{< ref "tailURL.md" >}}), [`labelURL`]({{< ref "labelURL.md" >}}) and
[`edgeURL`]({{< ref "edgeURL.md" >}}) allow control of various parts of an
edge.
if active areas of two edges overlap, it is unspecified which area dominates.
......@@ -4,6 +4,8 @@ url: /doc/info/attrs.html
aliases:
- /doc/info/attrs1.html
- /doc/info/attrs2.html
cascade:
type: attrs
weight: 4
---
The table below describes the attributes used by various Graphviz tools.
......@@ -30,7 +32,7 @@ abc -> def [arrowhead = diamond]
```
Further details concerning the setting of attributes can be found
in the description of the [DOT language.](lang.html)
in the description of the [DOT language.]({{< ref "../lang.md" >}})
At present, most device-independent units are either inches or
<A ID="points" HREF="http://en.wikipedia.org/wiki/Point_(typography)">points</A>,
......@@ -39,10 +41,10 @@ which we take as 72 points per inch.
<P ID="h:undir_note"></P>
**Note:** Some attributes, such as
[`dir`](#d:dir) or [`arrowtail`](#d:arrowtail), are ambiguous when used in
[DOT](lang.html) with an undirected graph since the head and tail of an edge
[`dir`]({{< ref "dir.md" >}}) or [`arrowtail`]({{< ref "arrowtail.md" >}}), are ambiguous when used in
[DOT]({{< ref "../lang.md" >}}) with an undirected graph since the head and tail of an edge
are meaningless. As a convention, the first time an undirected edge appears,
the [DOT](lang.html)
the [DOT]({{< ref "../lang.md" >}})
parser will assign the left node as the tail node and the right node as
the head. For example, the edge `A -- B` will have tail `A`
and head `B`. It is the user's responsibility to handle such
......@@ -56,8 +58,8 @@ the drawing will attach the tail label to node `A`.
To avoid possible confusion when such attributes are required, the user
is encouraged to use a directed graph.
If it is important to make the graph appear undirected, this can be
done using the [`dir`](#d:dir), [`arrowtail`](#d:arrowtail) or
[`arrowhead`](#d:arrowhead) attributes.
done using the [`dir`]({{< ref "dir.md" >}}), [`arrowtail`]({{< ref "arrowtail.md" >}}) or
[`arrowhead`]({{< ref "arrowhead.md" >}}) attributes.
<P ID="k:bool"></P>
......@@ -83,13 +85,3 @@ This field indicates which graph component uses the attribute.
In the **Notes** field, an annotation of *write only*
indicates that the attribute is used for output, and is not used or read by any
of the layout programs.
---
{{<attributes_toc>}}
---
## Attribute Descriptions
{{<attribute_descriptions>}}
......@@ -5,7 +5,7 @@ flags:
- patchwork
minimums:
- '>0'
name: area
title: area
types:
- double
used_by: NC
......
......@@ -3,13 +3,13 @@ defaults:
- normal
flags: []
minimums: []
name: arrowhead
title: arrowhead
types:
- arrowType
used_by: E
---
Style of arrowhead on the head node of an edge.
This will only appear if the [`dir` attribute](#d:dir)
This will only appear if the [`dir` attribute]({{< ref "dir.md" >}})
is `forward` or `both`.
See the [limitation](#h:undir_note).
See the [limitation]({{< ref "_index.md#undir_note" >}}).
......@@ -4,7 +4,7 @@ defaults:
flags: []
minimums:
- '0.0'
name: arrowsize
title: arrowsize
types:
- double
used_by: E
......
......@@ -3,13 +3,13 @@ defaults:
- normal
flags: []
minimums: []
name: arrowtail
title: arrowtail
types:
- arrowType
used_by: E
---
Style of arrowhead on the tail node of an edge.
This will only appear if the [`dir` attribute](#d:dir)
This will only appear if the [`dir` attribute]({{< ref "dir.md" >}})
is `back` or `both`.
See the [limitation](#h:undir_note).
See the [limitation]({{< ref "_index.md#undir_note" >}}).
......@@ -3,14 +3,14 @@ defaults:
- <none>
flags: []
minimums: []
name: _background
title: _background
types:
- string
used_by: G
---
A string in the [`xdot` format](/docs/outputs/canon/) specifying an arbitrary background.
During rendering, the canvas is first filled as described in the
[`bgcolor` attribute](#d:bgcolor).
[`bgcolor` attribute]({{< ref "bgcolor.md" >}}).
Then, if `_background` is defined, the graphics
operations described in the string are performed on the canvas.
......@@ -3,7 +3,7 @@ defaults: []
flags:
- write
minimums: []
name: bb
title: bb
types:
- rect
used_by: G
......
......@@ -3,7 +3,7 @@ defaults:
- <none>
flags: []
minimums: []
name: bgcolor
title: bgcolor
types:
- color
- colorList
......@@ -13,14 +13,14 @@ When attached to the root graph, this color is used as the background for
entire canvas.
When a cluster attribute, it is used as the initial background
for the cluster. If a cluster has a filled [`style`](#d:style), the cluster's
[`fillcolor`](#d:fillcolor) will overlay the background color.
for the cluster. If a cluster has a filled [`style`]({{< ref "style.md" >}}), the cluster's
[`fillcolor`]({{< ref "fillcolor.md" >}}) will overlay the background color.
If the value is a [`colorList`](/docs/attr-types/colorList/), a gradient fill is used. By
default, this is a linear fill; setting [`style`](#d:style)`=radial` will
default, this is a linear fill; setting <code>[style]({{< ref "style.md" >}})=radial</code> will
cause a radial fill. Only two colors are used. If the second color (after a
colon) is missing, the default color is used for it. See also the
[`gradientangle`](#d:gradientangle) attribute for setting the gradient angle.
[`gradientangle`]({{< ref "gradientangle.md" >}}) attribute for setting the gradient angle.
For certain output formats, such as PostScript, no fill is done for the root
graph unless `bgcolor` is explicitly set.
......
......@@ -3,7 +3,7 @@ defaults:
- 'false'
flags: []
minimums: []
name: center
title: center
types:
- bool
used_by: G
......
......@@ -3,7 +3,7 @@ defaults:
- '"UTF-8"'
flags: []
minimums: []
name: charset
title: charset
types:
- string
used_by: G
......
......@@ -4,13 +4,13 @@ defaults:
flags:
- svg
minimums: []
name: class
title: class
types:
- string
used_by: ENCG
---
Classnames to attach to the node, edge, graph, or cluster's SVG element.
Combine with [`stylesheet`](#d:stylesheet) for styling SVG output
Combine with [`stylesheet`]({{< ref "stylesheet.md" >}}) for styling SVG output
using CSS classnames.
Multiple space-separated classes are supported.
......
......@@ -4,7 +4,7 @@ defaults:
flags:
- dot
minimums: []
name: clusterrank
title: clusterrank
types:
- clusterMode
used_by: G
......@@ -14,7 +14,7 @@ subgraph whose name begins with `cluster` is given special treatment.
The subgraph is laid out separately, and then integrated as a unit into
its parent graph, with a bounding rectangle drawn about it.
If the cluster has a [`label`](#d:label) parameter, this label
If the cluster has a [`label`]({{< ref "label.md" >}}) parameter, this label
is displayed within the rectangle.
Note also that there can be clusters within clusters.
......
......@@ -3,14 +3,14 @@ defaults:
- black
flags: []
minimums: []
name: color
title: color
types:
- color
- colorList
used_by: ENC
---
Basic drawing color for graphics, not text. For the latter, use the
[`fontcolor`](#d:fontcolor) attribute.
[`fontcolor`]({{< ref "fontcolor.md" >}}) attribute.
For edges, the value can either be a single color or a
[`colorList`](/docs/attr-types/colorList/).
......@@ -38,4 +38,4 @@ digraph G {
yields:
<IMG SRC="colorlist.gif">
<IMG SRC="/doc/info/colorlist.gif">
......@@ -3,7 +3,7 @@ defaults:
- '""'
flags: []
minimums: []
name: colorscheme
title: colorscheme
types:
- string
used_by: ENCG
......@@ -12,7 +12,7 @@ This attribute specifies a color scheme namespace: the context for interpreting
In particular, if a [`color`](/docs/attr-types/color/) value has form `"xxx"` or `"//xxx"`,
then the color `xxx` will be evaluated according to the current color scheme.
If no color scheme is set, the standard X11 naming is used.
If no color scheme is set, the standard [X11 naming]({{< ref "../colors.md#x11" >}}) is used.
For example, if `colorscheme=bugn9`, then `color=7` is interpreted as
`color="/bugn9/7"`.
For example, if `colorscheme=bugn9` (from [Brewer color schemes]({{< ref "../colors.md#brewer" >}})), then `color=7` is interpreted as
`color="/bugn9/7"`, the 7th color in the `bugn9` colorscheme.
......@@ -3,7 +3,7 @@ defaults:
- '""'
flags: []
minimums: []
name: comment
title: comment
types:
- string
used_by: ENG
......
......@@ -4,11 +4,11 @@ defaults:
flags:
- dot
minimums: []
name: compound
title: compound
types:
- bool
used_by: G
---
If true, allow edges between clusters.
See [`lhead`](#d:lhead) and [`ltail`](#d:ltail) below.
See [`lhead`]({{< ref "lhead.md" >}}) and [`ltail`]({{< ref "ltail.md" >}}) below.
......@@ -3,7 +3,7 @@ defaults:
- 'false'
flags: []
minimums: []
name: concentrate
title: concentrate
types:
- bool
used_by: G
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment