view doc/tracker_templates.txt @ 4254:8d3582271a99

Minor update of doc/developers.txt... ...to point to the new resources on www.roundup-tracker.org: - pointed to the new tracker - removed references to CVS - removed "macros": _Roundup CVS, _feature tracker - hinted at http://www.roundup-tracker.org/code.html and the mailinglist instead of duplicating information
author Bernhard Reiter <Bernhard.Reiter@intevation.de>
date Thu, 17 Sep 2009 09:54:49 +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/