In a domain specific wiki (eg http://brewiki.org) there are lots of abbreviations and domain specific terms. What would be nice is the option of turning on "glossary tool tips". I want to avoid adding markup to the page for every glossary term (otherwise I would just use FootNote()).
In brief I am thinking something like:
- Create a special page called containing terms + definitions (+ optional link).
- Add pragma to a page which turned on the feature. The pragma might select the wiki page to use as a glossary.
When the page is rendered, terms that were in the glossary would have something like an HTML <abbr> tag added so when the user moused over the term, a definition popped up.
The glossary definition would presumably be some form of text dictionary. An optional link for the term would be nice too, which would be expanded as an <a> tag.
Example (pseudo markup), in the glossary page:
BJCP :: Beer Judge Certification Program :: http://bjcp.org
Instances of "BJCP" in other pages would show "Beer Judge Certification Program" as a tool tip and clicking on it would take me to http://bjcp.org.
I think this feature could be generally useful.
After digging about further, there seems to be an example related to this at http://benjamin.sipsolutions.net/Projects/eXperience/HowTo via http://moinmoin.wikiwikiweb.de/parser/acronyms.py
I have now got this to work, I fixed a typo in the example and I deleted my cache and badabing.
I guess I will have to grok the parser API to figure out how to make this work without additional markup. Any tips are welcome.
See parser/glossary.py for my first crack at it.