DokuWiki

It's better when it's simple

User Tools

Site Tools


abbreviations

This is an old revision of the document!


Abbreviations and Acronyms

DokuWiki can mark abbreviations and acronyms (terminology) automatically. If your browser supports the <acronym> tag, you can hover your mouse on an abbreviation to see a short explanation, shown as a tooltip. For example, if the mouse is positioned over XML (which is included in the default acronyms list), the tooltip displays Extensible Markup Language.

Some preconfigured examples:

  • BTW, CMS, FAQ, HTML, WYSIWYG

Note: only full words will be marked. Eg. an acronym that is used within a word will not result in a acronym tooltip. Example: XML is an acronym, myXML is not.

At some point, the supported tag will switch from <acronym> to <abbr>1) as DokuWiki becomes more HTML5-compliant. There is a general feature request in the bug tracker but it is not targeted for any particular release.

Configuration

  • DokuWiki's standard abbreviations are stored in the conf/acronyms.conf file. You can add your own abbreviations by creating a conf/acronyms.local.conf file and placing your abbreviations
  • The acronyms file has to be encoded in UTF-8.
  • Because it is reserved to mark a comment line, a hash (#) needs to be escaped by a backslash (\#)
1)
According to the W3C http://www.w3schools.com/tags/ref_html_dtd.asp, HTML5 includes the <abbr> tag but not <acronym>.
abbreviations.1371218877.txt.gz · Last modified: 2013-06-14 16:07 by 85.5.34.67

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki