Changes between Version 4 and Version 5 of WikiMacros


Ignore:
Timestamp:
2018-10-05T12:10:06+10:00 (6 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • WikiMacros

    v4 v5  
    33[[PageOutline(2-5,Contents,pullout)]]
    44
    5 '''Trac macros''' extend Trac with custom functionality. Macros are a special type of plugin and are written in Python. A macro generates HTML in any context supporting WikiFormatting.
     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
    77The macro syntax is `[[macro-name(optional-arguments)]]`.
    88
    9 '''WikiProcessors''' are another kind of macro, commonly used for source code highlighting using a processor like `!#python` or `!#apache`:
     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:
    1010
    1111{{{
    … …  
    1717== Using Macros
    1818
    19 Macro calls are enclosed in double-square brackets `[[..]]`. Like Python functions macros can have arguments, which take the form of a comma separated list within parentheses `[[..(,)]]`. A common macro used is a list of the 3 most recent changes to a wiki page, or here, for example, all wiki pages starting with 'Trac':
     19Macro calls are enclosed in double-square brackets `[[..]]`. Like Python functions, macros can have arguments, which is then a comma separated list within parentheses `[[..(,)]]`.
     20
     21=== Getting Detailed Help
     22
     23The list of available macros and the full help can be obtained using the !MacroList macro, as seen [#AvailableMacros below].
     24
     25A brief list can be obtained via `[[MacroList(*)]]` or `[[?]]`.
     26
     27Detailed 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?]]`.
     28
     29=== Example
     30
     31A list of the 3 most recently changed wiki pages starting with 'Trac':
    2032
    2133||= Wiki Markup =||= Display =||
    … …  
    2840[[RecentChanges(Trac,3)]]
    2941}}}
     42|-----------------------------------
     43{{{#!td
     44  {{{
     45  [[RecentChanges?(Trac,3)]]
     46  }}}
     47}}}
     48{{{#!td style="padding-left: 2em;"
     49[[RecentChanges?(Trac,3)]]
     50}}}
     51|-----------------------------------
     52{{{#!td
     53  {{{
     54  [[?]]
     55  }}}
     56}}}
     57{{{#!td style="padding-left: 2em"
     58{{{#!html
     59<div class="trac-macrolist">
     60<h3><code>[[Image]]</code></h3>Embed an image in wiki-formatted text.
    3061
    31 === Getting Detailed Help
    32 
    33 The list of available macros and the full help can be obtained using the !MacroList macro, see [#AvailableMacros below].
    34 
    35 A brief list can be obtained via `[[MacroList(*)]]` or `[[?]]`.
    36 
    37 Detailed 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?]]`.
     62The first argument is the file, as in <code>[[Image(filename.png)]]</code>
     63<h3><code>[[InterTrac]]</code></h3>Provide a list of known <a class="wiki" href="/wiki/InterTrac">InterTrac</a> prefixes.
     64<h3><code>[[InterWiki]]</code></h3>Provide a description list for the known <a class="wiki" href="/wiki/InterWiki">InterWiki</a> prefixes.
     65<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>
     67}}}
     68etc.
     69}}}
    3870
    3971== Available Macros
    4072
     73''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].''
     74
    4175[[MacroList]]
    4276
    43 == Contributed macros
     77== Macros from around the world
    4478
    45 The [http://trac-hacks.org/ Trac Hacks] site provides a large 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.
     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.
    4680
    4781== Developing Custom Macros
    4882
    49 Macros, like Trac itself, are written in the [http://python.org/ Python programming language] and are a type of [TracPlugins plugin].
     83Macros, like Trac itself, are written in the [http://python.org/ Python programming language] and are developed as part of TracPlugins.
    5084
    51 Here are 2 simple examples showing how to create a Macro. For more information about developing macros, see the [trac:TracDev development resources] and [trac:browser:branches/1.2-stable/sample-plugins sample-plugins].
     85For more information about developing macros, see the [trac:TracDev development resources] on the main project site.
     86
     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.
    5288
    5389=== Macro without arguments
    5490
    55 To test the following code, copy it to `timestamp_sample.py` in the TracEnvironment's `plugins/` directory.
     91To test the following code, save it in a `timestamp_sample.py` file located in the TracEnvironment's `plugins/` directory.
    5692
    5793{{{#!python
    58 from trac.util.datefmt import datetime_now, format_datetime, utc
     94from datetime import datetime
     95# Note: since Trac 0.11, datetime objects are used internally
     96
     97from trac.util.datefmt import format_datetime, utc
    5998from trac.util.html import tag
    6099from trac.wiki.macros import WikiMacroBase
    61100
    62 class TimestampMacro(WikiMacroBase):
    63     _description = "Inserts the current time (in seconds) into the wiki page."
     101class TimeStampMacro(WikiMacroBase):
     102    """Inserts the current time (in seconds) into the wiki page."""
    64103
    65     def expand_macro(self, formatter, name, content, args=None):
    66         t = datetime_now(utc)
     104    revision = "$Rev$"
     105    url = "$URL$"
     106
     107    def expand_macro(self, formatter, name, text):
     108        t = datetime.now(utc)
    67109        return tag.strong(format_datetime(t, '%c'))
    68110}}}
    … …  
    70112=== Macro with arguments
    71113
    72 To test the following code, copy it to `helloworld_sample.py` in the TracEnvironment's `plugins/` directory.
     114To test the following code, save it in a `helloworld_sample.py` file located in the TracEnvironment's `plugins/` directory.
    73115
    74116{{{#!python
    75 from trac.util.translation import cleandoc_
     117from trac.util.html import Markup
    76118from trac.wiki.macros import WikiMacroBase
    77119
    78120class HelloWorldMacro(WikiMacroBase):
    79     _description = cleandoc_(
    80121    """Simple HelloWorld macro.
    81122
    … …  
    87128    will become the documentation of the macro, as shown by
    88129    the !MacroList macro (usually used in the WikiMacros page).
    89     """)
     130    """
    90131
    91     def expand_macro(self, formatter, name, content, args=None):
     132    revision = "$Rev$"
     133    url = "$URL$"
     134
     135    def expand_macro(self, formatter, name, text, args):
    92136        """Return some output that will be displayed in the Wiki content.
    93137
    94138        `name` is the actual name of the macro (no surprise, here it'll be
    95139        `'HelloWorld'`),
    96         `content` is the text enclosed in parenthesis at the call of the
    97           macro. Note that if there are ''no'' parenthesis (like in, e.g.
    98           [[HelloWorld]]), then `content` is `None`.
    99         `args` will contain a dictionary of arguments when called using the
    100           Wiki processor syntax and will be `None` if called using the
    101           macro syntax.
     140        `text` is the text enclosed in parenthesis at the call of the macro.
     141          Note that if there are ''no'' parenthesis (like in, e.g.
     142          [[HelloWorld]]), then `text` is `None`.
     143        `args` are the arguments passed when HelloWorld is called using a
     144        `#!HelloWorld` code block.
    102145        """
    103         return 'Hello World, content = ' + unicode(content)
     146        return 'Hello World, text = %s, args = %s' % \
     147            (Markup.escape(text), Markup.escape(repr(args)))
     148
    104149}}}
    105150
    106 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. When called as a macro, `args` is `None`.
     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'').
    107152
    108153For example, when writing:
    … …  
    126171}}}
    127172
    128 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`).
     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`).
    129174
    130 You can also recursively use a wiki formatter to process the `content` as wiki markup:
     175You can also recursively use a wiki Formatter (`from trac.wiki import Formatter`) to process the `text` as wiki markup:
    131176
    132177{{{#!python
    133 from trac.wiki.formatter import format_to_html
     178from trac.util.html import Markup
    134179from trac.wiki.macros import WikiMacroBase
     180from trac.wiki import Formatter
     181import StringIO
    135182
    136183class HelloWorldMacro(WikiMacroBase):
    137     def expand_macro(self, formatter, name, content, args):
    138         content = "any '''wiki''' markup you want, even containing other macros"
    139         # Convert Wiki markup to HTML
    140         return format_to_html(self.env, formatter.context, content)
     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())
    141190}}}