Merge pull request #137 from riscv/136-adoc-link-replacement-to-html-bug

Fix for having two or more links in normative text

Author: james-ball-qualcomm

tests/norm-rule/expected/test-norm-rules.adoc

@@ -81,6 +81,12 @@ It's got 2 lines.
 .1+| hyperlink4
 | DEF <<non-norm-anchor,custom text>> GHI a| link:test.html#norm:hyperlink4[norm:hyperlink4]
 
+.1+| hyperlink5
+| GHI <<norm:superscript>> and <<norm:subscript>> JKL a| link:test.html#norm:hyperlink5[norm:hyperlink5]
+
+.1+| hyperlink6
+| JKL <<norm:superscript,hello>> and <<norm:subscript,goodbye>> MNO a| link:test.html#norm:hyperlink6[norm:hyperlink6]
+
 .1+| table1
 | ===
 WITH anchor

tests/norm-rule/expected/test-norm-rules.html

@@ -243,6 +243,16 @@ <h3>my-chapter_name</h3>
               <td>DEF <a href="test.html#non-norm-anchor">custom text</a> GHI</td>
               <td><a href="test.html#norm:hyperlink4">norm:hyperlink4</a></td>
             </tr>
+            <tr>
+              <td rowspan=1 id="hyperlink5">hyperlink5</td>
+              <td>GHI <a href="test.html#norm:superscript">norm:superscript</a> and <a href="test.html#norm:subscript">norm:subscript</a> JKL</td>
+              <td><a href="test.html#norm:hyperlink5">norm:hyperlink5</a></td>
+            </tr>
+            <tr>
+              <td rowspan=1 id="hyperlink6">hyperlink6</td>
+              <td>JKL <a href="test.html#norm:superscript">hello</a> and <a href="test.html#norm:subscript">goodbye</a> MNO</td>
+              <td><a href="test.html#norm:hyperlink6">norm:hyperlink6</a></td>
+            </tr>
             <tr>
               <td rowspan=1 id="table1">table1</td>
               <td>===<br>WITH anchor<br>WITHOUT anchor<br>===</td>

tests/norm-rule/expected/test-norm-rules.json

@@ -300,6 +300,32 @@
         }
       ]
     },
+    {
+      "name": "hyperlink5",
+      "def_filename": "tests/norm-rule/test.yaml",
+      "chapter_name": "my-chapter_name",
+      "tags": [
+        {
+          "name": "norm:hyperlink5",
+          "text": "GHI <<norm:superscript>> and <<norm:subscript>> JKL",
+          "tag_filename": "/build/test-norm-tags.json",
+          "stds_doc_url": "test.html"
+        }
+      ]
+    },
+    {
+      "name": "hyperlink6",
+      "def_filename": "tests/norm-rule/test.yaml",
+      "chapter_name": "my-chapter_name",
+      "tags": [
+        {
+          "name": "norm:hyperlink6",
+          "text": "JKL <<norm:superscript,hello>> and <<norm:subscript,goodbye>> MNO",
+          "tag_filename": "/build/test-norm-tags.json",
+          "stds_doc_url": "test.html"
+        }
+      ]
+    },
     {
       "name": "table1",
       "def_filename": "tests/norm-rule/test.yaml",

tests/norm-rule/expected/test-norm-rules.xlsx

@@ -22,6 +22,8 @@
     "norm:hyperlink2": "DEF <<norm:superscript,custom text>> GHI",
     "norm:hyperlink3": "ABC <<non-norm-anchor>> DEF",
     "norm:hyperlink4": "DEF <<non-norm-anchor,custom text>> GHI",
+    "norm:hyperlink5": "GHI <<norm:superscript>> and <<norm:subscript>> JKL",
+    "norm:hyperlink6": "JKL <<norm:superscript,hello>> and <<norm:subscript,goodbye>> MNO",
     "norm:table:no-anchors-in-cells:entire-table": "Header 1|Header 2\n===\nCell in column 1, row 1|Cell in column 2, row 1\nCell in column 1, row 2|Cell in column 2, row 2\n===",
     "norm:table:anchors-in-cells:entire-table-tagged:cell": "WITH anchor",
     "norm:table:anchors-in-cells:entire-table": "===\nWITH anchor\nWITHOUT anchor\n===",
@@ -96,7 +98,9 @@
               "norm:hyperlink1",
               "norm:hyperlink2",
               "norm:hyperlink3",
-              "norm:hyperlink4"
+              "norm:hyperlink4",
+              "norm:hyperlink5",
+              "norm:hyperlink6"
             ]
           },
           {

tests/norm-rule/expected/test-norm-tags.json

@@ -95,6 +95,10 @@ Before hyperlink [#norm:hyperlink3]#ABC <<non-norm-anchor>> DEF# outside.
 
 Before hyperlink [#norm:hyperlink4]#DEF <<non-norm-anchor,custom text>> GHI# outside.
 
+Before hyperlink [#norm:hyperlink5]#GHI <<norm:superscript>> and <<norm:subscript>> JKL# outside.
+
+Before hyperlink [#norm:hyperlink6]#JKL <<norm:superscript,hello>> and <<norm:subscript,goodbye>> MNO# outside.
+
 [[non-norm-anchor]]
 Here's some text that isn't normative but the normatively tagged text has an existing link into it.
 

tests/norm-rule/test.adoc

@@ -64,6 +64,10 @@ normative_rule_definitions:
     tag: "norm:hyperlink3"
   - name: hyperlink4
     tag: "norm:hyperlink4"
+  - name: hyperlink5
+    tag: "norm:hyperlink5"
+  - name: hyperlink6
+    tag: "norm:hyperlink6"
 
   # Table
   - name: table1

tests/norm-rule/test.yaml

@@ -1063,12 +1063,22 @@ def html_chapter_table(f, table_num, chapter_name, nr_defs, tags, tag_fname2url)
       #
       # Can assume that the link is to the same HTML standards document as the
       # tag text that it is found in because these kind of links only link within their document.
-      tag_text.gsub!(/#{LT_UNICODE_STR}#{LT_UNICODE_STR}([^,]+)#{GT_UNICODE_STR}#{GT_UNICODE_STR}/) do
-        tag2html_link($1, $1, html_fname)
-      end
-
-      tag_text.gsub!(/#{LT_UNICODE_STR}#{LT_UNICODE_STR}([^,]+),(.+)#{GT_UNICODE_STR}#{GT_UNICODE_STR}/) do
-        tag2html_link($1, $2, html_fname)
+      #
+      # Note that I'm using the non-greedy regular expression (? after +) otherwise the regular expression
+      # will return multiple <<link>> in the same text as one.
+      tag_text.gsub!(/#{LT_UNICODE_STR}#{LT_UNICODE_STR}(.+?)#{GT_UNICODE_STR}#{GT_UNICODE_STR}/) do
+        # Look to see if custom text has been provided.
+        split_texts = $1.split(",")
+
+        if split_texts.length == 0
+          fail("Hyperlink '$1' is empty")
+        elsif split_texts.length == 1
+          tag2html_link(split_texts[0], split_texts[0], html_fname)
+        elsif split_texts.length == 2
+          tag2html_link(split_texts[0], split_texts[1], html_fname)
+        else
+          fail("Hyperlink '$1' contains too many commas")
+        end
       end
 
       tag_link = tag2html_link(tag_ref, tag_ref, html_fname)