view doc/tracker_templates.txt @ 3874:4c8d853017f2

strip rolename & fix rolename unittest - strip the rolename earlier in processing so we handle pure-whitespace - change modeline per alex's suggestion - add unittest for all-white space roles - somehow I managed to check in a broken unittest previously. add in the user lookup so it works.
author Justus Pendleton <jpend@users.sourceforge.net>
date Fri, 31 Aug 2007 17:45:17 +0000
parents eb0015a2caa5
children 33a1f03b9de0
line wrap: on
line source

=========================
Roundup Tracker Templates
=========================

:Version: $Revision: 1.2 $

The templates distributed with Roundup are stored in the "share" directory
nominated by Python. On Unix this is typically
``/usr/share/roundup/templates/`` (or ``/usr/local/share...``) and
on Windows this is ``c:\python22\share\roundup\templates\``.

The template loading looks in four places to find the templates:

1. *share* - eg. ``<prefix>/share/roundup/templates/*``.
   This should be the standard place to find them when Roundup is
   installed.
2. ``<roundup.admin.__file__>/../templates/*``.
   This will be used if Roundup's run in the distro (aka. source)
   directory.
3. ``<current working dir>/*``.
   This is for when someone unpacks a 3rd-party template.
4. ``<current working dir>``.
   This is for someone who "cd"s to the 3rd-party template dir.

Templates contain:

- modules ``schema.py`` and ``initial_data.py``
- directories ``html``, ``detectors`` and ``extensions``
  (with appropriate contents)
- template "marker" file ``TEMPLATE-INFO.txt``, which contains
  the name of the template, a description of the template
  and its intended audience.

An example TEMPLATE-INFO.txt::

 Name: classic
 Description: This is a generic issue tracker that may be used to track bugs,
              feature requests, project issues or any number of other types
              of issues. Most users of Roundup will find that this template
              suits them, with perhaps a few customisations.
 Intended-For: All first-time Roundup users


Roundup Issue Tracker: http://roundup-tracker.org/