documentation/improved-navigation

doc/_config.yml

@@ -48,3 +48,13 @@ exclude:
 include:
   - CNAME
   - assets
+
+defaults:
+  - scope:
+      path: "changes"
+    values:
+      nav_exclude: true
+  - scope:
+      path: "changes/changes.md"
+    values:
+      nav_exclude: false

doc/developer_guide/developer_guide.md

@@ -3,6 +3,7 @@ layout: default
 title: Developer Guide
 nav_order: 3
 has_children: true
+has_toc: false
 ---
 
 # OpenFastTrace Developer Guide
@@ -11,6 +12,8 @@ This document contains technical information for developers contributing to Open
 
 If you want to know more about how to contribute to OFT, please check out our [Contributor Guide](../../CONTRIBUTING.md).
 
+* [Plugin Developer Guide](plugin_developer_guide.md)
+
 ## Getting the OpenFastTrace Library
 
 ### Getting OFT via Maven

doc/spec/design/quality_requirements.md

@@ -1,3 +1,10 @@
+---
+layout: default
+title: Quality Requirements
+nav_order: 3
+parent: Specification
+---
+
 # Quality Requirements
 
 This chapter documents architecture-relevant quality requirements and technical quality goals.

doc/spec/index.md

@@ -3,8 +3,13 @@ layout: default
 title: Specification
 nav_order: 4
 has_children: true
+has_toc: false
 ---
 
 # OpenFastTrace Specification
 
 This section contains the formal specifications for OpenFastTrace.
+
+* [System Requirements](system_requirements.md)
+* [Design](design.md)
+* [Quality Requirements](design/quality_requirements.md)

doc/user_guide/installation/installation.md

@@ -4,6 +4,7 @@ title: Installation
 parent: User Guide
 has_children: true
 nav_order: 2
+has_toc: false
 ---
 
 ## Installation
@@ -27,4 +28,4 @@ Depending on your operating system, there are different ways to install OpenFast
 
 ---
 
-← [Concepts and Terms](../introduction/concepts_and_terms.md) | ↑ [User Guide](../user_guide.md) | [Linux Installation](linux.md) →
+← [Concepts and Terms](../introduction/concepts_and_terms.md)   •   ↑ [User Guide](../user_guide.md)   •   [Linux Installation](linux.md) →

doc/user_guide/installation/linux.md

@@ -61,4 +61,4 @@ alias oft='java -jar /path/to/openfasttrace-<version>.jar'
 
 ---
 
-← [Installation](installation.md) | ↑ [Installation](installation.md) | [macOS Installation](macos.md) →
+← [Installation](installation.md) &nbsp;&nbsp;•&nbsp;&nbsp; ↑ [Installation](installation.md) &nbsp;&nbsp;•&nbsp;&nbsp; [macOS Installation](macos.md) →

doc/user_guide/installation/macos.md

@@ -49,4 +49,4 @@ alias oft='java -jar /path/to/openfasttrace-<version>.jar'
 
 ---
 
-← [Linux Installation](linux.md) | ↑ [Installation](installation.md) | [Windows Installation](windows.md) →
+← [Linux Installation](linux.md) &nbsp;&nbsp;•&nbsp;&nbsp; ↑ [Installation](installation.md) &nbsp;&nbsp;•&nbsp;&nbsp; [Windows Installation](windows.md) →

doc/user_guide/installation/windows.md

@@ -41,4 +41,4 @@ java -jar "C:\path\to\openfasttrace-<version>.jar" %*
 
 ---
 
-← [macOS Installation](macos.md) | ↑ [Installation](installation.md) | [Use Cases](../use_cases/use_cases.md) →
+← [macOS Installation](macos.md) &nbsp;&nbsp;•&nbsp;&nbsp; ↑ [Installation](installation.md) &nbsp;&nbsp;•&nbsp;&nbsp; [Use Cases](../use_cases/use_cases.md) →

doc/user_guide/introduction/concepts_and_terms.md

@@ -65,4 +65,4 @@ If, on the other hand, you only added a missing period at the end of a sentence,
 
 ---
 
-← [Why do I Need Requirement Tracing?](why_do_i_need_requirement_tracing.md) | ↑ [Introduction](introduction.md) | [Installation](../installation/installation.md) →
+← [Why do I Need Requirement Tracing?](why_do_i_need_requirement_tracing.md)   •   ↑ [Introduction](introduction.md)   •   [Installation](../installation/installation.md) →

