Mercurial > p > roundup > code
annotate doc/tracker_templates.txt @ 5112:8901cc4ef0e0
- issue1714899: Feature Request: Optional Change Note. Added a new
quiet=True/False option for all property types. When quiet=True
changes to the property will not be displayed in the::
confirmation banner (shown in green) when a change is made
property change section of change note (nosy emails)
web history display for an item.
Note that this may confuse users if used on a property that is
meant to be changed by a user. It is most useful on administrative
properties that are changed by an auditor as part of a user
generated change. Original patch by Daniel Diniz (ajaksu2)
discussed also at:
http://psf.upfronthosting.co.za/roundup/meta/issue249
Support for setting quiet when calling the class specifiers:
E.G. prop=String(quiet=True) rather than::
prop=String()
prop.quiet=True
support for anydb backend, added tests, doc updates, support for
ignoring quiet setting using showall=True in call to history()
function in templates by John Rouillard.
In addition to documenting quiet, I also documented required and
default_value additions to the hyperdb property classes. Only place I
could find is design.txt.
Note tests for history in web interface are not done. It was manually
checked but there are no automated tests. The template for setup is in
db_test_base.py::testQuietJournal but it has no asserts. I need
access to template.py::_HTMLItem::history() and I don't know how to do
that. test_templates.py isn't helping me any at all and I want to get
this patch in because it handles nicely an issue I have in the design
of my own tracker. The issue is:
The properties of an issue are displayed in framesets/subframes. The
user can roll up the frameset leaving only the title bar. When the
user saves the changes, the current state of the framesets
(collapsed/uncollapsed) is saved to a property in the user's
object. However there is no reason the user should see that this is
updated since it's an administrative detail.
Similarly, you could count the number of times an issue is reopened or
reassigned. Updates to properties that are an indirect result of a
user's change should not be displayed to the user as they can be
confusing and distracting.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Thu, 30 Jun 2016 20:38:23 -0400 |
| parents | 33a1f03b9de0 |
| children | b76be13e027e |
| 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 |
|
2133
f01befe8a7fe
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
8 on Windows this is ``c:\python22\share\roundup\templates\``. |
|
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 |
|
f01befe8a7fe
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
14 installed. |
|
f01befe8a7fe
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
15 2. ``<roundup.admin.__file__>/../templates/*``. |
|
f01befe8a7fe
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
16 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
|
17 directory. |
|
f01befe8a7fe
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
18 3. ``<current working dir>/*``. |
|
f01befe8a7fe
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
19 This is for when someone unpacks a 3rd-party template. |
|
f01befe8a7fe
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
20 4. ``<current working dir>``. |
|
f01befe8a7fe
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
21 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
|
22 |
|
f01befe8a7fe
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
23 Templates contain: |
|
f01befe8a7fe
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
24 |
|
2826
eb0015a2caa5
template contents description changed to new layout
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2133
diff
changeset
|
25 - 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
|
26 - directories ``html``, ``detectors`` and ``extensions`` |
|
eb0015a2caa5
template contents description changed to new layout
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2133
diff
changeset
|
27 (with appropriate contents) |
|
eb0015a2caa5
template contents description changed to new layout
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2133
diff
changeset
|
28 - 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
|
29 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
|
30 and its intended audience. |
|
2133
f01befe8a7fe
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
31 |
|
f01befe8a7fe
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
32 An example TEMPLATE-INFO.txt:: |
|
f01befe8a7fe
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
33 |
|
f01befe8a7fe
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
34 Name: classic |
|
f01befe8a7fe
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
35 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
|
36 feature requests, project issues or any number of other types |
|
f01befe8a7fe
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
37 of issues. Most users of Roundup will find that this template |
|
f01befe8a7fe
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
38 suits them, with perhaps a few customisations. |
|
f01befe8a7fe
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
39 Intended-For: All first-time Roundup users |
|
f01befe8a7fe
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
40 |
