Extended Wiki formatting

[whitelynx]

My company is using Trac for its project management. We use the Wiki portion for all our documentation, but we have run into some issues with it:

• A "comment block" markup similar to phpBB's [quote=username]...quote tags, to allow a comment block to be added and tagged with the name of the person who wrote the comment. This helps separate comments and side notes from the main flow of a document. (comment blocks could be floated to the side or even just enclosed in a border so they are visually separated and easier to read around)
• A "notes" markup. This one's somewhat harder to explain, but basically it should be easy to add small inline notes into a document that would usually be formatted as smaller, italicized text. This is useful for side notes and comments by the actual document author.
• TODO tags. (and possibly FIXME, and other similar tags) This is a useful way of keeping track of unfinished documents and documents that need to be fixed. It would also be nice to be able to generate a report showing all existing TODO tags in the wiki.

I've heard that some of these may be added to the Trac trunk in the near future, which would be great. If not, it would be nice to see these in a hack of some sort.

[Alec Thomas]

Most of this should be fairly trivial to add with the ​IWikiSyntaxProvider extension point. ​Here is an example from trac.ticket.api, providing ticket #<ticket> syntax

[muness@…]

TODO tags and FIXME (as well as any other tags you want) are already available. See ​http://dev.muness.textdriven.com/trac.cgi/wiki/tags to add tagging to Trac.

[whitelynx]

That's not exactly what I meant by TODO and FIXME tags, although that could be part of the solution. Basically, I'm thinking of something similar to the WantedPagesMacro hack, except instead of searching for broken traclinks, look for any of a given set of strings. (for instance, "TODO" and "FIXME") Then it could list those using a macro (similar to [ListTags]) on another page. The list of them could list how many of each string there were on each wiki page, and possibly even link directly to those occurrences.

[muness@…]

Thanks to Alec's tag api changes, you could implement this using the tagging stuff. What it comes down to is that you can now have different tag providers (one being the TagIt macro/tables and another being ticket keywords). You could implement another "provider" that actually searches wiki pages for TODO and FIXME or whatever convention you want to search on.

[Christian Boos]

See also ​#T2048 and the ​div-span-macro.patch and/or the ​WikiTemplates plugin at dev.usoft.org.

[Ryan J Ollos]

Replying to whitelynx:

• TODO tags. (and possibly FIXME, and other similar tags) This is a useful way of keeping track of unfinished documents and documents that need to be fixed. It would also be nice to be able to generate a report showing all existing TODO tags in the wiki.

See also WikiExtrasPlugin.