doc/user_guide/introduction/introduction.md

@@ -4,10 +4,16 @@ title: Introduction
 parent: User Guide
 has_children: true
 nav_order: 1
+has_toc: false
 ---
 
 ## Introduction
 
+* [Who Should Read This Document?](who_should_read_this_document.md)
+* [What is Requirement Tracing?](what_is_requirement_tracing.md)
+* [Why do I Need Requirement Tracing?](why_do_i_need_requirement_tracing.md)
+* [Concepts and Terms](concepts_and_terms.md)
+
 ---
 
-↑ [User Guide](../user_guide.md) | [Who Should Read This Document?](who_should_read_this_document.md) →
+↑ [User Guide](../user_guide.md)   •   [Who Should Read This Document?](who_should_read_this_document.md) →

doc/user_guide/introduction/what_is_requirement_tracing.md

@@ -24,4 +24,4 @@ Step-by-step you repeat this pattern for your design document and all resulting
 
 ---
 
-← [Who Should Read This Document?](who_should_read_this_document.md) | ↑ [Introduction](introduction.md) | [Why do I Need Requirement Tracing?](why_do_i_need_requirement_tracing.md) →
+← [Who Should Read This Document?](who_should_read_this_document.md)   •   ↑ [Introduction](introduction.md)   •   [Why do I Need Requirement Tracing?](why_do_i_need_requirement_tracing.md) →

doc/user_guide/introduction/who_should_read_this_document.md

@@ -29,4 +29,4 @@ Of course, requirement engineering and tracing are useful outside the software d
 
 ---
 
-← [Introduction](introduction.md) | ↑ [Introduction](introduction.md) | [What is Requirement Tracing?](what_is_requirement_tracing.md) →
+← [Introduction](introduction.md)   •   ↑ [Introduction](introduction.md)   •   [What is Requirement Tracing?](what_is_requirement_tracing.md) →

doc/user_guide/introduction/why_do_i_need_requirement_tracing.md

@@ -17,4 +17,4 @@ Requirement tracing is a safety net for non-trivial software projects:
 
 ---
 
-← [What is Requirement Tracing?](what_is_requirement_tracing.md) | ↑ [Introduction](introduction.md) | [Concepts and Terms](concepts_and_terms.md) →
+← [What is Requirement Tracing?](what_is_requirement_tracing.md)   •   ↑ [Introduction](introduction.md)   •   [Concepts and Terms](concepts_and_terms.md) →

doc/user_guide/oft_api/exit_codes.md

@@ -16,4 +16,4 @@ The OFT command line interface returns the following exit codes:
 
 ---
 
-← [Using OFT From Java](using_oft_from_java.md) | ↑ [OFT API](oft_api.md) | [Tool Support](../tool_support/tool_support.md) →
+← [Using OFT From Java](using_oft_from_java.md)   •   ↑ [OFT API](oft_api.md)   •   [Tool Support](../tool_support/tool_support.md) →

doc/user_guide/oft_api/oft_api.md

@@ -4,6 +4,7 @@ title: OFT API
 parent: User Guide
 has_children: true
 nav_order: 5
+has_toc: false
 ---
 
 ## OFT API
@@ -12,6 +13,9 @@ If you are a software developer planning to integrate OFT into one of your progr
 
 Below you find a few short examples of how to use the OFT API. For details check the Javadoc documentation of the interface [org.itsallcode.openfasttrace.core.Oft](../../../core/src/main/java/org/itsallcode/openfasttrace/core/Oft.java) in the source code.
 
+* [Using OFT From Java](using_oft_from_java.md)
+* [Exit Codes](exit_codes.md)
+
 ---
 
-← [XML Tracing Report](../reference/xml_tracing_report.md) | ↑ [User Guide](../user_guide.md) | [Using OFT From Java](using_oft_from_java.md) →
+← [XML Tracing Report](../reference/xml_tracing_report.md)   •   ↑ [User Guide](../user_guide.md)   •   [Using OFT From Java](using_oft_from_java.md) →

doc/user_guide/oft_api/using_oft_from_java.md

@@ -127,4 +127,4 @@ ReportSettings settings = ReportSettings.builder().newline(Newline.UNIX).build()
 
 ---
 
-← [OFT API](oft_api.md) | ↑ [OFT API](oft_api.md) | [Exit Codes](exit_codes.md) →
+← [OFT API](oft_api.md)   •   ↑ [OFT API](oft_api.md)   •   [Exit Codes](exit_codes.md) →

