Changes between Version 7 and Version 8 of 0.11/TracMacros

Timestamp:

Aug 5, 2007, 2:41:23 PM (17 years ago)

Author:

ThurnerRupert

Comment:

—

0.11/TracMacros

@@ -32 +32 @@
 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.
 
+== Implementation ==
+
+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.
+
+=== Macro without arguments ===
+It should be saved as `TimeStamp.py` as Trac will use the module name as the Macro name
+{{{
+from trac.core import *
+from trac.wiki.macros import WikiMacroBase
+from StringIO import StringIO
+import time
+
+__all__ = ['TimestampMacro']
+
+class TimestampMacro(WikiMacroBase):
+        """
+        Macro for inserting timestamp
+
+        {{{
+        [[Timestamp]]
+        }}}
+        """
+        def expand_macro(self, formatter, name, args):
+                buf = StringIO()
+                t = time.localtime()
+                buf = "<b>%s</b>" % time.strftime('%c', t)
+                return buf
+}}}
+
+=== Macro with arguments ===
+It should be saved as `HelloWorld.py` as Trac will use the module name as the Macro name
+{{{
+"""Example macro."""
+from trac.core import *
+from trac.wiki.macros import WikiMacroBase
+from trac.util import escape
+
+__all__ = ['HelloWorldMacro']
+
+class HelloWorldMacro(WikiMacroBase):
+        """
+        Demo macro for a greeting with an argument.
+
+        {{{
+        [[HelloWorld(args)]]
+        }}}
+
+        """
+        def expand_macro(self, formatter, name, args):
+                # args will be `None` if the macro is called without parenthesis.
+                txt = args or 'No arguments'
+
+                # then, as `txt` comes from the user, it's important to guard against
+                # the possibility to inject malicious HTML/Javascript, by using `escape()`:
+                return 'Hello World, args = ' + escape(txt)
+}}}
+
+