terminology-plugin-instructions.md 3.45 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
---
id: terminology-plugin-instructions
title: Terminology & Glossary plugin docs
---
import useBaseUrl from '@docusaurus/useBaseUrl';


### How it works

This plugin parses docs in two ways:

  1. Parses all markdown files and replaces a specific pattern with a React 
  component which supports a tooltip functionality (more information below)
  2. Parses all markdown files and generates a glossary page with all the 
  pattern terms found in the `.md` files
  
## Replace all patterns with tooltip information

When writing documentation, you can use the following syntax:

```
%%term_text|term_name%%
```

where:
- `term_text`: The terminology text you want it to be visible in the documentation 
page
- `term_name`: The filename of the term file, which resides under `./docs/terms` directory.

After the successful run of the script, the output of this functionality will be 
a React Component, which will render the `term_text` as a link, directing to 
the term page (which will be generated from the `term_name` attribute), and 
when the user *hovers* the `term_text` it will show a brief summary of the term.

### Example usage

Say you want to reference a term that exists under the `./docs/terms/` directory, 
e.g. `./docs/terms/party.md`. You can use the following syntax to reference 
this term in your documentation page:

```
Some content that wants to reference the %%Party|party%% term
```

When the script runs, this will be replaced as follows:

```
Some content that wants to reference the <Term reference="party" popup="Popup text">Party</Term> term
```

which supports the functionality explained above.

### How to correctly write a term

This plugin assumes that you follow the structure, as explained below:

Each term should have its own `.md` file, inside the `./docs/terms` directory, 
and it needs to consist of the following structure:

```title="./docs/terms/term.md"
---
id: term
title: Term page
hoverText: This hover text will appear in the documentation page that you reference this term
---

### Term explanation

content here
```

> Pay attention to the `hoverText` attribute, as it's important to provide this 
>attribute (along with the default docusaurus attributes), so the plugin can 
>fetch the correct popup text to show when referencing a term.

### Running the script

When you are finished referencing terms and generating term pages, you can test 
this locally by running the following command:

```.shell script
$ yarn parse
yarn run v1.22.5
 docusaurus parse
Replacing patterns with <Term />
Done in 1.41s.
```

This will replace all `%%term_text|term_name%%` occurrences everywhere with the 
React component to support the functionality above.

Here's an example where the terms have been replaced. When the project is up 
and running, you can visit the test example on the `/docs/replacement-test` page:

<img alt="replacement-test" src={useBaseUrl('images/replacement-test.png')}/>


## Generate the glossary page

If everything works well with the above procedure, you can then generate a 
glossary page, by running the following command:

```.shell script
$ yarn glossary
yarn run v1.22.5
 docusaurus glossary
Alphabetical list of terms
Done in 1.53s.
```

This will generate a file in `./docs/glossary.md` where every term that has been 
mentioned above, will be populated in the `glossary.md` page.

When the project is up and running, you can visit the glossary on the `/docs/essif-lab-glossary` page:

 <img alt="glossary-page" src={useBaseUrl('images/glossary-page.png')}/>