Mercurial > p > roundup > code

annotate doc/tracker_templates.txt @ 6728:f83e19465b70

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add new location where templates and locales are found. Needed to document the 'pip install' location of the templates/locales and other shared files (e.g. man pages).
author John Rouillard <rouilj@ieee.org>
date Sun, 26 Jun 2022 23:24:04 -0400
parents 3f3ce3004013
children 00fe67eb8a91
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2133
f01befe8a7fe *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1 =========================
f01befe8a7fe *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2 Roundup Tracker Templates
f01befe8a7fe *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
3 =========================
f01befe8a7fe *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
4
f01befe8a7fe *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
5 The templates distributed with Roundup are stored in the "share" directory
2826
eb0015a2caa5 template contents description changed to new layout
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2133
diff changeset
6 nominated by Python. On Unix this is typically
eb0015a2caa5 template contents description changed to new layout
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2133
diff changeset
7 ``/usr/share/roundup/templates/`` (or ``/usr/local/share...``) and
6727
3f3ce3004013 issue2551206 - remove mention of roundup installer, fix up windows docs
John Rouillard <rouilj@ieee.org>
parents: 5762
diff changeset
8 on Windows this is ``c:\python27\share\roundup\templates\``.
2133
f01befe8a7fe *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
9
f01befe8a7fe *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
10 The template loading looks in four places to find the templates:
2826
eb0015a2caa5 template contents description changed to new layout
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2133
diff changeset
11
2133
f01befe8a7fe *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
12 1. *share* - eg. ``<prefix>/share/roundup/templates/*``.
f01befe8a7fe *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
13 This should be the standard place to find them when Roundup is
6728
f83e19465b70 Add new location where templates and locales are found.
John Rouillard <rouilj@ieee.org>
parents: 6727
diff changeset
14 installed running setup.py from source.
f83e19465b70 Add new location where templates and locales are found.
John Rouillard <rouilj@ieee.org>
parents: 6727
diff changeset
15 2. ``install_dir``/../<prefix>/share/....``, where prefix is the
f83e19465b70 Add new location where templates and locales are found.
John Rouillard <rouilj@ieee.org>
parents: 6727
diff changeset
16 Python's ``sys.prefix``. This finds templates (and locales)
f83e19465b70 Add new location where templates and locales are found.
John Rouillard <rouilj@ieee.org>
parents: 6727
diff changeset
17 installed by pip. E.G. in a virtualenv located at (``sys.prefix``):
f83e19465b70 Add new location where templates and locales are found.
John Rouillard <rouilj@ieee.org>
parents: 6727
diff changeset
18 ``/tools/roundup``, roundup would be at:
f83e19465b70 Add new location where templates and locales are found.
John Rouillard <rouilj@ieee.org>
parents: 6727
diff changeset
19 ``/tools/roundup/lib/python3.6/site-packages/roundup``. The
f83e19465b70 Add new location where templates and locales are found.
John Rouillard <rouilj@ieee.org>
parents: 6727
diff changeset
20 templates would be at:
f83e19465b70 Add new location where templates and locales are found.
John Rouillard <rouilj@ieee.org>
parents: 6727
diff changeset
21 ``/tools/roundup/lib/python3.6/site-packages/tools/roundup/share/roundup/templates/``.
f83e19465b70 Add new location where templates and locales are found.
John Rouillard <rouilj@ieee.org>
parents: 6727
diff changeset
22 3. ``<roundup.admin.__file__>/../templates/*``.
2133
f01befe8a7fe *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
23 This will be used if Roundup's run in the distro (aka. source)
f01befe8a7fe *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
24 directory.
6728
f83e19465b70 Add new location where templates and locales are found.
John Rouillard <rouilj@ieee.org>
parents: 6727
diff changeset
25 4. ``<current working dir>/*``.
2133
f01befe8a7fe *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
26 This is for when someone unpacks a 3rd-party template.
6728
f83e19465b70 Add new location where templates and locales are found.
John Rouillard <rouilj@ieee.org>
parents: 6727
diff changeset
27 5. ``<current working dir>``.
2133
f01befe8a7fe *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
28 This is for someone who "cd"s to the 3rd-party template dir.
f01befe8a7fe *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
29
f01befe8a7fe *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
30 Templates contain:
f01befe8a7fe *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
31
2826
eb0015a2caa5 template contents description changed to new layout
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2133
diff changeset
32 - modules ``schema.py`` and ``initial_data.py``
eb0015a2caa5 template contents description changed to new layout
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2133
diff changeset
33 - directories ``html``, ``detectors`` and ``extensions``
eb0015a2caa5 template contents description changed to new layout
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2133
diff changeset
34 (with appropriate contents)
5762
b76be13e027e issue2551029: Jinja2 template install error.
John Rouillard <rouilj@ieee.org>
parents: 4557
diff changeset
35 - optional ``config_ini.ini`` file. It is structured like a tracker's
b76be13e027e issue2551029: Jinja2 template install error.
John Rouillard <rouilj@ieee.org>
parents: 4557
diff changeset
36 ``config.ini`` but contains only headers (e.g. ``[main]``) and
b76be13e027e issue2551029: Jinja2 template install error.
John Rouillard <rouilj@ieee.org>
parents: 4557
diff changeset
37 *required* parameters that are different from defaults:
b76be13e027e issue2551029: Jinja2 template install error.
John Rouillard <rouilj@ieee.org>
parents: 4557
diff changeset
38 e.g. ``template_engine = jinja2`` and ``static_files =
b76be13e027e issue2551029: Jinja2 template install error.
John Rouillard <rouilj@ieee.org>
parents: 4557
diff changeset
39 static``. These settings override the default values saved to the
b76be13e027e issue2551029: Jinja2 template install error.
John Rouillard <rouilj@ieee.org>
parents: 4557
diff changeset
40 tracker's ``config.ini``.
2826
eb0015a2caa5 template contents description changed to new layout
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2133
diff changeset
41 - template "marker" file ``TEMPLATE-INFO.txt``, which contains
eb0015a2caa5 template contents description changed to new layout
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2133
diff changeset
42 the name of the template, a description of the template
eb0015a2caa5 template contents description changed to new layout
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2133
diff changeset
43 and its intended audience.
2133
f01befe8a7fe *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
44
f01befe8a7fe *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
45 An example TEMPLATE-INFO.txt::
f01befe8a7fe *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
46
f01befe8a7fe *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
47 Name: classic
f01befe8a7fe *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
48 Description: This is a generic issue tracker that may be used to track bugs,
f01befe8a7fe *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
49 feature requests, project issues or any number of other types
f01befe8a7fe *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
50 of issues. Most users of Roundup will find that this template
f01befe8a7fe *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
51 suits them, with perhaps a few customisations.
f01befe8a7fe *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
52 Intended-For: All first-time Roundup users
f01befe8a7fe *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
53
Roundup Issue Tracker: http://roundup-tracker.org/