@neo4j-antora/mark-terms 1.0.0

package/README.md

@@ -0,0 +1,35 @@
+# mark-terms
+
+Marks the first usage of a term or terms on a page by appending asciidoc after the term. Typically, this is used to add a registered trademark.
+
+## Usage
+
+Add the extension to a playbook:
+
+```
+asciidoc:
+  extensions:
+  - ./extensions/mark-terms/mark-terms.js
+```
+
+Add a comma-separated list of terms to be marked:
+
+```
+asciidoc:
+  attributes:
+    page-terms-to-mark: Term1, Term2
+```
+
+Optionally, add the asciidoc to be appended to the first instance of the term:
+
+```
+asciidoc:
+  attributes:
+    page-terms-marker: ©
+```
+
+If you don't add `page-terms-marker`, the default value is used. The default value is `®`
+
+## Limitationa and known issues
+
+The extension reads the document blocks and matches 

package/mark-terms.js

@@ -0,0 +1,101 @@
+module.exports = function (registry) {
+  registry.treeProcessor(function () {
+    var self = this
+    self.process(function(doc) {
+
+      if (!doc.getAttribute('page-terms-to-mark')) return
+
+      let terms = doc.getAttribute('page-terms-to-mark').split(',').map(function (value) {
+          return value.trim();
+        })
+
+      let devMode = doc.getAttribute('page-terms-dev-mode')
+
+      if (!terms) return
+
+      let marker = doc.getAttribute('page-terms-marker') || '^®^'
+
+      let markAdded = []
+      
+      terms.forEach(term => {
+
+        // experimental regex with negative lookbehind and lookahead DO NOT USE
+        // let re = new RegExp(`(?<!\w+:)${term}(?!\\[\.*\])`)
+
+        // terms should appear:
+        // - as a word at the beginning of a line
+        // - as a word after a space
+        // - after a [ if they are the start of the text output of an inline macro
+              
+        // let re = new RegExp(`(^|\\[|\s)${term}`)
+
+        let re = new RegExp(`(^|\\[|\\s)${term}\\b`)
+
+        let reMarked = new RegExp(`${term} ${marker}`)
+
+        doc.findBy().forEach(block => {
+          
+
+          // if we've already marked ths, don't mark it again
+          // unless testing in dev mode
+          if ( markAdded.includes(term) && !devMode) return
+
+          // ignore listing blocks (which includes source blocks) and literal blocks
+          if (block.getContext() === 'listing' || block.getContext() === 'literal') return
+
+          // heading?
+          if (block.getContext() === 'section') {
+            let reggedTitle = testLine(block.getName())
+            block.setTitle(reggedTitle)
+            return
+          }
+
+          // tables aren't blocks with lines
+          // table cells can be checked for their text
+          if (block.getContext() === 'table_cell') {
+            let reggedText = testLine(block.text)
+            block.text = reggedText
+            return
+          }
+
+          // if the block contains no lines, return
+          if ( !block.lines) return
+
+          // test each line
+          block.lines.forEach((line, i) => {
+            let reggedLine = testLine(line)
+            block.lines[i] = reggedLine
+          })
+
+        })
+
+        // test a line of content from a block or a table cell
+        function testLine(line) {
+        
+          // return if we've already marked this term
+          if (markAdded.includes(term) && !devMode) return line
+
+          // return if this term is already marked
+          if (reMarked.test(line)) {
+              markAdded.push(term)
+              return line
+          }
+
+          // mark the first instance of the term if we find a match
+          if (re.test(line)) {
+              markAdded.push(term)
+              return line.replace(re, '$1' + term + marker)
+          }
+
+          // we checked but there was no match
+          return line
+          
+        }
+
+      })
+      
+    })
+  })
+}
+
+

package/package.json

@@ -0,0 +1,19 @@
+{
+    "name": "@neo4j-antora/mark-terms",
+    "version": "1.0.0",
+    "description": "Asciidoc extension to mark the first instance of a term on a page, typically with a copyright symbol",
+    "main": "mark-terms.js",
+    "scripts": {
+      "test": "echo \"Error: no test specified\" && exit 1"
+    },
+    "repository": {
+      "type": "git",
+      "url": "git+https://github.com/neo4j/docs-asciidoc-extensions.git"
+    },
+    "author": "Neo4j Documentation <docs@neo4j,com>",
+    "license": "MIT",
+    "bugs": {
+      "url": "https://github.com/neo4j/docs-asciidoc-extensions/issues"
+    },
+    "homepage": "https://github.com/neo4j/docs-asciidoc-extensions#readme"
+  }