Changes between Version 4 and Version 5 of WikiMacros

Timestamp:

Apr 13, 2010, 3:53:03 AM (14 years ago)

Author:

trac

Comment:

--

WikiMacros

@@ -8 +8 @@
 
 == Using Macros ==
+Macro calls are enclosed in two ''square brackets''. Like Python functions, macros can also have arguments, a comma separated list within parentheses. 
 
-Macro calls are enclosed in two ''square brackets''. Like Python functions, macros can also have arguments, 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].
-
-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?]].
-
-
+Trac macros can also be written as TracPlugins. This gives them some capabilities that macros do not have, such as being able to directly access the HTTP request.
 
 === Example ===
@@ -24 +16 @@
 A list of 3 most recently changed wiki pages starting with 'Trac':
 
-||= Wiki Markup =||= Display =||
-{{{#!td
-  {{{
-  [[RecentChanges(Trac,3)]]
-  }}}
+{{{
+ [[RecentChanges(Trac,3)]]
 }}}
-{{{#!td style="padding-left: 2em;"
-[[RecentChanges(Trac,3)]]
-}}}
-|-----------------------------------
-{{{#!td
-  {{{
-  [[RecentChanges?(Trac,3)]]
-  }}}
-}}}
-{{{#!td style="padding-left: 2em;"
-[[RecentChanges?(Trac,3)]]
-}}}
-|-----------------------------------
-{{{#!td
-  {{{
-  [[?]]
-  }}}
-}}}
-{{{#!td style="padding-left: 2em; font-size: 80%"
-[[?]]
-}}}
+
+Display:
+ [[RecentChanges(Trac,3)]]
 
 == Available Macros ==
@@ -63 +34 @@
 
 == Developing Custom Macros ==
-Macros, like Trac itself, are written in the [http://python.org/ Python programming language] and are developed as part of TracPlugins.
+Macros, like Trac itself, are written in the [http://python.org/ Python programming language].
 
 For more information about developing macros, see the [trac:TracDev development resources] on the main project site.
 
+
+== Implementation ==
 
 Here are 2 simple examples showing how to create a Macro with Trac 0.11. 
@@ -73 +46 @@
 
 === 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.
+It should be saved as `TimeStamp.py` as Trac will use the module name as the Macro name
 {{{
 #!python
@@ -90 +63 @@
     url = "$URL$"
 
-    def expand_macro(self, formatter, name, text):
+    def expand_macro(self, formatter, name, args):
         t = datetime.now(utc)
         return tag.b(format_datetime(t, '%c'))
@@ -96 +69 @@
 
 === 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.
+It should be saved as `HelloWorld.py` (in the plugins/ directory) as Trac will use the module name as the Macro name
 {{{
 #!python
-from genshi.core import Markup
-
 from trac.wiki.macros import WikiMacroBase
 
@@ -118 +89 @@
     url = "$URL$"
 
-    def expand_macro(self, formatter, name, text, args):
+    def expand_macro(self, formatter, name, args):
         """Return some output that will be displayed in the Wiki content.
 
         `name` is the actual name of the macro (no surprise, here it'll be
         `'HelloWorld'`),
-        `text` is the text enclosed in parenthesis at the call of the macro.
+        `args` is the text enclosed in parenthesis at the call of the macro.
           Note that if there are ''no'' parenthesis (like in, e.g.
-          [[HelloWorld]]), then `text` is `None`.
-        `args` are the arguments passed when HelloWorld is called using a
-        `#!HelloWorld` code block.
+          [[HelloWorld]]), then `args` is `None`.
         """
-        return 'Hello World, text = %s, args = %s' % \
-            (Markup.escape(text), Markup.escape(repr(args)))
-
+        return 'Hello World, args = ' + unicode(args)
+    
+    # Note that there's no need to HTML escape the returned data,
+    # as the template engine (Genshi) will do it for us.
 }}}
 
-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'').
 
-For example, when writing:
-{{{
-{{{#!HelloWorld style="polite"
-<Hello World!>
-}}}
+=== {{{expand_macro}}} details ===
+{{{expand_macro}}} should return either a simple Python string which will be interpreted as HTML, or preferably a Markup object (use {{{from trac.util.html import Markup}}}).  {{{Markup(string)}}} just annotates the string so the renderer will render the HTML string as-is with no escaping. You will also need to import Formatter using {{{from trac.wiki import Formatter}}}.
 
-{{{#!HelloWorld
-<Hello World!>
-}}}
-
-[[HelloWorld(<Hello World!>)]]
-}}}
-One should get:
-{{{
-Hello World, text = <Hello World!> , args = {'style': u'polite'}
-Hello World, text = <Hello World!> , args = {}
-Hello World, text = <Hello World!> , 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`).  
-
-You can also recursively use a wiki Formatter (`from trac.wiki import Formatter`) to process the `text` as wiki markup, for example by doing:
+If your macro creates wiki markup instead of HTML, you can convert it to HTML like this:
 
 {{{
 #!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())
+  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())
 }}}