commit 778f3be003bffe3b40ca1fdc1e3aadde12a30b64
parent b7165bd833b0215212645a8934167e1650ceb92c
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Fri, 28 Jul 2017 11:23:48 +0200
Document that constraints on the entity/anchor name
Diffstat:
1 file changed, 13 insertions(+), 10 deletions(-)
diff --git a/doc/solstice-input.5.txt b/doc/solstice-input.5.txt
@@ -649,9 +649,10 @@ identity, i.e. its *rotation* and *translation* are nulls.
Each entity has a *name* which must be unique per hierarchy level: 2 root
entities (i.e. entities without parent) cannot have the same name as well as
-the children of a same parent entity. A child entity is identified into the
-solar plant by successively concatenating, with the \'.' character, the name of
-its ancestors with its own name. This naming convention is used in the
+the children of a same parent entity. In addition, the name string cannot
+contain dots, spaces or tabulations. A child entity is identified into the
+solar plant by successively concatenating, with the \'.' character, the name
+of its ancestors with its own name. This naming convention is used in the
*solstice-receiver*(5) format to define the entities to track during the
*solstice*(1) computations. For instance, in the following example, the
*entity-identifier* of the child entity named *level2* is
@@ -764,13 +765,15 @@ Anchor
~~~~~~
An *anchor* defines a relative position into the entity hierarchy. They are
-particularly useful for pivots and hyperbolic shapes that may have to reference
-a position relative to an entity whose transformations may also depends of its
-ancestor. An anchor has a *name* that must be unique for the whole sets of per
-entity anchors. An anchor is identified into the solar plant by concatenating,
-with the \'.' character, its name to the *entity-identifier* of the entity into
-which it is declared. For instance, in the following example, the
-*anchor-identifier* of the anchor named *anchor0* is *level0.level1.anchor0*:
+particularly useful for pivots and hyperbolic shapes that may have to
+reference a position relative to an entity whose transformations may also
+depends of its ancestor. An anchor has a *name* that must be unique for the
+whole sets of per entity anchors. In addition, a name cannot contain
+dots, spaces or tabulations. An anchor is identified into the solar plant by
+concatenating, with the \'.' character, its name to the *entity-identifier* of
+the entity into which it is declared. For instance, in the following example,
+the *anchor-identifier* of the anchor named *anchor0* is
+*level0.level1.anchor0*:
.......
entity:
name: level0
