Edgewall Software

Wiki "phrases"

Wiki phrases are an interesting way to introduce some attention grabers in Wiki text, such as FIXME:FIXME. This wiki extension is provided by the TH:WikiExtrasPlugin.

Wiki Phrases

A wiki phrase belongs to one of the categories fixme, todo or done, and is highlighted to catch attention. Any delimiter ():<> adjacent to a phrase will not be presented. This makes it possible to naturally write, for example, FIXME: in a wiki text, but view the phrase highlighted without the colon (:) which would not look natural.

Use the following phrases to highlight problems, todos and results thereof:

BUG BUG
FIXME FIXME
CHECK CHECK
OPEN OPEN
REVIEW REVIEW
TODO TODO
VERIFY VERIFY
CHECKED CHECKED
CLOSED CLOSED
DONE DONE
FIXED FIXED
REVIEWED REVIEWED
VERIFIED VERIFIED

Prefixing a phrase with ! prevents it from being highlighted.

Example:

Wiki markup Display
FIXME: Something weird is going on
FIXME Something weird is going on

See also TracIni, for configuration of phrases, and WikiMacros on how to use the ShowPhrases macro.

Ideas

It would be nice to have the possibility of a "recap" of the occurrences of wiki phrases. Each occurrence should have a unique id, and a recap macro should present the links, perhaps sorted by category and phrases.

Examples:

[[PhrasesRecap(todo)]]
[[PhrasesRecap(todo fixme)]]

Besides the macro (useful for Wiki pages) there should also be a stream filter which could insert a recap for todo and fixme somewhere in a ticket…

Last modified 6 years ago Last modified on Apr 24, 2012, 12:42:04 PM
Note: See TracWiki for help on using the wiki.