Merge pull request #2533 from strictdoc-project/stanislaw/html2pdf

fix(export/html2pdf): implement a proper handling of LINKs to documents in bundle and non-bundle documents

Author: stanislaw

strictdoc/export/html/renderers/link_renderer.py

@@ -98,20 +98,6 @@ def render_node_link(
 
         assert isinstance(node, (SDocDocument, SDocNode, Anchor)), node
 
-        if isinstance(node, SDocDocument):
-            context_level_or_none: Optional[int] = None
-            if context_document is not None:
-                assert context_document.meta is not None
-                context_level_or_none = context_document.meta.level
-
-            assert node.meta is not None
-            document_link = node.meta.get_html_link(
-                document_type,
-                context_level_or_none,
-            )
-            return document_link + "#_TOP"
-
-        assert isinstance(node, (SDocNode, Anchor)), node
         assert isinstance(document_type, DocumentType), type(document_type)
         local_link = self.render_local_anchor(node)
 
@@ -122,18 +108,15 @@ def render_node_link(
             return f"#{local_link}"
 
         including_document = node.get_including_document()
-        if (
-            including_document is not None
-            and including_document.is_bundle_document
-        ):
+        if including_document is not None:
             return f"#{local_link}"
 
-        if (
-            allow_local
-            and context_document is not None
-            and node.get_document() == context_document
-        ):
-            return f"#{local_link}"
+        if allow_local and context_document is not None:
+            if isinstance(node, SDocDocument):
+                if node == context_document:
+                    return f"#{local_link}"
+            elif node.get_document() == context_document:
+                return f"#{local_link}"
 
         # Now two cases:
         # - Context document exists, and we want to take into account this
@@ -153,7 +136,11 @@ def render_node_link(
         else:
             self.req_link_cache[link_cache_key] = {}
 
-        parent_or_including_document = node.get_parent_or_including_document()
+        parent_or_including_document = (
+            node.get_parent_or_including_document()
+            if not isinstance(node, SDocDocument)
+            else node
+        )
         assert parent_or_including_document.meta is not None
         document_link = parent_or_including_document.meta.get_html_link(
             document_type,

strictdoc/export/html/templates/components/anchor_document/index.jinja

@@ -0,0 +1 @@
+<span style="position: absolute; left: 0;" id="{{ local_anchor }}" data-uid="{{ local_anchor }}" data-anchor="{{ local_anchor }}"></span>

strictdoc/export/html/templates/components/node_field/document_title/index.jinja

@@ -1 +1,5 @@
-<h1 data-testid="document-title">{{ view_object.document.title }}</h1>
+{%- set local_anchor = view_object.render_local_anchor(view_object.document) %}
+<h1 data-testid="document-title">
+  {{ view_object.document.title }}
+  {% include "components/anchor_document/index.jinja" %}
+</h1>

tests/integration/features/html/escaping/01_escape_input_from_sdoc/test.itest

@@ -41,8 +41,11 @@ CHECK-ALL-NEXT: >
 CHECK-ALL-NEXT: <b>"escaping" 'document title'</b>
 
 # Main document: Title.
-CHECK-INPUT: <h1 data-testid="document-title">&lt;b&gt;&#34;escaping&#34;&amp;nbsp;&#39;document title&#39;&lt;/b&gt;</h1>
-CHECK-TABLE: <h1 data-testid="document-title">&lt;b&gt;&#34;escaping&#34;&amp;nbsp;&#39;document title&#39;&lt;/b&gt;</h1>
+CHECK-INPUT: <h1 data-testid="document-title">
+CHECK-INPUT-NEXT:&lt;b&gt;&#34;escaping&#34;&amp;nbsp;&#39;document title&#39;&lt;/b&gt;
+
+CHECK-TABLE: <h1 data-testid="document-title">
+CHECK-TABLE-NEXT: &lt;b&gt;&#34;escaping&#34;&amp;nbsp;&#39;document title&#39;&lt;/b&gt;
 
 # Main document: Section.
 CHECK-INPUT: <sdoc-autogen>1.&nbsp;&lt;b&gt;&#34;escaping&#34;&amp;nbsp;&#39;section title&#39;&lt;/b&gt;</sdoc-autogen>

tests/integration/features/html2pdf/07_composable_document_with_relations/input.sdoc

@@ -1,5 +1,6 @@
 [DOCUMENT]
 TITLE: Project Risk Management
+UID: PARENT-DOC
 
 [TEXT]
 STATEMENT: Main file
@@ -11,7 +12,11 @@ FILE: nested/included.sdoc
 UID: REQ-003
 TITLE: Third one
 STATEMENT: >>>
-Third statement links to fourth: [LINK: REQ-004]
+Link from parent document to parent document: [LINK: PARENT-DOC]
+
+Link from parent document to included document: [LINK: INCLUDED-DOC]
+
+Link from parent document to this document's requiremnt: [LINK: REQ-004]
 <<<
 
 [REQUIREMENT]

tests/integration/features/html2pdf/07_composable_document_with_relations/nested/included.sdoc

@@ -1,11 +1,16 @@
 [DOCUMENT]
 TITLE: Included doc
+UID: INCLUDED-DOC
 
 [REQUIREMENT]
 UID: REQ-001
 TITLE: First one
 STATEMENT: >>>
-First statement links to second: [LINK: REQ-002]
+Link from included document to parent document: [LINK: PARENT-DOC]
+
+Link from included document to included document: [LINK: INCLUDED-DOC]
+
+Link from included document to this included document's requirement: [LINK: REQ-002]
 <<<
 
 [REQUIREMENT]

tests/integration/features/html2pdf/07_composable_document_with_relations/test.itest

@@ -9,7 +9,12 @@ RUN: %check_exists --file %T/html2pdf/html/%THIS_TEST_FOLDER/input-PDF.html
 RUN: %check_exists --file %T/html2pdf/pdf/input.pdf
 
 RUN: %cat %T/html2pdf/html/%THIS_TEST_FOLDER/input-PDF.html | filecheck %s --dump-input=fail --check-prefix CHECK-INPUT-PDF
-CHECK-INPUT-PDF: <p>First statement links to second: <a href="../07_composable_document_with_relations/input-PDF.html#REQ-002">🔗&nbsp;1.2. second one</a></p>
+CHECK-INPUT-PDF: <p>Link from included document to parent document: <a href="#PARENT-DOC">🔗&nbsp;Project Risk Management</a></p>
+CHECK-INPUT-PDF: <p>Link from included document to included document: <a href="#INCLUDED-DOC">🔗&nbsp;Included doc</a></p>
+CHECK-INPUT-PDF: <p>Link from included document to this included document's requirement: <a href="#REQ-002">🔗&nbsp;1.2. second one</a></p>
+CHECK-INPUT-PDF: <p>Link from parent document to parent document: <a href="#PARENT-DOC">🔗&nbsp;Project Risk Management</a></p>
+CHECK-INPUT-PDF: <p>Link from parent document to included document: <a href="#INCLUDED-DOC">🔗&nbsp;Included doc</a></p>
+CHECK-INPUT-PDF: <p>Link from parent document to this document's requiremnt: <a href="#REQ-004">🔗&nbsp;3. fourth one</a></p>
 
 # With --generate-bundle-document, a bundle document is generated.
 RUN: %strictdoc export %S --formats=html2pdf --included-documents --generate-bundle-document --output-dir %T | filecheck %s --dump-input=fail
@@ -18,4 +23,9 @@ RUN: %check_exists --file %T/html2pdf/pdf/bundle.pdf
 
 RUN: %cat %T/html2pdf/html/bundle-PDF.html | filecheck %s --dump-input=fail --check-prefix CHECK-BUNDLE-PDF
 # The link points to the same bundle document, not to its parent document.
-CHECK-BUNDLE-PDF: <p>First statement links to second: <a href="#REQ-002">🔗&nbsp;1.1.2. second one</a></p>
+CHECK-BUNDLE-PDF: <p>Link from included document to parent document: <a href="#PARENT-DOC">🔗&nbsp;Project Risk Management</a></p>
+CHECK-BUNDLE-PDF: <p>Link from included document to included document: <a href="#INCLUDED-DOC">🔗&nbsp;Included doc</a></p>
+CHECK-BUNDLE-PDF: <p>Link from included document to this included document's requirement: <a href="#REQ-002">🔗&nbsp;1.1.2. second one</a></p>
+CHECK-BUNDLE-PDF: <p>Link from parent document to parent document: <a href="#PARENT-DOC">🔗&nbsp;Project Risk Management</a></p>
+CHECK-BUNDLE-PDF: <p>Link from parent document to included document: <a href="#INCLUDED-DOC">🔗&nbsp;Included doc</a></p>
+CHECK-BUNDLE-PDF: <p>Link from parent document to this document's requiremnt: <a href="#REQ-004">🔗&nbsp;1.3. fourth one</a></p>

tests/integration/features/sdoc/markup/11_node_LINK_references_a_document/test.itest

@@ -3,8 +3,8 @@ CHECK: Published: Document 1
 
 RUN: %cat %T/html/%THIS_TEST_FOLDER/input1.html | filecheck %s --dump-input=fail --check-prefix CHECK-HTML-DOC1
 
-CHECK-HTML-DOC1: Read <a href="../11_node_LINK_references_a_document/input1.html#_TOP">🔗&nbsp;Document 1</a> then <a href="../11_node_LINK_references_a_document/input2.html#_TOP">🔗&nbsp;Document 2</a>.
+CHECK-HTML-DOC1: Read <a href="#DOC-1">🔗&nbsp;Document 1</a> then <a href="../11_node_LINK_references_a_document/input2.html#DOC-2">🔗&nbsp;Document 2</a>.
 
 RUN: %cat %T/html/%THIS_TEST_FOLDER/input2.html | filecheck %s --dump-input=fail --check-prefix CHECK-HTML-DOC2
 
-CHECK-HTML-DOC2: Read <a href="../11_node_LINK_references_a_document/input2.html#_TOP">🔗&nbsp;Document 2</a> then <a href="../11_node_LINK_references_a_document/input1.html#_TOP">🔗&nbsp;Document 1</a>.
+CHECK-HTML-DOC2: Read <a href="#DOC-2">🔗&nbsp;Document 2</a> then <a href="../11_node_LINK_references_a_document/input1.html#DOC-1">🔗&nbsp;Document 1</a>.