Changes between Version 4 and Version 5 of WikiMacros
- Timestamp:
- Apr 24, 2020, 9:10:29 AM (5 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
WikiMacros
v4 v5 1 = Trac Macros =1 = Trac Macros 2 2 3 [[PageOutline ]]3 [[PageOutline(2-5,Contents,pullout)]] 4 4 5 Trac macros are plugins to extend the Trac engine with custom 'functions' written in Python. A macro inserts dynamic HTML datain any context supporting WikiFormatting.5 '''Trac macros''' extend Trac with custom functionality. Macros are a special type of plugin and are written in Python. A macro generates HTML in any context supporting WikiFormatting. 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 macro syntax is `[[macro-name(optional-arguments)]]`. 8 8 9 == Using Macros == 9 '''WikiProcessors''' are another kind of macro, commonly used for source code highlighting using a processor like `!#python` or `!#apache`: 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 {{{ 12 {{{#!wiki-processor-name 13 ... 14 }}} 15 }}} 12 16 13 === Getting Detailed Help === 14 The list of available macros and the full help can be obtained using the !MacroList macro, as seen [#AvailableMacros below]. 17 == Using Macros 15 18 16 A brief list can be obtained via `[[MacroList(*)]]` or `[[?]]`. 17 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?]]`. 19 20 21 22 === Example === 23 24 A list of 3 most recently changed wiki pages starting with 'Trac': 19 Macro calls are enclosed in double-square brackets `[[..]]`. Like Python functions macros can have arguments, which take the form of a comma separated list within parentheses `[[..(,)]]`. A common macro used is a list of the 3 most recent changes to a wiki page, or here, for example, all wiki pages starting with 'Trac': 25 20 26 21 ||= Wiki Markup =||= Display =|| … … 33 28 [[RecentChanges(Trac,3)]] 34 29 }}} 35 |-----------------------------------36 {{{#!td37 {{{38 [[RecentChanges?(Trac,3)]]39 }}}40 }}}41 {{{#!td style="padding-left: 2em;"42 [[RecentChanges?(Trac,3)]]43 }}}44 |-----------------------------------45 {{{#!td46 {{{47 [[?]]48 }}}49 }}}50 {{{#!td style="padding-left: 2em"51 {{{#!html52 <div style="font-size: 80%" class="trac-macrolist">53 <h3><code>[[Image]]</code></h3>Embed an image in wiki-formatted text.54 30 55 The first argument is the file … 56 <h3><code>[[InterTrac]]</code></h3>Provide a list of known <a class="wiki" href="/wiki/InterTrac">InterTrac</a> prefixes. 57 <h3><code>[[InterWiki]]</code></h3>Provide a description list for the known <a class="wiki" href="/wiki/InterWiki">InterWiki</a> prefixes. 58 <h3><code>[[KnownMimeTypes]]</code></h3>List all known mime-types which can be used as <a class="wiki" href="/wiki/WikiProcessors">WikiProcessors</a>. 59 Can be …</div> 60 }}} 61 etc. 62 }}} 31 === Getting Detailed Help 63 32 64 == Available Macros == 33 The list of available macros and the full help can be obtained using the !MacroList macro, see [#AvailableMacros below]. 65 34 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].'' 35 A brief list can be obtained via `[[MacroList(*)]]` or `[[?]]`. 36 37 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?]]`. 38 39 == Available Macros 67 40 68 41 [[MacroList]] 69 42 70 == Macros from around the world ==43 == Contributed macros 71 44 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 tovisit that site.45 The [http://trac-hacks.org/ Trac Hacks] site provides a large 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. 73 46 74 == Developing Custom Macros == 75 Macros, like Trac itself, are written in the [http://python.org/ Python programming language] and are developed as part of TracPlugins. 47 == Developing Custom Macros 76 48 77 For more information about developing macros, see the [trac:TracDev development resources] on the main project site.49 Macros, like Trac itself, are written in the [http://python.org/ Python programming language] and are a type of [TracPlugins plugin]. 78 50 51 Here are 2 simple examples showing how to create a Macro. For more information about developing macros, see the [trac:TracDev development resources] and [trac:browser:branches/1.2-stable/sample-plugins sample-plugins]. 79 52 80 Here are 2 simple examples showing how to create a Macro with Trac 0.11. 53 === Macro without arguments 81 54 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.55 To test the following code, copy it to `timestamp_sample.py` in the TracEnvironment's `plugins/` directory. 83 56 84 === Macro without arguments === 85 To test the following code, you should saved it in a `timestamp_sample.py` file located in the TracEnvironment's `plugins/` directory. 86 {{{ 87 #!python 88 from datetime import datetime 89 # Note: since Trac 0.11, datetime objects are used internally 90 91 from genshi.builder import tag 92 93 from trac.util.datefmt import format_datetime, utc 57 {{{#!python 58 from trac.util.datefmt import datetime_now, format_datetime, utc 59 from trac.util.html import tag 94 60 from trac.wiki.macros import WikiMacroBase 95 61 96 class Time StampMacro(WikiMacroBase):97 """Inserts the current time (in seconds) into the wiki page."""62 class TimestampMacro(WikiMacroBase): 63 _description = "Inserts the current time (in seconds) into the wiki page." 98 64 99 revision = "$Rev$" 100 url = "$URL$" 101 102 def expand_macro(self, formatter, name, text): 103 t = datetime.now(utc) 104 return tag.b(format_datetime(t, '%c')) 65 def expand_macro(self, formatter, name, content, args=None): 66 t = datetime_now(utc) 67 return tag.strong(format_datetime(t, '%c')) 105 68 }}} 106 69 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. 109 {{{ 110 #!python 111 from genshi.core import Markup 70 === Macro with arguments 112 71 72 To test the following code, copy it to `helloworld_sample.py` in the TracEnvironment's `plugins/` directory. 73 74 {{{#!python 75 from trac.util.translation import cleandoc_ 113 76 from trac.wiki.macros import WikiMacroBase 114 77 115 78 class HelloWorldMacro(WikiMacroBase): 79 _description = cleandoc_( 116 80 """Simple HelloWorld macro. 117 81 … … 123 87 will become the documentation of the macro, as shown by 124 88 the !MacroList macro (usually used in the WikiMacros page). 125 """ 89 """) 126 90 127 revision = "$Rev$" 128 url = "$URL$" 129 130 def expand_macro(self, formatter, name, text, args): 91 def expand_macro(self, formatter, name, content, args=None): 131 92 """Return some output that will be displayed in the Wiki content. 132 93 133 94 `name` is the actual name of the macro (no surprise, here it'll be 134 95 `'HelloWorld'`), 135 `text` is the text enclosed in parenthesis at the call of the macro. 136 Note that if there are ''no'' parenthesis (like in, e.g. 137 [[HelloWorld]]), then `text` is `None`. 138 `args` are the arguments passed when HelloWorld is called using a 139 `#!HelloWorld` code block. 96 `content` is the text enclosed in parenthesis at the call of the 97 macro. Note that if there are ''no'' parenthesis (like in, e.g. 98 [[HelloWorld]]), then `content` is `None`. 99 `args` will contain a dictionary of arguments when called using the 100 Wiki processor syntax and will be `None` if called using the 101 macro syntax. 140 102 """ 141 return 'Hello World, text = %s, args = %s' % \ 142 (Markup.escape(text), Markup.escape(repr(args))) 143 103 return 'Hello World, content = ' + unicode(content) 144 104 }}} 145 105 146 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'').106 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. When called as a macro, `args` is `None`. 147 107 148 108 For example, when writing: … … 158 118 [[HelloWorld(<Hello World!>)]] 159 119 }}} 120 160 121 One should get: 161 122 {{{ 162 Hello World, text = <Hello World!> 163 Hello World, text = <Hello World!> 164 Hello World, text = <Hello World!> 123 Hello World, text = <Hello World!>, args = {'style': u'polite', 'silent': False, 'verbose': True} 124 Hello World, text = <Hello World!>, args = {} 125 Hello World, text = <Hello World!>, args = None 165 126 }}} 166 127 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`).128 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)` (`from trac.util.html import Markup`). 168 129 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:130 You can also recursively use a wiki formatter to process the `content` as wiki markup: 170 131 171 {{{ 172 #!python 173 from genshi.core import Markup 132 {{{#!python 133 from trac.wiki.formatter import format_to_html 174 134 from trac.wiki.macros import WikiMacroBase 175 from trac.wiki import Formatter176 import StringIO177 135 178 136 class HelloWorldMacro(WikiMacroBase): 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()) 137 def expand_macro(self, formatter, name, content, args): 138 content = "any '''wiki''' markup you want, even containing other macros" 139 # Convert Wiki markup to HTML 140 return format_to_html(self.env, formatter.context, content) 185 141 }}}