Changes between Version 3 and Version 4 of WikiMacros


Ignore:
Timestamp:
Apr 24, 2017, 10:36:27 AM (4 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WikiMacros

    v3 v4  
    1 = Trac Macros =
     1= 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.
     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 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 macro syntax is `[[macro-name(optional-arguments)]]`.
    88
    9 == Using Macros ==
     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
    11 Macro calls are enclosed in two ''square brackets''. Like Python functions, macros can also have arguments, a comma separated list within parentheses.
     11{{{
     12{{{#!wiki-processor-name
     13...
     14}}}
     15}}}
    1216
    13 === Getting Detailed Help ===
     17== Using Macros
     18
     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
    1423The list of available macros and the full help can be obtained using the !MacroList macro, as seen [#AvailableMacros below].
    1524
    16 A brief list can be obtained via ![[MacroList(*)]] or ![[?]].
     25A brief list can be obtained via `[[MacroList(*)]]` or `[[?]]`.
    1726
    18 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?]].
     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?]]`.
    1928
     29=== Example
    2030
    21 
    22 === Example ===
    23 
    24 A list of 3 most recently changed wiki pages starting with 'Trac':
     31A list of the 3 most recently changed wiki pages starting with 'Trac':
    2532
    2633||= Wiki Markup =||= Display =||
     
    4855  }}}
    4956}}}
    50 {{{#!td style="padding-left: 2em; font-size: 80%"
    51 [[?]]
     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.
     61
     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.
    5269}}}
    5370
    54 == Available Macros ==
     71== Available Macros
    5572
    5673''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].''
     
    5875[[MacroList]]
    5976
    60 == Macros from around the world ==
     77== Macros from around the world
    6178
    62 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.
     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.
    6380
    64 == Developing Custom Macros ==
     81== Developing Custom Macros
     82
    6583Macros, like Trac itself, are written in the [http://python.org/ Python programming language] and are developed as part of TracPlugins.
    6684
    6785For more information about developing macros, see the [trac:TracDev development resources] on the main project site.
    6886
     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.
    6988
    70 Here are 2 simple examples showing how to create a Macro with Trac 0.11.
     89=== Macro without arguments
    7190
    72 Also, have a look at [trac:source:tags/trac-0.11/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.
     91To test the following code, save it in a `timestamp_sample.py` file located in the TracEnvironment's `plugins/` directory.
    7392
    74 === Macro without arguments ===
    75 To test the following code, you should saved it in a `timestamp_sample.py` file located in the TracEnvironment's `plugins/` directory.
    76 {{{
    77 #!python
     93{{{#!python
    7894from datetime import datetime
    7995# Note: since Trac 0.11, datetime objects are used internally
     
    92108    def expand_macro(self, formatter, name, text):
    93109        t = datetime.now(utc)
    94         return tag.b(format_datetime(t, '%c'))
     110        return tag.strong(format_datetime(t, '%c'))
    95111}}}
    96112
    97 === Macro with arguments ===
    98 To test the following code, you should saved it in a `helloworld_sample.py` file located in the TracEnvironment's `plugins/` directory.
    99 {{{
    100 #!python
     113=== Macro with arguments
     114
     115To test the following code, save it in a `helloworld_sample.py` file located in the TracEnvironment's `plugins/` directory.
     116
     117{{{#!python
    101118from genshi.core import Markup
    102119
     
    134151}}}
    135152
    136 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'').
     153Note 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'').
    137154
    138155For example, when writing:
    139156{{{
    140 {{{#!HelloWorld style="polite"
     157{{{#!HelloWorld style="polite" -silent verbose
    141158<Hello World!>
    142159}}}
     
    148165[[HelloWorld(<Hello World!>)]]
    149166}}}
     167
    150168One should get:
    151169{{{
    152 Hello World, text = <Hello World!> , args = {'style': u'polite'}
    153 Hello World, text = <Hello World!> , args = {}
    154 Hello World, text = <Hello World!> , args = None
     170Hello World, text = <Hello World!>, args = {'style': u'polite', 'silent': False, 'verbose': True}
     171Hello World, text = <Hello World!>, args = {}
     172Hello World, text = <Hello World!>, args = None
    155173}}}
    156174
    157 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`). 
     175Note 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`).
    158176
    159 You can also recursively use a wiki Formatter (`from trac.wiki import Formatter`) to process the `text` as wiki markup, for example by doing:
     177You can also recursively use a wiki Formatter (`from trac.wiki import Formatter`) to process the `text` as wiki markup:
    160178
    161 {{{
    162 #!python
     179{{{#!python
    163180from genshi.core import Markup
    164181from trac.wiki.macros import WikiMacroBase
     
    167184
    168185class HelloWorldMacro(WikiMacroBase):
    169         def expand_macro(self, formatter, name, text, args):
    170                 text = "whatever '''wiki''' markup you want, even containing other macros"
    171                 # Convert Wiki markup to HTML, new style
    172                 out = StringIO.StringIO()
    173                 Formatter(self.env, formatter.context).format(text, out)
    174                 return Markup(out.getvalue())
     186    def expand_macro(self, formatter, name, text, args):
     187        text = "whatever '''wiki''' markup you want, even containing other macros"
     188        # Convert Wiki markup to HTML, new style
     189        out = StringIO.StringIO()
     190        Formatter(self.env, formatter.context).format(text, out)
     191        return Markup(out.getvalue())
    175192}}}