1 =========================
2 Roundup Tracker Templates
3 =========================
5 :Version: $Revision: 1.1 $
7 The templates distributed with Roundup are stored in the "share" directory
8 nominated by Python. On Unix this is typically
9 ``/usr/share/roundup/templates/`` (or ``/usr/local/share...``) and
10 on Windows this is ``c:\python22\share\roundup\templates\``.
12 The template loading looks in four places to find the templates:
14 1. *share* - eg. ``<prefix>/share/roundup/templates/*``.
15 This should be the standard place to find them when Roundup is
16 installed.
17 2. ``<roundup.admin.__file__>/../templates/*``.
18 This will be used if Roundup's run in the distro (aka. source)
19 directory.
20 3. ``<current working dir>/*``.
21 This is for when someone unpacks a 3rd-party template.
22 4. ``<current working dir>``.
23 This is for someone who "cd"s to the 3rd-party template dir.
25 Templates contain:
27 - modules __init__.py, dbinit.py, config.py, interfaces.py
28 - directories html and detectors (with appropriate contents)
29 - TEMPLATE-INFO.txt which is our template "marker" file, which contains
30 the name of the template, a description of the template and its
31 intended audience.
33 An example TEMPLATE-INFO.txt::
35 Name: classic
36 Description: This is a generic issue tracker that may be used to track bugs,
37 feature requests, project issues or any number of other types
38 of issues. Most users of Roundup will find that this template
39 suits them, with perhaps a few customisations.
40 Intended-For: All first-time Roundup users