|Version 9 (modified by dwclifton, 8 years ago) (diff)|
Trac.ini Dynamic Option Value Macros
The IniGetMacro package consists of two macros. The first, IniGet, returns as plain text the value of a trac.ini configuration option. The trac.ini file is a simple flat-file database of sections and option/value pairs:
[section] name = value
By calling the macro like so: [[IniGet(section.name)]], it returns the value. If no option matches, it returns an error message. Some option names themselves contain periods, this is supported.
The second macro in the package is Welcome, and it returns a level 1 heading element in the following format:
<h1 id="welcome">Welcome to the project.name Project</h1>
Where project.name is dynamically inserted in the same manner as IniGet. The example above is the default behavior. However, Welcome also supports from zero to two arguments that allow the user to specify the prefix and/or suffix strings. Both standard and dictionary keyword methods are supported. If using the standard method, order is important, if using the keyword method it is not. You cannot mix both methods.
These macros are useful for WikiStart project templates.
python setup.py bdist_egg cp dist/*.egg /trac/env/Project/plugins
Enable the macros in: /trac/env/Project/conf/trac.ini:
[components] iniget.* = enabled welcome.* = enabled
Then restart your Web server.
[[Welcome]] [[Welcome()]] [[Welcome(This is the,Project)]] [[Welcome(prefix=This is the,suffix=Project)]] [[Welcome(suffix=Super Cool Project)]] [[Welcome(,Super Cool Project)]] The [[IniGet(project.name)]] project is designed to track and document software defects...
- Browse the source at: GitHub
- Public clone URL:
git clone git://github.com/dwclifton/tracinigetmacro.git
If you have any issues, create a new ticket.
- 15264 by rjollos on 2016-02-11 05:22:34
Remove unnecessary svn:mime-type on py files
svn:mime-type was set to "plain" for many files.
- 12210 by rjollos on 2012-10-19 03:16:30
Updated README with contents of trac-hacks wiki page.
- 12209 by rjollos on 2012-10-19 03:12:14
Fixes #6039: Added documentation to macros. Updated README with contents of trac-hacks page. Imported the IniGet macro from GitHub.
- Author: dwclifton
- Contributors: The Python/Trac development community.