Skip to content

Commit 54cec46

Browse files
author
Richard Jones
committed
added missing documentation for a few of the config option values
1 parent 4138844 commit 54cec46

File tree

1 file changed

+34
-3
lines changed

1 file changed

+34
-3
lines changed

doc/customizing.txt

Lines changed: 34 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Customising Roundup
33
===================
44

5-
:Version: $Revision: 1.5 $
5+
:Version: $Revision: 1.6 $
66

77
.. contents::
88

@@ -78,14 +78,45 @@ instance is attempted.::
7878
FILTER_POSITION = 'bottom' # one of 'top', 'bottom', 'top and bottom'
7979

8080
# Deny or allow anonymous access to the web interface
81-
ANONYMOUS_ACCESS = 'deny'
81+
ANONYMOUS_ACCESS = 'deny' # either 'deny' or 'allow'
8282

8383
# Deny or allow anonymous users to register through the web interface
84-
ANONYMOUS_REGISTER = 'deny'
84+
ANONYMOUS_REGISTER = 'deny' # either 'deny' or 'allow'
85+
86+
# Deny or allow anonymous users to register through the mail interface
87+
ANONYMOUS_REGISTER_MAIL = 'deny' # either 'deny' or 'allow'
8588

8689
# Send nosy messages to the author of the message
8790
MESSAGES_TO_AUTHOR = 'no' # either 'yes' or 'no'
8891

92+
# Does the author of a message get placed on the nosy list automatically?
93+
# If 'new' is used, then the author will only be added when a message
94+
# creates a new issue. If 'yes', then the author will be added on followups
95+
# too. If 'no', they're never added to the nosy.
96+
ADD_AUTHOR_TO_NOSY = 'new' # one of 'yes', 'no', 'new'
97+
98+
# Do the recipients (To:, Cc:) of a message get placed on the nosy list?
99+
# If 'new' is used, then the recipients will only be added when a message
100+
# creates a new issue. If 'yes', then the recipients will be added on
101+
# followups
102+
# too. If 'no', they're never added to the nosy.
103+
ADD_RECIPIENTS_TO_NOSY = 'new' # either 'yes', 'no', 'new'
104+
105+
# Where to place the email signature
106+
EMAIL_SIGNATURE_POSITION = 'bottom' # one of 'top', 'bottom', 'none'
107+
108+
# Keep email citations
109+
EMAIL_KEEP_QUOTED_TEXT = 'no' # either 'yes' or 'no'
110+
111+
# Preserve the email body as is
112+
EMAIL_LEAVE_BODY_UNCHANGED = 'no' # either 'yes' or 'no'
113+
114+
# Default class to use in the mailgw if one isn't supplied in email
115+
# subjects. To disable, comment out the variable below or leave it blank.
116+
# Examples:
117+
MAIL_DEFAULT_CLASS = 'issue' # use "issue" class by default
118+
#MAIL_DEFAULT_CLASS = '' # disable (or just comment the var out)
119+
89120

90121
Instance Schema
91122
---------------

0 commit comments

Comments
 (0)