Changes between Version 5 and Version 6 of WikiMacros
- Timestamp:
- Jan 12, 2016, 11:21:52 PM (3 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
WikiMacros
v5 v6 1 = Trac Macros 1 = Trac Macros = 2 2 3 3 [[PageOutline]] … … 5 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 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.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 14 13 === Getting Detailed Help === 15 14 The list of available macros and the full help can be obtained using the !MacroList macro, as seen [#AvailableMacros below]. 16 15 … … 19 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?]]`. 20 19 21 === Example22 20 23 A list of the 3 most recently changed wiki pages starting with 'Trac': 21 22 === Example === 23 24 A list of 3 most recently changed wiki pages starting with 'Trac': 24 25 25 26 ||= Wiki Markup =||= Display =|| … … 61 62 }}} 62 63 63 == Available Macros 64 == Available Macros == 64 65 65 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].'' … … 67 68 [[MacroList]] 68 69 69 == Macros from around the world 70 == Macros from around the world == 70 71 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.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. 72 73 73 == Developing Custom Macros 74 74 == Developing Custom Macros == 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.80 79 81 === Macro without arguments 80 Here are 2 simple examples showing how to create a Macro with Trac 0.11. 82 81 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 === 83 85 To test the following code, you should saved it in a `timestamp_sample.py` file located in the TracEnvironment's `plugins/` directory. 84 86 {{{ … … 100 102 def expand_macro(self, formatter, name, text): 101 103 t = datetime.now(utc) 102 return tag. strong(format_datetime(t, '%c'))104 return tag.b(format_datetime(t, '%c')) 103 105 }}} 104 106 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 === 108 To test the following code, you should saved it in a `helloworld_sample.py` file located in the TracEnvironment's `plugins/` directory. 108 109 {{{ 109 110 #!python … … 166 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`). 167 168 168 You can also recursively use a wiki Formatter (`from trac.wiki import Formatter`) to process the `text` as wiki markup :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: 169 170 170 171 {{{ … … 176 177 177 178 class HelloWorldMacro(WikiMacroBase): 178 179 180 181 182 183 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()) 184 185 }}}