doc/user_guide/product_lifecycle/product_lifecycle.md

@@ -4,6 +4,7 @@ title: Product Lifecycle
 parent: User Guide
 has_children: true
 nav_order: 7
+has_toc: false
 ---
 
 # Product Lifecycle
@@ -57,4 +58,4 @@ Itsallcode.org distributes updates via GitHub releases. Even if the project shou
 
 ---
 
-← [Templates for IDEs](../tool_support/templates_for_ides.md) | ↑ [User Guide](../user_guide.md)
+← [Templates for IDEs](../tool_support/templates_for_ides.md)   •   ↑ [User Guide](../user_guide.md)

doc/user_guide/reference/build_integration.md

@@ -15,4 +15,4 @@ To integrate requirement tracing with OFT into your CI build, we recommend using
 
 ---
 
-← [OFT Command Line](oft_command_line.md) | ↑ [Reference](reference.md) | [Input Format Support](input_format_support.md) →
+← [OFT Command Line](oft_command_line.md)   •   ↑ [Reference](reference.md)   •   [Input Format Support](input_format_support.md) →

doc/user_guide/reference/console_tracing_report.md

@@ -85,4 +85,4 @@ Just in case you are wondering about the extra spaces in some places of the repo
 
 ---
 
-← [Input Format Support](input_format_support.md) | ↑ [Reference](reference.md) | [Report Summary](report_summary.md) →
+← [Input Format Support](input_format_support.md)   •   ↑ [Reference](reference.md)   •   [Report Summary](report_summary.md) →

doc/user_guide/reference/input_format_support.md

@@ -171,4 +171,4 @@ The SpecObject format is extended with support of namespaces to allow adding cus
 
 ---
 
-← [Build Integration](build_integration.md) | ↑ [Reference](reference.md) | [Console Tracing Report](console_tracing_report.md) →
+← [Build Integration](build_integration.md)   •   ↑ [Reference](reference.md)   •   [Console Tracing Report](console_tracing_report.md) →

doc/user_guide/reference/oft_command_line.md

