Mercurial > p > roundup > code
comparison doc/tracker_templates.txt @ 7744:6985f0ff3df3
doc: document lib, fix formating/example
Add lib as an optional directory in a template.
Make config_ini.ini example an actual code block using the file from
the jinja2 template.
Format the TEMPLATE-INFO.txt example as plain text (it was
highlighting words like 'in' and 'with'). Also move the whole example
under the bullet item, it was outside of the list. Reformat the input
text to be less than 80 characters.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Mon, 26 Feb 2024 11:23:36 -0500 |
| parents | 00fe67eb8a91 |
| children | 3614cd64f4c4 |
comparison
equal
deleted
inserted
replaced
| 7743:79779293d77b | 7744:6985f0ff3df3 |
|---|---|
| 31 Templates contain: | 31 Templates contain: |
| 32 | 32 |
| 33 - modules ``schema.py`` and ``initial_data.py`` | 33 - modules ``schema.py`` and ``initial_data.py`` |
| 34 - directories ``html``, ``detectors`` and ``extensions`` | 34 - directories ``html``, ``detectors`` and ``extensions`` |
| 35 (with appropriate contents) | 35 (with appropriate contents) |
| 36 - optional directory ``lib`` which contains modules used by the other | |
| 37 tracker components | |
| 36 - optional ``config_ini.ini`` file. It is structured like a tracker's | 38 - optional ``config_ini.ini`` file. It is structured like a tracker's |
| 37 ``config.ini`` but contains only headers (e.g. ``[main]``) and | 39 ``config.ini`` but contains only headers (e.g. ``[main]``) and |
| 38 *required* parameters that are different from defaults: | 40 *required* parameters that are different from defaults. For example:: |
| 39 e.g. ``template_engine = jinja2`` and ``static_files = | 41 |
| 40 static``. These settings override the default values saved to the | 42 [main] |
| 41 tracker's ``config.ini``. | 43 template_engine = jinja2 |
| 44 | |
| 45 static_files = static | |
| 46 | |
| 47 These settings override the default values in the tracker's | |
| 48 ``config.ini`` when using roundup-admin to install a template. | |
| 42 - template "marker" file ``TEMPLATE-INFO.txt``, which contains | 49 - template "marker" file ``TEMPLATE-INFO.txt``, which contains |
| 43 the name of the template, a description of the template | 50 the name of the template, a description of the template |
| 44 and its intended audience. | 51 and its intended audience. |
| 45 | 52 |
| 46 An example TEMPLATE-INFO.txt:: | 53 An example TEMPLATE-INFO.txt: |
| 47 | 54 |
| 48 Name: classic | 55 .. code-block:: text |
| 49 Description: This is a generic issue tracker that may be used to track bugs, | |
| 50 feature requests, project issues or any number of other types | |
| 51 of issues. Most users of Roundup will find that this template | |
| 52 suits them, with perhaps a few customisations. | |
| 53 Intended-For: All first-time Roundup users | |
| 54 | 56 |
| 57 Name: classic | |
| 58 Description: This is a generic issue tracker that may be used to | |
| 59 track bugs, feature requests, project issues or any | |
| 60 number of other types of issues. Most users of | |
| 61 Roundup will find that this template suits them, | |
| 62 with perhaps a few customisations. | |
| 63 Intended-For: All first-time Roundup users | |
| 64 |