Make Definition Tagging Case-Insensitive
I'd like to suggest an enhancement to the Definitions module.
Currently, tagging a definition automatically changes the text to match the capitalization used in the definition.
While this works well for headings and titles, it can create grammatical issues when the same term is used within normal sentence text.
For example, we have a definition titled "Ad Hoc Route." In a heading, this capitalization is appropriate. However, within a sentence, the term would normally be written as "ad hoc route." When the definition is tagged, WebManuals changes the text to "Ad Hoc Route," which is inconsistent with standard writing conventions.
It would be helpful if users could:
- Tag a defined term without changing its existing capitalization.
- Have definitions recognized regardless of case (e.g., "Ad Hoc Route," "ad hoc route," or "AD HOC ROUTE").
- Preserve the intended grammar and formatting of the document while still maintaining the definition link.
For organizations managing large manuals and controlled documentation, this would improve readability and reduce the need to choose between proper grammar and definition linking.
Is anyone else encountering this issue or interested in seeing this functionality added?
Thank you for considering this enhancement.
Comments
I totally agree, this would make the job a lot easier.
I would also like to see this improvement.
We currently have this same issue with a workaround that is not ideal, but functional.
First, we created multiple definitions for the same item. So for "hazard" we created a definition where it is capitalized (Hazard) and another where it is not capitalized (hazard). Then the editor chooses which definition to insert based on the grammar.
Second, Web Manuals Support provided some custom CSS for our Page Design that capitalizes all definitions in the Definitions module so that there is not a mixture of capitalized/non-capitalized items in the module. All definitions in the module are automatically capitalized.
The pitfall to avoid here is to only insert a definition one time throughout the manual. For example, if I insert hazard (non-capitalized) and Hazard (capitalized) in the same manual then Hazard will appear twice in the Definitions module.
One other detail, the CSS can also remove the highlighting of the definition where it appears in the text. It makes the definition look just like any other text around it rather than having the pale yellow highlighting. I'm guessing this could also be applied to Abbreviations if the highlighting was not wanted, but I have not tried it.
Please sign in to leave a comment.