Skip to content

Commit f3a6b95

Browse files
committed
Fix some phrasing issues
1 parent 2652757 commit f3a6b95

File tree

1 file changed

+18
-14
lines changed

1 file changed

+18
-14
lines changed

docs/content/documentation/tooldevelopers/graphdatastructure/elktextformat.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,18 @@ menu:
99

1010
The ELK text format has five basic elements: nodes, ports, labels, edges and edge sections.
1111
Details about each element can be found below.
12-
Note that the ELK text format uses default values for some things such as node sizes if they are not specified to make writing elkt files more convenient.
12+
Note that the ELK text format uses default node sizes if they are not specified to make writing elkt files more convenient.
1313
This is different from the JSON format, where no such defaults are assumed.
1414

1515
## Nodes, Ports, Labels, Edges, and Edge Sections
1616

17-
All elements, except labels, must have an _id_ that uniquely identifies them.
18-
Labels are usually not referred to from other parts of the graph,
19-
which is why the id is optional.
17+
Nodes and ports must have an _id_ that uniquely identifies them.
18+
Labels are usually not referred to from other parts of the graph, which is why the id is optional.
2019
The id is a string that has to begin with a letter.
2120
All elements furthermore can have [_layout options_]({{< relref "reference/options.md" >}}).
22-
Layout options are basically a list of key-value pairs that are used to
23-
assign layout option values to the element.
21+
Layout options are basically a list of key-value pairs that are used to assign layout option values to the element.
2422
Layout options can be an enum value, an enum set, an integer, a double, or other more complex objects.
23+
For each layout option the type is specified in the [_reference_]({{< relref "reference/options.html" >}})
2524

2625
```elkt
2726
layoutOption1: ENUM_VALUE
@@ -35,13 +34,19 @@ A special case is [_padding_]({{< relref "reference/options/org-eclipse-elk-padd
3534
padding: "[top=20.0,left=20.0,bottom=20.0,right=20.0]"
3635
```
3736

37+
[_Individual spacings_]({{< relref "reference/options/org-eclipse-elk-spacing-individual.html" >}}) are essentially a map of options.
38+
39+
```elkt
40+
spacing.individual: "TODO"
41+
```
42+
3843
## Nodes, Ports, and Labels
3944

4045
Nodes, ports, and labels have a two-dimensional location and size. Each of these elements
4146
can also have an arbitrary number of labels to describe them properly. Yes, even labels can
4247
have labels, although it depends on the layout algorithm whether or not it supports labeled
4348
labels.
44-
The `layout block is used to specify the size and positions of these elements.
49+
The optional `layout` block may be used to specify the size and positions of these elements.
4550

4651
```elkt
4752
layout [
@@ -57,11 +62,10 @@ Edges can connect to a node either directly or through one of its ports.
5762
A node can also contain an arbitrary number of child nodes.
5863
A graph is actually nothing more than a simple node whose children are the top-level nodes of the graph.
5964
Finally, a node can contain edges.
60-
While it is common to define those edges under a given node that connect that node's children, in fact any edge may be defined under any node, regardless of its
61-
end points. This allows for flexibility when defining hierarchy-crossing edges, as well as for
62-
alternative schemes, such as defining all edges at the root level.
63-
See [_Coordinate System_]({{< relref "documentation/tooldevelopers/graphdatastructure/coordinatesystem.md" >}})
64-
for the rules for interpreting edge coordinates.
65+
While it is common to define those edges under a given node that connect that node's children, in fact any edge may be defined under any node, regardless of its end points.
66+
This allows for flexibility when defining hierarchy-crossing edges, as well as for alternative schemes, such as defining all edges at the root level.
67+
Note that this is not recommended and in some cases poorly supported.
68+
See [_Coordinate System_]({{< relref "documentation/tooldevelopers/graphdatastructure/coordinatesystem.md" >}}) for the rules for interpreting edge coordinates.
6569

6670
```elkt
6771
node n {
@@ -81,7 +85,7 @@ Ports do not have any more interesting properties. Ports are boring.
8185

8286
## Labels
8387

84-
Labels can additionally contain text.
88+
Labels contain text.
8589
Note that layout algorithms
8690
generally don't perform any size estimation of the text.
8791
Therefore you should specify a reasonable width and height.
@@ -152,4 +156,4 @@ section incoming_sections -> outgoing_sections [
152156
```
153157

154158
## Examples
155-
Many examples can be found in [elklive](https://rtsys.informatik.uni-kiel.de/elklive/examples.html).
159+
Many examples can be found in [_elklive_](https://rtsys.informatik.uni-kiel.de/elklive/examples.html).

0 commit comments

Comments
 (0)