0.0.58

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.

What's Changed

• Bump version to 0.0.57, update documentation by @stanislaw in #1895
• User Guide: Explain conventions related to content field by @haxtibal in #1898
• backend/sdoc: relax the validation of UID when running Manage/AutoUID by @stanislaw in #1899
• Bump version to 0.0.58 by @stanislaw in #1901

Full Changelog: 0.0.57...0.0.58