jacobmbarnard / srsgem

Ruby gem that allows for making an SRS out of Markdown and PlantUML
Other
1 stars 0 forks source link

srsgem:tterm tag #9

Open jacobmbarnard opened 2 weeks ago

jacobmbarnard commented 2 weeks ago

Improvement

Allow user to create a link to a technical glossary term without having to know the anchor tag string.

The link URL portion should simply be srsgem:tterm, and the link text should match the technical term in question (case insensitive).

For example, [My Specific Term](srsgem:tterm) would be translated into <a href="#def_tech_my-specific-term">My Specific Term</a>, which then Pandoc can translate into a correct anchor link in the HTML documentation output.

Example Usage

In 006-technical-constraints.md ...

## Rate Limiting Specific Semaphores

- Rate limit of [Type 84NF2 Semaphore](srsgem:tterm) shall be 100 Hz.
- Rate limit of [Type 42O93 Semaphore](srsgem:tterm) shall be 200 Hz.
- Rate limit of [Type ABC10 Semaphore](srsgem:tterm) shall be 623 Hz.

...would end up looking like:

Rate Limiting Specific Semaphores