Changes between Version 1 and Version 2 of WikiMacros


Ignore:
Timestamp:
Nov 9, 2005 4:15:09 PM (11 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WikiMacros

    v1 v2  
    22Trac 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.
    33
    4 Another kind of macros are WikiProcessors. They typically deal with alternate markup formats and representation of larger blocks of information (like source code highlighting). See also: WikiProcessors.
     4Another kind of macros are WikiProcessors. They typically deal with alternate markup formats and representation of larger blocks of information (like source code highlighting).
    55
    66== Using Macros ==
    7 Macro calls are enclosed in two ''square brackets''. Like python functions, macros can also have arguments, a comma separated list within parenthesis.
     7Macro calls are enclosed in two ''square brackets''. Like python functions, macros can also have arguments, a comma separated list within parentheses.
    88
    99=== Examples ===
     
    2121 [[HelloWorld(Testing)]]
    2222
     23== Available Macros ==
    2324
    24 == Available Macros ==
    25 Macros are still a new feature, and the list of available (and distributed) macros is
    26 admittedly not very impressive. In future Trac releases, we hope to build a library of useful macros, and will of course happily include contributed macros (see below).
     25''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].''
    2726
    2827[[MacroList]]
    29 
    30 
    31 ----
    32 
    3328
    3429== Macros from around the world ==
    3530The [http://projects.edgewall.com/trac/ Trac Project] has a section dedicated to user-contributed macros, [http://projects.edgewall.com/trac/wiki/MacroBazaar MacroBazaar]. If you're looking for new macros, or have written new ones to share with the world, don't hesitate adding it to the [http://projects.edgewall.com/trac/wiki/MacroBazaar MacroBazaar] wiki page.
    3631
    37   http://projects.edgewall.com/trac/wiki/MacroBazaar
    38 
    39 
    4032----
    4133
    42 
    43 == Developing New Macros ==
     34== Developing Custom Macros ==
    4435Macros, like Trac itself, are written in the [http://www.python.org/ Python programming language]. They are very simple modules, identified by the filename and should contain a single ''entry point'' function. Trac will display the returned data inserted into the HTML where the macro was called.
    4536
    4637It's easiest to learn from an example:
    4738{{{
     39#!python
    4840# MyMacro.py -- The world's simplest macro
    4941
     
    5244}}}
    5345
    54 === Advanced Topics: Template-enabled Macros ===
    55 For advanced uses, macros can also render structured output in HDF, to be rendered to HTML using clearsilver templates - like most Trac output. In short, this allows more generic and well-designed advanced macros.
    56 
    57 Macros gain direct access to the main HDF tree, and are free to manipulate it.
    58 
    59 Example:
     46You can also use the environment (`env`) object, for example to access configuration data and the database, for example:
    6047{{{
    61 def execute(hdf, args, env):
    62     # Currently hdf is set only when the macro is called
    63     # From a wiki page
    64     if hdf:
    65         hdf.setValue('wiki.macro.greeting', 'Hello World')
    66        
    67     # args will be null if the macro is called without parentesis.
    68     args = args or 'No arguments'
    69     return 'Hello World, args = ' + args
     48#!python
     49def execute(hdf, txt, env):
     50    return env.get_config('trac', 'repository_dir')
    7051}}}
    7152
    72 You can also use the environment (env) object to access configuration data.
     53Note that since version 0.9, wiki macros can also be written as TracPlugins. This gives them some capabilities than “classic” macros do not have, such as directly access the HTTP request.
    7354
    74 Example.
    75 {{{
    76 def execute(hdf, txt, env):
    77     return env.config.get('trac', 'repository_dir')
    78 }}}
     55For more information about developing macros, see the [http://projects.edgewall.com/trac/wiki/TracDev development resources] on the main project site.
     56
    7957----
    8058See also:  WikiProcessors, WikiFormatting, TracGuide