Skip to content

Commit de112d7

Browse files
committed
Add section on allowing user access to the labelprop for a class so
that iterating over the class will work. Ezio found this flaw in the docs while working with the python tracker. Mark one other section as Required. Shorten another section heading.
1 parent 1a8e7ec commit de112d7

File tree

1 file changed

+37
-4
lines changed

1 file changed

+37
-4
lines changed

doc/upgrading.txt

Lines changed: 37 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,39 @@ Contents:
2323
Migrating from 1.5.1 to 1.6.0
2424
=============================
2525

26+
Make sure that user can view labelprop on classes (REQUIRED)
27+
------------------------------------------------------------
28+
29+
If you have View permissions that use ```properties=...```,
30+
make sure that the labelprop for the class is listed in the
31+
properties list.
32+
33+
The first one of these that exists must must be in the list:
34+
35+
1. the property set by a call to setlabelprop for the class
36+
2. the key of the class (as set by setkey())
37+
3. the "name" property (if it exists)
38+
4. the "title" property (if it exists)
39+
40+
if none of those apply, you must allow
41+
42+
* the "id" property
43+
44+
E.G. If your class does a setlabelprop("foo") you must include "foo"
45+
in the properties list even if the class has name or title properties.
46+
47+
See:
48+
http://www.roundup-tracker.org/docs/customizing.html#setlabelprop-property
49+
for further details on the labelprop.
50+
51+
If you don't do this, you will find that multilinks (and possibly
52+
links) may not be displayed properly. E.G. templates that iterate over
53+
a mutlilink field (with tal:repeat for example) may not show any
54+
content.
55+
56+
See: https://sourceforge.net/p/roundup/mailman/message/35763294/
57+
for the initial discussion of the issue.
58+
2659
Cross Site Request Forgery Detection Added
2760
------------------------------------------
2861

@@ -131,8 +164,8 @@ made it difficult to exploit. However allowing the use of
131164
subdirectories to organize the templates required that it be fixed.
132165

133166

134-
Database back end specified in config.ini
135-
-----------------------------------------
167+
Database back end specified in config.ini (REQUIRED)
168+
----------------------------------------------------
136169

137170
The ``db/backend_name`` file is no longer used to configure the database
138171
backend being used for a tracker. The backend is now configured in the
@@ -371,8 +404,8 @@ change the value assigned to @dispname in the href attribute from
371404
${qs/name} to ${qs/name/url_quote}. Note that you should *not* change
372405
the value for tal:content.
373406

374-
Schema change to allow "Show Unassigned" issues link to work for Anonymous user
375-
-------------------------------------------------------------------------------
407+
Allow "Show Unassigned" issues link to work for Anonymous user
408+
--------------------------------------------------------------
376409

377410
In this release the anonymous user is allowed to search the user
378411
class. The following was added to the schema for all templates that

0 commit comments

Comments
 (0)