Skip to content

Commit

Permalink
Merge pull request #1550 from strictdoc-project/stanislaw/move_toc
Browse files Browse the repository at this point in the history
export/html: Diff: display MIDs for requirements, sections, and documents
  • Loading branch information
stanislaw authored Dec 29, 2023
2 parents c84a3aa + 93e9017 commit 1344e7c
Show file tree
Hide file tree
Showing 8 changed files with 62 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,18 @@

<div class="diff_node_fields">

{# MID field, if permanent, is always printed as-is. It is never marked as modified. #}
{% if document.mid_permanent %}
<div
class="diff_node_field"
>
{%- with badge_text = "MID" -%}
{%- include "components/badge/index.jinja" -%}
{%- endwith -%}
<span class="sdoc_pre_content">{{ document.reserved_mid }}</span>
</div>
{% endif %}

{% if document.reserved_uid is not none %}
{% set uid_modified = document.reserved_uid is not none and document_change is not none and document_change.uid_modified %}
<div
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
{% assert requirement_change is defined %}

{# MID field, if permanent, is always printed as-is. It is never marked as modified. #}
{% if requirement.mid_permanent %}
<div
class="diff_node_field"
>
{%- with badge_text = "MID" -%}
{%- include "components/badge/index.jinja" -%}
{%- endwith -%}
<span class="sdoc_pre_content">{{ requirement.reserved_mid }}</span>
</div>
{% endif %}

<div class="diff_node_fields">
{%- for requirement_field_triple_ in requirement.enumerate_all_fields() -%}
{%- set is_multiline = requirement_field_triple_[0].field_value_multiline is not none -%}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,16 @@
<div class="diff_node_fields">
{# MID field, if permanent, is always printed as-is. It is never marked as modified. #}
{% if section.mid_permanent %}
<div
class="diff_node_field"
>
{%- with badge_text = "MID" -%}
{%- include "components/badge/index.jinja" -%}
{%- endwith -%}
<span class="sdoc_pre_content">{{ section.reserved_mid }}</span>
</div>
{% endif %}

{# UID #}
{%- if section.reserved_uid is not none and section.reserved_uid|length > 0 -%}
{% set uid_modified = section_change is not none and section_change.uid_modified %}
Expand Down
8 changes: 8 additions & 0 deletions strictdoc/export/html/templates/screens/git/nav_tabs.jinja
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,19 @@
<div class="sdoc-tab-list">
<a class="sdoc-tab"
{% if tab == "diff" %}active{% endif %}
{% if project_config.is_running_on_server %}
href="/diff?tab=diff&left_revision={{ left_revision_urlencoded }}&right_revision={{ right_revision_urlencoded }}"
{% else %}
href="diff.html"
{% endif %}
>Diff</a>
<a class="sdoc-tab"
{% if tab == "changelog" %}active{% endif %}
{% if project_config.is_running_on_server %}
href="/diff?tab=changelog&left_revision={{ left_revision_urlencoded }}&right_revision={{ right_revision_urlencoded }}"
{% else %}
href="changelog.html"
{% endif %}
>Changelog</a>
</div>
</nav>
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@ RUN: %strictdoc diff %S/lhs %S/rhs --output-dir Output

RUN: cat %S/Output/changelog.html | filecheck %s --check-prefix=CHECK-CHANGELOG

NOTE: This ensures that the links are printed for static HTML export, not the web server links.
CHECK-CHANGELOG:href="diff.html"
CHECK-CHANGELOG:href="changelog.html"

NOTE: Checking all the changes below.

CHECK-CHANGELOG:<div class="sdoc-table_key_value-section">Summary of the changes</div>

CHECK-CHANGELOG:<div class="sdoc-table_key_value-key">Nodes modified</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,10 @@ CHECK-CHANGELOG:<div class="sdoc-table_key_value-value">No sections were modifie
CHECK-CHANGELOG:<div class="sdoc-table_key_value-key">Requirements modified</div>
CHECK-CHANGELOG:<div class="sdoc-table_key_value-value">1 (1 modified)</div>

CHECK-CHANGELOG:ABCD0123
CHECK-CHANGELOG:<span class="sdoc_pre_content"><span class="lambda_red">R</span><span>e</span><span class="lambda_red">qu</span><span>i</span><span class="lambda_red">r</span><span>e</span><span class="lambda_red">ment #1</span></span>
CHECK-CHANGELOG:<span class="sdoc_pre_content"><span class="lambda_red">Sy</span><span>s</span><span>tem</span><span class="lambda_red"> shall do 1</span><span>.</span></span>

CHECK-CHANGELOG:ABCD0123
CHECK-CHANGELOG:TITLE{{.*}}<span class="sdoc_pre_content"><span class="lambda_green">Modifi</span><span>e</span><span class="lambda_green">d t</span><span>i</span><span class="lambda_green">tl</span><span>e</span>
CHECK-CHANGELOG:STATEMENT{{.*}}<span class="sdoc_pre_content"><span class="lambda_green">Modified </span><span>s</span><span class="lambda_green">ta</span><span>tem</span><span class="lambda_green">ent</span><span>.</span>
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,9 @@ CHECK-CHANGELOG:<div class="sdoc-table_key_value-key">Requirements modified</div
CHECK-CHANGELOG:<div class="sdoc-table_key_value-value">No requirements were modified.</div>

NOTE: Ensure that the colored diff is shown for the modified title.

CHECK-CHANGELOG:ABCD0123
CHECK-CHANGELOG:<div class="sdoc_pre_content"><span class="lambda_red">S</span><span>e</span><span class="lambda_red">ction</span><span> title</span></div>

CHECK-CHANGELOG:ABCD0123
CHECK-CHANGELOG:<div class="sdoc_pre_content"><span class="lambda_green">Modifi</span><span>e</span><span class="lambda_green">d</span><span> title</span></div>
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,8 @@ CHECK-CHANGELOG:<div class="sdoc-table_key_value-value">No sections were modifie
CHECK-CHANGELOG:<div class="sdoc-table_key_value-key">Requirements modified</div>
CHECK-CHANGELOG:<div class="sdoc-table_key_value-value">No requirements were modified.</div>

CHECK-CHANGELOG:ABCD0123
CHECK-CHANGELOG:span class="lambda_red">H</span><span>e</span><span class="lambda_red">llo worl</span><span>d doc</span>

CHECK-CHANGELOG:ABCD0123
CHECK-CHANGELOG:<span class="lambda_green">Modifi</span><span>e</span><span>d doc</span><span class="lambda_green">ument title</span>

0 comments on commit 1344e7c

Please sign in to comment.