view doc/tracker_templates.txt @ 5110:87b0358790ed

Adding some tests for admin.py. Specifically for issue2550572: setting nosy=+foo on multiple issues gives them all the same exact nosy list. To make this work had to change the admin.py code to use "sys.stdout.write" in place of "print". In the test I now hijack stdout.write following an existing example of this for admin's import/export command that hijacks sys.stderr.write. Also I corrected a misspelling in security.py. The word "everything" was misspelled. It is not inside _() markers so I don't think it's going to affect translation and grepping the locale subdir doesn't show the original string.
author John Rouillard <rouilj@ieee.org>
date Wed, 29 Jun 2016 18:35:19 -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/