Changes between Version 2 and Version 3 of WikiMacros
- Timestamp:
- Apr 4, 2011, 10:40:05 PM (14 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
WikiMacros
v2 v3 8 8 9 9 == Using Macros == 10 Macro calls are enclosed in two ''square brackets''. Like Python functions, macros can also have arguments, a comma separated list within parentheses.11 10 12 Trac macros can also be written as TracPlugins. This gives them some capabilities that macros do not have, such as being able to directly access the HTTP request. 11 Macro calls are enclosed in two ''square brackets''. Like Python functions, macros can also have arguments, a comma separated list within parentheses. 12 13 === Getting Detailed Help === 14 The list of available macros and the full help can be obtained using the !MacroList macro, as seen [#AvailableMacros below]. 15 16 A brief list can be obtained via ![[MacroList(*)]] or ![[?]]. 17 18 Detailed help on a specific macro can be obtained by passing it as an argument to !MacroList, e.g. ![[MacroList(MacroList)]], or, more conveniently, by appending a question mark (?) to the macro's name, like in ![[MacroList?]]. 19 20 13 21 14 22 === Example === … … 16 24 A list of 3 most recently changed wiki pages starting with 'Trac': 17 25 18 {{{ 19 [[RecentChanges(Trac,3)]] 26 ||= Wiki Markup =||= Display =|| 27 {{{#!td 28 {{{ 29 [[RecentChanges(Trac,3)]] 30 }}} 20 31 }}} 32 {{{#!td style="padding-left: 2em;" 33 [[RecentChanges(Trac,3)]] 34 }}} 35 |----------------------------------- 36 {{{#!td 37 {{{ 38 [[RecentChanges?(Trac,3)]] 39 }}} 40 }}} 41 {{{#!td style="padding-left: 2em;" 42 [[RecentChanges?(Trac,3)]] 43 }}} 44 |----------------------------------- 45 {{{#!td 46 {{{ 47 [[?]] 48 }}} 49 }}} 50 {{{#!td style="padding-left: 2em" 51 {{{#!html 52 <div style="font-size: 80%" class="trac-macrolist"> 53 <h3><code>[[Image]]</code></h3>Embed an image in wiki-formatted text. 21 54 22 Display: 23 [[RecentChanges(Trac,3)]] 55 The first argument is the file … 56 <h3><code>[[InterTrac]]</code></h3>Provide a list of known <a class="wiki" href="/wiki/InterTrac">InterTrac</a> prefixes. 57 <h3><code>[[InterWiki]]</code></h3>Provide a description list for the known <a class="wiki" href="/wiki/InterWiki">InterWiki</a> prefixes. 58 <h3><code>[[KnownMimeTypes]]</code></h3>List all known mime-types which can be used as <a class="wiki" href="/wiki/WikiProcessors">WikiProcessors</a>. 59 Can be …</div> 60 }}} 61 etc. 62 }}} 24 63 25 64 == Available Macros == … … 34 73 35 74 == Developing Custom Macros == 36 Macros, like Trac itself, are written in the [http://python.org/ Python programming language] .75 Macros, like Trac itself, are written in the [http://python.org/ Python programming language] and are developed as part of TracPlugins. 37 76 38 77 For more information about developing macros, see the [trac:TracDev development resources] on the main project site. 39 78 40 41 == Implementation ==42 79 43 80 Here are 2 simple examples showing how to create a Macro with Trac 0.11. … … 46 83 47 84 === Macro without arguments === 48 It should be saved as `TimeStamp.py` as Trac will use the module name as the Macro name 85 To test the following code, you should saved it in a `timestamp_sample.py` file located in the TracEnvironment's `plugins/` directory. 49 86 {{{ 50 87 #!python … … 63 100 url = "$URL$" 64 101 65 def expand_macro(self, formatter, name, args):102 def expand_macro(self, formatter, name, text): 66 103 t = datetime.now(utc) 67 104 return tag.b(format_datetime(t, '%c')) … … 69 106 70 107 === Macro with arguments === 71 It should be saved as `HelloWorld.py` (in the plugins/ directory) as Trac will use the module name as the Macro name 108 To test the following code, you should saved it in a `helloworld_sample.py` file located in the TracEnvironment's `plugins/` directory. 72 109 {{{ 73 110 #!python 111 from genshi.core import Markup 112 74 113 from trac.wiki.macros import WikiMacroBase 75 114 … … 89 128 url = "$URL$" 90 129 91 def expand_macro(self, formatter, name, args):130 def expand_macro(self, formatter, name, text, args): 92 131 """Return some output that will be displayed in the Wiki content. 93 132 94 133 `name` is the actual name of the macro (no surprise, here it'll be 95 134 `'HelloWorld'`), 96 ` args` is the text enclosed in parenthesis at the call of the macro.135 `text` is the text enclosed in parenthesis at the call of the macro. 97 136 Note that if there are ''no'' parenthesis (like in, e.g. 98 [[HelloWorld]]), then `args` is `None`. 137 [[HelloWorld]]), then `text` is `None`. 138 `args` are the arguments passed when HelloWorld is called using a 139 `#!HelloWorld` code block. 99 140 """ 100 return 'Hello World, args = ' + unicode(args) 101 102 # Note that there's no need to HTML escape the returned data, 103 # as the template engine (Genshi) will do it for us. 141 return 'Hello World, text = %s, args = %s' % \ 142 (Markup.escape(text), Markup.escape(repr(args))) 143 104 144 }}} 105 145 146 Note that `expand_macro` optionally takes a 4^th^ parameter ''`args`''. When the macro is called as a [WikiProcessors WikiProcessor], it's also possible to pass `key=value` [WikiProcessors#UsingProcessors processor parameters]. If given, those are stored in a dictionary and passed in this extra `args` parameter. On the contrary, when called as a macro, `args` is `None`. (''since 0.12''). 106 147 107 === {{{expand_macro}}} details === 108 {{{expand_macro}}} should return either a simple Python string which will be interpreted as HTML, or preferably a Markup object (use {{{from trac.util.html import Markup}}}). {{{Markup(string)}}} just annotates the string so the renderer will render the HTML string as-is with no escaping. You will also need to import Formatter using {{{from trac.wiki import Formatter}}}. 148 For example, when writing: 149 {{{ 150 {{{#!HelloWorld style="polite" 151 <Hello World!> 152 }}} 109 153 110 If your macro creates wiki markup instead of HTML, you can convert it to HTML like this: 154 {{{#!HelloWorld 155 <Hello World!> 156 }}} 157 158 [[HelloWorld(<Hello World!>)]] 159 }}} 160 One should get: 161 {{{ 162 Hello World, text = <Hello World!> , args = {'style': u'polite'} 163 Hello World, text = <Hello World!> , args = {} 164 Hello World, text = <Hello World!> , args = None 165 }}} 166 167 Note that the return value of `expand_macro` is '''not''' HTML escaped. Depending on the expected result, you should escape it by yourself (using `return Markup.escape(result)`) or, if this is indeed HTML, wrap it in a Markup object (`return Markup(result)`) with `Markup` coming from Genshi, (`from genshi.core import Markup`). 168 169 You can also recursively use a wiki Formatter (`from trac.wiki import Formatter`) to process the `text` as wiki markup, for example by doing: 111 170 112 171 {{{ 113 172 #!python 114 text = "whatever wiki markup you want, even containing other macros" 115 # Convert Wiki markup to HTML, new style 116 out = StringIO() 117 Formatter(self.env, formatter.context).format(text, out) 118 return Markup(out.getvalue()) 173 from genshi.core import Markup 174 from trac.wiki.macros import WikiMacroBase 175 from trac.wiki import Formatter 176 import StringIO 177 178 class HelloWorldMacro(WikiMacroBase): 179 def expand_macro(self, formatter, name, text, args): 180 text = "whatever '''wiki''' markup you want, even containing other macros" 181 # Convert Wiki markup to HTML, new style 182 out = StringIO.StringIO() 183 Formatter(self.env, formatter.context).format(text, out) 184 return Markup(out.getvalue()) 119 185 }}}