Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
VIGNET Pierre
cadbiom
Commits
9f896732
Commit
9f896732
authored
Jan 27, 2020
by
VIGNET Pierre
Browse files
[doc] files specs: Fix typos
parent
8c8d6854
Changes
1
Hide whitespace changes
Inline
Side-by-side
doc/source/file_format_specification.rst
View file @
9f896732
...
...
@@ -35,34 +35,34 @@ Tags for nodes
~~~~~~~~~~~~~~
Type of tags are:
- <CSimpleNode>
- <CStartNode>
-
``
<CSimpleNode>
``
-
``
<CStartNode>
``
Each node :term:`tag` have these attributes:
- name: (mandatory) the name of the node. The name must be unique in the whole model;
- xloc: (optional) x coordinate of the node for graphical representation in the graph editor of Cadbiom;
- yloc: (optional) y coordinate;
-
``
name
``
: (mandatory) the name of the node. The name must be unique in the whole model;
-
``
xloc
``
: (optional) x coordinate of the node for graphical representation in the graph editor of Cadbiom;
-
``
yloc
``
: (optional) y coordinate;
Tag for transitions
~~~~~~~~~~~~~~~~~~~
Type of :term:`tag` is:
<transition>
- ``
<transition>
``
:term:`Attributes<attribute>`:
- ori: (mandatory) the name of the consumed node which is at the left of the transition.
- ext: (mandatory) the name of the producted node which is at theright of the transition.
- event: (mandatory) the name of the event/clock; 1 event may share multiple transitions.
-
``
ori
``
: (mandatory) the name of the consumed node which is at the left of the transition.
-
``
ext
``
: (mandatory) the name of the producted node which is at theright of the transition.
-
``
event
``
: (mandatory) the name of the event/clock; 1 event may share multiple transitions.
Also, an event name can be a logical formula for complex transitions; this kind of formula
may involve time operators like ``default`` or ``when`` used to describe transitions shared by multiple events
under various conditions;
- condition: (mandatory) A logical formula whose satisfiability is necessary for the transition to take place.
-
``
condition
``
: (mandatory) A logical formula whose satisfiability is necessary for the transition to take place.
A condition can be an empty string.
- action: (optional):
???
- fact_ids: (deprecated) A list of publication IDs for tracability. The content of this attribute is now in metadata.
-
``
action
``
: (optional):
todo
-
``
fact_ids
``
: (deprecated) A list of publication IDs for tracability. The content of this attribute is now in metadata.
Metadata content :term:`elements<element>`:
...
...
@@ -117,8 +117,8 @@ Glossary
A tag is a markup construct that begins with < and ends with >.
2 flavors can be encountered:
- start-tag, such as <section>;
- end-tag, such as </section>;
- start-tag, such as
``
<section>
``
;
- end-tag, such as
``
</section>
``
;
element
An element is a logical document component that either begins with a start-tag and ends with a matching end-tag.
...
...
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment