Improvements to the Composable Documents feature, HTML2PDF UTF8 support on Windows

What's Changed

• Bump version to 0.0.53 by @stanislaw in #1753
• export/html: update CSS for project tree on the document page by @mettta in #1754
• Project Diff/Changelog: do not display included documents by @stanislaw in #1758
• Project Diff/Changelog: Ignore changes in included grammars for now by @stanislaw in #1760
• Document finder: filter out the asset folders based on the included/excluded search paths by @stanislaw in #1761
• export/html: collapsible_toc.js : Store the TOC state for each node by @mettta in #1762
• Source files finder: source_root_path shall be input path when not specified explicitly by @stanislaw in #1763
• HTML2PDF: minor changes and tests for UTF8 support on Windows by @stanislaw in #1767
• UI: Composable documents: fix writing back SDoc file with included grammars by @stanislaw in #1768
• SDoc: SDWriter: refactor to a more simple recursive algorithm by @stanislaw in #1769
• UI: Composable documents: Allow editing root node of included document by @stanislaw in #1771
• Bump version to 0.0.54a1 by @stanislaw in #1772
• document_from_file: fix the resolution of parent Document or Section nodes by @stanislaw in #1775

Full Changelog: 0.0.53...0.0.54

The JSON export: Support composable documents

What's Changed

• Bump version to 0.0.52 by @stanislaw in #1738
• export/html: collapsible_tree.js: double-click only affects current and child folders by @mettta in #1739
• export/json: handle more corner cases: nodes without levels, included documents by @stanislaw in #1740
• document_iterator: refactor the iteration algorithm by @stanislaw in #1742
• Code climate: improve a grammar form object class name by @stanislaw in #1743
• Remove all BibTeX bibliography-related code and pybtex dependency by @stanislaw in #1744
• docs: update requirements (ZEP, data integrity, fix all missing statuses, a few rationales) by @stanislaw in #1745
• export/json: do not export included documents by default by @stanislaw in #1746
• docs: document less portable features by @stanislaw in #1747
• export/html: update 'legend' markup on search/git screens by @mettta in #1748
• export/html: add zoomable.js: to zoom and move DTR screen by @mettta in #1741
• export/json: fix and simplify the iteration algorithm one more time by @stanislaw in #1749
• docs: update Roadmap by @stanislaw in #1751
• Code climate: CompositeRequirement -> SDocCompositeNode by @stanislaw in #1750

Full Changelog: 0.0.52...0.0.53

Grammar from File feature

What's Changed

• Bump version to 0.0.51 by @stanislaw in #1717
• Regenerate CHANGELOG by @stanislaw in #1718
• Fix a crash when following the user guide. by @MartyLake in #1720
• export/html: draggable_list_controller.js: Send a request to the server only if the object actually changes position by @mettta in #1722
• export/html: project_index: add dashboard; enable the option to hide/show fragments by @mettta in #1719
• docs: regenerate Read the Docs by @stanislaw in #1726
• export/html: Display the node type (requirement and custom) in the document view by @stanislaw in #1727
• export/html: introduce "Website" layout folder by @stanislaw in #1730
• backend/sdoc: including Grammars from grammar files *.sgra by @stanislaw in #1732
• backend/sdoc: read/write LAYOUT option by @stanislaw in #1731
• UI: Edit grammar form: block when a grammar is imported from file by @stanislaw in #1734
• tests/end2end/project_index: show_hide_included_documents by @mettta in #1735
• UI: Source coverage screen: Migrate to new markup by @mettta in #1736
• docs: regenerate Read the Docs by @stanislaw in #1737

New Contributors

• @MartyLake made their first contribution in #1720

Full Changelog: 0.0.51...0.0.52

Bugfix release: fix a regression on the Search screen related to finding requirements and sections

What's Changed

• export/html: Update project tree markup by @mettta in #1715
• UI: Search screen: fix the case when finding requirements/sections by @stanislaw in #1716

Full Changelog: 0.0.50...0.0.51

Ground work for composable documents, fix for running HTML2PDF on Windows, some CSS styles for RST

What's Changed

• Bump version to 0.0.49 by @stanislaw in #1700
• html2pdf: fix the issue of running within virtual environments by @stanislaw in #1702
• Migration from Fragments to includable Documents by @stanislaw in #1703
• backend/sdoc: remove last occurrences of Fragment, document the change by @stanislaw in #1704
• export/html: show the "included documents" only when there are included docs by @stanislaw in #1705
• UI: Diff screen: do not build source file traceability when doing history by @stanislaw in #1708
• docs: FAQ: resources: FOSDEM 2024 by @stanislaw in #1710
• export/html: project_index: Show fragments by default, disable switcher, add info about including file by @mettta in #1711
• Styles: add CSS for RST admonition markup by @mettta in #1712

Full Changelog: 0.0.49...0.0.50

What's Changed

• Bump version to 0.0.49 by @stanislaw in #1700
• html2pdf: fix the issue of running within virtual environments by @stanislaw in #1702
• Migration from Fragments to includable Documents by @stanislaw in #1703
• backend/sdoc: remove last occurrences of Fragment, document the change by @stanislaw in #1704
• export/html: show the "included documents" only when there are included docs by @stanislaw in #1705
• UI: Diff screen: do not build source file traceability when doing history by @stanislaw in #1708
• docs: FAQ: resources: FOSDEM 2024 by @stanislaw in #1710
• export/html: project_index: Show fragments by default, disable switcher, add info about including file by @mettta in #1711
• Styles: add CSS for RST admonition markup by @mettta in #1712
• Bump version to 0.0.50 by @stanislaw in #1713
• docs: regenerate Read the Docs by @stanislaw in #1714

Full Changelog: 0.0.49...0.0.50

Editing arbitrary nodes in UI, basic JSON export, HTML2PDF improvements

What's Changed

• Bump version to 0.0.48 by @stanislaw in #1619
• Requirements-to-source tracing: find all source files without exceptions by @stanislaw in #1624
• Bump version to 0.0.49a1 by @stanislaw in #1625
• models: composite requirement: fix requirement_prefix by @stanislaw in #1626
• export/html: render requirement's human titles in HTML by @stanislaw in #1627
• feat: Add validation for views by @dahbar in #1629
• Bump version to 0.0.49a2 by @stanislaw in #1628
• models: requirement: preserve REFS when setting a field by @stanislaw in #1631
• Bump version to 0.0.49a3 by @stanislaw in #1632
• fix: Validation for views and proper tests by @dahbar in #1634
• tests/integration: move several feature-related groups to features/ by @stanislaw in #1635
• fix: Review changes by @dahbar in #1641
• export/html: implement --view option by @stanislaw in #1638
• export/html2pdf: improved printing of tables (Firefox edge case) by @mettta in #1637
• export/html2pdf: customize webdriver cache manager to allow offline use by @stanislaw in #1642
• export/excel: allow generating Excel files for inter-document relations by @stanislaw in #1643
• export/excel: link Excel export requirement to source files by @stanislaw in #1644
• server: main_router: treat everything "not .html" as assets by @stanislaw in #1645
• tests/end2end: test opening a hyperlink to an CSV asset by @stanislaw in #1646
• Regenerate CHANGELOG by @stanislaw in #1647
• html2pdf: update bundle.js: Add preprocessing by @mettta in #1648
• html2pdf: update bundle.js: Fix 'block overruns the page bottom' by @mettta in #1649
• Refactoring: Node -> SDocObject by @stanislaw in #1650
• Refactoring: requirement.py -> node.py by @stanislaw in #1651
• Refactoring: rename three helper classes from Requirement* -> Node* by @stanislaw in #1652
• Refactoring: Requirement -> SDocNode by @stanislaw in #1653
• Refactoring: Section -> SDocSection by @stanislaw in #1654
• Refactoring: Document -> SDocDocument by @stanislaw in #1655
• html2pdf: update bundle.js: Add options to manually invoke or automatically run the script by @mettta in #1656
• export/html: introduce view_objects to encapsulate Jinja templates data by @stanislaw in #1657
• html2pdf: update bundle.js: Paragraph: split nested inline elements by @mettta in #1660
• export/html: node_controls: Updating the layout and icons for the "Add node" menu by @mettta in #1663
• Refactoring: DocumentGrammarFormObject -> GrammarElementFormObject, move more logic from Jinja to Python by @stanislaw in #1662
• Some style enhancements by @mettta in #1664
• export/html: Preparing the menu structure for adding new node types by @mettta in #1665
• server: creating grammar elements and arbitrary nodes by @stanislaw in #1666
• export/json: basic JSON export by @stanislaw in #1667
• export/dot: disable requirement links by @stanislaw in #1668
• feat: Make the document grammar editable with respect to human titles by @dahbar in #1669
• screens/diff: improve the legend with "HEAD vs HEAD+" by @stanislaw in #1671
• docs: SDoc grammar DOCUMENT fields: add REQ_PREFIX by @stanislaw in #1672
• docs: add a note about not detecting .sdoc files in the output/ folder by @stanislaw in #1673
• Code climate: update to new Ruff settings by @stanislaw in #1676
• server: requirement_form_object: adapt to custom elements in the last places by @stanislaw in #1675
• server: several validation messages: requirement -> node by @stanislaw in #1678
• export/dot: minor improvements to the layout by @stanislaw in #1679
• export/html: highlight current document by @stanislaw in #1680
• export/html: improve the edit grammar form by @mettta in #1681
• Bump version to 0.0.49a6 by @stanislaw in #1682
• export/html: Use self-hosting fonts by @mettta in #1684
• export/html: define the copy_to_clipboard in expandable node components by @mettta in #1685
• export/html: make collapsible_list.js based on MutationObserver by @mettta in #1686
• export/html: update form error styles for fields and field groups (driven by HUMAN_TITLE) by @stanislaw in #1689
• Bump version to 0.0.49a7 by @stanislaw in #1690
• docs: update Roadmap by @stanislaw in #1693
• backend/sdoc: resolve relative paths to full paths when importing fragments by @stanislaw in #1695
• backend/sdoc: rework the parsing algorithm for fragments by @stanislaw in #1696
• backend/sdoc: writing fragments back to files by @stanislaw in #1697
• backend/sdoc: writing fragments back to files by @stanislaw in #1699

Full Changelog: 0.0.48...0.0.49

Search screen, query engine and several UI improvements

See the changelogs:

• High-level release notes: https://strictdoc.readthedocs.io/en/stable/strictdoc_04_changelog.html
• Auto-generated changelog, commit-per-commit: https://github.com/strictdoc-project/strictdoc/blob/main/CHANGELOG.md

Hotfix release: Fix how the anchors are displayed

What's Changed

• Bump version to 0.0.45 by @stanislaw in #1361
• export/html: adding the ability to clone a requirement by @mettta in #1364
• export/html: Add restriction to show anchors only for sections with UIDs by @mettta in #1365

Full Changelog: 0.0.45...0.0.46

Full Changelog: 0.0.45...0.0.46

Requirement relations and roles, UI improvements (requirement and grammar tabs)

What's Changed

• drafts/requirements: L2 and L3: refine more requirements (SDoc format, Excel, open source, links) by @stanislaw in #1276
• backend/sdoc, export/html: support child / reverse parent links by @stanislaw in #1280
• export/html: do not precompile Jinja templates if a project is too small by @stanislaw in #1281
• server: introduce 200/304 handling of assets by @stanislaw in #1282
• server: introduce 200/304 handling of documents by @stanislaw in #1283
• server: 200/304 handling of documents: "Cache-Control": "no-cache" by @stanislaw in #1284
• export/html, server: add Mermaid by @stanislaw in #1285
• tests/integration: user-provided ReqIF file with a schema not compliant to ReqIF recommendations by @stanislaw in #1287
• Bump version to 0.0.44a3 by @stanislaw in #1288
• export/html: Project statistics screen by @stanislaw in #1292
• export/rst: add a missing branch to generate Anchors by @stanislaw in #1293
• docs: fix recent RST content markup by @stanislaw in #1294
• docs: add experimental features, limitations, improve Hello World part by @stanislaw in #1295
• strictdoc.toml: do not generate project statistics by default by @stanislaw in #1296
• traceability_index: fix finding an existing node with a given UID by @stanislaw in #1297
• UI: add missing features related to editing document grammar by @stanislaw in #1299
• cli and server: support --config parameter by @stanislaw in #1302
• cli and server: validate --config parameter by @stanislaw in #1303
• config: take into account config last modification date when invalidating caches by @stanislaw in #1304
• backend/sdoc: recognize REFS/RELATION field in the grammar by @stanislaw in #1305
• source coverage: fix case when source file last line is not empty by @stanislaw in #1308
• sdoc/grammar: introduce REFS/RELATIONS/ROLES by @stanislaw in #1309
• export/html: code climate: djLint issues in templates by @mettta in #1311
• export/html: code climate: djLint issues in templates by @mettta in #1312
• templates/components: new set of templates for editing requirements and grammar fields by @stanislaw in #1313
• helpers: new form data parser by @stanislaw in #1314
• backend, UI: ParentReqReference: role_uid -> role by @stanislaw in #1315
• tests/end2end: update to new naming conventions: edit_requirement/_requirement_relations/* by @stanislaw in #1316
• tests/end2end: rename several tests, update to e2e conventions by @stanislaw in #1317
• Requirement relations: good 80%+ of the overall implementation by @stanislaw in #1320
• main_router: update_grammar: fix an edge case, improve a flaky test case by @stanislaw in #1322
• finders, generators: added yaml reference finder by @villanella in #1324
• tasks: fix the PyInstaller issue (temporary workaround) by @stanislaw in #1326
• tasks: fix the PyInstaller issue by @stanislaw in #1325
• UI: update_requirement: fix an edge case with fields conversion by @stanislaw in #1327
• tests/end2end: improve the robustness of one test that can be flaky by @stanislaw in #1328
• tests/end2end: fix one Linux-flaky test with retries by @stanislaw in #1329
• UI: create_requirement: extract process to a separate transform class, improve handling of relations by @stanislaw in #1331
• UI: create_requirement: handle the updates of traceability index by @stanislaw in #1332
• CI: bring back the previously failing tests by @stanislaw in #1334
• commands/manage_autoiud_command: generate UID across documents by @stanislaw in #1335
• backend/sdoc: start to recognize requirement RELATIONS: in SDoc by @stanislaw in #1336
• UX: add tabs on requirement form by @mettta in #1338
• backend/sdoc: if one requirement RELATION is provided, switch document from REFS to RELATIONS by @stanislaw in #1339
• UI: add tabs to grammar form by @mettta in #1340
• Renames related to "parent links vs relations" by @mettta in #1342
• export/html: update toast markup by @mettta in #1344
• backend/sdoc: print deprecation warnings when REFS are used by @stanislaw in #1341
• export/html: Add copy_to_clipboard_button controller by @mettta in #1346
• docs: document RELATIONS, deprecate REFS by @stanislaw in #1347
• export/html: Add copy_to_clipboard button to section fields by @mettta in #1352
• docs: add the Roadmap diagram export (2023-11-21) by @stanislaw in #1354

New Contributors

• @villanella made their first contribution in #1324

Full Changelog: 0.0.43...0.0.45

Inline links and auto-generation of UID when creating requirements

What's Changed

• export/html, source traceability: add support for C++/.cc extension by @stanislaw in #1200
• export/dot: basic export to Graphviz/DOT by @stanislaw in #1201
• export/html: Adding anchor visualisation by @mettta in #1202
• export/html: Make anchors visible on hovering over the node by @mettta in #1203
• export/html: fix TOC styles for disabled items on DTR screen by @mettta in #1204
• export/html: fix margins in DOC TREE by @mettta in #1205
• export/dot: profile1: randomize link colors to simplify tracing by @stanislaw in #1206
• export/dot: color-code requirement status, add legend by @stanislaw in #1207
• export/dot: add legend and folder clusters, improve sorting of flowdown by @stanislaw in #1208
• resolve #1210: leading spaces allowed by @BenGardiner in #1211
• docs/strictdoc_01_user_guide.sdoc: remove accidental debug lines by @stanislaw in #1213
• export/html: fix RST rendering for custom fields by @stanislaw in #1214
• grammar, anchors: handle edge case of malformed RST by @stanislaw in #1215
• tests/end2end: add a test for adding LINK to an existing section ANCHOR by @stanislaw in #1216
• tests/end2end: start catching Selenium exceptions more targeted by @stanislaw in #1218
• Code climate: backend/sdoc/models: switch to using MID instead of str by @stanislaw in #1219
• tests/end2end: retry 3 times when Selenium CONNECTION_REFUSED is hit by @stanislaw in #1220
• backend/sdoc: requirement: make STATEMENT mandatory in custom grammar by @stanislaw in #1221
• UI: updating section: many more combinations of anchors and links use cases by @stanislaw in #1222
• export/html: CSS: remove a.reference.external style by @mettta in #1223
• tests/end2end: switch edit_document_classification test to new E2E class by @stanislaw in #1224
• tests/end2end: switch some more tests to new E2E class by @stanislaw in #1226
• Update README.md: Fix CI badges by @stanislaw in #1227
• export/dot: several improvements: reqs title UIDs and URL link back to server by @stanislaw in #1228
• HTML2PDF: basic implementation by @stanislaw in #1230
• drafts: integrate new StrictDoc requirements work by @stanislaw in #1231
• drafts/requirements: more links and statuses, also move DO-178C to the HLR level by @stanislaw in #1233
• export/html, server: fix edge case when dropping a req on another req by @stanislaw in #1234
• export:/html2pdf: bundle.js: improve grid splitting by @mettta in #1235
• drafts/requirements: assign status fields for ZEP and SDoc dev constraints by @stanislaw in #1236
• export:/html2pdf: replace requirement outline with border by @mettta in #1237
• export/html: update style for document and section meta by @mettta in #1239
• drafts/requirements: export/import requirements: allocate statuses, connect some SDoc grammar reqs by @stanislaw in #1238
• drafts/requirements: activate status of 3 SDoc reqs by @stanislaw in #1240
• export/html: incoming links to sections and anchors by @stanislaw in #1241
• export/dot: profile2: take into account folders by @stanislaw in #1242
• export/html: PDF & CSS: fixes unexpected margins by @mettta in #1244
• drafts/requirements: StrictDoc reqs: assign Active status to several reqs by @stanislaw in #1243
• drafts/requirements: assign status and links to more trivial requirements by @stanislaw in #1246
• export/html, server: fix a branch: rename section UID by @stanislaw in #1247
• Code climate: tests/end2end: adjust update_section group to new conventions by @stanislaw in #1248
• drafts/requirements: more statuses and links for reqs in the SDoc-level spec by @stanislaw in #1249
• export/html: PDF: adding pdf-version for anchored title components by @mettta in #1250
• backend/sdoc: reader: good performance improvement from pickling parsed SDoc content by @stanislaw in #1251
• tests/end2end: migrate 2 test cases to E2ECase by @stanislaw in #1252
• backend/reqif: more explicit default ReqIF profile: "P01 SDoc" by @stanislaw in #1253
• Code climate: tests/end2end: update more tests to latest conventions by @stanislaw in #1254
• Bump version to 0.0.43a7 by @stanislaw in #1255
• export:/html2pdf: add frontpage template by @mettta in #1256
• backend/sdoc: optimize grammar for some more performance by @stanislaw in #1257
• export/html: improvements in the caching algorithm by @stanislaw in #1258
• backend/sdoc and rst_to_html: take into account the output directory when hashing picked file names by @stanislaw in #1259
• Code climate: tests/end2end: migrate more tests to new conventions by @stanislaw in #1260
• Code climate: fix E721 by @stanislaw in #1263
• export/rst: multiline fields: make a newline break after field name by @stanislaw in #1262
• backend/reqif: ReqIFz roundtrip by @stanislaw in #1264
• docs: document the [LINK: ...] feature by @stanislaw in #1265
• drafts/requirements: L1 reqs: SDK and DB, general usability and UX, large number of users, qualification by @stanislaw in #1267
• drafts/ and docs/: merge the old and new backlog items by @stanislaw in #1268
• drafts/requirements: L1 reqs: integration between distinct projects requirements trees and reverse parent links by @stanislaw in #1269
• drafts/requirements: L1 and L2 reqs: compliance management and compliance matrices, requirements and source files traceability, auto UIDs by @stanislaw in #1270
• UI: generate the UID automatically when creating requirements by @stanislaw in #1273
• export/html/html_templates: filter out .DS_Store files when compiling Jinja templates by @stanislaw in #1274
• Bump version to 0.0.43 by @stanislaw in #1275

Full Changelog: 0.0.42...0.0.43