RegEx Tool

[FroudeDescartes]

Create a tool that will help PMs and content creators for writing a documents in .md. This tool will allow them to easily type without concerning about a special tags when they come across a keyword.

Keywords have their definition abbreviation and definition description (ex. 2D : Two-dimensional. Two special dimensions.). These keywords will be listed at the beginning of a document in a table. This table is linked to a property called terminology. This tool will recognize keywords when they get typed in and create a hyperlink to terminology table. Hyperlinking should NOT be affected by keyword being:

• written in plural or singular,
• italic, bold, subscript text, superscript text
• in blockquote, code-block, preformatted text, code with syntax, non-breaking line
• in a list (ordered or unordered)
• in a table cell

One documentation for def, one for abbr. One on root level, on remote (external).

Idea for constructing a architecture of tool is to have a single file called terminology.yml from which will this tool read definitions and abbreviations. This file can be constructed like this:

const terminology = {
  definitions: {
        type: Array,
        href: "string"//local path and external path
    },
    abbreviations: {
        type: Array,
        href: "string"//local path and external path
    }
}

For more detailed instructions, refer to a Terminology & Convention Rules

related issue: #68

[jpradocueva]

@FroudeDescartes, I am expanding some of the functionality here based on the discussion.

The current plan of record is to have a special tag Terminology: in the index.yaml file, with links to files (internal and external) containing definitions and abbreviations.

Terminology: on | off
   - definitions: 
          - <URL to .md file containing definitions, titles, and descriptions>
          - <URL to an external .md file containing definitions, titles, and descriptions>
   - abbreviations: 
          - <URL to .md file containing abbreviations>
          - <URL to an external .md file containing abbreviations>

If the special tag Terminology is included, MD2HTML will trigger the function for creating definition links in the document and show abbreviations on hover. This added feature will boost CPU usage and the time needed to construct terminology in the documents. Hence, we require a single on/off switch to retain the links to definitions and abbreviations in index.yaml to control when to build or not the terminology.