strictdoc 0.0.49a5__tar.gz → 0.0.49a6__tar.gz

{strictdoc-0.0.49a5 → strictdoc-0.0.49a6}/CHANGELOG.md

@@ -2,10 +2,188 @@
 
 ## [Unreleased](https://github.com/strictdoc-project/strictdoc/tree/HEAD)
 
-[Full Changelog](https://github.com/strictdoc-project/strictdoc/compare/0.0.47...HEAD)
+[Full Changelog](https://github.com/strictdoc-project/strictdoc/compare/0.0.48...HEAD)
+
+**Fixed bugs:**
+
+- models: requirement: preserve REFS when setting a field [\#1631](https://github.com/strictdoc-project/strictdoc/pull/1631) ([stanislaw](https://github.com/stanislaw))
+
+**Closed issues:**
+
+- Excel export: export multiple documents with relations between them, document the common commands [\#1639](https://github.com/strictdoc-project/strictdoc/issues/1639)
+- HTML2PDF: Make the webdriver\_manager to avoid downloading newer versions if a cached one already exists [\#1636](https://github.com/strictdoc-project/strictdoc/issues/1636)
+- auto-uid strips RELATIONS if the REQUIREMENT has no UID/MID [\#1630](https://github.com/strictdoc-project/strictdoc/issues/1630)
+- auto-uid throws AttributeError when I have a COMPOSITE\_REQUIREMENT [\#1623](https://github.com/strictdoc-project/strictdoc/issues/1623)
+- StrictDoc does not recognize source files with arbitrary extensions [\#1621](https://github.com/strictdoc-project/strictdoc/issues/1621)
+
+**Merged pull requests:**
+
+-  tests/end2end: test opening a hyperlink to an CSV asset  [\#1646](https://github.com/strictdoc-project/strictdoc/pull/1646) ([stanislaw](https://github.com/stanislaw))
+- server: main\_router: treat everything "not .html" as assets [\#1645](https://github.com/strictdoc-project/strictdoc/pull/1645) ([stanislaw](https://github.com/stanislaw))
+- export/excel: link Excel export requirement to source files [\#1644](https://github.com/strictdoc-project/strictdoc/pull/1644) ([stanislaw](https://github.com/stanislaw))
+- export/excel: allow generating Excel files for inter-document relations [\#1643](https://github.com/strictdoc-project/strictdoc/pull/1643) ([stanislaw](https://github.com/stanislaw))
+- export/html2pdf: customize webdriver cache manager to allow offline use [\#1642](https://github.com/strictdoc-project/strictdoc/pull/1642) ([stanislaw](https://github.com/stanislaw))
+- fix: Review changes [\#1641](https://github.com/strictdoc-project/strictdoc/pull/1641) ([dahbar](https://github.com/dahbar))
+- export/html: implement --view option  [\#1638](https://github.com/strictdoc-project/strictdoc/pull/1638) ([stanislaw](https://github.com/stanislaw))
+- export/html2pdf: improved printing of tables \(Firefox edge case\) [\#1637](https://github.com/strictdoc-project/strictdoc/pull/1637) ([mettta](https://github.com/mettta))
+-  tests/integration: move several feature-related groups to features/  [\#1635](https://github.com/strictdoc-project/strictdoc/pull/1635) ([stanislaw](https://github.com/stanislaw))
+- fix: Validation for views and proper tests [\#1634](https://github.com/strictdoc-project/strictdoc/pull/1634) ([dahbar](https://github.com/dahbar))
+- Bump version to 0.0.49a3 [\#1632](https://github.com/strictdoc-project/strictdoc/pull/1632) ([stanislaw](https://github.com/stanislaw))
+- feat: Add validation for views [\#1629](https://github.com/strictdoc-project/strictdoc/pull/1629) ([dahbar](https://github.com/dahbar))
+- Bump version to 0.0.49a2 [\#1628](https://github.com/strictdoc-project/strictdoc/pull/1628) ([stanislaw](https://github.com/stanislaw))
+- export/html: render requirement's human titles in HTML [\#1627](https://github.com/strictdoc-project/strictdoc/pull/1627) ([stanislaw](https://github.com/stanislaw))
+- models: composite requirement: fix requirement\_prefix [\#1626](https://github.com/strictdoc-project/strictdoc/pull/1626) ([stanislaw](https://github.com/stanislaw))
+- Bump version to 0.0.49a1 [\#1625](https://github.com/strictdoc-project/strictdoc/pull/1625) ([stanislaw](https://github.com/stanislaw))
+- Requirements-to-source tracing: find all source files without exceptions [\#1624](https://github.com/strictdoc-project/strictdoc/pull/1624) ([stanislaw](https://github.com/stanislaw))
+- Bump version to 0.0.48 [\#1619](https://github.com/strictdoc-project/strictdoc/pull/1619) ([stanislaw](https://github.com/stanislaw))
+
+## [0.0.48](https://github.com/strictdoc-project/strictdoc/tree/0.0.48) (2024-01-24)
+
+[Full Changelog](https://github.com/strictdoc-project/strictdoc/compare/0.0.47...0.0.48)
+
+**Fixed bugs:**
+
+- BUG: UID: loss of graph integrity during Req editing [\#1587](https://github.com/strictdoc-project/strictdoc/issues/1587)
+- Standalone export: Ensure that no JS controls from the server are available [\#1529](https://github.com/strictdoc-project/strictdoc/issues/1529)
+- Recursive copying of the assets shall be limited to a known set of folders [\#1472](https://github.com/strictdoc-project/strictdoc/issues/1472)
+- Arrow is missing for the last requirement of a document in the requirements coverage page [\#1298](https://github.com/strictdoc-project/strictdoc/issues/1298)
+- Document file name/url with invisible symbols [\#774](https://github.com/strictdoc-project/strictdoc/issues/774)
+
+**Closed issues:**
+
+- Traceability Matrix Screen: Small CSS layout tweaks [\#1553](https://github.com/strictdoc-project/strictdoc/issues/1553)
+- UI: Search screen: Left-align the legend text to make it similar to the Diff screen [\#1534](https://github.com/strictdoc-project/strictdoc/issues/1534)
+-  Diff screen: Make CSS for section free text to always start a new line after its badge [\#1526](https://github.com/strictdoc-project/strictdoc/issues/1526)
+- Diff screen: the Changelog content doesn't take full width when there is no content to be displayed [\#1519](https://github.com/strictdoc-project/strictdoc/issues/1519)
+- Diff screen: When "collapse all", scroll to top [\#1517](https://github.com/strictdoc-project/strictdoc/issues/1517)
+- Diff screen: Analyze performance of "Find and read SDoc files" step [\#1511](https://github.com/strictdoc-project/strictdoc/issues/1511)
+- Diff/Changelog screen: Part 2: Stabilization and further extensions [\#1503](https://github.com/strictdoc-project/strictdoc/issues/1503)
+- UI: Diff: Add more explanatory text [\#1500](https://github.com/strictdoc-project/strictdoc/issues/1500)
+- UI: Diff: Remove extra dotted line artifact [\#1499](https://github.com/strictdoc-project/strictdoc/issues/1499)
+- Minor visual issue: Search screen: long validation error messages overlap with "Clear query" link [\#1490](https://github.com/strictdoc-project/strictdoc/issues/1490)
+- 2023-Q4: Ongoing requirements work [\#1410](https://github.com/strictdoc-project/strictdoc/issues/1410)
+- Export with grammar filter [\#1374](https://github.com/strictdoc-project/strictdoc/issues/1374)
+- UX: \(Make filters in toml available in UI\): Unintuitive path generation when creating a new document [\#1330](https://github.com/strictdoc-project/strictdoc/issues/1330)
+- 2023-Q4: Documentation train [\#1318](https://github.com/strictdoc-project/strictdoc/issues/1318)
+- DTR view: do not show TOC when there are no requirements [\#1156](https://github.com/strictdoc-project/strictdoc/issues/1156)
+- Fix node markup for REQUIREMENTS COVERAGE [\#1111](https://github.com/strictdoc-project/strictdoc/issues/1111)
+- Populating and auto-incrementing requirement UID automatically [\#1081](https://github.com/strictdoc-project/strictdoc/issues/1081)
+- Introduce an option to activate automatic assignment of Machine Identifiers \(MID\). [\#1053](https://github.com/strictdoc-project/strictdoc/issues/1053)
+- Relation between the Document Tree, Requirements Coverage and Source Coverage is confusing. [\#1037](https://github.com/strictdoc-project/strictdoc/issues/1037)
+- DTR: make parts of the requirements tree collapsible [\#1031](https://github.com/strictdoc-project/strictdoc/issues/1031)
+- UI: Turn FREE\_TEXT into Abstract [\#940](https://github.com/strictdoc-project/strictdoc/issues/940)
+- UI: Fix the "H11" issue [\#910](https://github.com/strictdoc-project/strictdoc/issues/910)
+- Decide on the names of the content fields [\#891](https://github.com/strictdoc-project/strictdoc/issues/891)
+- Feature: Exporting and importing requirement subsets of a document [\#601](https://github.com/strictdoc-project/strictdoc/issues/601)
+- Requirements coverage: Make the currently viewed parent requirements stick to the top [\#510](https://github.com/strictdoc-project/strictdoc/issues/510)
+- Display the switch even if there are no ranges [\#427](https://github.com/strictdoc-project/strictdoc/issues/427)
+- HTML2PDF: Export to PDF [\#369](https://github.com/strictdoc-project/strictdoc/issues/369)
+- Feature: Search on HTML pages and CLI [\#368](https://github.com/strictdoc-project/strictdoc/issues/368)
+- export/html: Scrolling indication using JS [\#216](https://github.com/strictdoc-project/strictdoc/issues/216)
 
 **Merged pull requests:**
 
+-  docs: minor additions for HTML2PDF and a basic docblock for Python API [\#1618](https://github.com/strictdoc-project/strictdoc/pull/1618) ([stanislaw](https://github.com/stanislaw))
+- feat: Add grammar for custom views [\#1617](https://github.com/strictdoc-project/strictdoc/pull/1617) ([dahbar](https://github.com/dahbar))
+-  docs: update Release Notes and Roadmap  [\#1616](https://github.com/strictdoc-project/strictdoc/pull/1616) ([stanislaw](https://github.com/stanislaw))
+- export/html: Requirements coverage -\> Traceability matrix \(last occurrences\) [\#1615](https://github.com/strictdoc-project/strictdoc/pull/1615) ([stanislaw](https://github.com/stanislaw))
+- docs: include source files from tests/\*\* [\#1614](https://github.com/strictdoc-project/strictdoc/pull/1614) ([stanislaw](https://github.com/stanislaw))
+- export/spdx: export SPDX to JSON-LD [\#1613](https://github.com/strictdoc-project/strictdoc/pull/1613) ([stanislaw](https://github.com/stanislaw))
+-  export/spdx: Document and Package: generate to SDoc with basic meta info  [\#1612](https://github.com/strictdoc-project/strictdoc/pull/1612) ([stanislaw](https://github.com/stanislaw))
+- export/spdx: use CC0 1.0 as data license, set 3.0.0 for spec version [\#1611](https://github.com/strictdoc-project/strictdoc/pull/1611) ([stanislaw](https://github.com/stanislaw))
+- export/spdx: meta-level SPDX SDoc tree links back to reqs as source files [\#1610](https://github.com/strictdoc-project/strictdoc/pull/1610) ([stanislaw](https://github.com/stanislaw))
+- reqs-to-source traceability: forward range-based file links [\#1609](https://github.com/strictdoc-project/strictdoc/pull/1609) ([stanislaw](https://github.com/stanislaw))
+- file\_traceability\_index: reorder methods to CRUD [\#1607](https://github.com/strictdoc-project/strictdoc/pull/1607) ([stanislaw](https://github.com/stanislaw))
+- file\_traceability\_index: annotate all data containers [\#1606](https://github.com/strictdoc-project/strictdoc/pull/1606) ([stanislaw](https://github.com/stanislaw))
+- export/spdx: view SPDX through SDoc \(basic skeleton\) [\#1605](https://github.com/strictdoc-project/strictdoc/pull/1605) ([stanislaw](https://github.com/stanislaw))
+- tests/integration: extract HTML2PDF tests to a separate group [\#1604](https://github.com/strictdoc-project/strictdoc/pull/1604) ([stanislaw](https://github.com/stanislaw))
+- PDF: fix the split of a long table with unusual properties. [\#1603](https://github.com/strictdoc-project/strictdoc/pull/1603) ([mettta](https://github.com/mettta))
+- export/html2pdf: further improvements for bulk export [\#1602](https://github.com/strictdoc-project/strictdoc/pull/1602) ([stanislaw](https://github.com/stanislaw))
+- html2pdf: add more debugging lines by using a custom HTTPClient for wdm [\#1599](https://github.com/strictdoc-project/strictdoc/pull/1599) ([stanislaw](https://github.com/stanislaw))
+- export/html: PDF: improve the empty document check [\#1598](https://github.com/strictdoc-project/strictdoc/pull/1598) ([stanislaw](https://github.com/stanislaw))
+- export/html: PDF: a temporary solution to detect the empty TOC [\#1597](https://github.com/strictdoc-project/strictdoc/pull/1597) ([mettta](https://github.com/mettta))
+- export/html2pdf: Update page breakers types in Config API and logic [\#1595](https://github.com/strictdoc-project/strictdoc/pull/1595) ([mettta](https://github.com/mettta))
+- export/html2pdf: update bundle and Config API [\#1594](https://github.com/strictdoc-project/strictdoc/pull/1594) ([mettta](https://github.com/mettta))
+- export/html2pdf: update to latest bundle [\#1593](https://github.com/strictdoc-project/strictdoc/pull/1593) ([stanislaw](https://github.com/stanislaw))
+- export/html2pdf: generate HTML and PDF together for easier inspection [\#1592](https://github.com/strictdoc-project/strictdoc/pull/1592) ([stanislaw](https://github.com/stanislaw))
+- server: implement "export to PDF" function in UI and CLI [\#1591](https://github.com/strictdoc-project/strictdoc/pull/1591) ([stanislaw](https://github.com/stanislaw))
+- server: create\_requirement: validate uniquess of UID field [\#1590](https://github.com/strictdoc-project/strictdoc/pull/1590) ([stanislaw](https://github.com/stanislaw))
+- export/spdx: remove all TBDs for now as creating noise [\#1586](https://github.com/strictdoc-project/strictdoc/pull/1586) ([stanislaw](https://github.com/stanislaw))
+- export/spdx: boilerplate for exporting SDoc tree to SPDX [\#1585](https://github.com/strictdoc-project/strictdoc/pull/1585) ([stanislaw](https://github.com/stanislaw))
+- Bump version to 0.0.48a2 [\#1584](https://github.com/strictdoc-project/strictdoc/pull/1584) ([stanislaw](https://github.com/stanislaw))
+- export/html: move toc node: add assert on whereto parameter [\#1583](https://github.com/strictdoc-project/strictdoc/pull/1583) ([mettta](https://github.com/mettta))
+- docs: connect more most obvious requirements with files [\#1582](https://github.com/strictdoc-project/strictdoc/pull/1582) ([stanislaw](https://github.com/stanislaw))
+- export/html: register JS file type, use TextLexer\(\) for unregistered formats [\#1581](https://github.com/strictdoc-project/strictdoc/pull/1581) ([stanislaw](https://github.com/stanislaw))
+- docs: move all "Backlog"-status requirements to Backlog [\#1580](https://github.com/strictdoc-project/strictdoc/pull/1580) ([stanislaw](https://github.com/stanislaw))
+- docs: link several remaining L2 requirements to L1, provide file links [\#1579](https://github.com/strictdoc-project/strictdoc/pull/1579) ([stanislaw](https://github.com/stanislaw))
+- docs: link several L2 requirements to L1, provide file links [\#1578](https://github.com/strictdoc-project/strictdoc/pull/1578) ([stanislaw](https://github.com/stanislaw))
+-  docs: add several most obvious req-file links \(2\)  [\#1577](https://github.com/strictdoc-project/strictdoc/pull/1577) ([stanislaw](https://github.com/stanislaw))
+-  docs: update project goals  [\#1576](https://github.com/strictdoc-project/strictdoc/pull/1576) ([stanislaw](https://github.com/stanislaw))
+-  docs: bring in all draft requirements  [\#1574](https://github.com/strictdoc-project/strictdoc/pull/1574) ([stanislaw](https://github.com/stanislaw))
+- drafts/requirements: parent link for SDOC-SRS-18 \(SDoc data model\) [\#1573](https://github.com/strictdoc-project/strictdoc/pull/1573) ([stanislaw](https://github.com/stanislaw))
+- traceability\_index: more precise update of links between documents [\#1572](https://github.com/strictdoc-project/strictdoc/pull/1572) ([stanislaw](https://github.com/stanislaw))
+- export: html2pdf: print publication date [\#1571](https://github.com/strictdoc-project/strictdoc/pull/1571) ([stanislaw](https://github.com/stanislaw))
+- docs: add the initial architecture diagram [\#1570](https://github.com/strictdoc-project/strictdoc/pull/1570) ([stanislaw](https://github.com/stanislaw))
+- traceability\_index: finalize the delete\_requirement\(\) method [\#1569](https://github.com/strictdoc-project/strictdoc/pull/1569) ([stanislaw](https://github.com/stanislaw))
+- export/html: improve traceability matrix table layout [\#1567](https://github.com/strictdoc-project/strictdoc/pull/1567) ([mettta](https://github.com/mettta))
+- UI: Scroll indication and targeting in TOC [\#1566](https://github.com/strictdoc-project/strictdoc/pull/1566) ([mettta](https://github.com/mettta))
+- docs: update Roadmap [\#1565](https://github.com/strictdoc-project/strictdoc/pull/1565) ([stanislaw](https://github.com/stanislaw))
+-  graph/many2many\_set: further improve handling of 1-1 and many-many links  [\#1561](https://github.com/strictdoc-project/strictdoc/pull/1561) ([stanislaw](https://github.com/stanislaw))
+- traceability\_index: improve handling of sections metadata [\#1560](https://github.com/strictdoc-project/strictdoc/pull/1560) ([stanislaw](https://github.com/stanislaw))
+- traceability\_index: move requirements links to the new database class [\#1559](https://github.com/strictdoc-project/strictdoc/pull/1559) ([stanislaw](https://github.com/stanislaw))
+- traceability\_index: move more links to the new database class [\#1558](https://github.com/strictdoc-project/strictdoc/pull/1558) ([stanislaw](https://github.com/stanislaw))
+- traceability\_index: database: simplify handling of sections, anchors and links [\#1557](https://github.com/strictdoc-project/strictdoc/pull/1557) ([stanislaw](https://github.com/stanislaw))
+- tests/end: move\_node: improve the stability of the test [\#1555](https://github.com/strictdoc-project/strictdoc/pull/1555) ([stanislaw](https://github.com/stanislaw))
+-  Code climate: traceability\_index: group methods by get, update, remove, validate [\#1554](https://github.com/strictdoc-project/strictdoc/pull/1554) ([stanislaw](https://github.com/stanislaw))
+- Mass-rename: Requirements Coverage -\> Traceability Matrix \(part 1\) [\#1552](https://github.com/strictdoc-project/strictdoc/pull/1552) ([stanislaw](https://github.com/stanislaw))
+-  docs: Machine identifiers \(MID\)  [\#1551](https://github.com/strictdoc-project/strictdoc/pull/1551) ([stanislaw](https://github.com/stanislaw))
+- export/html: Diff: display MIDs for requirements, sections, and documents [\#1550](https://github.com/strictdoc-project/strictdoc/pull/1550) ([stanislaw](https://github.com/stanislaw))
+- export/html: edit requirement: make MID field non-editable [\#1549](https://github.com/strictdoc-project/strictdoc/pull/1549) ([stanislaw](https://github.com/stanislaw))
+- Code climate: MID class: make it a proper subclass of str [\#1548](https://github.com/strictdoc-project/strictdoc/pull/1548) ([stanislaw](https://github.com/stanislaw))
+- export/html: requirement\_form\_object: simplify MID field factory method [\#1547](https://github.com/strictdoc-project/strictdoc/pull/1547) ([stanislaw](https://github.com/stanislaw))
+- export/html: requirement\_form\_object: simplify MID field factory method [\#1546](https://github.com/strictdoc-project/strictdoc/pull/1546) ([stanislaw](https://github.com/stanislaw))
+- export/html: create requirement: display and save MID [\#1545](https://github.com/strictdoc-project/strictdoc/pull/1545) ([stanislaw](https://github.com/stanislaw))
+- export/html: requirement template: display MID [\#1544](https://github.com/strictdoc-project/strictdoc/pull/1544) ([stanislaw](https://github.com/stanislaw))
+- main\_router: move\_node: adjust to recent MID change [\#1542](https://github.com/strictdoc-project/strictdoc/pull/1542) ([stanislaw](https://github.com/stanislaw))
+- Bump version to 0.0.48a1 [\#1540](https://github.com/strictdoc-project/strictdoc/pull/1540) ([stanislaw](https://github.com/stanislaw))
+- export/html: Diff: update JS, simplifying skeleton [\#1536](https://github.com/strictdoc-project/strictdoc/pull/1536) ([mettta](https://github.com/mettta))
+- export/html: Diff/Search: improve markup/CSS [\#1535](https://github.com/strictdoc-project/strictdoc/pull/1535) ([mettta](https://github.com/mettta))
+- export/html: fix scroll for diff columns [\#1533](https://github.com/strictdoc-project/strictdoc/pull/1533) ([mettta](https://github.com/mettta))
+- export/html: fix scroll for table\_key\_value [\#1532](https://github.com/strictdoc-project/strictdoc/pull/1532) ([mettta](https://github.com/mettta))
+- export/html: Requirements Coverage -\> Traceability Matrix [\#1531](https://github.com/strictdoc-project/strictdoc/pull/1531) ([mettta](https://github.com/mettta))
+- export/html: fixes in DIFF and Static HTML export [\#1530](https://github.com/strictdoc-project/strictdoc/pull/1530) ([mettta](https://github.com/mettta))
+- export/html: Diff/Search: improve CSS layout, add nav tabs template [\#1528](https://github.com/strictdoc-project/strictdoc/pull/1528) ([mettta](https://github.com/mettta))
+-  export/html: DIFF: improve matching of sections and document UID, write more tests [\#1527](https://github.com/strictdoc-project/strictdoc/pull/1527) ([stanislaw](https://github.com/stanislaw))
+-  export/html: DIFF: improve matching of comments  [\#1525](https://github.com/strictdoc-project/strictdoc/pull/1525) ([stanislaw](https://github.com/stanislaw))
+- export/html: DIFF: update Changelog content view [\#1524](https://github.com/strictdoc-project/strictdoc/pull/1524) ([mettta](https://github.com/mettta))
+- export/html: DIFF: add a legend to explain the most basic query rules [\#1523](https://github.com/strictdoc-project/strictdoc/pull/1523) ([stanislaw](https://github.com/stanislaw))
+- file\_tree: improve file finding filter [\#1521](https://github.com/strictdoc-project/strictdoc/pull/1521) ([stanislaw](https://github.com/stanislaw))
+- Diff screen: Introduce the second tab with Changelog screen [\#1520](https://github.com/strictdoc-project/strictdoc/pull/1520) ([stanislaw](https://github.com/stanislaw))
+- export/html: DIFF: make the JS script not a module, to work in a static export [\#1516](https://github.com/strictdoc-project/strictdoc/pull/1516) ([mettta](https://github.com/mettta))
+- Code climate: remove the second favicon.ico [\#1515](https://github.com/strictdoc-project/strictdoc/pull/1515) ([stanislaw](https://github.com/stanislaw))
+- drafts/requirements: generate MID identifiers for all nodes [\#1514](https://github.com/strictdoc-project/strictdoc/pull/1514) ([stanislaw](https://github.com/stanislaw))
+- backend/sdoc: Requirement, Section, Document: add MID field to grammar [\#1513](https://github.com/strictdoc-project/strictdoc/pull/1513) ([stanislaw](https://github.com/stanislaw))
+- export/html: fix the REQUIREMENT's field name CSS \(to not break words apart\) [\#1506](https://github.com/strictdoc-project/strictdoc/pull/1506) ([stanislaw](https://github.com/stanislaw))
+- docs: update the roadmap diagram [\#1505](https://github.com/strictdoc-project/strictdoc/pull/1505) ([stanislaw](https://github.com/stanislaw))
+-  document\_meta: also store input doc relative path and the doc file name  [\#1501](https://github.com/strictdoc-project/strictdoc/pull/1501) ([stanislaw](https://github.com/stanislaw))
+- export/html: DIFF: package Section changes in a dedicated SectionChange class [\#1498](https://github.com/strictdoc-project/strictdoc/pull/1498) ([stanislaw](https://github.com/stanislaw))
+- export/html: DIFF: improve preloader [\#1497](https://github.com/strictdoc-project/strictdoc/pull/1497) ([mettta](https://github.com/mettta))
+- export/html: DIFF: add skeleton preloader [\#1496](https://github.com/strictdoc-project/strictdoc/pull/1496) ([mettta](https://github.com/mettta))
+- export/html: update form messages markup [\#1494](https://github.com/strictdoc-project/strictdoc/pull/1494) ([mettta](https://github.com/mettta))
+- export/html: DIFF: match requirements without UID, with the same title/statement/rationale [\#1493](https://github.com/strictdoc-project/strictdoc/pull/1493) ([stanislaw](https://github.com/stanislaw))
+- server: /diff endpoint: fix the lhs vs rhs calculation of git trees [\#1492](https://github.com/strictdoc-project/strictdoc/pull/1492) ([stanislaw](https://github.com/stanislaw))
+- export/html: DIFF: synchronize display of right and left fragment [\#1491](https://github.com/strictdoc-project/strictdoc/pull/1491) ([mettta](https://github.com/mettta))
+- project\_statistics: calculate total sections [\#1489](https://github.com/strictdoc-project/strictdoc/pull/1489) ([stanislaw](https://github.com/stanislaw))
+- project\_statistics: calculate sections without any free text, add relevant query [\#1488](https://github.com/strictdoc-project/strictdoc/pull/1488) ([stanislaw](https://github.com/stanislaw))
+- drafts/requirements: L1: Summary of user needs, more section texts [\#1487](https://github.com/strictdoc-project/strictdoc/pull/1487) ([stanislaw](https://github.com/stanislaw))
+- UI: Diff Screen to review changes between document trees [\#1485](https://github.com/strictdoc-project/strictdoc/pull/1485) ([stanislaw](https://github.com/stanislaw))
+- export/html: relax update\_requirement by only regenerating the updated document itself [\#1484](https://github.com/strictdoc-project/strictdoc/pull/1484) ([stanislaw](https://github.com/stanislaw))
+- export/html2pdf: project config option for custom document template [\#1483](https://github.com/strictdoc-project/strictdoc/pull/1483) ([stanislaw](https://github.com/stanislaw))
+-  docs: update "Security considerations"  [\#1482](https://github.com/strictdoc-project/strictdoc/pull/1482) ([stanislaw](https://github.com/stanislaw))
+- UI: Create Document validations: document path is not white-/blacklisted in the config [\#1481](https://github.com/strictdoc-project/strictdoc/pull/1481) ([stanislaw](https://github.com/stanislaw))
+- docs: release notes fix [\#1480](https://github.com/strictdoc-project/strictdoc/pull/1480) ([stanislaw](https://github.com/stanislaw))
+- export/html: file traceability: add RST lexer [\#1479](https://github.com/strictdoc-project/strictdoc/pull/1479) ([stanislaw](https://github.com/stanislaw))
+- Regenerate automatic CHANGELOG [\#1478](https://github.com/strictdoc-project/strictdoc/pull/1478) ([stanislaw](https://github.com/stanislaw))
 - Bump version to 0.0.47 [\#1477](https://github.com/strictdoc-project/strictdoc/pull/1477) ([stanislaw](https://github.com/stanislaw))
 
 ## [0.0.47](https://github.com/strictdoc-project/strictdoc/tree/0.0.47) (2023-11-20)
@@ -138,7 +316,7 @@
 - Path not found: replace assert with proper error handling [\#1291](https://github.com/strictdoc-project/strictdoc/issues/1291)
 - backend/sdoc: support Child links [\#1279](https://github.com/strictdoc-project/strictdoc/issues/1279)
 - UI: Editing grammar: ensure that all requirements can be mass-updated when the fields order is changed [\#1225](https://github.com/strictdoc-project/strictdoc/issues/1225)
-- Documentation train 2023-Q3 [\#1209](https://github.com/strictdoc-project/strictdoc/issues/1209)
+- 2023-Q3: Documentation train [\#1209](https://github.com/strictdoc-project/strictdoc/issues/1209)
 - Feature: Project statistics / progress report screen [\#1132](https://github.com/strictdoc-project/strictdoc/issues/1132)
 - Ensure a convention for the custom fields: single-line fields above, multiline fields below [\#948](https://github.com/strictdoc-project/strictdoc/issues/948)
 - UI: Make all text fields have a button "copy to buffer" [\#913](https://github.com/strictdoc-project/strictdoc/issues/913)
@@ -197,7 +375,7 @@
 - Unable to reference .cc files [\#1199](https://github.com/strictdoc-project/strictdoc/issues/1199)
 - Double-check if we want to allow RST quote blocks starting free text blocks [\#1148](https://github.com/strictdoc-project/strictdoc/issues/1148)
 - Investigate: test 'export tree to reqif' \(sometimes\) fails on Windows [\#1100](https://github.com/strictdoc-project/strictdoc/issues/1100)
-- Documentation train 2023-Q2 [\#1074](https://github.com/strictdoc-project/strictdoc/issues/1074)
+- 2023-Q2: Documentation train [\#1074](https://github.com/strictdoc-project/strictdoc/issues/1074)
 - UI: Section: Incoming/outgoing links [\#1045](https://github.com/strictdoc-project/strictdoc/issues/1045)
 - Document TOC tree: minor UI issue: difference in offset of Section and Requirement [\#1013](https://github.com/strictdoc-project/strictdoc/issues/1013)
 - Missing documentation for inline links [\#725](https://github.com/strictdoc-project/strictdoc/issues/725)

{strictdoc-0.0.49a5 → strictdoc-0.0.49a6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: strictdoc
-Version: 0.0.49a5
+Version: 0.0.49a6
 Summary: StrictDoc is open-source software for technical documentation and requirements management.
 Project-URL: Changelog, https://github.com/strictdoc-project/strictdoc/blob/main/CHANGELOG.md
 Project-URL: Homepage, https://strictdoc.readthedocs.io/en/stable/

{strictdoc-0.0.49a5 → strictdoc-0.0.49a6}/ruff.toml

@@ -1,6 +1,7 @@
 target-version = "py37"
 line-length = 80
 
+[lint]
 select = [
   "A",
   "ARG",
@@ -44,7 +45,6 @@ select = [
   "YTT",
 ]
 
-
 ignore = [
     # TBD: Unnecessary `list` comprehension (rewrite using `list()`)
     "C416",
@@ -88,7 +88,8 @@ ignore = [
 # Avoid trying to fix flake8-bugbear (`B`) violations.
 unfixable = ["B"]
 
-[per-file-ignores]
 # B008 Do not perform function calls in argument defaults.
 # The call is performed only once at function definition time.
+
+[lint.per-file-ignores]
 "strictdoc/server/routers/main_router.py" = ["B008"]

{strictdoc-0.0.49a5 → strictdoc-0.0.49a6}/strictdoc/__init__.py

@@ -1,6 +1,6 @@
 from strictdoc.core.environment import SDocRuntimeEnvironment
 
-__version__ = "0.0.49a5"
+__version__ = "0.0.49a6"
 
 
 environment = SDocRuntimeEnvironment(__file__)

{strictdoc-0.0.49a5 → strictdoc-0.0.49a6}/strictdoc/backend/excel/export/excel_generator.py

@@ -6,13 +6,13 @@ import xlsxwriter
 from xlsxwriter.workbook import Workbook
 from xlsxwriter.worksheet import Worksheet
 
-from strictdoc.backend.sdoc.models.document import Document
+from strictdoc.backend.sdoc.models.document import SDocDocument
+from strictdoc.backend.sdoc.models.node import SDocNode
 from strictdoc.backend.sdoc.models.reference import (
     BibReference,
     FileReference,
     ParentReqReference,
 )
-from strictdoc.backend.sdoc.models.requirement import Requirement
 from strictdoc.backend.sdoc.models.type_system import ReferenceType
 from strictdoc.core.project_config import ProjectConfig
 from strictdoc.core.traceability_index import TraceabilityIndex
@@ -44,7 +44,7 @@ class ExcelGenerator:
     ):
         Path(output_excel_root).mkdir(parents=True, exist_ok=True)
 
-        document: Document
+        document: SDocDocument
         for document in traceability_index.document_tree.document_list:
             document_out_file_name = (
                 f"{document.meta.document_filename_base}.xlsx"
@@ -59,7 +59,7 @@ class ExcelGenerator:
 
     @staticmethod
     def _export_single_document(
-        document: Document,
+        document: SDocDocument,
         traceability_index,
         document_out_file,
         project_config: ProjectConfig,
@@ -223,7 +223,7 @@ class ExcelGenerator:
         row = 1
 
         for content_node in document_contents:
-            if isinstance(content_node, Requirement):
+            if isinstance(content_node, SDocNode):
                 if content_node.reserved_uid:
                     # only export the requirements with uid, allowing tracking
                     row += 1

{strictdoc-0.0.49a5 → strictdoc-0.0.49a6}/strictdoc/backend/excel/import_/excel_to_sdoc_converter.py

@@ -3,18 +3,15 @@ from typing import List, NamedTuple, Optional, Tuple
 
 import xlrd
 
-from strictdoc.backend.sdoc.models.document import Document
+from strictdoc.backend.sdoc.models.document import SDocDocument
 from strictdoc.backend.sdoc.models.document_config import DocumentConfig
 from strictdoc.backend.sdoc.models.document_grammar import (
     DocumentGrammar,
     GrammarElement,
 )
+from strictdoc.backend.sdoc.models.node import SDocNode, SDocNodeField
 from strictdoc.backend.sdoc.models.object_factory import SDocObjectFactory
 from strictdoc.backend.sdoc.models.reference import ParentReqReference
-from strictdoc.backend.sdoc.models.requirement import (
-    Requirement,
-    RequirementField,
-)
 from strictdoc.backend.sdoc.models.type_system import GrammarElementFieldString
 
 
@@ -44,7 +41,7 @@ def safe_name(dangerous_name):
 class ExcelToSDocConverter:
     @staticmethod
     # optional argument title is present for external scripts to assign a title
-    def convert(excel_file, title=None) -> Document:
+    def convert(excel_file, title=None) -> SDocDocument:
         excel_workbook = xlrd.open_workbook(filename=excel_file, on_demand=True)
         xlrd_sheet: xlrd.sheet.Sheet = excel_workbook.sheet_by_index(0)
 
@@ -117,10 +114,12 @@ class ExcelToSDocConverter:
         return document
 
     @staticmethod
-    def create_document(title: Optional[str], extra_header_pairs) -> Document:
+    def create_document(
+        title: Optional[str], extra_header_pairs
+    ) -> SDocDocument:
         document_config = DocumentConfig.default_config(None)
         document_title = title if title else "<No title>"
-        document = Document(
+        document = SDocDocument(
             None, document_title, document_config, None, None, None, [], []
         )
 
@@ -191,7 +190,7 @@ class ExcelToSDocConverter:
             value = row_values[i].strip()
             if value != "":
                 template_requirement.ordered_fields_lookup[name] = [
-                    RequirementField(
+                    SDocNodeField(
                         parent=None,
                         field_name=name,
                         field_value=None,
@@ -204,7 +203,7 @@ class ExcelToSDocConverter:
                 template_requirement, parent_uid, role=None
             )
 
-            requirement_field = RequirementField(
+            requirement_field = SDocNodeField(
                 parent=template_requirement,
                 field_name="REFS",
                 field_value=None,
@@ -214,7 +213,7 @@ class ExcelToSDocConverter:
             template_requirement.ordered_fields_lookup["REFS"] = [
                 requirement_field
             ]
-        requirement = Requirement(
+        requirement = SDocNode(
             parent=template_requirement.parent,
             requirement_type=template_requirement.requirement_type,
             mid=None,

{strictdoc-0.0.49a5 → strictdoc-0.0.49a6}/strictdoc/backend/reqif/p01_sdoc/reqif_to_sdoc_converter.py

@@ -16,19 +16,16 @@ from strictdoc.backend.reqif.sdoc_reqif_fields import (
     ReqIFChapterField,
     ReqIFRequirementReservedField,
 )
-from strictdoc.backend.sdoc.models.document import Document
+from strictdoc.backend.sdoc.models.document import SDocDocument
 from strictdoc.backend.sdoc.models.document_config import DocumentConfig
 from strictdoc.backend.sdoc.models.document_grammar import (
     DocumentGrammar,
     GrammarElement,
 )
 from strictdoc.backend.sdoc.models.free_text import FreeText
+from strictdoc.backend.sdoc.models.node import SDocNode, SDocNodeField
 from strictdoc.backend.sdoc.models.reference import ParentReqReference
-from strictdoc.backend.sdoc.models.requirement import (
-    Requirement,
-    RequirementField,
-)
-from strictdoc.backend.sdoc.models.section import Section
+from strictdoc.backend.sdoc.models.section import SDocSection
 from strictdoc.backend.sdoc.models.type_system import (
     GrammarElementFieldMultipleChoice,
     GrammarElementFieldSingleChoice,
@@ -39,7 +36,7 @@ from strictdoc.helpers.string import unescape
 
 class P01_ReqIFToSDocConverter:  # pylint: disable=invalid-name
     @staticmethod
-    def convert_reqif_bundle(reqif_bundle: ReqIFBundle) -> List[Document]:
+    def convert_reqif_bundle(reqif_bundle: ReqIFBundle) -> List[SDocDocument]:
         # TODO: Should we rather show an error that there are no specifications?
         if (
             reqif_bundle.core_content is None
@@ -48,7 +45,7 @@ class P01_ReqIFToSDocConverter:  # pylint: disable=invalid-name
         ):
             return [P01_ReqIFToSDocConverter.create_document(title=None)]
 
-        documents: List[Document] = []
+        documents: List[SDocDocument] = []
         for (
             specification
         ) in reqif_bundle.core_content.req_if_content.specifications:
@@ -70,9 +67,9 @@ class P01_ReqIFToSDocConverter:  # pylint: disable=invalid-name
         spec_object_type = reqif_bundle.lookup.get_spec_type_by_ref(
             spec_object.spec_object_type
         )
-        attribute_map: Dict[
-            str, SpecAttributeDefinition
-        ] = spec_object_type.attribute_map
+        attribute_map: Dict[str, SpecAttributeDefinition] = (
+            spec_object_type.attribute_map
+        )
         for attribute in spec_object.attributes:
             long_name_or_none: Optional[str] = attribute_map[
                 attribute.definition_ref
@@ -128,8 +125,8 @@ class P01_ReqIFToSDocConverter:  # pylint: disable=invalid-name
                     for _ in range(
                         0, current_section.ng_level - current_hierarchy.level
                     ):
-                        assert not isinstance(current_section, Document)
-                        if isinstance(current_section, Section):
+                        assert not isinstance(current_section, SDocDocument)
+                        if isinstance(current_section, SDocSection):
                             current_section = current_section.parent
                     current_section.section_contents.append(section)
                 else:
@@ -137,7 +134,7 @@ class P01_ReqIFToSDocConverter:  # pylint: disable=invalid-name
             elif P01_ReqIFToSDocConverter.is_spec_object_requirement(
                 spec_object
             ):
-                requirement: Requirement = P01_ReqIFToSDocConverter.create_requirement_from_spec_object(
+                requirement: SDocNode = P01_ReqIFToSDocConverter.create_requirement_from_spec_object(
                     spec_object=spec_object,
                     parent_section=current_section,
                     reqif_bundle=reqif_bundle,
@@ -150,7 +147,7 @@ class P01_ReqIFToSDocConverter:  # pylint: disable=invalid-name
         # See SDOC_IMPL_1.
         if (
             len(document.section_contents) > 0
-            and isinstance(document.section_contents[0], Section)
+            and isinstance(document.section_contents[0], SDocSection)
             and document.section_contents[0].title == "Abstract"
         ):
             assert len(document.section_contents[0].free_texts)
@@ -158,10 +155,10 @@ class P01_ReqIFToSDocConverter:  # pylint: disable=invalid-name
             document.section_contents.pop(0)
 
         for used_spec_object_type_id in used_spec_object_types_ids:
-            spec_object_type_or_none: Optional[
-                ReqIFSpecObjectType
-            ] = reqif_bundle.get_spec_object_type_by_ref(
-                ref=used_spec_object_type_id,
+            spec_object_type_or_none: Optional[ReqIFSpecObjectType] = (
+                reqif_bundle.get_spec_object_type_by_ref(
+                    ref=used_spec_object_type_id,
+                )
             )
             assert (
                 spec_object_type_or_none is not None
@@ -259,10 +256,10 @@ class P01_ReqIFToSDocConverter:  # pylint: disable=invalid-name
         return requirement_element
 
     @staticmethod
-    def create_document(title: Optional[str]) -> Document:
+    def create_document(title: Optional[str]) -> SDocDocument:
         document_config = DocumentConfig.default_config(None)
         document_title = title if title else "<No title>"
-        document = Document(
+        document = SDocDocument(
             None, document_title, document_config, None, None, None, [], []
         )
         document.grammar = DocumentGrammar.create_default(document)
@@ -273,13 +270,13 @@ class P01_ReqIFToSDocConverter:  # pylint: disable=invalid-name
     @staticmethod
     def create_section_from_spec_object(
         spec_object: ReqIFSpecObject, level, reqif_bundle: ReqIFBundle
-    ) -> Section:
+    ) -> SDocSection:
         spec_object_type = reqif_bundle.lookup.get_spec_type_by_ref(
             spec_object.spec_object_type
         )
-        attribute_map: Dict[
-            str, SpecAttributeDefinition
-        ] = spec_object_type.attribute_map
+        attribute_map: Dict[str, SpecAttributeDefinition] = (
+            spec_object_type.attribute_map
+        )
         assert attribute_map is not None
         for attribute in spec_object.attributes:
             field_name_or_none: Optional[str] = attribute_map[
@@ -312,7 +309,7 @@ class P01_ReqIFToSDocConverter:  # pylint: disable=invalid-name
         #                 Some value
         #               </THE-VALUE>
         section_title = section_title.strip().replace("\n", " ")
-        section = Section(
+        section = SDocSection(
             parent=None,
             mid=None,
             uid=None,
@@ -328,17 +325,17 @@ class P01_ReqIFToSDocConverter:  # pylint: disable=invalid-name
     @staticmethod
     def create_requirement_from_spec_object(
         spec_object: ReqIFSpecObject,
-        parent_section: Union[Section, Document],
+        parent_section: Union[SDocSection, SDocDocument],
         reqif_bundle: ReqIFBundle,
         level,
-    ) -> Requirement:
+    ) -> SDocNode:
         fields = []
         spec_object_type = reqif_bundle.lookup.get_spec_type_by_ref(
             spec_object.spec_object_type
         )
-        attribute_map: Dict[
-            str, SpecAttributeDefinition
-        ] = spec_object_type.attribute_map
+        attribute_map: Dict[str, SpecAttributeDefinition] = (
+            spec_object_type.attribute_map
+        )
 
         foreign_key_id_or_none: Optional[str] = None
         for attribute in spec_object.attributes:
@@ -382,7 +379,7 @@ class P01_ReqIFToSDocConverter:  # pylint: disable=invalid-name
 
                 enum_values = ", ".join(enum_values_resolved)
                 fields.append(
-                    RequirementField(
+                    SDocNodeField(
                         parent=None,
                         field_name=sdoc_field_name,
                         field_value=enum_values,
@@ -410,7 +407,7 @@ class P01_ReqIFToSDocConverter:  # pylint: disable=invalid-name
                 )
             )
             fields.append(
-                RequirementField(
+                SDocNodeField(
                     parent=None,
                     field_name=sdoc_field_name,
                     field_value=attribute_value,
@@ -418,7 +415,7 @@ class P01_ReqIFToSDocConverter:  # pylint: disable=invalid-name
                     field_value_references=None,
                 )
             )
-        requirement = Requirement(
+        requirement = SDocNode(
             parent=parent_section,
             requirement_type="REQUIREMENT",
             mid=None,
@@ -450,7 +447,7 @@ class P01_ReqIFToSDocConverter:  # pylint: disable=invalid-name
                     )
                 )
             if len(parent_refs) > 0:
-                requirement_field = RequirementField(
+                requirement_field = SDocNodeField(
                     parent=requirement,
                     field_name="REFS",
                     field_value=None,