diff --git a/docs/sphinx/source/strictdoc_01_user_guide.rst b/docs/sphinx/source/strictdoc_01_user_guide.rst index c734b5d84..6cf6e5add 100644 --- a/docs/sphinx/source/strictdoc_01_user_guide.rst +++ b/docs/sphinx/source/strictdoc_01_user_guide.rst @@ -1122,6 +1122,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. @@ -1141,10 +1149,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. diff --git a/docs/sphinx/source/strictdoc_04_release_notes.rst b/docs/sphinx/source/strictdoc_04_release_notes.rst index 8a97e3229..2978bf3bf 100644 --- a/docs/sphinx/source/strictdoc_04_release_notes.rst +++ b/docs/sphinx/source/strictdoc_04_release_notes.rst @@ -3,6 +3,21 @@ $$$$$$$$$$$$$ This document maintains a record of all changes to StrictDoc since November 2023. It serves as a user-friendly version of the changelog, complementing the automatically generated, commit-by-commit changelog available here: `StrictDoc Changelog `_. +0.0.58 (2024-06-25) +=================== + +This is a release with a single fix and a minor documentation update. + +The ``manage auto-uid`` command is now compatible with grammars that define the ``UID`` field as ``REQUIRED: True``. Previously, StrictDoc would raise a validation message if the ``auto-uid`` command was run against a document with ``UID`` defined as a required field but containing nodes without ``UID``. The new behavior allows the ``auto-uid`` command to operate without validation and correctly creates a new UID for the node. Thanks to @simhein for reporting this issue. + +@haxtibal contributed a patch to the User Guide that explains the StrictDoc convention of how the single-line (meta information) fields should be used compared to the multiline fields, such as ``STATEMENT``, ``RATIONALE``, ``COMMENT``, etc. Quoting the key part: + + 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. + +See the updated User Guide for more details. + 0.0.57 (2024-06-23) =================== diff --git a/docs/strictdoc_04_release_notes.sdoc b/docs/strictdoc_04_release_notes.sdoc index ea9d82cb9..57fc9a7f1 100644 --- a/docs/strictdoc_04_release_notes.sdoc +++ b/docs/strictdoc_04_release_notes.sdoc @@ -5,6 +5,26 @@ TITLE: Release Notes This document maintains a record of all changes to StrictDoc since November 2023. It serves as a user-friendly version of the changelog, complementing the automatically generated, commit-by-commit changelog available here: `StrictDoc Changelog `_. [/FREETEXT] +[SECTION] +TITLE: 0.0.58 (2024-06-25) + +[TEXT] +STATEMENT: >>> +This is a release with a single fix and a minor documentation update. + +The ``manage auto-uid`` command is now compatible with grammars that define the ``UID`` field as ``REQUIRED: True``. Previously, StrictDoc would raise a validation message if the ``auto-uid`` command was run against a document with ``UID`` defined as a required field but containing nodes without ``UID``. The new behavior allows the ``auto-uid`` command to operate without validation and correctly creates a new UID for the node. Thanks to @simhein for reporting this issue. + +@haxtibal contributed a patch to the User Guide that explains the StrictDoc convention of how the single-line (meta information) fields should be used compared to the multiline fields, such as ``STATEMENT``, ``RATIONALE``, ``COMMENT``, etc. Quoting the key part: + + 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. + +See the updated User Guide for more details. +<<< + +[/SECTION] + [SECTION] TITLE: 0.0.57 (2024-06-23) diff --git a/strictdoc/__init__.py b/strictdoc/__init__.py index 69d62fa39..8ca9876d0 100644 --- a/strictdoc/__init__.py +++ b/strictdoc/__init__.py @@ -1,6 +1,6 @@ from strictdoc.core.environment import SDocRuntimeEnvironment -__version__ = "0.0.58a1" +__version__ = "0.0.58" environment = SDocRuntimeEnvironment(__file__)