source: wikiextrasplugin/trunk/tracwikiextras/doc/WikiPhrases

Last change on this file was 10273, checked in by Mikael Relbe, 12 years ago

WikiExtrasPlugin: Initial code

File size: 864 bytes
Line 
1= Wiki Phrases
2
3A wiki phrase belongs to one of the categories ''fixme'', ''todo'' or ''done'',
4and is highlighted to catch attention. Any delimiter `():<>` adjacent to a
5phrase will not be presented. This makes it possible to naturally write, for
6example, `FIXME:` in a wiki text, but view the phrase highlighted without the
7colon (`:`) which would not look natural.
8
9Use the following phrases to highlight problems, todos and results thereof:
10
11 [[ShowPhrases]]
12
13Prefixing a phrase with `!` prevents it from being highlighted.
14
15Example:
16 ||= Wiki markup =||= Display =||
17{{{#!td
18{{{
19FIXME: Something weird is going on
20}}}
21}}}
22 || FIXME: Something weird is going on ||
23
24----
25See also [TracIni#wikiextras-section TracIni], for configuration of phrases,
26and [WikiMacros#ShowPhrases-macro WikiMacros] on how to use the `ShowPhrases`
27macro.
Note: See TracBrowser for help on using the repository browser.