view doc/tracker_templates.txt @ 5086:2b551b6b0830

issue2550549 Postgres error on message templating Exception gets thrown and not captured if nodeid is too large on postgres. Added a check in rdbms_common layer that max nodeid is < 2^31 -1. This is also the limit for INTEGER on MySql. SqlLite can support up to 2^63-1, but I chose the smallest common denominator. Large nodeid should now returns no such id rather than a stack trace. Patch idea from: martin.v.loewis. (John Rouillard) This fixes the reason for patches: https://hg.python.org/tracker/roundup/rev/1548763e8273 and https://hg.python.org/tracker/roundup/rev/eb3be57f1ef2
author John Rouillard <rouilj@ieee.org>
date Sat, 18 Jun 2016 22:48:21 -0400
parents 33a1f03b9de0
children b76be13e027e
line wrap: on
line source

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

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/