Changes between Version 4 and Version 5 of WikiMacros
- Timestamp:
- Apr 6, 2012, 4:33:18 PM (12 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
WikiMacros
v4 v5 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 26 ||= Wiki Markup =||= Display =|| 18 27 {{{ 19 [[RecentChanges(Trac,3)]] 28 #!td 29 {{{ 30 [[RecentChanges(Trac,3)]] 31 20 32 }}} 21 22 Display: 23 [[RecentChanges(Trac,3)]] 33 }}} 34 {{{ 35 #!td style="padding-left: 2em;" 36 [[RecentChanges(Trac,3)]] 37 }}} 38 |----------------------------------- 39 {{{ 40 #!td 41 {{{ 42 [[RecentChanges?(Trac,3)]] 43 44 }}} 45 }}} 46 {{{ 47 #!td style="padding-left: 2em;" 48 [[RecentChanges?(Trac,3)]] 49 }}} 50 |----------------------------------- 51 {{{ 52 #!td 53 {{{ 54 [[?]] 55 56 }}} 57 }}} 58 {{{ 59 #!td style="padding-left: 2em; font-size: 80%" 60 [[?]] 61 }}} 24 62 25 63 == Available Macros == … … 34 72 35 73 == Developing Custom Macros == 36 Macros, like Trac itself, are written in the [http://python.org/ Python programming language] .74 Macros, like Trac itself, are written in the [http://python.org/ Python programming language] and are developed as part of TracPlugins. 37 75 38 76 For more information about developing macros, see the [trac:TracDev development resources] on the main project site. 39 77 40 41 == Implementation ==42 78 43 79 Here are 2 simple examples showing how to create a Macro with Trac 0.11. … … 46 82 47 83 === Macro without arguments === 48 It should be saved as `TimeStamp.py` as Trac will use the module name as the Macro name 84 To test the following code, you should saved it in a `timestamp_sample.py` file located in the TracEnvironment's `plugins/` directory. 49 85 {{{ 50 86 #!python … … 63 99 url = "$URL$" 64 100 65 def expand_macro(self, formatter, name, args):101 def expand_macro(self, formatter, name, text): 66 102 t = datetime.now(utc) 67 103 return tag.b(format_datetime(t, '%c')) … … 69 105 70 106 === 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 107 To test the following code, you should saved it in a `helloworld_sample.py` file located in the TracEnvironment's `plugins/` directory. 72 108 {{{ 73 109 #!python 110 from genshi.core import Markup 111 74 112 from trac.wiki.macros import WikiMacroBase 75 113 … … 89 127 url = "$URL$" 90 128 91 def expand_macro(self, formatter, name, args):129 def expand_macro(self, formatter, name, text, args): 92 130 """Return some output that will be displayed in the Wiki content. 93 131 94 132 `name` is the actual name of the macro (no surprise, here it'll be 95 133 `'HelloWorld'`), 96 ` args` is the text enclosed in parenthesis at the call of the macro.134 `text` is the text enclosed in parenthesis at the call of the macro. 97 135 Note that if there are ''no'' parenthesis (like in, e.g. 98 [[HelloWorld]]), then `args` is `None`. 136 [[HelloWorld]]), then `text` is `None`. 137 `args` are the arguments passed when HelloWorld is called using a 138 `#!HelloWorld` code block. 99 139 """ 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. 140 return 'Hello World, text = %s, args = %s' % \ 141 (Markup.escape(text), Markup.escape(repr(args))) 142 104 143 }}} 105 144 145 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 146 107 === {{{ 108 expand_macro 109 }}} details === 147 For example, when writing: 110 148 {{{ 111 expand_macro 112 }}} should return either a simple Python string which will be interpreted as HTML, or preferably a Markup object (use {{{ 113 from trac.util.html import Markup 114 }}}). {{{ 115 Markup(string) 116 }}} 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 {{{ 117 from trac.wiki import Formatter 118 }}}. 149 {{{ 150 #!HelloWorld style="polite" 151 <Hello World!> 152 }}} 119 153 120 If your macro creates wiki markup instead of HTML, you can convert it to HTML like this: 154 {{{ 155 #!HelloWorld 156 <Hello World!> 157 }}} 158 159 [[HelloWorld(<Hello World!>)]] 160 }}} 161 One should get: 162 {{{ 163 Hello World, text = <Hello World!> , args = {'style': u'polite'} 164 Hello World, text = <Hello World!> , args = {} 165 Hello World, text = <Hello World!> , args = None 166 }}} 167 168 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`). 169 170 You can also recursively use a wiki Formatter (`from trac.wiki import Formatter`) to process the `text` as wiki markup, for example by doing: 121 171 122 172 {{{ 123 173 #!python 124 text = "whatever wiki markup you want, even containing other macros"125 # Convert Wiki markup to HTML, new style126 out = StringIO()127 Formatter(self.env, formatter.context).format(text, out)128 return Markup(out.getvalue())174 text = "whatever wiki markup you want, even containing other macros" 175 # Convert Wiki markup to HTML, new style 176 out = StringIO() 177 Formatter(self.env, formatter.context).format(text, out) 178 return Markup(out.getvalue()) 129 179 }}} 130 180