Changes between Version 1 and Version 2 of WikiMacros


Ignore:
Timestamp:
11/17/17 12:56:10 (7 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • WikiMacros

    v1 v2  
    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 ==
    10 Macro calls are enclosed in two ''square brackets''. Like Python functions, macros can also have arguments, a comma separated list within parentheses.
    11 
    12 Trac macros can also be written as TracPlugins. This gives them some capabilities that macros do not have, such as being able to directly access the HTTP request.
    13 
    14 === Example ===
    15 
    16 A list of 3 most recently changed wiki pages starting with 'Trac':
     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:
    1710
    1811{{{
    19  [[RecentChanges(Trac,3)]]
     12{{{#!wiki-processor-name
     13...
     14}}}
    2015}}}
    2116
    22 Display:
    23  [[RecentChanges(Trac,3)]]
     17== Using Macros
    2418
    25 == Available Macros ==
     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':
     32
     33||= Wiki Markup =||= Display =||
     34{{{#!td
     35  {{{
     36  [[RecentChanges(Trac,3)]]
     37  }}}
     38}}}
     39{{{#!td style="padding-left: 2em;"
     40[[RecentChanges(Trac,3)]]
     41}}}
     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.
     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.
     69}}}
     70
     71== Available Macros
    2672
    2773''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].''
    … …  
    2975[[MacroList]]
    3076
    31 == Macros from around the world ==
     77== Macros from around the world
    3278
    33 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.
    3480
    35 == Developing Custom Macros ==
    36 Macros, like Trac itself, are written in the [http://python.org/ Python programming language].
     81== Developing Custom Macros
    3782
    38 For more information about developing macros, see the [wiki:TracDev development resources] on the main project site.
     83Macros, like Trac itself, are written in the [http://python.org/ Python programming language] and are developed as part of TracPlugins.
    3984
     85For more information about developing macros, see the [trac:TracDev development resources] on the main project site.
    4086
    41 == Implementation ==
     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.
    4288
    43 Here are 2 simple examples on how to create a Macro with [wiki:0.11 Trac 0.11] have a look at source:trunk/sample-plugins/Timestamp.py for an example that shows the difference between old style and new style macros and also source:trunk/wiki-macros/README which provides a little more insight about the transition.
     89=== Macro without arguments
    4490
    45 === Macro without arguments ===
    46 It should be saved as `TimeStamp.py` as Trac will use the module name as the Macro name
    47 {{{
    48 #!python
     91To test the following code, save it in a `timestamp_sample.py` file located in the TracEnvironment's `plugins/` directory.
     92
     93{{{#!python
    4994from datetime import datetime
    5095# Note: since Trac 0.11, datetime objects are used internally
    … …  
    55100from trac.wiki.macros import WikiMacroBase
    56101
    57 class TimestampMacro(WikiMacroBase):
     102class TimeStampMacro(WikiMacroBase):
    58103    """Inserts the current time (in seconds) into the wiki page."""
    59104
    … …  
    61106    url = "$URL$"
    62107
    63     def expand_macro(self, formatter, name, args):
     108    def expand_macro(self, formatter, name, text):
    64109        t = datetime.now(utc)
    65         return tag.b(format_datetime(t, '%c'))
     110        return tag.strong(format_datetime(t, '%c'))
    66111}}}
    67112
    68 === Macro with arguments ===
    69 It should be saved as `HelloWorld.py` (in the plugins/ directory) as Trac will use the module name as the Macro name
    70 {{{
    71 #!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
     118from genshi.core import Markup
     119
    72120from trac.wiki.macros import WikiMacroBase
    73121
    … …  
    87135    url = "$URL$"
    88136
    89     def expand_macro(self, formatter, name, args):
     137    def expand_macro(self, formatter, name, text, args):
    90138        """Return some output that will be displayed in the Wiki content.
    91139
    92140        `name` is the actual name of the macro (no surprise, here it'll be
    93141        `'HelloWorld'`),
    94         `args` is the text enclosed in parenthesis at the call of the macro.
     142        `text` is the text enclosed in parenthesis at the call of the macro.
    95143          Note that if there are ''no'' parenthesis (like in, e.g.
    96           [[HelloWorld]]), then `args` is `None`.
     144          [[HelloWorld]]), then `text` is `None`.
     145        `args` are the arguments passed when HelloWorld is called using a
     146        `#!HelloWorld` code block.
    97147        """
    98         return 'Hello World, args = ' + unicode(args)
    99    
    100     # Note that there's no need to HTML escape the returned data,
    101     # as the template engine (Genshi) will do it for us.
     148        return 'Hello World, text = %s, args = %s' % \
     149            (Markup.escape(text), Markup.escape(repr(args)))
     150
    102151}}}
    103152
     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'').
    104154
    105 === {{{expand_macro}}} details ===
    106 {{{expand_macro}}} should return either a simple Python string which will be interpreted as HTML, or preferably a Markup object (use {{{from trac.util.html import Markup}}}).  {{{Markup(string)}}} just annotates the string so the renderer will render the HTML string as-is with no escaping. You will also need to import Formatter using {{{from trac.wiki import Formatter}}}.
     155For example, when writing:
     156{{{
     157{{{#!HelloWorld style="polite" -silent verbose
     158<Hello World!>
     159}}}
    107160
    108 If your macro creates wiki markup instead of HTML, you can convert it to HTML like this:
     161{{{#!HelloWorld
     162<Hello World!>
     163}}}
    109164
     165[[HelloWorld(<Hello World!>)]]
     166}}}
     167
     168One should get:
    110169{{{
    111 #!python
    112   text = "whatever wiki markup you want, even containing other macros"
    113   # Convert Wiki markup to HTML, new style
    114   out = StringIO()
    115   Formatter(self.env, formatter.context).format(text, out)
    116   return Markup(out.getvalue())
     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
    117173}}}
     174
     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`).
     176
     177You can also recursively use a wiki Formatter (`from trac.wiki import Formatter`) to process the `text` as wiki markup:
     178
     179{{{#!python
     180from genshi.core import Markup
     181from trac.wiki.macros import WikiMacroBase
     182from trac.wiki import Formatter
     183import StringIO
     184
     185class HelloWorldMacro(WikiMacroBase):
     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())
     192}}}