Skip to content

Commit 02a4091

Browse files
authored
Merge pull request #2390 from strictdoc-project/stanislaw/new_section_included_documents
docs: update release notes
2 parents ec61d88 + b62e5ff commit 02a4091

File tree

2 files changed

+45
-2
lines changed

2 files changed

+45
-2
lines changed

docs/strictdoc_04_release_notes.sdoc

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,13 +52,56 @@ TITLE: Unreleased
5252
[TEXT]
5353
MID: c536381cea6842f0b77c1aa5ac942ce0
5454
STATEMENT: >>>
55-
This release includes a small improvement to the behavior of the ``LEVEL / AUTO_LEVEL`` fields.
55+
This release includes the following enhancements.
56+
57+
**1) A small improvement to the behavior of the LEVEL/AUTO_LEVEL fields.**
5658

5759
The following cases are now considered valid and will no longer trigger validation errors:
5860

5961
- **When AUTO_LEVELS is On**, a node without a level or with a custom level is acceptable. The custom level will be used as-is, while all other nodes will be numbered automatically.
6062

6163
- **When AUTO_LEVELS is Off**, a node without a level is also valid. In this case, the node will simply be omitted from the Table of Contents (TOC).
64+
65+
**2) Initial support for direct reading of ReqIF files alongside SDoc files.**
66+
67+
It is now possible to add a ReqIF file to a Git repository and have it read directly into the StrictDoc HTML view, without first converting it to SDoc. The conversion to internal SDoc models happens automatically at runtime. This feature enables workflows where a requirements baseline is maintained in a ReqIF file, and there is no need to convert it to SDoc before adding parent trace links from child SDoc documents stored in the same repository.
68+
69+
**3) ReqIF Schema compatibility for ReqIF export.**
70+
71+
StrictDoc now exports ReqIF files that fully comply with the ReqIF XSD schema. Previously, exported files could trigger minor validation errors — harmless but distracting when editing XML in an IDE. These issues have now been resolved. All relevant integration tests have been updated to include schema validation, ensuring ongoing compliance with the ReqIF XSD standard.
72+
73+
**4) Support HTTP Conneg on stable links.**
74+
75+
This change enables an API integration with StrictDoc. It lays the groundwork for implementing APIs such as OSLC Requirements Management, allowing integration with tools like IBM DOORS NG, the broader IBM Jazz platform, Siemens Polarion, and other OSLC-compliant systems.
76+
77+
With this change, StrictDoc can support content negotiation based on the Accept header in incoming requests. For example:
78+
79+
- When a client requests a requirement with ``Accept: text/html``, StrictDoc will serve the regular HTML export.
80+
81+
- When a tool like Polarion sends a request for the same URI but with headers such as ``Accept: text/turtle;q=0.9, application/ld+json;q=0.7, application/rdf+xml;q=0.5``, the server can detect this and return an appropriate OSLC-compliant response instead.
82+
83+
This approach enables serving different representations of the same requirement, e.g.,
84+
``localhost:3000/?a=SDOC-HIGH-REQS-MANAGEMENT``, while maintaining a consistent ID across formats.
85+
86+
Thanks to @berezovskyi for contributing this change.
87+
88+
**5) The DOCUMENT_FROM_FILE compatibility with new [[SECTION]] syntax.**
89+
90+
During the migration to [[SECTION]], we overlooked verifying that the DOCUMENT_FROM_FILE directive works with the new section elements. Based on a user report, this has now been corrected — DOCUMENT_FROM_FILE is fully compatible with [[SECTION]].
91+
92+
Thanks to @nowittyusername for reporting this issue.
93+
94+
**6) The TITLE-STATEMENT-DESCRIPTION-CONTENT validation has been removed.**
95+
96+
StrictDoc no longer requires one of the fields TITLE-STATEMENT-DESCRIPTION-CONTENT to be present on every SDoc node. The rationale for removal is as follows.
97+
98+
There are cases where we want to allow none of the standard SDoc reserved fields to be present on a node, even though this means that no SDoc naming conventions are followed.
99+
100+
In particular, some ReqIF files contain fields that follow neither ReqIF nor SDoc naming conventions.
101+
102+
Previously, the fields TITLE, STATEMENT, DESCRIPTION, or CONTENT were used to determine whether a field should be treated as single-line or multiline. Under the new behavior, if none of these fields are present, all fields will be treated as multiline by default.
103+
104+
In the future, we may introduce a separate field for the GrammarElement field declarations, for example, to explicitly specify whether a field should be interpreted as Title, Meta, Content, etc.
62105
<<<
63106

64107
[[/SECTION]]

tests/end2end/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
# Dummy comment to trigger CI
1+
# Dummy comment to trigger CI.

0 commit comments

Comments
 (0)