Changes between Version 2 and Version 3 of WikiMacros

Timestamp:

01/10/14 11:40:42 (11 years ago)

Author:

trac

Comment:

--

WikiMacros

@@ -3 +3 @@
 [[PageOutline]]
 
-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.
+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)]]`.
 
-Another kind of macros are WikiProcessors. They typically deal with alternate markup formats and representation of larger blocks of information (like source code highlighting).
+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.
 
 == Using Macros ==
@@ -14 +14 @@
 The list of available macros and the full help can be obtained using the !MacroList macro, as seen [#AvailableMacros below].
 
-A brief list can be obtained via ![[MacroList(*)]] or ![[?]].
+A brief list can be obtained via `[[MacroList(*)]]` or `[[?]]`.
 
-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?]].
+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?]]`.
 
 
@@ -48 +48 @@
   }}}
 }}}
-{{{#!td style="padding-left: 2em; font-size: 80%"
-[[?]]
+{{{#!td style="padding-left: 2em"
+{{{#!html 
+<div style="font-size: 80%" class="trac-macrolist">
+<h3><code>[[Image]]</code></h3>Embed an image in wiki-formatted text.
+
+The first argument is the file …
+<h3><code>[[InterTrac]]</code></h3>Provide a list of known <a class="wiki" href="/wiki/InterTrac">InterTrac</a> prefixes.
+<h3><code>[[InterWiki]]</code></h3>Provide a description list for the known <a class="wiki" href="/wiki/InterWiki">InterWiki</a> prefixes.
+<h3><code>[[KnownMimeTypes]]</code></h3>List all known mime-types which can be used as <a class="wiki" href="/wiki/WikiProcessors">WikiProcessors</a>.
+Can be …</div>
+}}}
+etc.
 }}}
 
@@ -138 +148 @@
 For example, when writing:
 {{{
-{{{#!HelloWorld style="polite"
+{{{#!HelloWorld style="polite" -silent verbose
 <Hello World!>
 }}}
@@ -150 +160 @@
 One should get:
 {{{
-Hello World, text = <Hello World!> , args = {'style': u'polite'}
+Hello World, text = <Hello World!> , args = {'style': u'polite', 'silent': False, 'verbose': True}
 Hello World, text = <Hello World!> , args = {}
 Hello World, text = <Hello World!> , args = None
@@ -161 +171 @@
 {{{
 #!python
-    text = "whatever wiki markup you want, even containing other macros"
-    # Convert Wiki markup to HTML, new style
-    out = StringIO()
-    Formatter(self.env, formatter.context).format(text, out)
-    return Markup(out.getvalue())
+from genshi.core import Markup
+from trac.wiki.macros import WikiMacroBase
+from trac.wiki import Formatter
+import StringIO
+
+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())
 }}}