Changes between Version 4 and Version 5 of WikiMacros


Ignore:
Timestamp:
Feb 4, 2019, 3:14:10 PM (2 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WikiMacros

    v4 v5  
    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 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.
    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 macro, commonly used for source code highlighting using a processor like `!#python` or `!#apache`:
     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 `[[..(,)]]`.
    12 
    13 === Getting Detailed Help
    14 
    15 The list of available macros and the full help can be obtained using the !MacroList macro, as seen [#AvailableMacros below].
    16 
    17 A brief list can be obtained via `[[MacroList(*)]]` or `[[?]]`.
    18 
    19 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?]]`.
    20 
    21 === Example
    22 
    23 A list of the 3 most recently changed wiki pages starting with 'Trac':
     19Macro 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':
    2420
    2521||= Wiki Markup =||= Display =||
     
    3228[[RecentChanges(Trac,3)]]
    3329}}}
    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.
    5330
    54 The 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>.
    58 Can be …</div>
    59 }}}
    60 etc.
    61 }}}
     31=== Getting Detailed Help
     32
     33The list of available macros and the full help can be obtained using the !MacroList macro, see [#AvailableMacros below].
     34
     35A brief list can be obtained via `[[MacroList(*)]]` or `[[?]]`.
     36
     37Detailed 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?]]`.
    6238
    6339== Available Macros
    6440
    65 ''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].''
    66 
    6741[[MacroList]]
    6842
    69 == Macros from around the world
     43== Contributed macros
    7044
    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.
     45The [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.
    7246
    7347== Developing Custom Macros
    7448
    75 Macros, like Trac itself, are written in the [http://python.org/ Python programming language] and are developed as part of TracPlugins.
     49Macros, like Trac itself, are written in the [http://python.org/ Python programming language] and are a type of [TracPlugins plugin].
    7650
    77 For more information about developing macros, see the [trac:TracDev development resources] on the main project site.
    78 
    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.
     51Here 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].
    8052
    8153=== Macro without arguments
    8254
    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
    86 from datetime import datetime
    87 # Note: since Trac 0.11, datetime objects are used internally
     55To test the following code, copy it to `timestamp_sample.py` in the TracEnvironment's `plugins/` directory.
    8856
    89 from genshi.builder import tag
    90 
    91 from trac.util.datefmt import format_datetime, utc
     57{{{#!python
     58from trac.util.datefmt import datetime_now, format_datetime, utc
     59from trac.util.html import tag
    9260from trac.wiki.macros import WikiMacroBase
    9361
    94 class TimeStampMacro(WikiMacroBase):
    95     """Inserts the current time (in seconds) into the wiki page."""
     62class TimestampMacro(WikiMacroBase):
     63    _description = "Inserts the current time (in seconds) into the wiki page."
    9664
    97     revision = "$Rev$"
    98     url = "$URL$"
    99 
    100     def expand_macro(self, formatter, name, text):
    101         t = datetime.now(utc)
     65    def expand_macro(self, formatter, name, content, args=None):
     66        t = datetime_now(utc)
    10267        return tag.strong(format_datetime(t, '%c'))
    10368}}}
     
    10570=== Macro with arguments
    10671
    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
     72To test the following code, copy it to `helloworld_sample.py` in the TracEnvironment's `plugins/` directory.
    11173
     74{{{#!python
     75from trac.util.translation import cleandoc_
    11276from trac.wiki.macros import WikiMacroBase
    11377
    11478class HelloWorldMacro(WikiMacroBase):
     79    _description = cleandoc_(
    11580    """Simple HelloWorld macro.
    11681
     
    12287    will become the documentation of the macro, as shown by
    12388    the !MacroList macro (usually used in the WikiMacros page).
    124     """
     89    """)
    12590
    126     revision = "$Rev$"
    127     url = "$URL$"
    128 
    129     def expand_macro(self, formatter, name, text, args):
     91    def expand_macro(self, formatter, name, content, args=None):
    13092        """Return some output that will be displayed in the Wiki content.
    13193
    13294        `name` is the actual name of the macro (no surprise, here it'll be
    13395        `'HelloWorld'`),
    134         `text` is the text enclosed in parenthesis at the call of the macro.
    135           Note that if there are ''no'' parenthesis (like in, e.g.
    136           [[HelloWorld]]), then `text` is `None`.
    137         `args` are the arguments passed when HelloWorld is called using a
    138         `#!HelloWorld` code block.
     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.
    139102        """
    140         return 'Hello World, text = %s, args = %s' % \
    141             (Markup.escape(text), Markup.escape(repr(args)))
    142 
     103        return 'Hello World, content = ' + unicode(content)
    143104}}}
    144105
    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'').
     106Note 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`.
    146107
    147108For example, when writing:
     
    157118[[HelloWorld(<Hello World!>)]]
    158119}}}
     120
    159121One should get:
    160122{{{
    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
     123Hello World, text = <Hello World!>, args = {'style': u'polite', 'silent': False, 'verbose': True}
     124Hello World, text = <Hello World!>, args = {}
     125Hello World, text = <Hello World!>, args = None
    164126}}}
    165127
    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`). 
     128Note 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`).
    167129
    168 You can also recursively use a wiki Formatter (`from trac.wiki import Formatter`) to process the `text` as wiki markup:
     130You can also recursively use a wiki formatter to process the `content` as wiki markup:
    169131
    170 {{{
    171 #!python
    172 from genshi.core import Markup
     132{{{#!python
     133from trac.wiki.formatter import format_to_html
    173134from trac.wiki.macros import WikiMacroBase
    174 from trac.wiki import Formatter
    175 import StringIO
    176135
    177136class 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())
     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)
    184141}}}