From 93e9017473d7d3f21c3aea0d5b88478846a17fe9 Mon Sep 17 00:00:00 2001
From: Stanislav Pankevich <s.pankevich@gmail.com>
Date: Fri, 29 Dec 2023 20:50:56 +0100
Subject: [PATCH] export/html: Diff: display MIDs for requirements, sections,
 and documents

---
 .../screens/git/fields/document_fields.jinja         | 12 ++++++++++++
 .../screens/git/fields/requirement_fields.jinja      | 12 ++++++++++++
 .../screens/git/fields/section_fields.jinja          | 12 ++++++++++++
 .../export/html/templates/screens/git/nav_tabs.jinja |  8 ++++++++
 .../test.itest                                       |  6 ++++++
 .../test.itest                                       |  5 +++++
 .../test.itest                                       |  4 ++++
 .../test.itest                                       |  3 +++
 8 files changed, 62 insertions(+)

diff --git a/strictdoc/export/html/templates/screens/git/fields/document_fields.jinja b/strictdoc/export/html/templates/screens/git/fields/document_fields.jinja
index bb651a9da..158116581 100644
--- a/strictdoc/export/html/templates/screens/git/fields/document_fields.jinja
+++ b/strictdoc/export/html/templates/screens/git/fields/document_fields.jinja
@@ -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
diff --git a/strictdoc/export/html/templates/screens/git/fields/requirement_fields.jinja b/strictdoc/export/html/templates/screens/git/fields/requirement_fields.jinja
index 224760536..8bfc64cd9 100644
--- a/strictdoc/export/html/templates/screens/git/fields/requirement_fields.jinja
+++ b/strictdoc/export/html/templates/screens/git/fields/requirement_fields.jinja
@@ -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 -%}
diff --git a/strictdoc/export/html/templates/screens/git/fields/section_fields.jinja b/strictdoc/export/html/templates/screens/git/fields/section_fields.jinja
index 7373a42d6..1b9d98ed8 100644
--- a/strictdoc/export/html/templates/screens/git/fields/section_fields.jinja
+++ b/strictdoc/export/html/templates/screens/git/fields/section_fields.jinja
@@ -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 %}
diff --git a/strictdoc/export/html/templates/screens/git/nav_tabs.jinja b/strictdoc/export/html/templates/screens/git/nav_tabs.jinja
index 05a8c2a16..589ff42a4 100644
--- a/strictdoc/export/html/templates/screens/git/nav_tabs.jinja
+++ b/strictdoc/export/html/templates/screens/git/nav_tabs.jinja
@@ -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>
diff --git a/tests/integration/commands/diff/01__requirements__from_empty_doc_to_one_requirement/test.itest b/tests/integration/commands/diff/01__requirements__from_empty_doc_to_one_requirement/test.itest
index e1d67980f..3ad218fa2 100644
--- a/tests/integration/commands/diff/01__requirements__from_empty_doc_to_one_requirement/test.itest
+++ b/tests/integration/commands/diff/01__requirements__from_empty_doc_to_one_requirement/test.itest
@@ -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>
diff --git a/tests/integration/commands/diff/_mid_match/01__mid_match__requirements__from_requirement_to_requirement_no_uid/test.itest b/tests/integration/commands/diff/_mid_match/01__mid_match__requirements__from_requirement_to_requirement_no_uid/test.itest
index 3fab3bbab..9e91f71f4 100644
--- a/tests/integration/commands/diff/_mid_match/01__mid_match__requirements__from_requirement_to_requirement_no_uid/test.itest
+++ b/tests/integration/commands/diff/_mid_match/01__mid_match__requirements__from_requirement_to_requirement_no_uid/test.itest
@@ -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>
diff --git a/tests/integration/commands/diff/_mid_match/10__mid_match__sections__from_section_to_section_modify_title/test.itest b/tests/integration/commands/diff/_mid_match/10__mid_match__sections__from_section_to_section_modify_title/test.itest
index 0ea42d208..f85a955a2 100644
--- a/tests/integration/commands/diff/_mid_match/10__mid_match__sections__from_section_to_section_modify_title/test.itest
+++ b/tests/integration/commands/diff/_mid_match/10__mid_match__sections__from_section_to_section_modify_title/test.itest
@@ -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>
diff --git a/tests/integration/commands/diff/_mid_match/20__mid_match__document__from_document_to_document_changed_path/test.itest b/tests/integration/commands/diff/_mid_match/20__mid_match__document__from_document_to_document_changed_path/test.itest
index 9a340d289..ec18e1741 100644
--- a/tests/integration/commands/diff/_mid_match/20__mid_match__document__from_document_to_document_changed_path/test.itest
+++ b/tests/integration/commands/diff/_mid_match/20__mid_match__document__from_document_to_document_changed_path/test.itest
@@ -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>