comparison doc/reference.txt @ 8137:f5aa7853abda

doc: document Search permission ignores a check clause. Also update formating and add a couple of missing User permisions to list for classic tracker. There are more missing.
author John Rouillard <rouilj@ieee.org>
date Wed, 23 Oct 2024 13:26:18 -0400
parents 394f72021dad
children 0692740e9b56
comparison
equal deleted inserted replaced
8124:800c8dd75051 8137:f5aa7853abda
1284 1284
1285 For the "User" Role, the "classic" tracker defines: 1285 For the "User" Role, the "classic" tracker defines:
1286 1286
1287 - Create, Edit and View issue, file, msg, query, keyword 1287 - Create, Edit and View issue, file, msg, query, keyword
1288 - View priority, status 1288 - View priority, status
1289 - View user 1289 - View user (limited properties)
1290 - View their own user record
1290 - Edit their own user record 1291 - Edit their own user record
1292 - Search queries
1291 1293
1292 And the "Anonymous" Role has the following permissions: 1294 And the "Anonymous" Role has the following permissions:
1293 1295
1294 - Web interface access 1296 - Web interface access
1295 - Register user (for registration) 1297 - Register user (for registration)
1507 ctx['classname'] the name of the class that is being checked 1509 ctx['classname'] the name of the class that is being checked
1508 (issue, query ....). 1510 (issue, query ....).
1509 1511
1510 ctx['permission'] the name of the permission (e.g. View, Edit...). 1512 ctx['permission'] the name of the permission (e.g. View, Edit...).
1511 1513
1512 The second form is preferred as it makes it easier to implement more 1514 The second form is preferred as it makes it easier to implement more
1513 complex permission schemes. An `example in upgrading.html 1515 complex permission schemes. An `example in upgrading.html
1514 <upgrading.html#enhancement-to-check-command-for-permissions>`_ 1516 <upgrading.html#enhancement-to-check-command-for-permissions>`_
1515 shows the use of ``ctx``. 1517 shows the use of ``ctx``.
1518
1519 Note that the check option is not supported for the Search
1520 permission. When searching there is no item defined, so a check
1521 function doesn not make any sense.
1516 1522
1517 **properties** 1523 **properties**
1518 A sequence of property names that are the only properties to apply the 1524 A sequence of property names that are the only properties to apply the
1519 new Permission to (eg. ``... klass='user', properties=('name', 1525 new Permission to (eg. ``... klass='user', properties=('name',
1520 'email') ...``) 1526 'email') ...``)

Roundup Issue Tracker: http://roundup-tracker.org/