@@ -136,4 +136,4 @@ Log level for console logging. One of `OFF`, `SEVERE`, `WARNING`, `INFO`, `CONFI
 
 ---
 
-← [Reference](reference.md) | ↑ [Reference](reference.md) | [Build Integration](build_integration.md) →
+← [Reference](reference.md)   •   ↑ [Reference](reference.md)   •   [Build Integration](build_integration.md) →

doc/user_guide/reference/reference.md

@@ -4,6 +4,7 @@ title: Reference
 parent: User Guide
 has_children: true
 nav_order: 4
+has_toc: false
 ---
 
 ## Reference
@@ -19,4 +20,4 @@ The reference section provides detailed technical information about the OpenFast
 
 ---
 
-← [Understanding and Fixing Broken Requirement Branches](../use_cases/understanding_and_fixing_broken_requirement_branches.md) | ↑ [User Guide](../user_guide.md) | [OFT Command Line](oft_command_line.md) →
+← [Understanding and Fixing Broken Requirement Branches](../use_cases/understanding_and_fixing_broken_requirement_branches.md)   •   ↑ [User Guide](../user_guide.md)   •   [OFT Command Line](oft_command_line.md) →

doc/user_guide/reference/report_summary.md

@@ -20,4 +20,4 @@ Here, "direct" means that the item itself has a coverage defect, and "transitive
 
 ---
 
-← [Console Tracing Report](console_tracing_report.md) | ↑ [Reference](reference.md) | [XML Tracing Report](xml_tracing_report.md) →
+← [Console Tracing Report](console_tracing_report.md)   •   ↑ [Reference](reference.md)   •   [XML Tracing Report](xml_tracing_report.md) →

doc/user_guide/reference/xml_tracing_report.md

@@ -176,4 +176,4 @@ and the requirement type with the element `<doctype>`.
 
 ---
 
-← [Report Summary](report_summary.md) | ↑ [Reference](reference.md) | [OFT API](../oft_api/oft_api.md) →
+← [Report Summary](report_summary.md) &nbsp;&nbsp;•&nbsp;&nbsp; ↑ [Reference](reference.md) &nbsp;&nbsp;•&nbsp;&nbsp; [OFT API](../oft_api/oft_api.md) →

doc/user_guide/tool_support/templates_for_ides.md

@@ -12,4 +12,4 @@ You can create OpenFastTrace artifacts faster with templates for your IDE. See [
 
 ---
 
-← [Tools for Authoring OFT Documents](tools_for_authoring_oft_documents.md) | ↑ [Tool Support](tool_support.md) | [Product Lifecycle](../product_lifecycle/product_lifecycle.md) →
+← [Tools for Authoring OFT Documents](tools_for_authoring_oft_documents.md)   •   ↑ [Tool Support](tool_support.md)   •   [Product Lifecycle](../product_lifecycle/product_lifecycle.md) →

doc/user_guide/tool_support/tool_support.md

@@ -4,10 +4,14 @@ title: Tool Support
 parent: User Guide
 has_children: true
 nav_order: 6
+has_toc: false
 ---
 
 ## Tool Support
 
+* [Tools for Authoring OFT Documents](tools_for_authoring_oft_documents.md)
+* [Templates for IDEs](templates_for_ides.md)
+
 ---
 
-← [Exit Codes](../oft_api/exit_codes.md) | ↑ [User Guide](../user_guide.md) | [Tools for Authoring OFT Documents](tools_for_authoring_oft_documents.md) →
+← [Exit Codes](../oft_api/exit_codes.md)   •   ↑ [User Guide](../user_guide.md)   •   [Tools for Authoring OFT Documents](tools_for_authoring_oft_documents.md) →

doc/user_guide/tool_support/tools_for_authoring_oft_documents.md

@@ -39,4 +39,4 @@ Typical features include:
 
 ---
 
-← [Tool Support](tool_support.md) | ↑ [Tool Support](tool_support.md) | [Templates for IDEs](templates_for_ides.md) →
+← [Tool Support](tool_support.md)   •   ↑ [Tool Support](tool_support.md)   •   [Templates for IDEs](templates_for_ides.md) →

doc/user_guide/use_cases/delegating_requirement_coverage.md

@@ -50,4 +50,4 @@ To avoid confusion, it is best to have all forwards in a separate section with t
 
 ---
 
-← [Excluding Parts of a Specification Document for OFT Parsing](excluding_parts_of_a_specification_document_for_oft_parsing.md) | ↑ [Use Cases](use_cases.md) | [Distributing the Detailing Work](distributing_the_detailing_work.md) →
+← [Excluding Parts of a Specification Document for OFT Parsing](excluding_parts_of_a_specification_document_for_oft_parsing.md)   •   ↑ [Use Cases](use_cases.md)   •   [Distributing the Detailing Work](distributing_the_detailing_work.md) →

doc/user_guide/use_cases/distributing_the_detailing_work.md

@@ -40,4 +40,4 @@ If you want to also import specification items that do not have any tags, add a
 
 ---
 
-← [Delegating Requirement Coverage](delegating_requirement_coverage.md) | ↑ [Use Cases](use_cases.md) | [Filtering by Status](filtering_by_status.md) →
+← [Delegating Requirement Coverage](delegating_requirement_coverage.md)   •   ↑ [Use Cases](use_cases.md)   •   [Filtering by Status](filtering_by_status.md) →

doc/user_guide/use_cases/excluding_parts_of_a_specification_document_for_oft_parsing.md

@@ -28,4 +28,4 @@ ReStructured text example:
 
 ---
 
-← [Writing a Specification](writing_a_specification.md) | ↑ [Use Cases](use_cases.md) | [Delegating Requirement Coverage](delegating_requirement_coverage.md) →
+← [Writing a Specification](writing_a_specification.md)   •   ↑ [Use Cases](use_cases.md)   •   [Delegating Requirement Coverage](delegating_requirement_coverage.md) →

doc/user_guide/use_cases/filtering_by_status.md

@@ -20,4 +20,4 @@ This tells OFT to only import specification items that have the status `approved
 
 ---
 
-← [Distributing the Detailing Work](distributing_the_detailing_work.md) | ↑ [Use Cases](use_cases.md) | [Tracing the Whole Chain](tracing_the_whole_chain.md) →
+← [Distributing the Detailing Work](distributing_the_detailing_work.md)   •   ↑ [Use Cases](use_cases.md)   •   [Tracing the Whole Chain](tracing_the_whole_chain.md) →

doc/user_guide/use_cases/html_tracing_reports.md

@@ -16,4 +16,4 @@ oft trace -o html
 
 ---
 
