Planet
navi homeaboutscreenshotsdownloaddevelopmentforum

Changes between Version 4 and Version 5 of WikiMacros


Ignore:
Timestamp:
Mar 18, 2017, 3:45:33 PM (9 months ago)
Author:
trac
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • WikiMacros

    v4 v5  
    1 = Trac Macros =
     1= Trac Macros
    22
    33[[PageOutline]]
    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.
     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 Another kind of macros are WikiProcessors. They typically deal with alternate markup formats and representation of larger blocks of information (like source code highlighting).
     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.
    88
    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.
     9== Using Macros
    1110
    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.
     11Macro calls are enclosed in two ''square brackets'' `[[..]]`. Like Python functions, macros can also have arguments, a comma separated list within parentheses `[[..(,)]]`.
    1312
    14 === Example ===
     13=== Getting Detailed Help
    1514
    16 A list of 3 most recently changed wiki pages starting with 'Trac':
     15The list of available macros and the full help can be obtained using the !MacroList macro, as seen [#AvailableMacros below].
    1716
    18 {{{
    19  [[RecentChanges(Trac,3)]]
     17A brief list can be obtained via `[[MacroList(*)]]` or `[[?]]`.
     18
     19Detailed 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?]]`.
     20
     21=== Example
     22
     23A list of the 3 most recently changed wiki pages starting with 'Trac':
     24
     25||= Wiki Markup =||= Display =||
     26{{{#!td
     27  {{{
     28  [[RecentChanges(Trac,3)]]
     29  }}}
     30}}}
     31{{{#!td style="padding-left: 2em;"
     32[[RecentChanges(Trac,3)]]
     33}}}
     34|-----------------------------------
     35{{{#!td
     36  {{{
     37  [[RecentChanges?(Trac,3)]]
     38  }}}
     39}}}
     40{{{#!td style="padding-left: 2em;"
     41[[RecentChanges?(Trac,3)]]
     42}}}
     43|-----------------------------------
     44{{{#!td
     45  {{{
     46  [[?]]
     47  }}}
     48}}}
     49{{{#!td style="padding-left: 2em"
     50{{{#!html
     51<div style="font-size: 80%" class="trac-macrolist">
     52<h3><code>[[Image]]</code></h3>Embed an image in wiki-formatted text.
     53
     54The first argument is the file …
     55<h3><code>[[InterTrac]]</code></h3>Provide a list of known <a class="wiki" href="/wiki/InterTrac">InterTrac</a> prefixes.
     56<h3><code>[[InterWiki]]</code></h3>Provide a description list for the known <a class="wiki" href="/wiki/InterWiki">InterWiki</a> prefixes.
     57<h3><code>[[KnownMimeTypes]]</code></h3>List all known mime-types which can be used as <a class="wiki" href="/wiki/WikiProcessors">WikiProcessors</a>.
     58Can be …</div>
     59}}}
     60etc.
    2061}}}
    2162
    22 Display:
    23  [[RecentChanges(Trac,3)]]
    24 
    25 == Available Macros ==
     63== Available Macros
    2664
    2765''Note that the following list will only contain the macro documentation if you've not enabled `-OO` optimizations, or not set the `PythonOptimize` option for [wiki:TracModPython mod_python].''
     
    2967[[MacroList]]
    3068
    31 == Macros from around the world ==
     69== Macros from around the world
    3270
    33 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're looking for new macros, or have written one that you'd like to share with the world, please don't hesitate to 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.
    3472
    35 == Developing Custom Macros ==
    36 Macros, like Trac itself, are written in the [http://python.org/ Python programming language].
     73== Developing Custom Macros
    3774
    38 For more information about developing macros, see the [wiki:TracDev development resources] on the main project site.
     75Macros, like Trac itself, are written in the [http://python.org/ Python programming language] and are developed as part of TracPlugins.
    3976
     77For more information about developing macros, see the [trac:TracDev development resources] on the main project site.
    4078
    41 == Implementation ==
     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.
    4280
    43 Here are 2 simple examples on how to create a Macro with [wiki:0.11 Trac 0.11] have a look at source:trunk/sample-plugins/Timestamp.py for an example that shows the difference between old style and new style macros and also source:trunk/wiki-macros/README which provides a little more insight about the transition.
     81=== Macro without arguments
    4482
    45 === Macro without arguments ===
    46 It should be saved as `TimeStamp.py` as Trac will use the module name as the Macro name
     83To test the following code, you should saved it in a `timestamp_sample.py` file located in the TracEnvironment's `plugins/` directory.
    4784{{{
    4885#!python
     
    5592from trac.wiki.macros import WikiMacroBase
    5693
    57 class TimestampMacro(WikiMacroBase):
     94class TimeStampMacro(WikiMacroBase):
    5895    """Inserts the current time (in seconds) into the wiki page."""
    5996
     
    6198    url = "$URL$"
    6299
    63     def expand_macro(self, formatter, name, args):
     100    def expand_macro(self, formatter, name, text):
    64101        t = datetime.now(utc)
    65         return tag.b(format_datetime(t, '%c'))
     102        return tag.strong(format_datetime(t, '%c'))
    66103}}}
    67104
    68 === Macro with arguments ===
    69 It should be saved as `HelloWorld.py` (in the plugins/ directory) as Trac will use the module name as the Macro name
     105=== Macro with arguments
     106
     107To test the following code, you should save it in a `helloworld_sample.py` file located in the TracEnvironment's `plugins/` directory.
    70108{{{
    71109#!python
     110from genshi.core import Markup
     111
    72112from trac.wiki.macros import WikiMacroBase
    73113
     
    87127    url = "$URL$"
    88128
    89     def expand_macro(self, formatter, name, args):
     129    def expand_macro(self, formatter, name, text, args):
    90130        """Return some output that will be displayed in the Wiki content.
    91131
    92132        `name` is the actual name of the macro (no surprise, here it'll be
    93133        `'HelloWorld'`),
    94         `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.
    95135          Note that if there are ''no'' parenthesis (like in, e.g.
    96           [[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.
    97139        """
    98         return 'Hello World, args = ' + unicode(args)
    99    
    100     # Note that there's no need to HTML escape the returned data,
    101     # 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
    102143}}}
    103144
     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'').
    104146
    105 === {{{expand_macro}}} details ===
    106 {{{expand_macro}}} should return either a simple Python string which will be interpreted as HTML, or preferably a Markup object (use {{{from trac.util.html import Markup}}}).  {{{Markup(string)}}} 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 {{{from trac.wiki import Formatter}}}.
     147For example, when writing:
     148{{{
     149{{{#!HelloWorld style="polite" -silent verbose
     150<Hello World!>
     151}}}
    107152
    108 If your macro creates wiki markup instead of HTML, you can convert it to HTML like this:
     153{{{#!HelloWorld
     154<Hello World!>
     155}}}
     156
     157[[HelloWorld(<Hello World!>)]]
     158}}}
     159One should get:
     160{{{
     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
     164}}}
     165
     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`). 
     167
     168You can also recursively use a wiki Formatter (`from trac.wiki import Formatter`) to process the `text` as wiki markup:
    109169
    110170{{{
    111171#!python
    112   text = "whatever wiki markup you want, even containing other macros"
    113   # Convert Wiki markup to HTML, new style
    114   out = StringIO()
    115   Formatter(self.env, formatter.context).format(text, out)
    116   return Markup(out.getvalue())
     172from genshi.core import Markup
     173from trac.wiki.macros import WikiMacroBase
     174from trac.wiki import Formatter
     175import StringIO
     176
     177class 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())
    117184}}}