Mercurial > p > roundup > code
changeset 2133:f01befe8a7fe
*** empty log message ***
| author | Richard Jones <richard@users.sourceforge.net> |
|---|---|
| date | Fri, 26 Mar 2004 01:19:25 +0000 |
| parents | 6535aa11418a |
| children | 00dfd8b50773 |
| files | doc/Makefile doc/index.txt doc/templating.txt doc/tracker_templates.txt |
| diffstat | 4 files changed, 63 insertions(+), 28 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/Makefile Fri Mar 26 01:10:19 2004 +0000 +++ b/doc/Makefile Fri Mar 26 01:19:25 2004 +0000 @@ -4,7 +4,7 @@ SOURCE = announcement.txt customizing.txt developers.txt FAQ.txt features.txt \ glossary.txt implementation.txt index.txt design.txt mysql.txt \ installation.txt upgrading.txt user_guide.txt admin_guide.txt \ - postgresql.txt + postgresql.txt tracker_templates.txt COMPILED := $(SOURCE:.txt=.html)
--- a/doc/index.txt Fri Mar 26 01:10:19 2004 +0000 +++ b/doc/index.txt Fri Mar 26 01:19:25 2004 +0000 @@ -5,18 +5,31 @@ Contents ======== -- Features_ -- Installation_ and Upgrading_ existing installs -- `Frequently Asked Questions`_ -- `User Guide`_ -- Configuring and `Customising Roundup`_ -- `Administering Roundup Trackers`_ -- `Roundup's Design`_ (original_) -- `Developing Roundup`_ +- Features__ +- Installation__ and Upgrading__ existing installs +- `Frequently Asked Questions`__ +- `User Guide`__ +- `Configuring and Customising Roundup`__ +- `Administering Roundup Trackers`__ +- `Roundup's Design`__ (original__) +- `Developing Roundup`__ +- `Roundup Tracker Templates`__ - Contact_ - Acknowledgements_ - License_ +.. __: features.html +.. __: installation.html +.. __: upgrading.html +.. __: FAQ.html +.. __: user_guide.html +.. __: customizing.html +.. __: admin_guide.html +.. __: design.html +.. __: spec.html +.. __: developers.html +.. __: tracker_templates.html + Contact ======= @@ -107,16 +120,3 @@ See COPYING.txt in the software distribution for the licensing terms. - -.. _Features: features.html -.. _Installation: installation.html -.. _Upgrading: upgrading.html -.. _`Frequently Asked Questions`: FAQ.html -.. _`User Guide`: user_guide.html -.. _`Customising Roundup`: customizing.html -.. _`Administering Roundup Trackers`: admin_guide.html -.. _`Roundup's Design`: design.html -.. _`Developing Roundup`: developers.html -.. _original: spec.html -.. _Upgrading: upgrading.html -
--- a/doc/templating.txt Fri Mar 26 01:10:19 2004 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,6 +0,0 @@ -========================= -Roundup Tracker Templates -========================= - -:Version: $Revision: 1.15 $ -
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/tracker_templates.txt Fri Mar 26 01:19:25 2004 +0000 @@ -0,0 +1,41 @@ +========================= +Roundup Tracker Templates +========================= + +:Version: $Revision: 1.1 $ + +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 __init__.py, dbinit.py, config.py, interfaces.py +- directories html and detectors (with appropriate contents) +- TEMPLATE-INFO.txt which is our template "marker" file, 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 +
