Changes between Version 2 and Version 3 of WikiMacros


Ignore:
Timestamp:
Aug 22, 2019, 8:54:37 AM (5 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • WikiMacros

    v2 v3  
    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 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 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 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
     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].
    7952
    80 Here are 2 simple examples showing how to create a Macro with Trac 0.11.
     53=== Macro without arguments
    8154
    82 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.
     55To test the following code, copy it to `timestamp_sample.py` in the TracEnvironment's `plugins/` directory.
    8356
    84 === Macro without arguments ===
    85 To test the following code, you should saved it in a `timestamp_sample.py` file located in the TracEnvironment's `plugins/` directory.
    86 {{{
    87 #!python
    88 from datetime import datetime
    89 # Note: since Trac 0.11, datetime objects are used internally
    90 
    91 from genshi.builder import tag
    92 
    93 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
    9460from trac.wiki.macros import WikiMacroBase
    9561
    96 class TimeStampMacro(WikiMacroBase):
    97     """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."
    9864
    99     revision = "$Rev$"
    100     url = "$URL$"
    101 
    102     def expand_macro(self, formatter, name, text):
    103         t = datetime.now(utc)
    104         return tag.b(format_datetime(t, '%c'))
     65    def expand_macro(self, formatter, name, content, args=None):
     66        t = datetime_now(utc)
     67        return tag.strong(format_datetime(t, '%c'))
    10568}}}
    10669
    107 === Macro with arguments ===
    108 To test the following code, you should saved it in a `helloworld_sample.py` file located in the TracEnvironment's `plugins/` directory.
    109 {{{
    110 #!python
    111 from genshi.core import Markup
     70=== Macro with arguments
    11271
     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_
    11376from trac.wiki.macros import WikiMacroBase
    11477
    11578class HelloWorldMacro(WikiMacroBase):
     79    _description = cleandoc_(
    11680    """Simple HelloWorld macro.
    11781
    … …  
    12387    will become the documentation of the macro, as shown by
    12488    the !MacroList macro (usually used in the WikiMacros page).
    125     """
     89    """)
    12690
    127     revision = "$Rev$"
    128     url = "$URL$"
    129 
    130     def expand_macro(self, formatter, name, text, args):
     91    def expand_macro(self, formatter, name, content, args=None):
    13192        """Return some output that will be displayed in the Wiki content.
    13293
    13394        `name` is the actual name of the macro (no surprise, here it'll be
    13495        `'HelloWorld'`),
    135         `text` is the text enclosed in parenthesis at the call of the macro.
    136           Note that if there are ''no'' parenthesis (like in, e.g.
    137           [[HelloWorld]]), then `text` is `None`.
    138         `args` are the arguments passed when HelloWorld is called using a
    139         `#!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.
    140102        """
    141         return 'Hello World, text = %s, args = %s' % \
    142             (Markup.escape(text), Markup.escape(repr(args)))
    143 
     103        return 'Hello World, content = ' + unicode(content)
    144104}}}
    145105
    146 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`.
    147107
    148108For example, when writing:
    149109{{{
    150 {{{#!HelloWorld style="polite"
     110{{{#!HelloWorld style="polite" -silent verbose
    151111<Hello World!>
    152112}}}
    … …  
    158118[[HelloWorld(<Hello World!>)]]
    159119}}}
     120
    160121One should get:
    161122{{{
    162 Hello World, text = <Hello World!> , args = {'style': u'polite'}
    163 Hello World, text = <Hello World!> , args = {}
    164 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
    165126}}}
    166127
    167 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`).
    168129
    169 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:
    170131
    171 {{{
    172 #!python
    173 from genshi.core import Markup
     132{{{#!python
     133from trac.wiki.formatter import format_to_html
    174134from trac.wiki.macros import WikiMacroBase
    175 from trac.wiki import Formatter
    176 import StringIO
    177135
    178136class HelloWorldMacro(WikiMacroBase):
    179         def expand_macro(self, formatter, name, text, args):
    180                 text = "whatever '''wiki''' markup you want, even containing other macros"
    181                 # Convert Wiki markup to HTML, new style
    182                 out = StringIO.StringIO()
    183                 Formatter(self.env, formatter.context).format(text, out)
    184                 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)
    185141}}}