Merge lp:~rthiels1/postorius/help_text into lp:postorius

Proposed by RThielstrom
Status: Merged
Merged at revision: 153
Proposed branch: lp:~rthiels1/postorius/help_text
Merge into: lp:postorius
Diff against target: 369 lines (+162/-31)
1 file modified
src/postorius/forms.py (+162/-31)
To merge this branch: bzr merge lp:~rthiels1/postorius/help_text
Reviewer Review Type Date Requested Status
Terri Pending
Review via email: mp+189481@code.launchpad.net

Description of the change

Fixes long help_text lines

To post a comment you must log in.

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file 'src/postorius/forms.py'
2--- src/postorius/forms.py 2013-10-05 17:47:19 +0000
3+++ src/postorius/forms.py 2013-10-05 19:34:08 +0000
4@@ -1,4 +1,4 @@
5-# -*- coding: utf-8 -*-
6+#-*- coding: utf-8 -*-
7 # Copyright (C) 2012 by the Free Software Foundation, Inc.
8 #
9 # This file is part of Postorius.
10@@ -213,13 +213,27 @@
11 widget=forms.RadioSelect,
12 required=False,
13 label= _('Include RFC2369 headers'),
14- help_text=_('Yes is highly recommended. RFC 2369 defines a set of List-* headers that are normally added to every message sent to the list membership. These greatly aid end-users who are using standards compliant mail readers. They should normally always be enabled.However, not all mail readers are standards compliant yet, and if you have a large number of members who are using non-compliant mail readers, they may be annoyed at these headers. You should first try to educate your members as to why these headers exist, and how to hide them in their mail clients. As a last resort you can disable these headers, but this is not recommended (and in fact, your ability to disable these headers may eventually go away).'))
15+ help_text=_(
16+ 'Yes is highly recommended. RFC 2369 defines a set of List-* '
17+ 'headers that are normally added to every message sent to the list '
18+ 'membership. These greatly aid end-users who are using standards '
19+ 'compliant mail readers. They should normally always be enabled. '
20+ 'However, not all mail readers are standards compliant yet, and if '
21+ 'you have a large number of members who are using non-compliant '
22+ 'mail readers, they may be annoyed at these headers. You should '
23+ 'first try to educate your members as to why these headers exist, '
24+ 'and how to hide them in their mail clients. As a last resort you '
25+ 'can disable these headers, but this is not recommended '
26+ '(and in fact, your ability to disable these headers may '
27+ 'eventually go away).'))
28 allow_list_posts = forms.TypedChoiceField(
29 choices=choices,
30 widget=forms.RadioSelect,
31 label=_("Include the list post header"),
32 help_text=_(
33- "This can be set to no for announce lists that do not wish to include the List-Post header because posting to the list is discouraged."),
34+ "This can be set to no for announce lists that do not wish to "
35+ "include the List-Post header because posting to the list is "
36+ "discouraged."),
37 )
38 archive_policy_choices = (
39 ("public", _("Public Archives")),
40@@ -240,7 +254,9 @@
41 choices=autorespond_choices,
42 widget=forms.RadioSelect,
43 label=_('Autorespond to list owner'),
44- help_text=('Should Mailman send an auto-response to emails sent to the -owner address?'))
45+ help_text=(
46+ 'Should Mailman send an auto-response to emails sent to the '
47+ '-owner address?'))
48 autoresponse_owner_text = forms.CharField(
49 label=_('Autoresponse owner text'),
50 widget=forms.Textarea(),
51@@ -250,7 +266,8 @@
52 choices=autorespond_choices,
53 widget=forms.RadioSelect,
54 label=_('Autorespond postings'),
55- help_text=('Should Mailman send an auto-response to mailing list posters?'))
56+ help_text=(
57+ 'Should Mailman send an auto-response to mailing list posters?'))
58 autoresponse_postings_text = forms.CharField(
59 label=_('Autoresponse postings text'),
60 widget=forms.Textarea(),
61@@ -260,7 +277,11 @@
62 choices=autorespond_choices,
63 widget=forms.RadioSelect,
64 label=_('Autorespond requests'),
65- help_text=('Should Mailman send an auto-response to emails sent to the -request address? If you choose yes, decide whether you want Mailman to discard the original email, or forward it on to the system as a normal mail command.'))
66+ help_text=(
67+ 'Should Mailman send an auto-response to emails sent to the '
68+ '-request address? If you choose yes, decide whether you want '
69+ 'Mailman to discard the original email, or forward it on to the '
70+ 'system as a normal mail command.'))
71 autoresponse_request_text = forms.CharField(
72 label=_('Autoresponse request text'),
73 widget=forms.Textarea(),
74@@ -268,7 +289,11 @@
75 help_text=('Auto-response text to send to -request emails.'))
76 autoresponse_grace_period = forms.CharField(
77 label=_('Autoresponse grace period'),
78- help_text=('Number of days between auto-responses to either the mailing list or -request/-owner address from the same poster. Set to zero (or negative) for no grace period (i.e. auto-respond to every message).'))
79+ help_text=(
80+ 'Number of days between auto-responses to either the mailing list '
81+ 'or -request/-owner address from the same poster. Set to zero '
82+ '(or negative) for no grace period (i.e. auto-respond to every '
83+ 'message).'))
84 # This doesn't make sense as a configurable, so we're leaving it out
85 # bounces_address = forms.EmailField(
86 # label=_('Bounces Address'),
87@@ -278,28 +303,35 @@
88 choices=((True, _('Yes')), (False, _('No'))),
89 widget=forms.RadioSelect,
90 label=_('Advertise the existance of this list?'),
91- help_text=('Choose whether to include this list on the list of all lists'))
92+ help_text=(
93+ 'Choose whether to include this list on the list of all lists'))
94 filter_content = forms.TypedChoiceField(
95 coerce=lambda x: x == 'True',
96 choices=((True, _('Yes')), (False, _('No'))),
97 widget=forms.RadioSelect,
98 required=False,
99 label=_('Filter content'),
100- help_text=('Should Mailman filter the content of list traffic according to the settings below?'))
101+ help_text=(
102+ 'Should Mailman filter the content of list traffic according to '
103+ 'the settings below?'))
104 collapse_alternatives = forms.TypedChoiceField(
105 coerce=lambda x: x == 'True',
106 choices=((True, _('Yes')), (False, _('No'))),
107 widget=forms.RadioSelect,
108 required=False,
109 label=_('Collapse alternatives'),
110- help_text=('Should Mailman collapse multipart/alternative to its first part content?'))
111+ help_text=(
112+ 'Should Mailman collapse multipart/alternative to its first part '
113+ 'content?'))
114 convert_html_to_plaintext = forms.TypedChoiceField(
115 coerce=lambda x: x == 'True',
116 choices=((True, _('Yes')), (False, _('No'))),
117 widget=forms.RadioSelect,
118 required=False,
119 label=_('Convert html to plaintext'),
120- help_text=('Should Mailman convert text/html parts to plain text? This conversion happens after MIME attachments have been stripped.'))
121+ help_text=(
122+ 'Should Mailman convert text/html parts to plain text? This '
123+ 'conversion happens after MIME attachments have been stripped.'))
124 action_choices = (
125 ("hold", _("Hold for moderator")),
126 ("reject", _("Reject (with notification)")),
127@@ -313,7 +345,17 @@
128 'required': _("Please choose a default member action.")},
129 required=True,
130 choices=action_choices,
131- help_text=('Default action to take when a member posts to the list.Hold -- This holds the message for approval by the list moderators. Reject -- this automatically rejects the message by sending a bounce notice to the post\'s author. The text of the bounce notice can be configured by you. Discard -- this simply discards the message, with no notice sent to the post\'s author. Accept --accepts any postings to the list by default. Defer -- Defers any postings to the list by default. '))
132+ help_text=(
133+ 'Default action to take when a member posts to the list. '
134+ 'Hold -- This holds the message for approval by the list '
135+ 'moderators.'
136+ 'Reject -- this automatically rejects the message by sending a '
137+ 'bounce notice to the post\'s author. The text of the bounce '
138+ 'notice can be configured by you. '
139+ 'Discard -- this simply discards the message, with no notice '
140+ 'sent to the post\'s author. '
141+ 'Accept --accepts any postings to the list by default. '
142+ 'Defer -- Defers any postings to the list by default. '))
143 default_nonmember_action = forms.ChoiceField(
144 widget=forms.RadioSelect(),
145 label=_('Default action to take when a non-member posts to the'
146@@ -322,11 +364,18 @@
147 'required': _("Please choose a default non-member action.")},
148 required=True,
149 choices=action_choices,
150- help_text=('When a post from a non-member is received, the message\'s sender is matched against the list of explicitly accepted, held, rejected (bounced), and discarded addresses. If no match is found, then this action is taken.'))
151+ help_text=(
152+ 'When a post from a non-member is received, the message\'s sender '
153+ 'is matched against the list of explicitly accepted, held, '
154+ 'rejected (bounced), and discarded addresses. '
155+ 'If no match is found, then this action is taken.'))
156 description = forms.CharField(
157 label=_('Description'),
158 help_text=(
159- 'This description is used when the mailing list is listed with other mailing lists, or in headers, and so forth. It should be as succinct as you can get it, while still identifying what the list is.'),
160+ 'This description is used when the mailing list is listed with '
161+ 'other mailing lists, or in headers, and so forth. It should be '
162+ 'as succinct as you can get it, while still identifying what the '
163+ 'list is.'),
164 widget=forms.Textarea())
165 digest_size_threshold = forms.DecimalField(
166 label=_('Digest size threshold'),
167@@ -344,7 +393,9 @@
168 widget=forms.RadioSelect,
169 required=False,
170 help_text=_(
171- 'Should any existing Reply-To: header found in the original message be stripped? If so, this will be done regardless of whether an explict Reply-To: header is added by Mailman or not.')
172+ 'Should any existing Reply-To: header found in the original '
173+ 'message be stripped? If so, this will be done regardless of '
174+ 'whether an explict Reply-To: header is added by Mailman or not.')
175 )
176 generic_nonmember_action = forms.IntegerField(
177 label=_('Generic nonmember action'),
178@@ -357,7 +408,12 @@
179 error_messages={'required': _('Please a domain name'),
180 'invalid': _('Please enter a valid domain name.')},
181 required=True,
182- help_text="The \"host_name\" is the preferred name for email to mailman-related addresses on this host, and generally should be the mail host's exchanger address, if any. This setting can be useful for selecting among alternative names of a host that has multiple addresses.")
183+ help_text=(
184+ "The \"host_name\" is the preferred name for email to "
185+ "'mailman-related addresses on this host, and generally should be "
186+ "the mail host's exchanger address, if any. This setting can be "
187+ "useful for selecting among alternative names of a host that "
188+ "has multiple addresses."))
189 # informational, not editable
190 # next_digest_number = forms.IntegerField(
191 # label=_('Next digest number'),
192@@ -399,12 +455,36 @@
193 ("no_munging", _("No Munging")),
194 ("point_to_list", _("Reply goes to list")),
195 ("explicit_header", _("Explicit Reply-to header set"))),
196- help_text=('Where are replies to list messages directed? No Munging is strongly recommended for most mailing lists. \nThis option controls what Mailman does to the Reply-To: header in messages flowing through this mailing list. When set to No Munging, no Reply-To: header is added by Mailman, although if one is present in the original message, it is not stripped. Setting this value to either Reply to List or Explicit Reply causes Mailman to insert a specific Reply-To: header in all messages, overriding the header in the original message if necessary (Explicit Reply inserts the value of reply_to_address).There are many reasons not to introduce or override the Reply-To: header. One is that some posters depend on their own Reply-To: settings to convey their valid return address. Another is that modifying Reply-To: makes it much more difficult to send private replies. See `Reply-To\' Munging Considered Harmful for a general discussion of this issue. See Reply-To Munging Considered Useful for a dissenting opinion.Some mailing lists have restricted posting privileges, with a parallel list devoted to discussions. Examples are `patches\' or `checkin\' lists, where software changes are posted by a revision control system, but discussion about the changes occurs on a developers mailing list. To support these types of mailing lists, select Explicit Reply and set the Reply-To: address option to point to the parallel list. '))
197+ help_text=(
198+ 'Where are replies to list messages directed? No Munging is strongly '
199+ 'recommended for most mailing lists. \nThis option controls what '
200+ 'Mailman does to the Reply-To: header in messages flowing through '
201+ 'this mailing list. When set to No Munging, no Reply-To: header is '
202+ 'added by Mailman, although if one is present in the original '
203+ 'message, it is not stripped. Setting this value to either Reply to '
204+ 'List or Explicit Reply causes Mailman to insert a specific Reply-To: '
205+ 'header in all messages, overriding the header in the original '
206+ 'message if necessary (Explicit Reply inserts the value of '
207+ 'reply_to_address). There are many reasons not to introduce or '
208+ 'override the Reply-To: header. One is that some posters depend on '
209+ 'their own Reply-To: settings to convey their valid return address. '
210+ 'Another is that modifying Reply-To: makes it much more difficult to '
211+ 'send private replies. See `Reply-To\' Munging Considered Harmful for '
212+ 'a general discussion of this issue. See Reply-To Munging Considered '
213+ 'Useful for a dissenting opinion.Some mailing lists have restricted '
214+ 'posting privileges, with a parallel list devoted to discussions. '
215+ 'Examples are `patches\' or `checkin\' lists, where software changes '
216+ 'are posted by a revision control system, but discussion about the '
217+ 'changes occurs on a developers mailing list. To support these types '
218+ 'of mailing lists, select Explicit Reply and set the Reply-To: '
219+ 'address option to point to the parallel list. '))
220 reply_to_address = forms.CharField(
221 label=_('Explicit reply-to address'),
222 required=False,
223 help_text=_(
224- 'This option allows admins to set an explicit Reply-to address. It is only used if the reply-to is set to use an explicitly set header'),
225+ 'This option allows admins to set an explicit Reply-to address. '
226+ 'It is only used if the reply-to is set to use an explicitly set '
227+ 'header'),
228 )
229 # informational, not editable
230 # request_address = forms.EmailField(
231@@ -416,11 +496,17 @@
232 widget=forms.RadioSelect,
233 required=False,
234 label=_('Send welcome message'),
235- help_text=('Send welcome message to newly subscribed members?Turn this off only if you plan on subscribing people manually and don\'t want them to know that you did so. This option is most useful for transparently migrating lists from some other mailing list manager to Mailman.'))
236+ help_text=(
237+ 'Send welcome message to newly subscribed members? '
238+ 'Turn this off only if you plan on subscribing people manually '
239+ 'and don\'t want them to know that you did so. This option is most '
240+ 'useful for transparently migrating lists from some other mailing '
241+ 'list manager to Mailman.'))
242 welcome_message_uri = forms.CharField(
243 label=_('URI for the welcome message'),
244 help_text=_(
245- 'If a welcome message is to be sent to subscribers, you can specify a URI that gives the text of this message.'),
246+ 'If a welcome message is to be sent to subscribers, you can '
247+ 'specify a URI that gives the text of this message.'),
248 )
249 # tko - look this up
250 # scheme = forms.CharField(
251@@ -430,29 +516,51 @@
252 widget=forms.Textarea(),
253 label=_("Acceptable aliases"),
254 required=False,
255- help_text=('Alias names which qualify as explicit to or cc destination names for this list.Alternate addresses that are acceptable when `require_explicit_destination\' is enabled. This option takes a list of regular expressions, one per line, which is matched against every recipient address in the message. The matching is performed with Python\'s re.match() function, meaning they are anchored to the start of the string.'))
256+ help_text=(
257+ 'Alias names which qualify as explicit to or cc destination names '
258+ 'for this list. Alternate addresses that are acceptable when '
259+ '`require_explicit_destination\' is enabled. This option takes a '
260+ 'list of regular expressions, one per line, which is matched against '
261+ 'every recipient address in the message. The matching is performed '
262+ 'with Python\'s re.match() function, meaning they are anchored to '
263+ 'the start of the string.'))
264 admin_immed_notify = forms.BooleanField(
265 widget=forms.RadioSelect(choices=choices),
266 required=False,
267 label=_('Admin immed notify'),
268- help_text=('Should the list moderators get immediate notice of new requests, as well as daily notices about collected ones? List moderators (and list administrators) are sent daily reminders of requests pending approval, like subscriptions to a moderated list, or postings that are being held for one reason or another. Setting this option causes notices to be sent immediately on the arrival of new requests as well. '))
269+ help_text=(
270+ 'Should the list moderators get immediate notice of new requests, '
271+ 'as well as daily notices about collected ones? List moderators '
272+ '(and list administrators) are sent daily reminders of requests '
273+ 'pending approval, like subscriptions to a moderated list, '
274+ 'or postings that are being held for one reason or another. '
275+ 'Setting this option causes notices to be sent immediately on the '
276+ 'arrival of new requests as well. '))
277 admin_notify_mchanges = forms.BooleanField(
278 widget=forms.RadioSelect(choices=choices),
279 required=False,
280 label=_('Notify admin of membership changes'),
281- help_text=('Should administrator get notices of subscribes and unsubscribes?'))
282+ help_text=(
283+ 'Should administrator get notices of subscribes and unsubscribes?'))
284 administrivia = forms.BooleanField(
285 widget=forms.RadioSelect(choices=choices),
286 required=False,
287 label=_('Administrivia'),
288- help_text=('Administrivia tests will check postings to see whether it\'s really meant as an administrative request (like subscribe, unsubscribe, etc), and will add it to the the administrative requests queue, notifying the administrator of the new request, in the process.'))
289+ help_text=(
290+ 'Administrivia tests will check postings to see whether it\'s '
291+ 'really meant as an administrative request (like subscribe, '
292+ 'unsubscribe, etc), and will add it to the the administrative '
293+ 'requests queue, notifying the administrator of the new request, '
294+ 'in the process.'))
295 anonymous_list = forms.TypedChoiceField(
296 coerce=lambda x: x == 'True',
297 choices=((True, _('Yes')), (False, _('No'))),
298 widget=forms.RadioSelect,
299 required=False,
300 label=_('Anonymous list'),
301- help_text=('Hide the sender of a message, replacing it with the list address (Removes From, Sender and Reply-To fields)'))
302+ help_text=(
303+ 'Hide the sender of a message, replacing it with the list address '
304+ '(Removes From, Sender and Reply-To fields)'))
305 # Informational field, not needed.
306 # created_at = forms.IntegerField(
307 # label=_('Created at'),
308@@ -624,33 +732,56 @@
309 choices=delivery_status_choices,
310 required=False,
311 label=_('Delivery status'),
312- help_text=_('Set this option to Enabled to receive messages posted to this mailing list. Set it to Disabled if you want to stay subscribed, but don\'t want mail delivered to you for a while (e.g. you\'re going on vacation). If you disable mail delivery, don\'t forget to re-enable it when you come back; it will not be automatically re-enabled.'))
313+ help_text=_(
314+ 'Set this option to Enabled to receive messages posted to this '
315+ 'mailing list. Set it to Disabled if you want to stay subscribed, '
316+ 'but don\'t want mail delivered to you for a while (e.g. you\'re '
317+ 'going on vacation). If you disable mail delivery, don\'t forget to '
318+ 're-enable it when you come back; it will not be automatically
319+ 're-enabled.'))
320 delivery_mode = forms.ChoiceField(
321 widget=forms.Select(),
322 choices=delivery_mode_choices,
323 required=False,
324 label=_('Delivery mode'),
325- help_text=_('If you select summary digests , you\'ll get posts bundled together (usually one per day but possibly more on busy lists), instead of singly when they\'re sent. Your mail reader may or may not support MIME digests. In general MIME digests are preferred, but if you have a problem reading them, select plain text digests.'))
326+ help_text=_(
327+ 'If you select summary digests , you\'ll get posts bundled together '
328+ '(usually one per day but possibly more on busy lists), instead of '
329+ 'singly when they\'re sent. Your mail reader may or may not support '
330+ 'MIME digests. In general MIME digests are preferred, but if you '
331+ 'have a problem reading them, select plain text digests.'))
332 receive_own_postings = forms.BooleanField(
333 widget=forms.RadioSelect(choices=choices),
334 required=False,
335 label=_('Receive own postings'),
336- help_text=_('Ordinarily, you will get a copy of every message you post to the list. If you don\'t want to receive this copy, set this option to No'))
337+ help_text=_(
338+ 'Ordinarily, you will get a copy of every message you post to the '
339+ 'list. If you don\'t want to receive this copy, set this option to No'
340+ ))
341 acknowledge_posts = forms.BooleanField(
342 widget=forms.RadioSelect(choices=choices),
343 required=False,
344 label=_('Acknowledge posts'),
345- help_text=_('Receive acknowledgement mail when you send mail to the list?'))
346+ help_text=_(
347+ 'Receive acknowledgement mail when you send mail to the list?'))
348 hide_address = forms.BooleanField(
349 widget=forms.RadioSelect(choices=choices),
350 required=False,
351 label=_('Hide address'),
352- help_text=_('When someone views the list membership, your email address is normally shown (in an obscured fashion to thwart spam harvesters). If you do not want your email address to show up on this membership roster at all, select Yes for this option.'))
353+ help_text=_(
354+ 'When someone views the list membership, your email address is '
355+ 'normally shown (in an obscured fashion to thwart spam harvesters). '
356+ 'If you do not want your email address to show up on this '
357+ 'membership roster at all, select Yes for this option.'))
358 receive_list_copy = forms.BooleanField(
359 widget=forms.RadioSelect(choices=choices),
360 required=False,
361 label=_('Receive list copy'),
362- help_text=_('When you are listed explicitly in the To: or Cc: headers of a list message, you can opt to not receive another copy from the mailing list. Select Yes to avoid receiving copies from the mailing list; select No to receive copies. '))
363+ help_text=_(
364+ 'When you are listed explicitly in the To: or Cc: headers of a '
365+ 'list message, you can opt to not receive another copy from the '
366+ 'mailing list. Select Yes to avoid receiving copies from the '
367+ 'mailing list; select No to receive copies. '))
368
369 class Meta:
370

Subscribers

People subscribed via source and target branches