Mercurial > p > roundup > code
comparison doc/installation.txt @ 7302:d2633821fe07
update doc on supplied templates
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Sun, 07 May 2023 09:25:19 -0400 |
| parents | d5442d781a09 |
| children | 9bd9d06e2f2c |
comparison
equal
deleted
inserted
replaced
| 7301:d5442d781a09 | 7302:d2633821fe07 |
|---|---|
| 530 ---------------------- | 530 ---------------------- |
| 531 | 531 |
| 532 Classic Template | 532 Classic Template |
| 533 ~~~~~~~~~~~~~~~~ | 533 ~~~~~~~~~~~~~~~~ |
| 534 | 534 |
| 535 The classic template is the one defined in the `Roundup Specification`_. It | 535 The classic template is the one defined in the `Roundup |
| 536 holds issues which have priorities and statuses. Each issue may also have a | 536 Specification`_. It holds issues which have priorities and |
| 537 set of messages which are disseminated to the issue's list of nosy users. | 537 statuses. Each issue may also have a set of messages which are |
| 538 disseminated to the issue's list of nosy users. | |
| 538 | 539 |
| 539 Minimal Template | 540 Minimal Template |
| 540 ~~~~~~~~~~~~~~~~ | 541 ~~~~~~~~~~~~~~~~ |
| 541 | 542 |
| 542 The minimal template has the minimum setup required for a tracker | 543 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 installation. That is, it has the configuration files, defines a user |
| 544 and the basic HTML interface to that. It's a completely clean slate for you to | 545 database and the basic HTML interface to that. It's a completely clean |
| 545 create your tracker on. | 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. | |
| 546 | 578 |
| 547 .. index:: database; choosing your backend | 579 .. index:: database; choosing your backend |
| 548 | 580 |
| 549 Choosing Your Backend | 581 Choosing Your Backend |
| 550 --------------------- | 582 --------------------- |