Changes between Version 188 and Version 189 of MacroBazaar

Timestamp:

Dec 14, 2006, 7:21:09 PM (17 years ago)

Author:

Christian Boos

Comment:

Updated AutoNav plugin as examples for single file plugins that can be installed in the plugins folder and used as a replacement for the now deprecated old style macros (those installed in wiki-macros)

MacroBazaar

@@ -10 +10 @@
 '''Another Note:''' '' [http://trac-hacks.org Trac Hacks] provides free '''Trac + Subversion''' hosting for Trac macros, patches, plugins,  etc.'''
 
-'''Installing a macro'''
+'''Installing a macro ''(old style "HDF" macros)'' '''
  1. Download the ''<macro>.py'' file.
- 1. Save it to your `projenv/wiki-macros` directory
+ 1. Save it to your '''`projenv/wiki-macros`''' directory
  1. Restart your web server
- 1. Open a Wiki page and add the macro text to test the macro (usually something like {{{[[Macro]]}}} or {{{[[Macro(argument1, argument2)]}}}
+ 1. Open a Wiki page and add the macro text to test the macro (usually something like `[[Macro]]` or `[[Macro(argument1, argument2)]`
+
+Note that this kind of macros is still supported in Trac [milestone:0.10], but deprecated. You should start developing and using macros as plugins implementing the `IWikiMacroProvider` interface, or, even simpler, inheriting from the `trac.wiki.macros.WikiMacroBase` class.
+
+'''Installing a macro ''(new style macros)'' '''
+
+This follows the same rules as installing a plugin, see TracPlugins.
+
+But usually, macros are simple enough so that they can be developed as ''single file plugins''. In that case, the installation is simpler, and much similar to the above:
+ 1. Download the ''<macro>.py'' file.
+ 1. Save it to your '''`projenv/plugins`''' directory
+ 1. Restart your web server
+ 1. Open a Wiki page and add the macro text to test the macro (usually something like `[[Macro]]` or `[[Macro(argument1, argument2)]`
+
+Example for such macros are provided below:
+ - [#AutoNav AutoNav]
+ - ...
+
+
 
 You can '''edit the macro''' by using any text editor and editing the ''trac.db/wiki-macros/<macro>.py'' file. Make the appropriate changes, restart the web server you are using, and the changes should appear.
@@ -157 +175 @@
 
 ''Question:'' Is there a chance to integrate the macro in the wiki menu like Title Index? Would be very appretiated.
+
 === !AutoNav ===
 Derived from !BackLinks. All references to the page where the macro is and all arguments supplied is sorted and looked up for references.
@@ -170 +189 @@
 }}}
 Add the Names "MyPage", "AndThisPageToo" and "WithThisPage" with the list of references to this page.
-''Download:'' [attachment:AutoNav.2.py]
-[[BR]]''By:'' Anders Jansson <anders dot jansson at kastanj dot net>
-
-Fixed a small bug in the page enumeration.
-''Download:'' [attachment:AutoNav.3.py]
-[[BR]]''By:'' anonymous
-
-Reimplemented !AutoNav as plugin for upcoming Trac 0.11 (#3958)
-''Download'' [attachment:ticket:3958:AutoNavPlugin.tar.bz2 AutoNavPlugin.tar.bz2]
-[[BR]]''By:'' Andrew Stromnov <stromnov at gmail dot com>
+
+''By:'' Anders Jansson <anders dot jansson at kastanj dot net>
+
+Reimplemented !AutoNav as plugin for upcoming Trac 0.11 (#3958) [[br]]
+''Download:'' [attachment:autonav-trac-0.10.py autonav-trac-0.10.py] [attachment:autonav-trac-0.11.py autonav-trac-0.11.py] [[br]]
+''Installation:'' place in your TracEnvironment, in the `plugins` subfolder.
+''By:'' Andrew Stromnov <stromnov at gmail dot com>, cboos
 
 === !SubWiki ===