Changes between Version 47 and Version 48 of WikiMacros
- Timestamp:
- Jan 14, 2015, 10:52:26 PM (9 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
WikiMacros
v47 v48 1 = Trac Macros =1 = Trac Macros 2 2 3 3 [[PageOutline]] … … 6 6 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)]]`. 7 7 8 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.8 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. 9 9 10 == Using Macros ==10 == Using Macros 11 11 12 Macro calls are enclosed in two ''square brackets'' . Like Python functions, macros can also have arguments, a comma separated list within parentheses.12 Macro calls are enclosed in two ''square brackets'' `[[..]]`. Like Python functions, macros can also have arguments, a comma separated list within parentheses `[[..(,)]]`. 13 13 14 === Getting Detailed Help === 14 === Getting Detailed Help 15 15 16 The list of available macros and the full help can be obtained using the !MacroList macro, as seen [#AvailableMacros below]. 16 17 … … 19 20 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?]]`. 20 21 22 === Example 21 23 22 23 === Example === 24 25 A list of 3 most recently changed wiki pages starting with 'Trac': 24 A list of the 3 most recently changed wiki pages starting with 'Trac': 26 25 27 26 ||= Wiki Markup =||= Display =|| … … 63 62 }}} 64 63 65 == Available Macros ==64 == Available Macros 66 65 67 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].'' … … 69 68 [[MacroList]] 70 69 71 == Macros from around the world ==70 == Macros from around the world 72 71 73 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, pleasedon't hesitate to visit that site.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 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. 74 73 75 == Developing Custom Macros == 74 == Developing Custom Macros 75 76 76 Macros, like Trac itself, are written in the [http://python.org/ Python programming language] and are developed as part of TracPlugins. 77 77 … … 80 80 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. 81 81 82 === Macro without arguments === 82 === Macro without arguments 83 83 84 To test the following code, you should saved it in a `timestamp_sample.py` file located in the TracEnvironment's `plugins/` directory. 84 85 {{{ … … 103 104 }}} 104 105 105 === Macro with arguments === 106 To test the following code, you should saved it in a `helloworld_sample.py` file located in the TracEnvironment's `plugins/` directory. 106 === Macro with arguments 107 108 To test the following code, you should save it in a `helloworld_sample.py` file located in the TracEnvironment's `plugins/` directory. 107 109 {{{ 108 110 #!python … … 165 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`). 166 168 167 You can also recursively use a wiki Formatter (`from trac.wiki import Formatter`) to process the `text` as wiki markup , for example by doing:169 You can also recursively use a wiki Formatter (`from trac.wiki import Formatter`) to process the `text` as wiki markup: 168 170 169 171 {{{
