Changes between Version 1 and Version 2 of WikiMacros


Ignore:
Timestamp:
08/04/18 22:08:33 (6 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • WikiMacros

    v1 v2  
    1 = Trac Macros =
     1= Trac Macros
    22
    33[[PageOutline]]
    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.
     5Trac 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)]]`.
    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 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.
    88
    9 == Using Macros ==
     9== Using Macros
    1010
    11 Macro calls are enclosed in two ''square brackets''. Like Python functions, macros can also have arguments, a comma separated list within parentheses.
     11Macro calls are enclosed in two ''square brackets'' `[[..]]`. Like Python functions, macros can also have arguments, a comma separated list within parentheses `[[..(,)]]`.
    1212
    13 === Getting Detailed Help ===
     13=== Getting Detailed Help
     14
    1415The list of available macros and the full help can be obtained using the !MacroList macro, as seen [#AvailableMacros below].
    1516
    16 A brief list can be obtained via ![[MacroList(*)]] or ![[?]].
     17A brief list can be obtained via `[[MacroList(*)]]` or `[[?]]`.
    1718
    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?]].
     19Detailed 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?]]`.
    1920
     21=== Example
    2022
    21 
    22 === Example ===
    23 
    24 A list of 3 most recently changed wiki pages starting with 'Trac':
     23A list of the 3 most recently changed wiki pages starting with 'Trac':
    2524
    2625||= Wiki Markup =||= Display =||
    … …  
    6261}}}
    6362
    64 == Available Macros ==
     63== Available Macros
    6564
    6665''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].''
    … …  
    6867[[MacroList]]
    6968
    70 == Macros from around the world ==
     69== Macros from around the world
    7170
    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.
     71The [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.
    7372
    74 == Developing Custom Macros ==
     73== Developing Custom Macros
     74
    7575Macros, like Trac itself, are written in the [http://python.org/ Python programming language] and are developed as part of TracPlugins.
    7676
    7777For more information about developing macros, see the [trac:TracDev development resources] on the main project site.
    7878
     79Here 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.
    7980
    80 Here are 2 simple examples showing how to create a Macro with Trac 0.11.
     81=== Macro without arguments
    8182
    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.
    83 
    84 === Macro without arguments ===
    8583To test the following code, you should saved it in a `timestamp_sample.py` file located in the TracEnvironment's `plugins/` directory.
    8684{{{
    … …  
    102100    def expand_macro(self, formatter, name, text):
    103101        t = datetime.now(utc)
    104         return tag.b(format_datetime(t, '%c'))
     102        return tag.strong(format_datetime(t, '%c'))
    105103}}}
    106104
    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.
     105=== Macro with arguments
     106
     107To test the following code, you should save it in a `helloworld_sample.py` file located in the TracEnvironment's `plugins/` directory.
    109108{{{
    110109#!python
    … …  
    148147For example, when writing:
    149148{{{
    150 {{{#!HelloWorld style="polite"
     149{{{#!HelloWorld style="polite" -silent verbose
    151150<Hello World!>
    152151}}}
    … …  
    160159One should get:
    161160{{{
    162 Hello World, text = <Hello World!> , args = {'style': u'polite'}
     161Hello World, text = <Hello World!> , args = {'style': u'polite', 'silent': False, 'verbose': True}
    163162Hello World, text = <Hello World!> , args = {}
    164163Hello World, text = <Hello World!> , args = None
    … …  
    167166Note 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`). 
    168167
    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:
     168You can also recursively use a wiki Formatter (`from trac.wiki import Formatter`) to process the `text` as wiki markup:
    170169
    171170{{{
    … …  
    177176
    178177class 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())
     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())
    185184}}}