Opened 9 years ago

Last modified 9 years ago

#4909 new enhancement

[PATCH] Add class documentation to appear in [[WikiMacros]] call

Reported by: kontakt@… Owned by: Shun-ichi Goto
Priority: low Component: TicketBoxMacro
Severity: trivial Keywords:
Cc: Trac Release: 0.11


As my users are ancouraged to make use of all the TracWiki magic they want to express themselves, I like to have all those possibilities well documented. However, when I looked at the WikiMacros Page after having installed TicketBoxMacro, I noticed that [[TicketBox]] only had the word "None" showing up as documentation.

So I did a little hacking and basically just copied the doc lines from the beginning of to just after the class definition, so it gets rendered by a [[WikiMacros]] call.

I've svn-diffed it and attached it as a patch, though it's trivial after all. If you decide to use it, please remember to change all two instances of the documentation when you change sth therein. (Maybe one could put it in a variable to re-use it, but I'm all new to python as of now.)

Attachments (1)

wikimakros_doc.patch (2.7 KB) - added by kontakt@… 9 years ago.
Re-used Macro documentation for class documentation to show up in a WikiMacros call

Download all attachments as: .zip

Change History (2)

Changed 9 years ago by kontakt@…

Attachment: wikimakros_doc.patch added

Re-used Macro documentation for class documentation to show up in a WikiMacros call

comment:1 Changed 9 years ago by kontakt@…

Darn, shoulda escaped that [[WikiMacros]] in the upload description, too... sorry for that.

Modify Ticket

Change Properties
Set your email in Preferences
as new The owner will remain Shun-ichi Goto.

Add Comment

E-mail address and name can be saved in the Preferences.

Note: See TracTickets for help on using tickets.