-← [Tracing the Whole Chain in the Same File System](tracing_the_whole_chain_in_the_same_file_system.md) | ↑ [Use Cases](use_cases.md) | [Understanding and Fixing Broken Requirement Branches](understanding_and_fixing_broken_requirement_branches.md) →
+← [Tracing the Whole Chain in the Same File System](tracing_the_whole_chain_in_the_same_file_system.md)   •   ↑ [Use Cases](use_cases.md)   •   [Understanding and Fixing Broken Requirement Branches](understanding_and_fixing_broken_requirement_branches.md) →

doc/user_guide/use_cases/tracing_the_whole_chain.md

@@ -12,4 +12,4 @@ If you plan to assess the coverage state of your product as a whole, you need to
 
 ---
 
-← [Filtering by Status](filtering_by_status.md) | ↑ [Use Cases](use_cases.md) | [Tracing the Whole Chain in the Same File System](tracing_the_whole_chain_in_the_same_file_system.md) →
+← [Filtering by Status](filtering_by_status.md)   •   ↑ [Use Cases](use_cases.md)   •   [Tracing the Whole Chain in the Same File System](tracing_the_whole_chain_in_the_same_file_system.md) →

doc/user_guide/use_cases/tracing_the_whole_chain_in_the_same_file_system.md

@@ -51,4 +51,4 @@ See also:
 
 ---
 
-← [Tracing the Whole Chain](tracing_the_whole_chain.md) | ↑ [Use Cases](use_cases.md) | [HTML Tracing Reports](html_tracing_reports.md) →
+← [Tracing the Whole Chain](tracing_the_whole_chain.md)   •   ↑ [Use Cases](use_cases.md)   •   [HTML Tracing Reports](html_tracing_reports.md) →

doc/user_guide/use_cases/understanding_and_fixing_broken_requirement_branches.md

@@ -70,4 +70,4 @@ Duplicate links are special. They don't have a clear direction, since OFT cannot
 
 ---
 
-← [HTML Tracing Reports](html_tracing_reports.md) | ↑ [Use Cases](use_cases.md) | [Reference](../reference/reference.md) →
+← [HTML Tracing Reports](html_tracing_reports.md)   •   ↑ [Use Cases](use_cases.md)   •   [Reference](../reference/reference.md) →

doc/user_guide/use_cases/use_cases.md

@@ -4,6 +4,7 @@ title: Use Cases
 parent: User Guide
 has_children: true
 nav_order: 3
+has_toc: false
 ---
 
 ## Use Cases
@@ -22,4 +23,4 @@ The following use cases describe common tasks and workflows when using OpenFastT
 
 ---
 
-← [Windows Installation](../installation/windows.md) | ↑ [User Guide](../user_guide.md) | [Writing a Specification](writing_a_specification.md) →
+← [Windows Installation](../installation/windows.md)   •   ↑ [User Guide](../user_guide.md)   •   [Writing a Specification](writing_a_specification.md) →

doc/user_guide/use_cases/writing_a_specification.md

@@ -179,7 +179,7 @@ Tags are described in detail later in this document, see section [Distributing t
 
 ---
 
-← [Use Cases](use_cases.md) | ↑ [Use Cases](use_cases.md) | [Excluding Parts of a Specification Document for OFT Parsing](excluding_parts_of_a_specification_document_for_oft_parsing.md) →
+← [Use Cases](use_cases.md)   •   ↑ [Use Cases](use_cases.md)   •   [Excluding Parts of a Specification Document for OFT Parsing](excluding_parts_of_a_specification_document_for_oft_parsing.md) →
 
 ### Quality Scenarios
 

doc/user_guide/user_guide.md

@@ -3,6 +3,7 @@ layout: default
 title: User Guide
 nav_order: 2
 has_children: true
+has_toc: false
 ---
 
 ![oft-logo](../assets/images/openfasttrace_logo.svg)
@@ -16,3 +17,11 @@ OFT is a requirement tracing tool. It helps you make sure that all defined requi
 1. Create requirement and specification documents in Markdown, including OFT-readable specification items
 2. Put tags into your source code that mark the coverage of items from the specification
 3. Use OFT to trace the requirements from the source to the final implementation
+
+* [Introduction](introduction/introduction.md)
+* [Installation](installation/installation.md)
+* [Use Cases](use_cases/use_cases.md)
+* [Reference](reference/reference.md)
+* [OFT API](oft_api/oft_api.md)
+* [Tool Support](tool_support/tool_support.md)
+* [Product Lifecycle](product_lifecycle/product_lifecycle.md)