Skip to content

Commit 31853cf

Browse files
committed
update doc on supplied templates
1 parent 910f6fd commit 31853cf

File tree

1 file changed

+38
-6
lines changed

1 file changed

+38
-6
lines changed

doc/installation.txt

Lines changed: 38 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -532,17 +532,49 @@ Choosing Your Template
532532
Classic Template
533533
~~~~~~~~~~~~~~~~
534534

535-
The classic template is the one defined in the `Roundup Specification`_. It
536-
holds issues which have priorities and statuses. Each issue may also have a
537-
set of messages which are disseminated to the issue's list of nosy users.
535+
The classic template is the one defined in the `Roundup
536+
Specification`_. It holds issues which have priorities and
537+
statuses. Each issue may also have a set of messages which are
538+
disseminated to the issue's list of nosy users.
538539

539540
Minimal Template
540541
~~~~~~~~~~~~~~~~
541542

542543
The minimal template has the minimum setup required for a tracker
543-
installation. That is, it has the configuration files, defines a user database
544-
and the basic HTML interface to that. It's a completely clean slate for you to
545-
create your tracker on.
544+
installation. That is, it has the configuration files, defines a user
545+
database and the basic HTML interface to that. It's a completely clean
546+
slate for you to create your tracker on.
547+
548+
Other Templates
549+
~~~~~~~~~~~~~~~
550+
551+
There are three other templates distributed with Roundup:
552+
553+
responsive
554+
This issue tracker uses the same schema as devel. The difference
555+
between devel and responsive templates is the use of Twitter
556+
bootstrap (https://github.com/twbs/bootstrap) in templates and
557+
HTML5 markup. Make sure the "static_files" setting in your
558+
config.ini of your instance is set to the directory where the
559+
static files live (the subdirectory "static" in the default of the
560+
template).
561+
562+
devel
563+
This is a generic issue tracker that may be used to track bugs,
564+
feature requests, project issues or any number of other types of
565+
issues. Most users of Roundup will find that this template suits
566+
them, with perhaps a few customisations.
567+
568+
569+
jinja2
570+
This is a generic issue tracker based on classic schema. It uses
571+
Jinja2 for templating and Twitter bootstrap for responsive markup.
572+
You will need jinja and gettext for this to work. See the wiki
573+
page https://wiki.roundup-tracker.org/Jinja2 for updates
574+
between releases.
575+
576+
Also other people have listed their trackers for different needs at:
577+
https://wiki.roundup-tracker.org/TrackerTemplates.
546578

547579
.. index:: database; choosing your backend
548580

0 commit comments

Comments
 (0)