doc/tracker_templates.txt

   1 =========================
   2 Roundup Tracker Templates
   3 =========================
   4
   5 :Version: $Revision: 1.2 $
   6
   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\``.
  11
  12 The template loading looks in four places to find the templates:
  13
  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.
  24
  25 Templates contain:
  26
  27 - modules ``schema.py`` and ``initial_data.py``
  28 - directories ``html``, ``detectors`` and ``extensions``
  29   (with appropriate contents)
  30 - template "marker" file ``TEMPLATE-INFO.txt``, which contains
  31   the name of the template, a description of the template
  32   and its intended audience.
  33
  34 An example TEMPLATE-INFO.txt::
  35
  36  Name: classic
  37  Description: This is a generic issue tracker that may be used to track bugs,
  38               feature requests, project issues or any number of other types
  39               of issues. Most users of Roundup will find that this template
  40               suits them, with perhaps a few customisations.
  41  Intended-For: All first-time Roundup users
  42