search

riebl / artery

OMNeT++ V2X simulation framework for ETSI ITS-G5
GNU General Public License v2.0
203 stars 131 forks source link

Add Glossary Feature #307

Closed Enough7 closed 1 year ago

Enough7 commented 1 year ago

Added a new file (abbreviations.md) which contains a comprehensive list of abbreviations used throughout the project documentation. This helps to ensure that all documentation readers are familiar with the specific language and terminologies used herein. The abbreviations list was also integrated into the project markdown extensions for automatic appending in documents, improving readability and understandability of the project documentation.

Example (Cursor is not visible): Screencast from 2023-08-31 11-42-24.webm

Enough7 commented 1 year ago

I took these from my LaTeX-Glossary. Some of them are not used by the website but some of them could be used in the future. I probably add more soon. Let me know if this work is appreciated.

riebl commented 1 year ago

Thanks, much appreciated! Does mkdocs also support links for glossary entries? If the acronym refers to a project, institute, or product, we may want to add a URL to prevent any ambiguities.

Enough7 commented 1 year ago

@riebl I think I tried that here and I think it did not work out as intended but it looks like it is possible