Changes between Version 2 and Version 3 of WikiMacros
- Timestamp:
- 09/24/15 13:13:19 (9 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
WikiMacros
v2 v3 1 = Trac Macros =1 = Trac Macros 2 2 3 3 [[PageOutline]] 4 4 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 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)]]`. 6 6 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).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. 8 8 9 == Using Macros ==9 == Using Macros 10 10 11 Macro calls are enclosed in two ''square brackets'' . Like Python functions, macros can also have arguments, a comma separated list within parentheses.11 Macro calls are enclosed in two ''square brackets'' `[[..]]`. Like Python functions, macros can also have arguments, a comma separated list within parentheses `[[..(,)]]`. 12 12 13 === Getting Detailed Help === 13 === Getting Detailed Help 14 14 15 The list of available macros and the full help can be obtained using the !MacroList macro, as seen [#AvailableMacros below]. 15 16 … … 18 19 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 === Example 20 22 21 22 === Example === 23 24 A list of 3 most recently changed wiki pages starting with 'Trac': 23 A list of the 3 most recently changed wiki pages starting with 'Trac': 25 24 26 25 ||= Wiki Markup =||= Display =|| … … 62 61 }}} 63 62 64 == Available Macros ==63 == Available Macros 65 64 66 65 ''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].'' … … 68 67 [[MacroList]] 69 68 70 == Macros from around the world ==69 == Macros from around the world 71 70 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, pleasedon't hesitate to visit that site.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. 73 72 74 == Developing Custom Macros == 73 == Developing Custom Macros 74 75 75 Macros, like Trac itself, are written in the [http://python.org/ Python programming language] and are developed as part of TracPlugins. 76 76 77 77 For more information about developing macros, see the [trac:TracDev development resources] on the main project site. 78 78 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. 79 80 80 Here are 2 simple examples showing how to create a Macro with Trac 0.11. 81 === Macro without arguments 81 82 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 ===85 83 To test the following code, you should saved it in a `timestamp_sample.py` file located in the TracEnvironment's `plugins/` directory. 86 84 {{{ … … 102 100 def expand_macro(self, formatter, name, text): 103 101 t = datetime.now(utc) 104 return tag. b(format_datetime(t, '%c'))102 return tag.strong(format_datetime(t, '%c')) 105 103 }}} 106 104 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 107 To test the following code, you should save it in a `helloworld_sample.py` file located in the TracEnvironment's `plugins/` directory. 109 108 {{{ 110 109 #!python … … 167 166 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`). 168 167 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:168 You can also recursively use a wiki Formatter (`from trac.wiki import Formatter`) to process the `text` as wiki markup: 170 169 171 170 {{{ … … 177 176 178 177 class HelloWorldMacro(WikiMacroBase): 179 180 181 182 183 184 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()) 185 184 }}}
