Skip to content

Commit

Permalink
Merge pull request #1898 from haxtibal/bugfix/docmetafieldconvention
Browse files Browse the repository at this point in the history
User Guide: Explain conventions related to content field
  • Loading branch information
stanislaw committed Jun 24, 2024
2 parents 24c7228 + 92a37d3 commit c5add0d
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions docs/strictdoc_01_user_guide.sdoc
Original file line number Diff line number Diff line change
Expand Up @@ -1302,6 +1302,14 @@ declare them as the ``[REQUIREMENT]`` special fields:
STATEMENT: System A shall do B.
COMMENT: Test comment.

Each grammar element must have exactly one content field named ``STATEMENT``,
``DESCRIPTION`` or ``CONTENT``. The content field plays a key role in the HTML
user interface as well as other export formats.

All fields before the content field are considered meta information. Meta information
fields are assumed to be single-line. The content field and all following fields
accept single-line and multiline strings.

**Note:** The order of fields must match the order of their declaration in the
grammar.
<<<
Expand All @@ -1324,10 +1332,12 @@ The supported field types are:
- Simple String

* - ``SingleChoice``
- Enum-like behavior, one choice is possible
- Enum-like behavior, one choice is possible. Must be single-line and thus
has to be defined before the content field.

* - ``MultipleChoice``
- comma-separated words with fixed options
- comma-separated words with fixed options. Must be single-line and thus has
to be defined before the content field.

* - ``Tag``
- comma-separated list of tags/key words. Only Alphanumeric tags (a-z, A-Z, 0-9 and underscore) are supported.
Expand Down

0 comments on commit c5add0d

Please sign in to comment.