Development

WikiMacros (diff)

You must first sign up to be able to contribute.

Changes between Version 1 and Version 2 of WikiMacros

Show
Ignore:
Author:
trac (IP: 127.0.0.1)
Timestamp:
11/24/05 20:19:33 (12 years ago)
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 == 
    2323== Available Macros == 
    2424 
    25 Macros are still a relatively 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]] 
    2928 
    3029== Macros from around the world == 
    31 The [http://projects.edgewall.com/trac/ Trac Project] has a section dedicated to user-contributed macros, [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 [wiki:MacroBazaar MacroBazaar] wiki page. 
    32  
    33   http://projects.edgewall.com/trac/wiki/MacroBazaar 
    34  
     30The [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. 
    3531 
    3632---- 
    3733 
    38  
    39 == Developing New Macros == 
     34== Developing Custom Macros == 
    4035Macros, 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. 
    4136 
    4944}}} 
    5045 
    51 === Advanced Topics: Template-enabled Macros === 
    52 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. 
    53  
    54 Macros gain direct access to the main HDF tree, and are free to manipulate it.  
    55  
    56 Example: 
    57 {{{ 
    58 #!python 
    59 def execute(hdf, args, env): 
    60     # Currently hdf is set only when the macro is called 
    61     # from a wiki page. 
    62     if hdf: 
    63         hdf.setValue('wiki.macro.greeting', 'Hello World') 
    64          
    65     # args will be null if the macro is called without parentheses. 
    66     args = args or 'No arguments' 
    67     return 'Hello World, args = ' + args 
    68 }}} 
    69  
    70 You can also use the environment (env) object to access configuration data. 
    71  
    72 Example. 
     46You can also use the environment (`env`) object, for example to access configuration data and the database, for example: 
    7347{{{ 
    7448#!python 
    7751}}} 
    7852 
    79 Here is information on the different WikiMacroObjects. 
     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. 
     54 
     55For more information about developing macros, see the [http://projects.edgewall.com/trac/wiki/TracDev development resources] on the main project site. 
    8056 
    8157---- 
    82 See also:  WikiProcessors, WikiFormatting, TracGuide, WikiMacroObjects 
     58See also:  WikiProcessors, WikiFormatting, TracGuide