Commit b2a18ac7 authored by Costa Shulyupin's avatar Costa Shulyupin
Browse files

add simple descriptions for attributes

into yaml header.
The descriptions are generated from
the first sentence of the text.
These original sentences are
replaces with the description.
parent f2967a4d
......@@ -9,7 +9,7 @@ title: Damping
types:
- double
used_by: G
description: Factor damping force motions. On each iteration, a node's movement
---
Factor damping force motions. On each iteration, a node's movement
is limited to this factor of its potential motion. By being less than
`1.0`, the system tends to "cool", thereby preventing cycling.
......@@ -10,8 +10,8 @@ title: K
types:
- double
used_by: GC
description: Spring constant used in virtual physical model. It roughly correspond
---
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.
......
......@@ -10,8 +10,8 @@ title: URL
types:
- escString
used_by: ENGC
description: Hyperlinks incorporated into device-dependent output
---
Hyperlinks incorporated into device-dependent output.
At present, used in `ps2`, `cmap`, `i*map` and `svg` formats.
For all these formats, URLs can be attached to nodes, edges and
clusters. URL attributes can also be attached to the root graph in `ps2`,
......
......@@ -9,8 +9,8 @@ title: area
types:
- double
used_by: NC
description: Indicates the preferred area for a node or empty cluster when laid out by [patchwork](/docs/layouts/patchwork/)
---
Indicates the preferred area for a node or empty cluster when laid out by [patchwork](/docs/layouts/patchwork/).
{{< dot_card header="Example: Australian Coins, area proportional to value">}}
graph {
......
......@@ -7,8 +7,8 @@ title: arrowhead
types:
- arrowType
used_by: E
description: Style of arrowhead on the head node of an edge
---
Style of arrowhead on the head node of an edge.
This will only appear if the [`dir` attribute]({{< ref "dir.md" >}})
is `forward` or `both`.
......
......@@ -8,8 +8,8 @@ title: arrowsize
types:
- double
used_by: E
description: Multiplicative scale factor for arrowheads
---
Multiplicative scale factor for arrowheads.
{{< dot_card header="Example">}}
digraph {
......
......@@ -7,8 +7,8 @@ title: arrowtail
types:
- arrowType
used_by: E
description: Style of arrowhead on the tail node of an edge
---
Style of arrowhead on the tail node of an edge.
This will only appear if the [`dir` attribute]({{< ref "dir.md" >}})
is `back` or `both`.
......
......@@ -7,5 +7,5 @@ title: bb
types:
- rect
used_by: G
description: Bounding box of drawing in points
---
Bounding box of drawing in points.
......@@ -7,5 +7,5 @@ title: center
types:
- bool
used_by: G
description: If true, the drawing is centered in the output canvas
---
If true, the drawing is centered in the output canvas.
......@@ -8,8 +8,8 @@ title: class
types:
- string
used_by: ENCG
description: Classnames to attach to the node, edge, graph, or cluster's SVG element
---
Classnames to attach to the node, edge, graph, or cluster's SVG element.
Combine with [`stylesheet`]({{< ref "stylesheet.md" >}}) for styling SVG output
using CSS classnames.
......
......@@ -8,8 +8,9 @@ title: clusterrank
types:
- clusterMode
used_by: G
description: Mode used for handling clusters
---
Mode used for handling clusters. If `clusterrank=local`, a
If `clusterrank=local`, a
subgraph whose name begins with `cluster` is given special treatment.
The subgraph is laid out separately, and then integrated as a unit into
......
......@@ -8,8 +8,9 @@ types:
- color
- colorList
used_by: ENC
description: Basic drawing color for graphics, not text
---
Basic drawing color for graphics, not text. For the latter, use the
For the latter, use the
[`fontcolor`]({{< ref "fontcolor.md" >}}) attribute.
For edges, the value can either be a single color or a
......
......@@ -7,8 +7,8 @@ title: colorscheme
types:
- string
used_by: ENCG
description: "This attribute specifies a color scheme namespace: the context for interpreting color names"
---
This attribute specifies a color scheme namespace: the context for interpreting color names.
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.
......
......@@ -7,8 +7,9 @@ title: comment
types:
- string
used_by: ENG
description: Comments are inserted into output
---
Comments are inserted into output. Device-dependent
Device-dependent.
{{< dot_card header="Example">}}
......
......@@ -8,8 +8,8 @@ title: compound
types:
- bool
used_by: G
description: If true, allow edges between clusters
---
If true, allow edges between clusters.
See [`lhead`]({{< ref "lhead.md" >}}) and [`ltail`]({{< ref "ltail.md" >}}).
......
......@@ -7,8 +7,8 @@ title: concentrate
types:
- bool
used_by: G
description: If true, use edge concentrators
---
If true, use edge concentrators.
This merges multiedges into a single edge and causes partially parallel
edges to share part of their paths. The latter feature is not yet available
......
......@@ -8,9 +8,9 @@ title: constraint
types:
- bool
used_by: E
description: If false, the edge is not used in ranking the nodes
---
If false, the edge is not used in ranking the nodes. For example,
in the graph:
For example in the graph:
{{< dot_card >}}
digraph G {
......
......@@ -7,8 +7,8 @@ title: decorate
types:
- bool
used_by: E
description: If true, attach edge label to edge by a 2-segmen
---
If true, attach edge label to edge by a 2-segment
polyline, underlining the label, then going to the closest point of spline.
{{< dot_card header="Example">}}
......
......@@ -9,8 +9,8 @@ title: defaultdist
types:
- double
used_by: G
description: This specifies the distance between nodes in separate connecte
---
This specifies the distance between nodes in separate connected
components. If set too small, connected components may overlap.
Only applicable if <code>[pack]({{< ref "pack.md" >}})=false</code>.
......@@ -11,7 +11,7 @@ title: dim
types:
- int
used_by: G
description: Set the number of dimensions used for the layout
---
Set the number of dimensions used for the layout.
The maximum value allowed is `10`.
Supports Markdown
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