Skip to content

Commit 1bca1a6

Browse files
committed
Link designator terms to glossary; expand permission doc; typo fixes
1 parent 85c58d0 commit 1bca1a6

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

doc/user_guide.txt

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ its item class. To identify a particular issue or user, we combine the
3131
class with the number to create a unique label, so that user 1 (who,
3232
incidentally, is *always* the "admin" user) is referred to as "user1".
3333
Issue number 315 is referred to as "issue315". We call that label the
34-
item's *designator*.
34+
item's :term:`designator`.
3535

3636
Items in the database are never deleted, they're just "retired". You
3737
can still refer to them by ID - hence removing an item won't break
@@ -411,7 +411,7 @@ propname selects the values the item properties given by propname must
411411
etc)
412412
============ =============================================================
413413

414-
You may manually write URLS that contain these arguments, like so
414+
You may manually write URLs that contain these arguments, like so
415415
(whitespace has been added for clarity)::
416416

417417
/issue?status=unread,in-progress,resolved&
@@ -445,9 +445,17 @@ Access Controls
445445

446446
User access is controlled through Permissions. These are are grouped
447447
into Roles, and users have a comma-separated list of Roles assigned to
448-
them.
448+
them. Roles can allow you to access:
449449

450-
Permissions divide access controls up into answering questions like:
450+
- an entire class of items (e.g. issues)
451+
- only certain fields of a class (e.g. you can see the username but
452+
not the phone number of other users)
453+
- fields or classes based on your relationship to an item (e.g.
454+
you can see the phone number of your user entry since you are the
455+
owner of your user entry)
456+
457+
Other permissions divide access controls up into answering questions
458+
like:
451459

452460
- may the user edit issues ("Edit", "issue")
453461
- is the user allowed to use the web interface ("Web Access")
@@ -460,7 +468,6 @@ the customisation documentation. Examples of new access controls are:
460468
- don't give users who register through e-mail web access
461469
- let some users edit the details of all users
462470

463-
464471
E-Mail Gateway
465472
==============
466473

@@ -505,7 +512,7 @@ brackets and after the class item name. So ``[issue2]`` and
505512
Any "re:" or "fwd:" prefixes are stripped off the subject line before
506513
we start looking for real information.
507514

508-
If an item designator (class name and id number, for example
515+
If an item :term:`designator` (class name and id number, for example
509516
``issue123``) is found there, a new "msg" item is added to the
510517
"messages" property for that item, and any new "file" items are added to
511518
the "files" property for the item.

0 commit comments

Comments
 (0)