Glossary

DynaDoc includes a script that will automatically generate a glossary of terms page with links to pages where the terms appear. You need to define the terms and definitions.

Generally, the glossary is updated only when the script is ready for publishing. You do not need to update the glossary links during the normal edit and review cycles.

Building the glossary is fairly easy, and uses very basic syntax. The glossary source should be created as a text file in the glossary folder and named glossary.csv. Each line contains the following elements separated by "|". The trailing "|" is required.

case_control|word|description|

Case Control can have the following

• * - Forces case sensitive match, and can be used for acronyms.
• ~ - Separates variations of words, example: "video ~video, ~video." will not match VideoRay

If case control is not used, the "|" is still required before the word.

To create a glossary, follow these steps:

1. open glossary\glossary.csv in your editor.

2. The first line in the file should be: case_control|word|description|
3. After this required line, we can start adding entries. Entry format is always |Keyword|Definition or Description| as shown in the above image.
4. Create a new line after every glossary entry.
5. Once you've saved your file with the entries, we need to run the dynadoc_glossary.php script using the Glossary button.
6. Open localhost, and navigate to your project's category.
7. Click on the "Glossary" button to create the glossary.
8. The glossary is generated.
9. Make sure to regenerate your document with the regular DynaDoc script to include the newly created _glossary.htm file.

exclude.csv provides the glossary script with a list of pages that should be ignored when the glossary links are created. For example, links should not be created to the table of contents. A master exclude.csv is included in the required folder. If you want to exclude pages on a project basis, create an exclude.csv file in the project's local glossary folder. See the required exclude.csv for the file's format.