Changes between Version 2 and Version 3 of WikiMacros


Ignore:
Timestamp:
May 2, 2019, 9:45:05 AM (14 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WikiMacros

    v2 v3  
    11= Trac Macros
    22
    3 [[PageOutline(2-5,Contents,pullout)]]
     3[[PageOutline]]
    44
    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.
     5Trac 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)]]`.
    66
    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 }}}
     7The 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.
    168
    179== Using Macros
    1810
    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 `[[..(,)]]`.
     11Macro calls are enclosed in two ''square brackets'' `[[..]]`. Like Python functions, macros can also have arguments, a comma separated list within parentheses `[[..(,)]]`.
    2012
    2113=== Getting Detailed Help
     
    5749{{{#!td style="padding-left: 2em"
    5850{{{#!html
    59 <div class="trac-macrolist">
     51<div style="font-size: 80%" class="trac-macrolist">
    6052<h3><code>[[Image]]</code></h3>Embed an image in wiki-formatted text.
    6153
    62 The first argument is the file, as in <code>[[Image(filename.png)]]</code>
     54The first argument is the file …
    6355<h3><code>[[InterTrac]]</code></h3>Provide a list of known <a class="wiki" href="/wiki/InterTrac">InterTrac</a> prefixes.
    6456<h3><code>[[InterWiki]]</code></h3>Provide a description list for the known <a class="wiki" href="/wiki/InterWiki">InterWiki</a> prefixes.
    6557<h3><code>[[KnownMimeTypes]]</code></h3>List all known mime-types which can be used as <a class="wiki" href="/wiki/WikiProcessors">WikiProcessors</a>.
    66 </div>
     58Can be …</div>
    6759}}}
    6860etc.
     
    7769== Macros from around the world
    7870
    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.
     71The [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 to visit that site.
    8072
    8173== Developing Custom Macros
     
    8577For more information about developing macros, see the [trac:TracDev development resources] on the main project site.
    8678
    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.
     79Here 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 little more insight about the transition.
    8880
    8981=== Macro without arguments
    9082
    91 To test the following code, save it in a `timestamp_sample.py` file located in the TracEnvironment's `plugins/` directory.
    92 
    93 {{{#!python
     83To test the following code, you should saved it in a `timestamp_sample.py` file located in the TracEnvironment's `plugins/` directory.
     84{{{
     85#!python
    9486from datetime import datetime
    9587# Note: since Trac 0.11, datetime objects are used internally
     
    113105=== Macro with arguments
    114106
    115 To test the following code, save it in a `helloworld_sample.py` file located in the TracEnvironment's `plugins/` directory.
    116 
    117 {{{#!python
     107To test the following code, you should save it in a `helloworld_sample.py` file located in the TracEnvironment's `plugins/` directory.
     108{{{
     109#!python
    118110from genshi.core import Markup
    119111
     
    151143}}}
    152144
    153 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'').
     145Note 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'').
    154146
    155147For example, when writing:
     
    165157[[HelloWorld(<Hello World!>)]]
    166158}}}
    167 
    168159One should get:
    169160{{{
    170 Hello World, text = <Hello World!>, args = {'style': u'polite', 'silent': False, 'verbose': True}
    171 Hello World, text = <Hello World!>, args = {}
    172 Hello World, text = <Hello World!>, args = None
     161Hello World, text = <Hello World!> , args = {'style': u'polite', 'silent': False, 'verbose': True}
     162Hello World, text = <Hello World!> , args = {}
     163Hello World, text = <Hello World!> , args = None
    173164}}}
    174165
    175 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`).
     166Note 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`). 
    176167
    177168You can also recursively use a wiki Formatter (`from trac.wiki import Formatter`) to process the `text` as wiki markup:
    178169
    179 {{{#!python
     170{{{
     171#!python
    180172from genshi.core import Markup
    181173from trac.wiki.macros import WikiMacroBase