Abbreviation Definitions

Foxtrek_64

Active member
When working with communities which have a lot of proprietary terms, it can be helpful to have a set collection of definitions.

This can be done manually with abbr bbcode which gets converted into <abbr /> tags on rendering, but users must remember to do this for every single acronym or term in every single post they write.

We can simplify this process by setting up key-value pairs of terms and their definitions, and have these automatically be inserted when any user posts.

For instance, I could type "Go to the ACP and select the users node..." and if there is a definition configured for "ACP", it'll automatically be rendered as <abbr title="Admin Control Panel>ACP</abbr> when converted to HTML. I would expect that when saving the post (just to save on queries), it would save as [abbr="Admin Control Panel]ACP[/abbr].

Similarly, a [noabbr] tag may be useful, so if you don't want the abbreviation to be automatically inserted, you can wrap the term with this tag. When rendered as HTML, the noabbr tag is not rendered.

For bonus points, saving the data as an abbr tag should mean that searching for both the abbreviation and the expanded name should be possible.
 
Upvote 0
Similar position here.

Back with Xenforo v1 I used to use the word censor replacement to add these abbreviations, I've just tested now with Xenforo v2 and unfortunately it doesn't output replacement text as HTML.

I may end up resorting to Javascript/jQuery to achieve my goals dynamically - but would rather abbreviations were handled in the original served page for better SEO value/interpretation.
 
Back
Top Bottom