Changes between Version 4 and Version 5 of WikiMacros

Timestamp:

2020-07-23T14:06:24-07:00 (4 years ago)

Author:

trac

Comment:

--

WikiMacros

@@ -3 +3 @@
 [[PageOutline(2-5,Contents,pullout)]]
 
-'''Trac macros''' extend the Trac engine with custom functionality. Macros are a special type of plugin and are 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.
 
 The macro syntax is `[[macro-name(optional-arguments)]]`.
 
-'''WikiProcessors''' are another kind of macros. They are typically used for source code highlighting, such as `!#python` or `!#apache` and when the source code spans multiple lines, such as:
+'''WikiProcessors''' are another kind of macro, commonly used for source code highlighting using a processor like `!#python` or `!#apache`:
 
 {{{
@@ -17 +17 @@
 == Using Macros
 
-Macro calls are enclosed in double-square brackets `[[..]]`. Like Python functions, macros can have arguments, which is then 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?]]`.
-
-=== Example
-
-A list of the 3 most recently changed wiki pages starting with 'Trac':
+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':
 
 ||= Wiki Markup =||= Display =||
@@ -40 +28 @@
 [[RecentChanges(Trac,3)]]
 }}}
-|-----------------------------------
-{{{#!td
-  {{{
-  [[RecentChanges?(Trac,3)]]
-  }}}
-}}}
-{{{#!td style="padding-left: 2em;"
-[[RecentChanges?(Trac,3)]]
-}}}
-|-----------------------------------
-{{{#!td
-  {{{
-  [[?]]
-  }}}
-}}}
-{{{#!td style="padding-left: 2em"
-{{{#!html 
-<div class="trac-macrolist">
-<h3><code>[[Image]]</code></h3>Embed an image in wiki-formatted text.
 
-The first argument is the file, as in <code>[[Image(filename.png)]]</code>
-<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>.
-</div>
-}}}
-etc.
-}}}
+=== 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
 
-''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].''
-
 [[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 are looking for new macros, or have written one that you would like to share, please visit that site.
+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.
 
 == 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 [https://python.org/ Python programming language] and are a type of [TracPlugins plugin].
 
-For more information about developing macros, see the [trac:TracDev development resources] on the main project site.
-
-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 more insight about the transition.
+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].
 
 === Macro without arguments
 
-To test the following code, save it in a `timestamp_sample.py` file located in the TracEnvironment's `plugins/` directory.
+To test the following code, copy it to `timestamp_sample.py` in the TracEnvironment's `plugins/` directory.
 
 {{{#!python
-from datetime import datetime
-# Note: since Trac 0.11, datetime objects are used internally
-
-from trac.util.datefmt import format_datetime, utc
+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."""
+class TimestampMacro(WikiMacroBase):
+    _description = "Inserts the current time (in seconds) into the wiki page."
 
-    revision = "$Rev$"
-    url = "$URL$"
-
-    def expand_macro(self, formatter, name, text):
-        t = datetime.now(utc)
+    def expand_macro(self, formatter, name, content, args=None):
+        t = datetime_now(utc)
         return tag.strong(format_datetime(t, '%c'))
 }}}
@@ -112 +70 @@
 === Macro with arguments
 
-To test the following code, save it in a `helloworld_sample.py` file located in the TracEnvironment's `plugins/` directory.
+To test the following code, copy it to `helloworld_sample.py` in the TracEnvironment's `plugins/` directory.
 
 {{{#!python
-from trac.util.html import Markup
+from trac.util.translation import cleandoc_
 from trac.wiki.macros import WikiMacroBase
 
 class HelloWorldMacro(WikiMacroBase):
+    _description = cleandoc_(
     """Simple HelloWorld macro.
 
@@ -128 +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, text, 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'`),
-        `text` 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.
+        `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, text = %s, args = %s' % \
-            (Markup.escape(text), Markup.escape(repr(args)))
-
+        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. In the other case, when called as a macro, `args` is `None`. (''since 0.12'').
+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`.
 
 For example, when writing:
@@ -171 +126 @@
 }}}
 
-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`).
+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 (`from trac.wiki import Formatter`) to process the `text` as wiki markup:
+You can also recursively use a wiki formatter to process the `content` as wiki markup:
 
 {{{#!python
-from trac.util.html import Markup
+from trac.wiki.formatter import format_to_html
 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())
+    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)
 }}}