= The Macro Bazaar [[PageOutline(2-3, Categories, pullout)]] {{{#!box warn **THIS PAGE IS DEPRECATED:** If you are the author of a macro listed here, please move it to more suitable hosting. [http://trac-hacks.org trac-hacks.org] provides free hosting for TracPlugins, WikiProcessors and WikiMacros. }}} Some macros got removed, as they are (or their functionality is) now available as plugins on th:wiki. There is currently a discusson if this page should be phased out completely on [http://groups.google.com/group/trac-dev/browse_thread/thread/9c1f20fb5de41b6a trac-dev list]. Looking for fresh macro goodness for your Trac installation? Have you written a clever macro you're dying to share with the world? This is the place. The macro bazaar is for sharing information about user-developer macros, links to source code and requests. '''Note:''' ''Please state your name, email, and version of Trac your macro is developed for.'' '''Another Note:''' '' [http://trac-hacks.org Trac Hacks] provides free '''Trac + Subversion''' hosting for Trac macros, patches, plugins, etc.''' '''Installing a macro ''(old style "HDF" macros)'' ''' 1. Download the ''.py'' file. 1. Save it to your '''`projenv/wiki-macros`''' directory 1. Restart your web server 1. Open a Wiki page and add the macro text to test the macro (usually something like `[[Macro]]` or `[[Macro(argument1, argument2)]]` Note that this kind of macros is still supported in Trac [milestone:0.10], but deprecated. You should start developing and using macros as plugins implementing the `IWikiMacroProvider` interface, or, even simpler, inheriting from the `trac.wiki.macros.WikiMacroBase` class. '''Installing a macro ''(new style macros)'' ''' This follows the same rules as installing a plugin, see TracPlugins. But usually, macros are simple enough so that they can be developed as ''single file plugins''. In that case, the installation is simpler, and much similar to the above: 1. Download the ''.py'' file. 1. Save it to your '''`projenv/plugins`''' directory 1. Restart your web server 1. Open a Wiki page and add the macro text to test the macro (usually something like `[[Macro]]` or `[[Macro(argument1, argument2)]]` Example for such macros are provided below: - [#AutoNav AutoNav] - [#Color Color] You can '''edit the macro''' by using any text editor and editing the ''trac.db/wiki-macros/.py'' file. Make the appropriate changes, restart the web server you are using, and the changes should appear. '''To delete the macro''', just delete all the macro files in the ''trac.db/wiki-macros'' directory (that have the form ''.*''). == Examples == === !HelloWorld === A simple example macro. Distributed with Trac. [[BR]]''Download:'' source:trunk/wiki-macros/HelloWorld.py [[BR]]''By:'' TracTeam -- ''Ver:'' >0.5.2 [wiki:MacroBazaar#Categories (categories)] ---- == Includes == === include === Inserts the output of an external URL. Example: {{{ [[include(http://www.example.com/)]] }}} [[BR]]''Download:'' http://randomfoo.net/code/trac/include.py [[BR]]''By:'' lhl -- ''Ver:'' 0.7.1 Replacement that also handles the [wiki:MacroBazaar#WikiFile WikiFile] macro below. Docs are inside the module @ the top. [[BR]]''Download:'' [attachment:Include.2.py] [[BR]]''By:'' csawyer@yumaed.org -- ''Ver:'' 0.8 [[BR]]''Download:'' [attachment:Include.3.py] [[BR]]''By:'' cbrant@gmail.com -- ''Ver:'' 0.9.3 === !WikiInclude === Inserts the contents of another wiki page. It expands arguments in the page in the form {{N}}. Example: {{{ [[WikiInclude(Foo)]] [[WikiInclude(Foo|Argument1|Argument2..|ArgumentN)]] }}} ''Version:'' >= 0.8 [[BR]]''Download:'' [attachment:WikiInclude.py] ''Version:'' >= 0.9 [[BR]]''Download:'' [attachment:WikiInclude.2.py] [[BR]]''By:'' Vegard Eriksen zyp at jvnv dot net ''Version:'' >= 0.11 [[BR]]''Download:'' [attachment:WikiInclude.0.11.py] [[BR]]''By:'' [mailto:chelah@bootbox.net] [[BR]]'''Based on !WikiInclude, I've created the sucessor [http://dev.ufsoft.org/TracWikiTemplates TracWikiTemplates Plugin] - [mailto:ufsATufsoftDOTorg s0undt3ch]''' === !WikiFile === Inserts the output of an URL/file as wiki file. The file can be written in trac syntax and the macro will convert it to html. The macro looks at the suffix of the file and tries to interpret it according to that syntax, html will be intrepreted as html rst will be interpreted Restructured Text cpp as c++ etc So you can have a file on the filesystem that is written with trac syntax or restructured text and display it within the wiki. The advantage is that you can use version control on file. The disadvantage is that you cant click page history and see the history of the page. You can also not edit the file within the Wiki which takes away alot of the advantages of a Wiki. But within a company it might be ok. Example: {{{ [[WikiFile(http://www.example.com/myfile.rst)]] }}} ''Download:'' [attachment:WikiFile.py] ''By:'' Toni Brkic toni.brkic at switchcore.com -- ''Required ver'' patch for #801 must be implemented === !MimeInclude === Inserts the output of an external URL, with an optional MIMEtype argument for rendering mode and colorization. See the examples in code docstring. Enjoy! [[BR]]''Download:'' [attachment:MimeInclude.py] [[BR]]''By:'' Carlo C8E Miron -- ''Ver:'' >= 0.8.1 (tested on Debian versions 0.8.1-2 until 0.8.4-1) === !IncludeSource === This plugin define a new wiki macro "!IncludeSource", then you can use a source file under subversion as wiki source for trac wiki. Example: {{{ [[InsertSource(/path/to/wiki-source-file/under/subversion)]] }}} [[BR]]''Download:'' http://niw.at/articles/2006/12/16/include-source-wiki-macro-for-trac [[BR]]''By:'' niw -- ''Ver:'' = 0.10.x I have attached a modified version of the IncludeSource macro here. It is based on niw's version (linked above), buts adds a few new features, such as line numbering with links (just like the regular Trac browser pages), along with support for including line ranges and targeting specific revisions. From the macro doc: Examples: {{{ # include entire file [[IncludeSource(trunk/proj/file.py)]] # includes line 20-50 inclusive [[IncludeSource(trunk/proj/file.py, start=20, end=50)]] # includes last 30 lines of file at revision 1200 [[IncludeSource(trunk/proj/file.py, start=-30, rev=1200)]] # include entire file but formatted plain [[IncludeSource(trunk/proj/file.py, mimetype=text/plain)]] }}} Note that it currently has a bug with calling the macro twice in the same page. The source has additional information about where this happens. It seems to be related to apr pool stuff in the subversion python bindings. [[BR]]''By:'' chris.heller -- ''Ver:'' = 0.10.x [wiki:MacroBazaar#Categories (categories)] ---- == Site Navigation == === !BackLinks === First stab at a macro that displays all wiki pages linking to a specified page name. Usage: {{{ [[BackLinks(pagename)]] }}} I'd really like it to default to displaying backlinks to the current page when a page name isn't supplied, but, um, I have no idea how to do that. Suggestions greatly appreciated. [[BR]] ''Download:'' [attachment:BackLinks.py] [[BR]]''By:'' Dan Hon -- ''Ver.'' >= 0.7.1 Dan, here's an idea. {{{ thispage = hdf.getValue('wiki.page_name', '') }}} ''Download:'' [attachment:BackLinks.2.py] patches the wikimacro to default to display backlinks to the current page if a page name is not specified. [[BR]]''By:'' Muness Alrubaie -- ''Ver.'' >= 0.8 Well, both those seem to have a bug: they will list pages for which at least one version linked to thispage, rather than just the latest version. So here's a fixed macro. ''Download:'' [attachment:BackLinks3.py] patches the wikimacro to display only pages where the latest version links to the specified or current page. [[BR]] ''By:'' Andrew Durdin -- ''Ver.'' >= 0.8 [[BR]] Well, both those seem to have a bug: they will list pages for which at least one version linked to thispage, rather than just the latest version. So here's a fixed macro. ''Download:'' [attachment:BackLinks.3.py] based on Andrew's fix displays only pages where the latest version explicitly links (i.e. no CamelCase, only {{{ [wiki:... ...]}}} links) to the specified or current page. [[BR]] ''By:'' Muness Alrubaie -- ''Ver.'' >= 0.8 [[BR]] ''Download:'' [attachment:BackLinks.4.py] based on Andrew's and Muness's fixes, displays pages where the latest version contains either a CamelCase link OR explicitly links (i.e. {{{ [wiki:... ...]}}} links) to the specified or current page. [[BR]] ''By:'' Ed Szynaka -- ''Ver.'' >= 0.8 [[BR]] ''Download:'' [http://www.trapanator.com/blog/archives/category/trac BackLinks.5.py] based on Andrew's and Muness's fixes, with UTF-8 support and links like {{{[wiki:link]}}}.[[BR]] ''By:'' Trapanator -- ''Ver.'' >= 0.8[[BR]] ''Question:'' Is there a chance to integrate the macro in the wiki menu like Title Index? Would be very appretiated.[[BR]] ''Answer:'' See the section '''!BackLinksMenu''' === !BackLinksMenu === !BackLinksMenu is a macro that that can show a menu with wiki-pages that refer to actual page or to one page of your choice.[[BR]] You can download it from here: http://trac-hacks.org/wiki/BackLinksMenuMacro [[BR]] ''By:'' Trapanator -- ''Ver.'' >= 0.9[[BR]] === !AutoNav === Derived from !BackLinks. All references to the page where the macro is and all arguments supplied is sorted and looked up for references. ''Example:'' {{{ [[AutoNav()]] }}} Behaves as !BackLinks above and gets all the references to this page in a list. [[BR]]''Example:'' {{{ [[AutoNav(MyPage, AndThisPageToo, WithThisPage)]] }}} Add the Names "MyPage", "AndThisPageToo" and "WithThisPage" with the list of references to this page. ''By:'' Anders Jansson Reimplemented [attachment:AutoNav.3.py old] !AutoNav as a plugin (a.k.a "new style macro") for Trac 0.10 and upcoming Trac 0.11 (#3958) [[br]] ''Download:'' [attachment:autonav-trac-0.10.py autonav-trac-0.10.py] [attachment:autonav-trac-0.11.py autonav-trac-0.11.py] [[br]] ''Installation:'' place in your TracEnvironment, in the `plugins` subfolder. ''By:'' Andrew Stromnov , cboos === !ParentLinkage === Inserts a sort of "breadcrumb" set of links to the parent, grand-parent and so-forth wiki entries. This macro is inspired and sorta based on the !ParentWiki macro. This applies to wiki pages that have a "/" in their name indiciating the heirarchy. There is one argument allowed and this is a simple string of equal signs in the spirit of the wiki header formatting. The string must contain one or more equal signs and no other characters. The argument will trigger the macro to wrap the entire linkage in the appropriate HTML heading tags (with id attribute set). Something interesting to note is that if the content of the href's are !CamelCased words; the macro will somewhat intelligently break them up with spaces. This feature will also take the words "And" and "Of" and replace them with "and" and "of" respectively resulting in "ThisAndThat" being converted into "This and That". ''Download:'' [attachment:ParentLinkage.py] [[BR]]''Version:'' >= 0.10 [[BR]]''By:'' Kevin C. Krinke ==== !ParentLinkage Example A: ==== If the current page was named "!GrandParent/Parent/ACamelCaseName" and you insert: {{{ [[ParentLinkage]] }}} Results in the following HTML output: {{{ Grand Parent - Parent - A Camel Case Name }}} Which renders to something like: {{{ Grand Parent - Parent - A Camel Case Name }}} ==== !ParentLinkage Example B: ==== If the current page was named "!GrandParent/Parent/ACamelCaseName" and you insert: {{{ [[ParentLinkage(==)]] }}} Results in the following HTML output: {{{

Grand Parent - Parent - A Camel Case Name

}}} Which renders to something like: {{{ == Grand Parent - Parent - A Camel Case Name == }}} === !RelLink === Creates a link relative to the current page. Examples: ![[RelLink(deeper1)]] ''Download:'' [attachment:RelLink.py] [[BR]]''Version:'' >= 0.8? [[BR]]''By:'' Thomas Richter tr+tracweb@ariva.de === !ShowPath === Show the path to the specified wiki or the current wiki if none is specified. This is similar to the directory names at the top of the TracBrowser. This applies mainly to hierarchical wiki entries. e.g. the path to a {{{Book/Chapter/Section/Subsection}}} would be {{{WikiStart/Book/Chapter/Section/Subsection}}} (all but the current would be linked). ''Download:'' [attachment:ShowPath.py] [[BR]]''Version:'' >= 0.8 [[BR]]''By:'' Muness Alrubaie Note: If this strikes you as something you want to hack into Trac (rather than calling it on every page) use [http://trac-hacks.org/wiki/TracShowPathPatch TracShowPathPatch]. '''0.11 version available:''' same functionality as described above, but for Trac 0.11dev (trunk). See source for details and trac.ini options. ''Download:'' [attachment:ShowPath.2.py] [[BR]]''Version:'' >= 0.11 [[BR]]''By:'' Morris === Redirect === It is sometimes useful to create alias names for wiki pages (or tickets or other trac objects. This can be accomplished using the "redirect" macro. ''Download:'' * For 0.8, use [attachment:redirect.py] * For 0.9, please see http://svn.ipd.uni-karlsruhe.de/trac/javaparty/wiki/TracRedirect ''Usage:'' E.g., on page !RequestForRedirect use ![[redirect(ticket:976)]] to create an alias wiki name for ticket #976. ''Note:'' the argument to the redirect macro must be in general form of TracLinks (item:id). ''Note:'' to edit a page that contains a redirect macro, you must type its URL directly into your browser's location bar and append the string '?edit=true' to it. ''Version:'' >= 0.8; < 0.9 [[BR]]''By:'' Bernhard Haumacher === TOC === This macro adds the ability to create table of contents on any set of pages. If a page is not specified, the current page and version is used. The table of contents is automatically generated from headings in the page. Usage: Table of contents for the current page and version: {{{ [[TOC]] }}} Table of contents for multiple pages: {{{ [[TOC(WikiStart, WikiFormatting)]] }}} ''Download:'' http://trac-hacks.org/wiki/TocMacro [[BR]]''By:'' Alec Thomas [[BR]]''Version:'' >= 0.7.1 (requires patch available at http://trac-hacks.org/wiki/AnchorPatch) ''23/05/05'': Michel Jouvin has added a {{{titleindex}}} argument which generates one line summaries for each page. He also modified the default behaviour to exclude the top-level heading, only displaying sub-headings. You can override this by explicitly including a page name. These changes have been integrated into trunk at the URL below. == Time & Date == === Timestamp === Inserts current date and time. Distributed with Trac. [[BR]]''Download:'' source:trunk/wiki-macros/Timestamp.py [[BR]]''By:'' TracTeam -- ''Ver:'' >0.5.2 === !DateOffset === Returns the date referred to as follows: * First arg is the offset, i.e. the date to start from * Second arg is the multiplier to multiply the count by (e.g. 7 for a week) * Third arg is the count (i.e. the number of additions to make). So, for example: * {{{ [[DateOffset(2005/01/05,7,0)]] }}} returns Wed Jan 05 * {{{ [[DateOffset(2005/01/05,7,4)]] }}} returns Wed Feb 02 You can also configure the input and output date formats. (See http://python.org/doc/2.3.4/lib/module-time.html). e.g.: * {{{ [[DateOffset(01/05/2005,7,0,%m/%d/%Y,%A %B %d)]] }}} returns Wednesday January 05 Please email me fixes and excuse any obvious errors: I've never written any python before this. ''Download:'' [attachment:DateOffset.py] [[BR]]''Version:'' >= 0.8 [[BR]]''By:'' Muness Alrubaie == Miscellaneous == === !TracChart === http://www.piedcow.com/archives/2005/03/inspired_to_cre.html Simple* Chart Stylesheet. A simple stylesheet and chart generator based on Digital Media Minute XML/SWF Charts. [[BR]]''By:'' The Pied Cow -- ''Ver:'' >0.8.0 === Debbug === Link to the [http://bugs.debian.org Debian BTS]; either a package's bug page or a specific bug. Example usage: {{{ [[Debbug(123456)]] [[Debbug(trac)]] }}} ''Download:'' [attachment:Debbug.py] [[BR]]''By:'' Joe Wreschnig -- ''Ver:'' >= 0.5.2 === Javadoc === Creates links to Javadoc pages based on a package or fully-qualified class name. Example usage: {{{ [[javadoc(java.lang)]] [[javadoc(java.lang.String)]] [[javadoc(java.lang.String, Text for link)]] }}} See source for customizing the available Javadoc URLs. ''Download:'' [attachment:javadoc.py] [[BR]]''By:'' Matthew Good -- ''Ver:'' >=0.7.1 === !TracPythonDoc === Generates PythonDoc output for files in the repository. Example usage for current revision: {{{ [[TracPythonDoc(trunk/myproject/myfile.py)]] }}} And specific revision: {{{ [[TracPythonDoc(trunk/myproject/myfile.py, 420)]] }}} ''Download:'' http://blog.melhase.net/files/TracPythonDoc.py [[BR]]''By:'' Troy Melhase -- ''Ver:'' >=0.9 [wiki:MacroBazaar#Categories (categories)] ---- == Uncategorized == === Download Stats === This macro shows webalizer statistics from one or more patterns. You have to give the webalizer html files path as first argument followed by one or more patterns using | (pipe) as delimiter. Usage: {{{ [[downloadStats(|||...|)]] }}} Example: {{{ [[downloadStats(/var/www/webalizer/|sarge-i386-1.raw|debian-br-cdd_1.0pre5.iso)]] }}} ''Download:'' [attachment:downloadStats.py] [[BR]]''By:'' Tiago Bortoletto Vaz [[BR]]''Ver.'' >= 0.7.1 === !UserChanges === Trivial change of the RecentChanges macro that only displays the recently changed pages for a specified user. Usage: {{{ [[UserChange(username)]] or [[UserChange(username, # of last modified pages to display)]] }}} ''Download:'' [attachment:UserChanges.py] [[BR]]''By:'' David Mohr -- ''Ver.'' >= 0.7.1 === !SvnFiles === This macro autogenerates a list of clickable file links referring to files in a given directory of the repository whose names match a given regular expression. We needed this for a page giving an overall view of project progress for a project broken up into a shallow hierarchy, combined with !ReTickets (below) it autogenerates an overview wiki page. ''Please don't laugh at the code, I've been playing with trac for 2 days and had never touched python before writing these two...'' ''Usage'' {{{ [[SvnFiles(directory,regexp)]] }}} All arguments are needed, god alone knows what happens if you leave them out. ''Download:'' [attachment:SvnFiles.py] ''Version:'' 0.8 ''By:'' Simon Stapleton ''Download:'' [attachment:SvnFiles.2.py] ''Version:'' 0.9 ''By:'' Krachtwerk ''Download:'' [attachment:SvnFiles-0.10.py] ''Version:'' 0.10 ''By:'' Rasmus -- patched 0.9 with file name sorting and added
at end of each line === !ReTickets === This macro autogenerates a list of clickable ticket links (link number and person assigned) referring to tickets whose summaries match a given regular expression. We needed this for a page giving an overall view of project progress for a project broken up into a shallow hierarchy, combined with SvnFiles (above) it autogenerates an overview wiki page. As an added bonus, hovering over the links gives the summary and description of the ticket. Patched 2008-01-30 by Vladislav Naumov to handle a nasty issue with quotes in summary or description. ''Usage'' {{{ [[ReTickets(regexp)]] }}} ''Download:'' [attachment:ReTickets.2.py][[BR]] ''Version:'' 0.8[[BR]] ''By:'' Simon Stapleton [[BR]] ''Updated By:'' Vladislav Naumov === Search === Build a search URL for the supplied argument or just a link to a search engine if no args are present. Set to use google. Edit the macro to modify the engine(/url). ''Download:'' [attachment:Search.py] [[BR]]''Version:'' >= 0.8 [[BR]]''By:'' Muness Alrubaie === !TracSearch === Builds a link to search for a supplied argument in any or all of the wiki, changesets, and tickets. ''Download:'' [attachment:TracSearch.py] [[BR]]''Version:'' >= 0.8 [[BR]]''By:'' Andrew Durdin === Blog === A simple blog macro which renders matched wiki pages on one page. Only one month's wiki pages are shown at once. Usage example: {{{ [[Blog(blog/%)]] [[Blog(2004%,blog/%)]] }}} Note: if you're using macro redirect and AddComment, you may need to modify these macros to disable them by: {{{ if hdf.getValue('macro.blog.rendering', '0') == '1': # workaround: if this wiki is rendering via macro Blog, don't redirect! out.write('
Warning: redirection disabled in Blog mode.
') return out.getvalue() }}} [[BR]]Download: [attachment:Blog.py] [[BR]]By: Walter Wong [[BR]]Version: >=0.8 Download: [attachment:Blog.2.py] [[BR]]Adopted to work on my 0.9.3 [[BR]]''Version:'' >= 0.9.x? [[BR]]''By:'' Christian Eberl [[BR]]Download: [attachment:Blog.ByCreationDate.py] [[BR]]Adapted By: Dan Mahn [[BR]]Version: 0.10 [[BR]]Mods: 1. Display blog pages by page creation date instead of last edit date. This allows edits to previous blog pages without reordering them. 1. Fixed a problem with call to {{{wiki_to_html(text,env,hdf,db,0)}}}. Trac 0.10 doesn't like the `hdf` argument because it's apparently looking for a `href` inside of it. Changed `hdf` to `None`; it looks like `env` is then used instead of `hdf`. === Acronym === Add support for HTML acronyms. Usage example: {{{ [[acronym(HTML, Hypertext Markup Language)]] }}} [[BR]]Download: [attachment:acronym.py] [[BR]]By: Justin Palmer [[BR]]Version: >=0.8 '''''Note:''' The [http://trac-hacks.org/wiki/AcronymsPlugin Acronym plugin] adds acronyms on-the-fly from a table in a Wiki page. === !FootNote === Automatically collates and generates foot-notes. Usage example: {{{ Some text [[FootNote(This is a footnote)]] This foot-note refers to the first[[FootNote(1)]]. ... Listing the foot-notes in this page: [[FootNote]] }}} Multiple sets of foot-notes can be generated and existing foot-notes referred to by index. The latest version coalesces identical foot-note text into a single foot-note. ''Download:'' http://trac-hacks.org/wiki/FootNoteMacro [[BR]]''By:'' Alec Thomas [[BR]]''Version:'' >= 0.8 === Image === '''Note: this macro is a default macro since Trac 0.9, see WikiMacros#AvailableMacros ''' Display image of attachment or repository file onto any wiki/ticket document. Example {{{ Take image from same page: [[Image(photo.jpg)]] # simple [[Image(photo.jpg,120px)]] # as specified size [[Image(photo.jpg,right)]] # place image in right of page Or from other place: [[Image(OtherPage/foo.bmp)]] # from OtherPage [[Image(wiki/OtherPage/foo.bmp)]] # same above [[Image(ticket/36/boo.jpg)]] # from ticket:36 [[Image(file/images/bee.jpg)]] # from repository }}} See heading comment of source file for more detail. [[BR]]''Download:'' [attachment:Image.2.py] [[BR]]''By:'' Shun-ichi Goto [[BR]]''Version:'' >= 0.8 [[BR]]''Download:'' [attachment:Image.3.py] [[BR]]''Version'': >= [1688] === !TicketBox === Display list of ticket numbers in a box on the right side of the page. The purpose of this macro is show related tickets compactly. You can specify ticket number or report number which would be expanded as ticket numbers. Tickets will be displayed as sorted and uniq'ed. Example: {{{ [[TicketBox(#1,#7,#31)]] ... list of tickets [[TicketBox(1,7,31)]] ... '#' char can be omitted [[TicketBox({1})]] ... expand report result as ticket list [[TicketBox([report:1])]] ... alternate format of report [[TicketBox([report:9?name=val])]] ... report with dynamic variable [[TicketBox({1),#50,{2},100)]] ... convination of above [[TicketBox(500pt,{1})]] ... with box width as 50 point [[TicketBox(200px,{1})]] ... with box width as 200 pixel [[TicketBox(25%,{1})]] ... with box width as 25% [[TicketBox('Different Title',#1,#2)]] ... Use different title [[TicketBox("Other Title",#1,#2)]] ... likewise }}} [wiki:TracReports#AdvancedReportsDynamicVariables Dynamic Variables] is supported for report. Variables can be specified like {{{[report:9?PRIORITY=high&COMPONENT=ui]}}}. Of course, the special variable '{{{$USER}}}' is available. [[BR]]''Download:'' http://trac-hacks.org/wiki/TicketBoxMacro [[BR]]''By:'' Shun-ichi Goto [[BR]]''Version:'' >= 0.8 (also 0.9pre) [[BR]]''Revised:'' 2005/07/09 === !NotImplemented === The !NotImplemented macro is a simple text output macro for system documentation. It outputs a simple block that states a feature is not implemented and optionally includes a ticket or milestone (or any other wiki content) reference point. Examples: {{{ [[NotImplemented]] }}} {{{ [[NotImplemented(ticket:177)]] }}} and {{{ [[NotImplemented(ticket:177 and ticket:179)]] }}} will output (with the correct wiki links replaced): {{{ #!html
Currently Not Implemented: This feature is planned but is not yet implemented. Please see ticket:177 and ticket:179 for details.
}}} [[BR]]''Download:'' [attachment:NotImplemented.py] [[BR]]''Author:'' ebrown@esolvere.com [[BR]]''Version:'' Tested on 0.9pre === !ChooseTemplate === Allow Trac to support templates for wiki-pages Example: {{{ [[ChooseTemplate]] [[ChooseTemplate(templates)]] }}} The argument has to point to a wikipage whose subpages are the templates. If no argumnent is given, a default argument of "WikiTemplates" is assumed. [[BR]]''Download:'' [attachment:ChooseTemplate.1.py] [[BR]]''Author:'' spamfaenger at gmx.de [[BR]]''Version:'' Tested on 0.9b2 === !ListTracProjects === Lists all your Trac projects, which can be used to switch easy to another project page Example: {{{ [[ListTracProjects]] }}} '''Make sure''' to change the following things in the source: 1. Line 7 -- Local directory of where the trac projects are located 1. Line 13 -- Change the /projects/ to something you use for multiple projects 1. Line 16 -- Change the /projects/ to something you use for multiple projects Although it's very small, the source can probably be improved a lot, but it's my first Python thingie [[BR]]''Author:'' robert@exa-omicron.nl [[BR]]''Version:'' Tested on 0.9.2 and 0.9.3 '''NOTE:''' An updated version of this script is available on [http://www.trac-hacks.org/wiki/ListTracProjectsMacro Trac-Hacks]. This version prints links in an alphabetized, tabled format, more suitable for listing large numbers of projects. It also provides some amount of error checking and information retrieval (i.e. displaying project descriptions). [[BR]] ''Author'': mathomas@aero.org [[BR]] ''Version'': Tested on 0.10 [[BR]]''Download Original:'' [attachment:ListTracProjects.py] === Center === This macro facilitates an easy way to align content to the center. For example {{{ [[Center(begin)]] Everythig between "begin" and "end" will appear aligned to the center [[Center(end)]] }}} === Color === This is a simple macro to colorize short text. Example: {{{ Text can be written [[Color(green, with green)]], [[Color(blue, with blue)]], or [[Color(#b06cc3, in any other RGB color)]] }}} There is a version in the attachments below that supports v0.11. === RSSget === A Simple RSS News Retriever: Returns the content of an rss2 feed, parsed and pretty. This edition: * caches fetched feeds to /tmp/tracrss * returns the feed as a
Example usage: {{{ [[RSSget(http://www.example.com/feed.xml)]] }}} Customisation: [[BR]]RESULTS_FULL = 1; < number of results for which descriptions are displayed [[BR]]RESULTS_TOTAL = 5; < total number of results, titles of posts are displayed [[BR]]CACHE_INTERVAL = 1500 < time till feed is rechecked. ''Download:'' http://trac-hacks.org/browser/rssgetmacro/0.9 [[BR]]''By:'' Graeme Worthy -- ''Ver:'' >= 0.0.1 === !VisitCounter === Displays current or specified wiki page visit count in text or image form. Stores visited pages information in cookie on client side. Example usage: {{{ [[VisitCounter(WikiStart)]] }}} ''Download:'' http://trac-hacks.org/browser/visitcoutermacro [[BR]]''By:'' Radek Bartoň === !LastModifiedVersion === This is a macro inspired by [wiki:MacroBazaar#LastModified LastModified]. It simply prints the last modified version of the current wiki page. Usage: {{{ [[LastModifiedVersion]] }}} ''Download:'' [attachment:LastModifiedVersion.py] [[BR]]''By:'' Matt Shin [wiki:MacroBazaar#Categories (categories)] ''Add your macro here ...'' ---- == Requests == ''Requests, comments, etc. go here.'' * Request: A macro, that simply prints the number of the last changeset. * Request: A macro, that simply shows a signature of the current user with timestamp. e.g. using {{{[[sign]]}}} in the wiki text edit would render to "--anonymous 2008-01-20 20:02:34". * Request: A mcaro, that simply shows a timestamp. e.g. using [[timestamp]] would always show the fixed time of when the page was saved then, like "2008-01-22 10:42:17" ([[CurrentDate]] does not work, since it always updates when the page is saved again...). * Request: Extend the Image Macro. Enable Descriptions for Images and enable linking Images in the text. Example: {{{[[Image(image.png, desc("This is a wonderful Image"))]]}}} and {{{You can see this in [Image{1}] what I mean }}} * Request: Extend the Image Macro: If a page links to a lot of Images (~ a screenshot page) it would be nice to only show small thumbnails instead of resizing the image through html. Something like `[[Image(myimage.png, thumbnail=50%)]]` would create a thumb thats only 50% the size of the original image… * Something like pararaph numbers in http://www.blueoxen.org/tools/purplewiki/ helps with documentation authoring. * Request: Extend the !TicketBox macro so that it can display tickets returned by a ticket report as well. Example: {{{[[TicketBox({1},5)]]}}} would show tickets returned by report 1 and ticket no. 5 as well * Good idea. I've implemented and attached. See above. (gotoh) * Request: Extend the !TicketBox macro so that it can display tickets returned by a ticket report using dynamic variables. Example: {{{[[TicketBox(200px,'Active Tickets',[report:11?COMPONENT=name])]]}}} * Ok, implemented. See above. (gotoh) * Request: Binding of the [http://www.nv-l.org/twiki/bin/view/Plugins/TWikiDrawPlugin TWikiDraw] to Trac. Example: drawing:foo * Request: [wiki:MacroBazaar#WikiInclude WikiInclude] doesn't check if user has WIKI_VIEW privilege. This could be considered a security hole, if a user uses wiki formatting in a ticket. * Request: In !ReTickets I'd like to be able to grab tickets including one or more (with regexps even) keywords listed in it, rather then using the summary. Perhaps as an option or new Macro? * Request: In !LastModified or !DateOffset it would be cool to be able to put references to pages, source, changeset, roadmap instead of date only. That way i could display in my user pages a lot of usefull informations (days left before milestone, not modified since, commited since, and so on, ...) * It would be cool to have a macro that could include a file in the project repository: {{{[[includeP('trunk/project/main.cpp')]]}}} or, even cooler, part of the file: {{{[[includeLines('trunk/project/main.cpp',from=10,to=5)]]}}} Or the part of a file enclosed by a tag. For example, let trunk/foo.cpp be: {{{ #!cpp ... void a(); //tag1 void b() { ... } //tag1 ... }}} one could write {{{ See for example method "b" in file foo.cpp: [[includetag('trunk/foo.cpp', 'tag1')]] }}} '''Is this Already Available ?''' Does !IncludeSource / !InsertSource ( http://niw.at/articles/2006/12/16/include-source-wiki-macro-for-trac ) above make a good starting point? * Request: Project/ticket price quotes. For ticket poster to entice developers to work on ticket, they can offer an amount. Or for clients requesting features the developer can enter their price to complete the ticket. * Request: Time tracking for tickets! Each user can enter the time they've spent working on a ticket. Total time and total per developer will be summarized on the ticket. Perhaps integrates with the above? * PS: I'm willing to pay for the above two enhancements ;P please contact me at . * Request: I'd like a macro that lists WikiWords in the Wiki that don't have pages yet, to remind us of what we haven't yet got round to writing. [wiki:MacroBazaar#Categories (categories)] ---- See also: WikiMacros