Mercurial > p > roundup > code
comparison doc/tracker_templates.txt @ 2826:eb0015a2caa5
template contents description changed to new layout
| author | Alexander Smishlajev <a1s@users.sourceforge.net> |
|---|---|
| date | Sun, 24 Oct 2004 11:38:54 +0000 |
| parents | f01befe8a7fe |
| children | 33a1f03b9de0 |
comparison
equal
deleted
inserted
replaced
| 2825:574525e4936b | 2826:eb0015a2caa5 |
|---|---|
| 1 ========================= | 1 ========================= |
| 2 Roundup Tracker Templates | 2 Roundup Tracker Templates |
| 3 ========================= | 3 ========================= |
| 4 | 4 |
| 5 :Version: $Revision: 1.1 $ | 5 :Version: $Revision: 1.2 $ |
| 6 | 6 |
| 7 The templates distributed with Roundup are stored in the "share" directory | 7 The templates distributed with Roundup are stored in the "share" directory |
| 8 nominated by Python. On Unix this is typically | 8 nominated by Python. On Unix this is typically |
| 9 ``/usr/share/roundup/templates/`` (or ``/usr/local/share...``) and | 9 ``/usr/share/roundup/templates/`` (or ``/usr/local/share...``) and |
| 10 on Windows this is ``c:\python22\share\roundup\templates\``. | 10 on Windows this is ``c:\python22\share\roundup\templates\``. |
| 11 | 11 |
| 12 The template loading looks in four places to find the templates: | 12 The template loading looks in four places to find the templates: |
| 13 | 13 |
| 14 1. *share* - eg. ``<prefix>/share/roundup/templates/*``. | 14 1. *share* - eg. ``<prefix>/share/roundup/templates/*``. |
| 15 This should be the standard place to find them when Roundup is | 15 This should be the standard place to find them when Roundup is |
| 16 installed. | 16 installed. |
| 17 2. ``<roundup.admin.__file__>/../templates/*``. | 17 2. ``<roundup.admin.__file__>/../templates/*``. |
| 18 This will be used if Roundup's run in the distro (aka. source) | 18 This will be used if Roundup's run in the distro (aka. source) |
| 22 4. ``<current working dir>``. | 22 4. ``<current working dir>``. |
| 23 This is for someone who "cd"s to the 3rd-party template dir. | 23 This is for someone who "cd"s to the 3rd-party template dir. |
| 24 | 24 |
| 25 Templates contain: | 25 Templates contain: |
| 26 | 26 |
| 27 - modules __init__.py, dbinit.py, config.py, interfaces.py | 27 - modules ``schema.py`` and ``initial_data.py`` |
| 28 - directories html and detectors (with appropriate contents) | 28 - directories ``html``, ``detectors`` and ``extensions`` |
| 29 - TEMPLATE-INFO.txt which is our template "marker" file, which contains | 29 (with appropriate contents) |
| 30 the name of the template, a description of the template and its | 30 - template "marker" file ``TEMPLATE-INFO.txt``, which contains |
| 31 intended audience. | 31 the name of the template, a description of the template |
| 32 and its intended audience. | |
| 32 | 33 |
| 33 An example TEMPLATE-INFO.txt:: | 34 An example TEMPLATE-INFO.txt:: |
| 34 | 35 |
| 35 Name: classic | 36 Name: classic |
| 36 Description: This is a generic issue tracker that may be used to track bugs, | 37 Description: This is a generic issue tracker that may be used to track bugs, |