Changes between Version 1 and Version 2 of WikiMacros
- Timestamp:
- 09/14/17 14:47:49 (7 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
WikiMacros
v1 v2 1 1 = Trac Macros 2 2 3 [[PageOutline ]]3 [[PageOutline(2-5,Contents,pullout)]] 4 4 5 Trac macros are plugins to extend the Trac engine with custom 'functions' written in Python. A macro inserts dynamic HTML data in any context supporting WikiFormatting. Its syntax is `[[macro-name(optional-arguments)]]`.5 '''Trac macros''' extend the Trac engine with custom functionality. Macros are a special type of plugin and are written in Python. A macro inserts dynamic HTML data in any context supporting WikiFormatting. 6 6 7 The WikiProcessors are another kind of macros. They typically deal with alternate markup formats and transformation of larger "blocks" of information, like source code highlighting. They are used for processing the multiline `{{{#!wiki-processor-name ... }}}` blocks. 7 The macro syntax is `[[macro-name(optional-arguments)]]`. 8 9 '''WikiProcessors''' are another kind of macros. They are typically used for source code highlighting, such as `!#python` or `!#apache` and when the source code spans multiple lines, such as: 10 11 {{{ 12 {{{#!wiki-processor-name 13 ... 14 }}} 15 }}} 8 16 9 17 == Using Macros 10 18 11 Macro calls are enclosed in two ''square brackets'' `[[..]]`. Like Python functions, macros can also have arguments,a comma separated list within parentheses `[[..(,)]]`.19 Macro calls are enclosed in double-square brackets `[[..]]`. Like Python functions, macros can have arguments, which is then a comma separated list within parentheses `[[..(,)]]`. 12 20 13 21 === Getting Detailed Help … … 49 57 {{{#!td style="padding-left: 2em" 50 58 {{{#!html 51 <div style="font-size: 80%"class="trac-macrolist">59 <div class="trac-macrolist"> 52 60 <h3><code>[[Image]]</code></h3>Embed an image in wiki-formatted text. 53 61 54 The first argument is the file …62 The first argument is the file, as in <code>[[Image(filename.png)]]</code> 55 63 <h3><code>[[InterTrac]]</code></h3>Provide a list of known <a class="wiki" href="/wiki/InterTrac">InterTrac</a> prefixes. 56 64 <h3><code>[[InterWiki]]</code></h3>Provide a description list for the known <a class="wiki" href="/wiki/InterWiki">InterWiki</a> prefixes. 57 65 <h3><code>[[KnownMimeTypes]]</code></h3>List all known mime-types which can be used as <a class="wiki" href="/wiki/WikiProcessors">WikiProcessors</a>. 58 Can be …</div>66 </div> 59 67 }}} 60 68 etc. … … 69 77 == Macros from around the world 70 78 71 The [http://trac-hacks.org/ Trac Hacks] site provides a wide collection of macros and other Trac [TracPlugins plugins] contributed by the Trac community. If you are looking for new macros, or have written one that you would like to share with the world, don't hesitate tovisit that site.79 The [http://trac-hacks.org/ Trac Hacks] site provides a wide collection of macros and other Trac [TracPlugins plugins] contributed by the Trac community. If you are looking for new macros, or have written one that you would like to share, please visit that site. 72 80 73 81 == Developing Custom Macros … … 77 85 For more information about developing macros, see the [trac:TracDev development resources] on the main project site. 78 86 79 Here are 2 simple examples showing how to create a Macro. Also, have a look at [trac:source:tags/trac-1.0.2/sample-plugins/Timestamp.py Timestamp.py] for an example that shows the difference between old style and new style macros and at the [trac:source:tags/trac-0.11/wiki-macros/README macros/README] which provides a littlemore insight about the transition.87 Here are 2 simple examples showing how to create a Macro. Also, have a look at [trac:source:tags/trac-1.0.2/sample-plugins/Timestamp.py Timestamp.py] for an example that shows the difference between old style and new style macros and at the [trac:source:tags/trac-0.11/wiki-macros/README macros/README] which provides more insight about the transition. 80 88 81 89 === Macro without arguments 82 90 83 To test the following code, you should savedit in a `timestamp_sample.py` file located in the TracEnvironment's `plugins/` directory.84 {{{ 85 #!python91 To test the following code, save it in a `timestamp_sample.py` file located in the TracEnvironment's `plugins/` directory. 92 93 {{{#!python 86 94 from datetime import datetime 87 95 # Note: since Trac 0.11, datetime objects are used internally 88 96 89 from genshi.builder import tag90 91 97 from trac.util.datefmt import format_datetime, utc 98 from trac.util.html import tag 92 99 from trac.wiki.macros import WikiMacroBase 93 100 … … 105 112 === Macro with arguments 106 113 107 To test the following code, you should save it in a `helloworld_sample.py` file located in the TracEnvironment's `plugins/` directory. 108 {{{ 109 #!python 110 from genshi.core import Markup 114 To test the following code, save it in a `helloworld_sample.py` file located in the TracEnvironment's `plugins/` directory. 111 115 116 {{{#!python 117 from trac.util.html import Markup 112 118 from trac.wiki.macros import WikiMacroBase 113 119 … … 143 149 }}} 144 150 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'').151 Note that `expand_macro` optionally takes a 4^th^ parameter ''`args`''. When the macro is called as a [WikiProcessors WikiProcessor], it is 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. In the other case, when called as a macro, `args` is `None`. (''since 0.12''). 146 152 147 153 For example, when writing: … … 157 163 [[HelloWorld(<Hello World!>)]] 158 164 }}} 165 159 166 One should get: 160 167 {{{ 161 Hello World, text = <Hello World!> 162 Hello World, text = <Hello World!> 163 Hello World, text = <Hello World!> 168 Hello World, text = <Hello World!>, args = {'style': u'polite', 'silent': False, 'verbose': True} 169 Hello World, text = <Hello World!>, args = {} 170 Hello World, text = <Hello World!>, args = None 164 171 }}} 165 172 166 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`).173 Note that the return value of `expand_macro` is '''not''' HTML escaped. Depending on the expected result, you should escape it yourself (using `return Markup.escape(result)`) or, if this is indeed HTML, wrap it in a Markup object: `return Markup(result)` (`from trac.util.html import Markup`). 167 174 168 175 You can also recursively use a wiki Formatter (`from trac.wiki import Formatter`) to process the `text` as wiki markup: 169 176 170 {{{ 171 #!python 172 from genshi.core import Markup 177 {{{#!python 178 from trac.util.html import Markup 173 179 from trac.wiki.macros import WikiMacroBase 174 180 from trac.wiki import Formatter … … 176 182 177 183 class HelloWorldMacro(WikiMacroBase): 178 179 180 181 182 183 184 def expand_macro(self, formatter, name, text, args): 185 text = "whatever '''wiki''' markup you want, even containing other macros" 186 # Convert Wiki markup to HTML, new style 187 out = StringIO.StringIO() 188 Formatter(self.env, formatter.context).format(text, out) 189 return Markup(out.getvalue()) 184 190 }}}
