Changes between Version 5 and Version 6 of WikiMacros


Ignore:
Timestamp:
04/19/23 14:06:21 (13 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • WikiMacros

    v5 v6  
    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. 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)]]`.
    88
    9 == Using Macros ==
     9'''WikiProcessors''' are another kind of macro, commonly used for source code highlighting using a processor like `!#python` or `!#apache`:
    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 ===
    14 The list of available macros and the full help can be obtained using the !MacroList macro, as seen [#AvailableMacros below].
     17== Using Macros
    1518
    16 A brief list can be obtained via `[[MacroList(*)]]` or `[[?]]`.
    17 
    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?]]`.
    19 
    20 
    21 
    22 === Example ===
    23 
    24 A list of 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':
    2520
    2621||= Wiki Markup =||= Display =||
    … …  
    3328[[RecentChanges(Trac,3)]]
    3429}}}
    35 |-----------------------------------
    36 {{{#!td
    37   {{{
    38   [[RecentChanges?(Trac,3)]]
    39   }}}
    40 }}}
    41 {{{#!td style="padding-left: 2em;"
    42 [[RecentChanges?(Trac,3)]]
    43 }}}
    44 |-----------------------------------
    45 {{{#!td
    46   {{{
    47   [[?]]
    48   }}}
    49 }}}
    50 {{{#!td style="padding-left: 2em"
    51 {{{#!html
    52 <div style="font-size: 80%" class="trac-macrolist">
    53 <h3><code>[[Image]]</code></h3>Embed an image in wiki-formatted text.
    5430
    55 The first argument is the file …
    56 <h3><code>[[InterTrac]]</code></h3>Provide a list of known <a class="wiki" href="/wiki/InterTrac">InterTrac</a> prefixes.
    57 <h3><code>[[InterWiki]]</code></h3>Provide a description list for the known <a class="wiki" href="/wiki/InterWiki">InterWiki</a> prefixes.
    58 <h3><code>[[KnownMimeTypes]]</code></h3>List all known mime-types which can be used as <a class="wiki" href="/wiki/WikiProcessors">WikiProcessors</a>.
    59 Can be …</div>
    60 }}}
    61 etc.
    62 }}}
     31=== Getting Detailed Help
    6332
    64 == Available Macros ==
     33The list of available macros and the full help can be obtained using the !MacroList macro, see [#AvailableMacros below].
    6534
    66 ''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].''
     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?]]`.
     38
     39== Available Macros
    6740
    6841[[MacroList]]
    6942
    70 == Macros from around the world ==
     43== Contributed macros
    7144
    72 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.
     45The [https://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.
    7346
    74 == Developing Custom Macros ==
    75 Macros, like Trac itself, are written in the [http://python.org/ Python programming language] and are developed as part of TracPlugins.
     47== Developing Custom Macros
    7648
    77 For more information about developing macros, see the [trac:TracDev development resources] on the main project site.
     49Macros, like Trac itself, are written in the [https://python.org/ Python programming language] and are a type of [TracPlugins plugin].
    7850
    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.4-stable/sample-plugins sample-plugins].
    8052
    81 === Macro without arguments ===
    82 To test the following code, you should saved it in a `timestamp_sample.py` file located in the TracEnvironment's `plugins/` directory.
    83 {{{
    84 #!python
    85 from datetime import datetime
    86 # Note: since Trac 0.11, datetime objects are used internally
     53=== Macro without arguments
    8754
    88 from genshi.builder import tag
     55To test the following code, copy it to `timestamp_sample.py` in the TracEnvironment's `plugins/` directory.
    8956
    90 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
    9160from trac.wiki.macros import WikiMacroBase
    9261
    93 class TimeStampMacro(WikiMacroBase):
    94     """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."
    9564
    96     revision = "$Rev$"
    97     url = "$URL$"
    98 
    99     def expand_macro(self, formatter, name, text):
    100         t = datetime.now(utc)
     65    def expand_macro(self, formatter, name, content, args=None):
     66        t = datetime_now(utc)
    10167        return tag.strong(format_datetime(t, '%c'))
    10268}}}
    10369
    104 === Macro with arguments ===
    105 To test the following code, you should saved it in a `helloworld_sample.py` file located in the TracEnvironment's `plugins/` directory.
    106 {{{
    107 #!python
    108 from genshi.core import Markup
     70=== Macro with arguments
    10971
     72To test the following code, copy it to `helloworld_sample.py` in the TracEnvironment's `plugins/` directory.
     73
     74{{{#!python
     75from trac.util.translation import cleandoc_
    11076from trac.wiki.macros import WikiMacroBase
    11177
    11278class HelloWorldMacro(WikiMacroBase):
     79    _description = cleandoc_(
    11380    """Simple HelloWorld macro.
    11481
    … …  
    12087    will become the documentation of the macro, as shown by
    12188    the !MacroList macro (usually used in the WikiMacros page).
    122     """
     89    """)
    12390
    124     revision = "$Rev$"
    125     url = "$URL$"
    126 
    127     def expand_macro(self, formatter, name, text, args):
     91    def expand_macro(self, formatter, name, content, args=None):
    12892        """Return some output that will be displayed in the Wiki content.
    12993
    13094        `name` is the actual name of the macro (no surprise, here it'll be
    13195        `'HelloWorld'`),
    132         `text` is the text enclosed in parenthesis at the call of the macro.
    133           Note that if there are ''no'' parenthesis (like in, e.g.
    134           [[HelloWorld]]), then `text` is `None`.
    135         `args` are the arguments passed when HelloWorld is called using a
    136         `#!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.
    137102        """
    138         return 'Hello World, text = %s, args = %s' % \
    139             (Markup.escape(text), Markup.escape(repr(args)))
    140 
     103        return 'Hello World, content = ' + unicode(content)
    141104}}}
    142105
    143 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`.
    144107
    145108For example, when writing:
    … …  
    155118[[HelloWorld(<Hello World!>)]]
    156119}}}
     120
    157121One should get:
    158122{{{
    159 Hello World, text = <Hello World!> , args = {'style': u'polite', 'silent': False, 'verbose': True}
    160 Hello World, text = <Hello World!> , args = {}
    161 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
    162126}}}
    163127
    164 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`).
    165129
    166 You can also recursively use a wiki Formatter (`from trac.wiki import Formatter`) to process the `text` as wiki markup, for example by doing:
     130You can also recursively use a wiki formatter to process the `content` as wiki markup:
    167131
    168 {{{
    169 #!python
    170 from genshi.core import Markup
     132{{{#!python
     133from trac.wiki.formatter import format_to_html
    171134from trac.wiki.macros import WikiMacroBase
    172 from trac.wiki import Formatter
    173 import StringIO
    174135
    175136class HelloWorldMacro(WikiMacroBase):
    176         def expand_macro(self, formatter, name, text, args):
    177                 text = "whatever '''wiki''' markup you want, even containing other macros"
    178                 # Convert Wiki markup to HTML, new style
    179                 out = StringIO.StringIO()
    180                 Formatter(self.env, formatter.context).format(text, out)
    181                 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)
    182141}}}