Changes between Version 1 and Version 2 of WikiMacros


Ignore:
Timestamp:
09/14/17 14:49:44 (7 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • WikiMacros

    v1 v2  
    11= Trac Macros
    22
    3 [[PageOutline]]
     3[[PageOutline(2-5,Contents,pullout)]]
    44
    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.
    66
    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.
     7The 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}}}
    816
    917== Using Macros
    1018
    11 Macro calls are enclosed in two ''square brackets'' `[[..]]`. Like Python functions, macros can also have arguments, a comma separated list within parentheses `[[..(,)]]`.
     19Macro calls are enclosed in double-square brackets `[[..]]`. Like Python functions, macros can have arguments, which is then a comma separated list within parentheses `[[..(,)]]`.
    1220
    1321=== Getting Detailed Help
    … …  
    4957{{{#!td style="padding-left: 2em"
    5058{{{#!html
    51 <div style="font-size: 80%" class="trac-macrolist">
     59<div class="trac-macrolist">
    5260<h3><code>[[Image]]</code></h3>Embed an image in wiki-formatted text.
    5361
    54 The first argument is the file …
     62The first argument is the file, as in <code>[[Image(filename.png)]]</code>
    5563<h3><code>[[InterTrac]]</code></h3>Provide a list of known <a class="wiki" href="/wiki/InterTrac">InterTrac</a> prefixes.
    5664<h3><code>[[InterWiki]]</code></h3>Provide a description list for the known <a class="wiki" href="/wiki/InterWiki">InterWiki</a> prefixes.
    5765<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>
    5967}}}
    6068etc.
    … …  
    6977== Macros from around the world
    7078
    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 to visit that site.
     79The [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.
    7280
    7381== Developing Custom Macros
    … …  
    7785For more information about developing macros, see the [trac:TracDev development resources] on the main project site.
    7886
    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 little more insight about the transition.
     87Here 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.
    8088
    8189=== Macro without arguments
    8290
    83 To test the following code, you should saved it in a `timestamp_sample.py` file located in the TracEnvironment's `plugins/` directory.
    84 {{{
    85 #!python
     91To test the following code, save it in a `timestamp_sample.py` file located in the TracEnvironment's `plugins/` directory.
     92
     93{{{#!python
    8694from datetime import datetime
    8795# Note: since Trac 0.11, datetime objects are used internally
    8896
    89 from genshi.builder import tag
    90 
    9197from trac.util.datefmt import format_datetime, utc
     98from trac.util.html import tag
    9299from trac.wiki.macros import WikiMacroBase
    93100
    … …  
    105112=== Macro with arguments
    106113
    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
     114To test the following code, save it in a `helloworld_sample.py` file located in the TracEnvironment's `plugins/` directory.
    111115
     116{{{#!python
     117from trac.util.html import Markup
    112118from trac.wiki.macros import WikiMacroBase
    113119
    … …  
    143149}}}
    144150
    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'').
     151Note 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'').
    146152
    147153For example, when writing:
    … …  
    157163[[HelloWorld(<Hello World!>)]]
    158164}}}
     165
    159166One should get:
    160167{{{
    161 Hello World, text = <Hello World!> , args = {'style': u'polite', 'silent': False, 'verbose': True}
    162 Hello World, text = <Hello World!> , args = {}
    163 Hello World, text = <Hello World!> , args = None
     168Hello World, text = <Hello World!>, args = {'style': u'polite', 'silent': False, 'verbose': True}
     169Hello World, text = <Hello World!>, args = {}
     170Hello World, text = <Hello World!>, args = None
    164171}}}
    165172
    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`). 
     173Note 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`).
    167174
    168175You can also recursively use a wiki Formatter (`from trac.wiki import Formatter`) to process the `text` as wiki markup:
    169176
    170 {{{
    171 #!python
    172 from genshi.core import Markup
     177{{{#!python
     178from trac.util.html import Markup
    173179from trac.wiki.macros import WikiMacroBase
    174180from trac.wiki import Formatter
    … …  
    176182
    177183class HelloWorldMacro(WikiMacroBase):
    178         def expand_macro(self, formatter, name, text, args):
    179                 text = "whatever '''wiki''' markup you want, even containing other macros"
    180                 # Convert Wiki markup to HTML, new style
    181                 out = StringIO.StringIO()
    182                 Formatter(self.env, formatter.context).format(text, out)
    183                 return Markup(out.getvalue())
     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())
    184190}}}