Changes between Version 49 and Version 50 of WikiMacros
- Timestamp:
- Jan 7, 2016, 2:34:03 PM (8 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
WikiMacros
v49 v50 1 1 = Trac Macros 2 2 3 [[PageOutline ]]3 [[PageOutline(2-5,Contents,pullout)]] 4 4 [[TranslatedPages]] 5 5 6 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)]]`.6 '''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. 7 7 8 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. 8 The macro syntax is `[[macro-name(optional-arguments)]]`. 9 10 '''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: 11 12 {{{ 13 {{{#!wiki-processor-name 14 ... 15 }}} 16 }}} 9 17 10 18 == Using Macros 11 19 12 Macro calls are enclosed in two ''square brackets'' `[[..]]`. Like Python functions, macros can also have arguments,a comma separated list within parentheses `[[..(,)]]`.20 Macro calls are enclosed in double-square brackets `[[..]]`. Like Python functions, macros can have arguments, which is then a comma separated list within parentheses `[[..(,)]]`. 13 21 14 22 === Getting Detailed Help … … 50 58 {{{#!td style="padding-left: 2em" 51 59 {{{#!html 52 <div style="font-size: 80%"class="trac-macrolist">60 <div class="trac-macrolist"> 53 61 <h3><code>[[Image]]</code></h3>Embed an image in wiki-formatted text. 54 62 55 The first argument is the file …63 The first argument is the file, as in <code>[[Image(filename.png)]]</code> 56 64 <h3><code>[[InterTrac]]</code></h3>Provide a list of known <a class="wiki" href="/wiki/InterTrac">InterTrac</a> prefixes. 57 65 <h3><code>[[InterWiki]]</code></h3>Provide a description list for the known <a class="wiki" href="/wiki/InterWiki">InterWiki</a> prefixes. 58 66 <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>67 </div> 60 68 }}} 61 69 etc. … … 70 78 == Macros from around the world 71 79 72 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.80 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. 73 81 74 82 == Developing Custom Macros … … 78 86 For more information about developing macros, see the [trac:TracDev development resources] on the main project site. 79 87 80 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.88 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. 81 89 82 90 === Macro without arguments 83 91 84 To test the following code, you should savedit in a `timestamp_sample.py` file located in the TracEnvironment's `plugins/` directory.85 {{{ 86 #!python92 To test the following code, save it in a `timestamp_sample.py` file located in the TracEnvironment's `plugins/` directory. 93 94 {{{#!python 87 95 from datetime import datetime 88 96 # Note: since Trac 0.11, datetime objects are used internally … … 106 114 === Macro with arguments 107 115 108 To test the following code, you shouldsave it in a `helloworld_sample.py` file located in the TracEnvironment's `plugins/` directory.109 {{{ 110 #!python116 To test the following code, save it in a `helloworld_sample.py` file located in the TracEnvironment's `plugins/` directory. 117 118 {{{#!python 111 119 from genshi.core import Markup 112 120 … … 144 152 }}} 145 153 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'').154 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''). 147 155 148 156 For example, when writing: … … 158 166 [[HelloWorld(<Hello World!>)]] 159 167 }}} 168 160 169 One should get: 161 170 {{{ 162 Hello World, text = <Hello World!> 163 Hello World, text = <Hello World!> 164 Hello World, text = <Hello World!> 171 Hello World, text = <Hello World!>, args = {'style': u'polite', 'silent': False, 'verbose': True} 172 Hello World, text = <Hello World!>, args = {} 173 Hello World, text = <Hello World!>, args = None 165 174 }}} 166 175 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`).176 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)`) with `Markup` coming from Genshi (`from genshi.core import Markup`). 168 177 169 178 You can also recursively use a wiki Formatter (`from trac.wiki import Formatter`) to process the `text` as wiki markup: 170 179 171 {{{ 172 #!python 180 {{{#!python 173 181 from genshi.core import Markup 174 182 from trac.wiki.macros import WikiMacroBase