Changes between Version 1 and Version 2 of TracMacroConfigPlugin


Ignore:
Timestamp:
Aug 26, 2015, 12:10:16 PM (9 years ago)
Author:
figaro
Comment:

Cosmetic changes, tagged with license

Legend:

Unmodified
Added
Removed
Modified

  • TracMacroConfigPlugin

    v1 v2  
    11[[PageOutline(2-5,Contents,pullout)]]
    22         
    3 = Help Macros and Plugins with trac.ini lookup and defaulting =
     3= Help Macros and Plugins with trac.ini lookup and defaulting
    44
    5 == Description ==
     5== Description
    66
    77''By itself, this modules does not provide any functionality.'''
    88         
    9 This module provides a helper class which can be used by other plugins,
    10 especially macros, in retrieving optional arguments from trac.ini.
     9This module provides a helper class which can be used by other plugins, especially macros, in retrieving optional arguments from trac.ini.
    1110
    12 A macro using this module, can be called with a '''config=xxx''' option,
    13 to retrieve a set of options which in trac.ini all start with prefix '''xxx.'''
     11A macro using this module, can be called with a '''config=xxx''' option, to retrieve a set of options which in trac.ini all start with prefix '''xxx.'''
    1412         
    15 Inheritance is supported, by writing an option '''xxx.inherit = yyy''' in trac.ini - all macro options not yet determined, are then searched with the
    16 other prefix, '''yyy.'''
     13Inheritance is supported, by writing an option '''xxx.inherit = yyy''' in trac.ini - all macro options not yet determined, are then searched with the other prefix, '''yyy.'''
    1714         
    18 Multiple inheritance is supported, by writing '''config=prefixA|prefixB''' in the macro invocation, or writing an '''xxx.inherit = prefixC|prefixD''' option in trac.ini 
     15Multiple inheritance is supported, by writing '''config=prefixA|prefixB''' in the macro invocation, or writing an '''xxx.inherit = prefixC|prefixD''' option in trac.ini.
    1916 
    2017The macro module which uses this functionality, specifies a list of expected options, as well as their defaults. These defaults will then be used when the respective option is specified nowhere.
    2118         
    22 == Example ==
     19== Bugs/Feature Requests
     20
     21Existing bugs and feature requests for TracMacroConfigPlugin are [report:9?COMPONENT=TracMacroConfigPlugin here].
     22
     23If you have any issues, create a [/newticket?component=TracMacroConfigPlugin new ticket].
     24
     25== Download
     26
     27Download the zipped source from [download:tracmacroconfigplugin here].
     28
     29== Source
     30
     31You can check out TracMacroConfigPlugin from [http://trac-hacks.org/svn/tracmacroconfigplugin here] using Subversion, or [source:tracmacroconfigplugin browse the source] with Trac.
     32
     33== Installation
     34
     35General instructions on installing Trac plugins can be found on the [TracPlugins#InstallingaTracplugin TracPlugins] page.
     36
     37== Example
     38
     39Currently no plugin or macro uses the functionality.
    2340         
    24 Right now, as this is brand new, no plugin / macro uses the functionality.
    25          
    26 There is an '''examlemacro.py''' file included in the distribution, which when enabled through the admin plugings interface, provides a macro named '''!TracMacroConfigExample''', which displays a table detailling various interesting things about concrete option lookups. This allows you to play with macro arguments and in a corresponding '''[macroconfig-example]''' section in trac.ini,
    27 to play with inheritance setups.
     41There is an '''examlemacro.py''' file included in the distribution, which when enabled through the admin plugings interface, provides a macro named '''!TracMacroConfigExample''', which displays a table detailling various interesting things about concrete option lookups. This allows you to play with macro arguments and in a corresponding '''[macroconfig-example]''' section in trac.ini, to play with inheritance setups.
    2842
    2943This is how exemplary calls to that macro would be written in a wiki page:
    … …  
    3347
    3448Use this together with a trac.ini section like this:
    35 {{{
    36 #!ini
     49{{{#!ini
    3750[macroconfig-example]
    3851class-a.bool = True
    … …  
    4457}}}
    4558
    46 == Bugs/Feature Requests == 
    47 
    48 Existing bugs and feature requests for TracMacroConfigPlugin are [report:9?COMPONENT=TracMacroConfigPlugin here].
    49 
    50 If you have any issues, create a  [http://trac-hacks.org/newticket?component=TracMacroConfigPlugin&owner=bof new ticket].
    51 
    52 == Download ==
    53 
    54 Download the zipped source from [download:tracmacroconfigplugin here].
    55 
    56 == Source ==
    57 
    58 You can check out TracMacroConfigPlugin from [http://trac-hacks.org/svn/tracmacroconfigplugin here] using Subversion, or [source:tracmacroconfigplugin browse the source] with Trac.
    59 
    60 == Recent Changes ==
     59== Recent Changes
    6160
    6261[[ChangeLog(tracmacroconfigplugin, 3)]]
    6362
    64 == Author/Contributors ==
     63== Author/Contributors
    6564
    6665'''Author:''' [wiki:bof] [[BR]]
    6766'''Maintainer:''' [wiki:bof] [[BR]]
    68 '''Sponsor:''' [http://www.yalwa.de/ Yalwa Branchenbuch] [[BR]]
    69 '''Contributors:'''
     67'''Contributors:''' [http://www.yalwa.de/ Yalwa Branchenbuch] (sponsor)