https://github.com/DITAWriter/dita_glossary_example

An example of a converted DITA-based document ("On Yacht Sailing") that implements a glossary
https://github.com/DITAWriter/dita_glossary_example

Last synced: 2 months ago
JSON representation

An example of a converted DITA-based document ("On Yacht Sailing") that implements a glossary

• Host: GitHub
• URL: https://github.com/DITAWriter/dita_glossary_example
• Owner: DITAWriter
• License: cc0-1.0
• Created: 2023-09-20T01:47:19.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-09-20T13:07:23.000Z (over 1 year ago)
• Last Synced: 2024-08-02T06:12:09.446Z (5 months ago)
• Size: 1.15 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-technical-writing-learning - DITA Glossary Example - A book named *On Yacht Sailing* rewritten in DITA to demonstrate how to implement glossaries. (Authoring formats / DITA)

README

        
# dita_glossary_example

An example of a converted DITA-based document ("On Yacht Sailing") that implements a glossary. 

This implements one possible version of a glossary based in DITA, where term tags in the the body content point to specific glossentry topics, arranged within the backmatter of a bookmap. This sample goes overboard (pardon the pun) when it comes to referencing terms, as best practice suggests only referencing a term at first instance within a topic, rather than any instance.