Changes between Version 2 and Version 3 of TracMacroConfigPlugin


Ignore:
Timestamp:
Nov 25, 2015, 9:47:58 AM (8 years ago)
Author:
figaro
Comment:

Cosmetic changes

Legend:

Unmodified
Added
Removed
Modified

  • TracMacroConfigPlugin

    v2 v3  
    55== Description
    66
    7 ''By itself, this modules does not provide any functionality.'''
    8          
    9 This module provides a helper class which can be used by other plugins, especially macros, in retrieving optional arguments from trac.ini.
     7This module provides a helper class which can be used by other plugins, especially macros, in retrieving optional arguments from the `trac.ini` configuration file. By itself, this modules does not provide any functionality.
    108
    11 A 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.'''
    12          
    13 Inheritance 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.'''
    14          
    15 Multiple inheritance is supported, by writing '''config=prefixA|prefixB''' in the macro invocation, or writing an '''xxx.inherit = prefixC|prefixD''' option in trac.ini.
    16  
    17 The 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.
    18          
     9A 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'''.
     10
     11Inheritance 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'''.
     12
     13Multiple inheritance is supported, by writing '''config=prefixA|prefixB''' in the macro invocation, or writing an '''xxx.inherit = prefixC|prefixD''' option in `trac.ini`.
     14
     15The 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 not specified anywhere.
     16
    1917== Bugs/Feature Requests
    2018
    … …  
    2321If you have any issues, create a [/newticket?component=TracMacroConfigPlugin new ticket].
    2422
     23[[TicketQuery(component=AccountManagerPlugin&group=type,format=progress)]]
     24
    2525== Download
    2626
    27 Download the zipped source from [download:tracmacroconfigplugin here].
     27Download the zipped source from [export:tracmacroconfigplugin here].
    2828
    2929== Source
    3030
    31 You can check out TracMacroConfigPlugin from [http://trac-hacks.org/svn/tracmacroconfigplugin here] using Subversion, or [source:tracmacroconfigplugin browse the source] with Trac.
     31You can check out TracMacroConfigPlugin from [/svn/tracmacroconfigplugin here] using Subversion, or [source:tracmacroconfigplugin browse the source] with Trac.
    3232
    3333== Installation
    … …  
    3939Currently no plugin or macro uses the functionality.
    4040         
    41 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, to play with inheritance setups.
     41There is an '''examplemacro.py''' file included in the distribution, which when enabled through the admin plugings interface, provides a macro named '''!TracMacroConfigExample''', which displays a table detailing interesting things about concrete option lookups. This allows you to play with macro arguments and in a corresponding '''[macroconfig-example]''' section in `trac.ini` and to play with inheritance setups.
    4242
    4343This is how exemplary calls to that macro would be written in a wiki page:
    … …  
    4646}}}
    4747
    48 Use this together with a trac.ini section like this:
     48Use this together with a `trac.ini` section like this:
    4949{{{#!ini
    5050[macroconfig-example]
    … …  
    6464
    6565'''Author:''' [wiki:bof] [[BR]]
    66 '''Maintainer:''' [wiki:bof] [[BR]]
     66'''Maintainer:''' [[Maintainer]] [[BR]]
    6767'''Contributors:''' [http://www.yalwa.de/ Yalwa Branchenbuch] (sponsor)