Changes between Version 1 and Version 2 of WikiMacros

Timestamp:

04/05/20 23:48:44 (5 years ago)

Author:

trac

Comment:

--

WikiMacros

@@ -1 @@
-= 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.
+'''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.
 
-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 macro syntax is `[[macro-name(optional-arguments)]]`.
 
-== Using Macros ==
-Macro calls are enclosed in two ''square brackets''. Like Python functions, macros can also have arguments, a comma separated list within parentheses. 
-
-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 ===
-
-A list of 3 most recently changed wiki pages starting with 'Trac':
+'''WikiProcessors''' are another kind of macro, commonly used for source code highlighting using a processor like `!#python` or `!#apache`:
 
 {{{
- [[RecentChanges(Trac,3)]]
+{{{#!wiki-processor-name
+... 
+}}}
 }}}
 
-Display:
- [[RecentChanges(Trac,3)]]
+== Using Macros
 
-== Available Macros ==
+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':
 
-''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].''
+||= Wiki Markup =||= Display =||
+{{{#!td
+  {{{
+  [[RecentChanges(Trac,3)]]
+  }}}
+}}}
+{{{#!td style="padding-left: 2em;"
+[[RecentChanges(Trac,3)]]
+}}}
+
+=== Getting Detailed Help
+
+The list of available macros and the full help can be obtained using the !MacroList macro, see [#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?]]`.
+
+== Available Macros
 
 [[MacroList]]
 
-== Macros from around the world ==
+== Contributed macros
 
-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 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.
 
-== Developing Custom Macros ==
-Macros, like Trac itself, are written in the [http://python.org/ Python programming language].
+== Developing Custom Macros
 
-For more information about developing macros, see the [wiki:TracDev development resources] on the main project site.
+Macros, like Trac itself, are written in the [http://python.org/ Python programming language] and are a type of [TracPlugins plugin].
 
+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].
 
-== Implementation ==
+=== Macro without arguments
 
-Here are 2 simple examples on how to create a Macro with [wiki:0.11 Trac 0.11] have a look at source:trunk/sample-plugins/Timestamp.py for an example that shows the difference between old style and new style macros and also source:trunk/wiki-macros/README which provides a little more insight about the transition.
+To test the following code, copy it to `timestamp_sample.py` in the TracEnvironment's `plugins/` directory.
 
-=== Macro without arguments ===
-It should be saved as `TimeStamp.py` as Trac will use the module name as the Macro name
-{{{
-#!python
-from datetime import datetime
-# Note: since Trac 0.11, datetime objects are used internally
-
-from genshi.builder import tag
-
-from trac.util.datefmt import format_datetime, utc
+{{{#!python
+from trac.util.datefmt import datetime_now, format_datetime, utc
+from trac.util.html import tag
 from trac.wiki.macros import WikiMacroBase
 
 class TimestampMacro(WikiMacroBase):
-    """Inserts the current time (in seconds) into the wiki page."""
+    _description = "Inserts the current time (in seconds) into the wiki page."
 
-    revision = "$Rev$"
-    url = "$URL$"
-
-    def expand_macro(self, formatter, name, args):
-        t = datetime.now(utc)
-        return tag.b(format_datetime(t, '%c'))
+    def expand_macro(self, formatter, name, content, args=None):
+        t = datetime_now(utc)
+        return tag.strong(format_datetime(t, '%c'))
 }}}
 
-=== Macro with arguments ===
-It should be saved as `HelloWorld.py` (in the plugins/ directory) as Trac will use the module name as the Macro name
-{{{
-#!python
+=== Macro with arguments
+
+To test the following code, copy it to `helloworld_sample.py` in the TracEnvironment's `plugins/` directory.
+
+{{{#!python
+from trac.util.translation import cleandoc_
 from trac.wiki.macros import WikiMacroBase
 
 class HelloWorldMacro(WikiMacroBase):
+    _description = cleandoc_(
     """Simple HelloWorld macro.
 
@@ -82 +87 @@
     will become the documentation of the macro, as shown by
     the !MacroList macro (usually used in the WikiMacros page).
-    """
+    """)
 
-    revision = "$Rev$"
-    url = "$URL$"
-
-    def expand_macro(self, formatter, name, args):
+    def expand_macro(self, formatter, name, content, args=None):
         """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'`),
-        `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 `args` is `None`.
+        `content` 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 `content` is `None`.
+        `args` will contain a dictionary of arguments when called using the
+          Wiki processor syntax and will be `None` if called using the
+          macro syntax.
         """
-        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.
+        return 'Hello World, content = ' + unicode(content)
 }}}
 
+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`.
 
-=== {{{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}}}.
+For example, when writing:
+{{{
+{{{#!HelloWorld style="polite" -silent verbose
+<Hello World!>
+}}}
 
-If your macro creates wiki markup instead of HTML, you can convert it to HTML like this:
+{{{#!HelloWorld
+<Hello World!>
+}}}
 
+[[HelloWorld(<Hello World!>)]]
+}}}
+
+One should get:
 {{{
-#!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())
+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
 }}}
+
+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`).
+
+You can also recursively use a wiki formatter to process the `content` as wiki markup:
+
+{{{#!python
+from trac.wiki.formatter import format_to_html
+from trac.wiki.macros import WikiMacroBase
+
+class HelloWorldMacro(WikiMacroBase):
+    def expand_macro(self, formatter, name, content, args):
+        content = "any '''wiki''' markup you want, even containing other macros"
+        # Convert Wiki markup to HTML
+        return format_to_html(self.env, formatter.context, content)
+}}}