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