# Changes between Version 3 and Version 4 of WikiMacros

Ignore:
Timestamp:
01/14/19 00:01:55 (3 years ago)
Comment:

--

Unmodified
Removed
Modified
• ## WikiMacros

 v3 = Trac Macros = = Trac Macros [[PageOutline]] [[PageOutline(2-5,Contents,pullout)]] 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)]]. '''Trac macros''' extend the Trac engine with custom functionality. Macros are a special type of plugin and are written in Python. A macro inserts dynamic HTML data in any context supporting WikiFormatting. 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. The macro syntax is [[macro-name(optional-arguments)]]. == Using Macros == '''WikiProcessors''' are another kind of macros. They are typically used for source code highlighting, such as !#python or !#apache and when the source code spans multiple lines, such as: Macro calls are enclosed in two ''square brackets''. Like Python functions, macros can also have arguments, a comma separated list within parentheses. {{{ {{{#!wiki-processor-name ... }}} }}} === Getting Detailed Help === == Using Macros Macro calls are enclosed in double-square brackets [[..]]. Like Python functions, macros can have arguments, which is then a comma separated list within parentheses [[..(,)]]. === Getting Detailed Help The list of available macros and the full help can be obtained using the !MacroList macro, as seen [#AvailableMacros below]. 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?]]. === Example === Example === A list of 3 most recently changed wiki pages starting with 'Trac': A list of the 3 most recently changed wiki pages starting with 'Trac': ||= Wiki Markup =||= Display =|| {{{#!td style="padding-left: 2em" {{{#!html

[[Image]]

Embed an image in wiki-formatted text. The first argument is the file … The first argument is the file, as in [[Image(filename.png)]]

[[InterTrac]]

Provide a list of known InterTrac prefixes.

[[InterWiki]]

Provide a description list for the known InterWiki prefixes.

[[KnownMimeTypes]]

List all known mime-types which can be used as WikiProcessors. Can be …
}}} etc. }}} == Available Macros == == Available Macros ''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].'' [[MacroList]] == Macros from around the world == == Macros from around the world 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. 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, please visit that site. == Developing Custom Macros == == Developing Custom Macros Macros, like Trac itself, are written in the [http://python.org/ Python programming language] and are developed as part of TracPlugins. For more information about developing macros, see the [trac:TracDev development resources] on the main project site. 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 more insight about the transition. Here are 2 simple examples showing how to create a Macro with Trac 0.11. === Macro without arguments 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. To test the following code, save it in a timestamp_sample.py file located in the TracEnvironment's plugins/ directory. === Macro without arguments === To test the following code, you should saved it in a timestamp_sample.py file located in the TracEnvironment's plugins/ directory. {{{ #!python {{{#!python from datetime import datetime # Note: since Trac 0.11, datetime objects are used internally def expand_macro(self, formatter, name, text): t = datetime.now(utc) return tag.b(format_datetime(t, '%c')) return tag.strong(format_datetime(t, '%c')) }}} === Macro with arguments === To test the following code, you should saved it in a helloworld_sample.py file located in the TracEnvironment's plugins/ directory. {{{ #!python === Macro with arguments To test the following code, save it in a helloworld_sample.py file located in the TracEnvironment's plugins/ directory. {{{#!python from genshi.core import Markup }}} Note that expand_macro optionally takes a 4^th^ parameter ''args''. When the macro is called as a [WikiProcessors WikiProcessor], it's also possible to pass key=value [WikiProcessors#UsingProcessors processor parameters]. If given, those are stored in a dictionary and passed in this extra args parameter. On the contrary, when called as a macro, args is None. (''since 0.12''). Note that expand_macro optionally takes a 4^th^ parameter ''args''. When the macro is called as a [WikiProcessors WikiProcessor], it is also possible to pass key=value [WikiProcessors#UsingProcessors processor parameters]. If given, those are stored in a dictionary and passed in this extra args parameter. In the other case, when called as a macro, args is None. (''since 0.12''). For example, when writing: [[HelloWorld()]] }}} One should get: {{{ Hello World, text =  , args = {'style': u'polite', 'silent': False, 'verbose': True} Hello World, text =  , args = {} Hello World, text =  , args = None Hello World, text = , args = {'style': u'polite', 'silent': False, 'verbose': True} Hello World, text = , args = {} Hello World, text = , args = None }}} 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). Note that the return value of expand_macro is '''not''' HTML escaped. Depending on the expected result, you should escape it 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). You can also recursively use a wiki Formatter (from trac.wiki import Formatter) to process the text as wiki markup, for example by doing: You can also recursively use a wiki Formatter (from trac.wiki import Formatter) to process the text as wiki markup: {{{ #!python {{{#!python from genshi.core import Markup from trac.wiki.macros import WikiMacroBase class HelloWorldMacro(WikiMacroBase): def expand_macro(self, formatter, name, text, args): text = "whatever '''wiki''' markup you want, even containing other macros" # Convert Wiki markup to HTML, new style out = StringIO.StringIO() Formatter(self.env, formatter.context).format(text, out) return Markup(out.getvalue()) def expand_macro(self, formatter, name, text, args): text = "whatever '''wiki''' markup you want, even containing other macros" # Convert Wiki markup to HTML, new style out = StringIO.StringIO() Formatter(self.env, formatter.context).format(text, out) return Markup(out.getvalue()) }}}