Changes between Version 6 and Version 7 of WikiMacros


Ignore:
Timestamp:
03/24/15 23:15:03 (3 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WikiMacros

    v6 v7  
    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. Its syntax is `[[macro-name(optional-arguments)]]`.
     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.
    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.
     7Another kind of macros are WikiProcessors. They typically deal with alternate markup formats and representation of larger blocks of information (like source code highlighting).
    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
    14 
     13=== Getting Detailed Help ===
    1514The list of available macros and the full help can be obtained using the !MacroList macro, as seen [#AvailableMacros below].
    1615
     
    1918Detailed 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?]]`.
    2019
    21 === Example
    2220
    23 A list of the 3 most recently changed wiki pages starting with 'Trac':
     21
     22=== Example ===
     23
     24A list of 3 most recently changed wiki pages starting with 'Trac':
    2425
    2526||= Wiki Markup =||= Display =||
     
    6162}}}
    6263
    63 == Available Macros
     64== Available Macros ==
    6465
    6566''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].''
     
    6768[[MacroList]]
    6869
    69 == Macros from around the world
     70== Macros from around the world ==
    7071
    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.
     72The [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.
    7273
    73 == Developing Custom Macros
    74 
     74== Developing Custom Macros ==
    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
    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.
    8079
    81 === Macro without arguments
     80Here are 2 simple examples showing how to create a Macro with Trac 0.11.
    8281
     82Also, 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 ===
    8385To test the following code, you should saved it in a `timestamp_sample.py` file located in the TracEnvironment's `plugins/` directory.
    8486{{{
     
    100102    def expand_macro(self, formatter, name, text):
    101103        t = datetime.now(utc)
    102         return tag.strong(format_datetime(t, '%c'))
     104        return tag.b(format_datetime(t, '%c'))
    103105}}}
    104106
    105 === Macro with arguments
    106 
    107 To test the following code, you should save it in a `helloworld_sample.py` file located in the TracEnvironment's `plugins/` directory.
     107=== Macro with arguments ===
     108To test the following code, you should saved it in a `helloworld_sample.py` file located in the TracEnvironment's `plugins/` directory.
    108109{{{
    109110#!python
     
    166167Note 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`). 
    167168
    168 You can also recursively use a wiki Formatter (`from trac.wiki import Formatter`) to process the `text` as wiki markup:
     169You can also recursively use a wiki Formatter (`from trac.wiki import Formatter`) to process the `text` as wiki markup, for example by doing:
    169170
    170171{{{