Merge lp:~stylistica/postorius/inline_helptext into lp:postorius

[Sneha Priscilla]

Added inline help text for the 'more info' mouseover for each option in the list's settings.

[Terri (terriko)]

Sorry it took so long to review, but this (of course!) looks great and we're merging it in today.

review: Approve

=== modified file 'src/postorius/forms.py'
--- src/postorius/forms.py	2012-12-31 19:14:28 +0000
+++ src/postorius/forms.py	2013-01-03 08:08:26 +0000
@@ -208,7 +208,8 @@
         choices=((True, _('Yes')), (False, _('No'))),
         widget=forms.RadioSelect,
         required=False,
-        label= _('Include RFC2369 headers'))
+        label= _('Include RFC2369 headers'),
+	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).'))
     autorespond_choices = (
         ("respond_and_continue", _("Respond and continue processing")),
         ("respond_and_discard", _("Respond and discard message")),
@@ -216,29 +217,36 @@
     autorespond_owner = forms.ChoiceField(
         choices=autorespond_choices,
         widget=forms.RadioSelect,
-        label=_('Autorespond to list owner'))
+        label=_('Autorespond to list owner'),
+	help_text=('Should Mailman send an auto-response to emails sent to the -owner address?'))
     autoresponse_owner_text = forms.CharField(
         label=_('Autoresponse owner text'),
         widget=forms.Textarea(),
-        required=False)
+        required=False,
+	help_text=('Auto-response text to send to -owner emails.'))
     autorespond_postings = forms.ChoiceField(
         choices=autorespond_choices,
         widget=forms.RadioSelect,
-        label=_('Autorespond postings'))
+        label=_('Autorespond postings'),
+        help_text=('Should Mailman send an auto-response to mailing list posters?'))
     autoresponse_postings_text = forms.CharField(
         label=_('Autoresponse postings text'),
         widget=forms.Textarea(),
-        required=False)
+        required=False,
+        help_text=('Auto-response text to send to mailing list posters.'))
     autorespond_requests = forms.ChoiceField(
         choices=autorespond_choices,
         widget=forms.RadioSelect,
-        label=_('Autorespond requests'))
+        label=_('Autorespond requests'),
+        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.'))
     autoresponse_request_text = forms.CharField(
         label=_('Autoresponse request text'),
         widget=forms.Textarea(),
-        required=False)
+        required=False,
+        help_text=('Auto-response text to send to -request emails.'))
     autoresponse_grace_period = forms.CharField(
-        label=_('Autoresponse grace period'))
+        label=_('Autoresponse grace period'),
+        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).'))
     bounces_address = forms.EmailField(
         label=_('Bounces Address'),
         required=False)
@@ -253,19 +261,22 @@
         choices=((True, _('Yes')), (False, _('No'))),
         widget=forms.RadioSelect,
         required=False,
-        label=_('Filter content'))
+        label=_('Filter content'),
+	help_text=('Should Mailman filter the content of list traffic according to the settings below?'))
     collapse_alternatives = forms.TypedChoiceField(
         coerce=lambda x: x == 'True',
         choices=((True, _('Yes')), (False, _('No'))),
         widget=forms.RadioSelect,
         required=False,
-        label=_('Collapse alternatives'))
+        label=_('Collapse alternatives'),
+	help_text=('Should Mailman collapse multipart/alternative to its first part content?'))
     convert_html_to_plaintext = forms.TypedChoiceField(
         coerce=lambda x: x == 'True',
         choices=((True, _('Yes')), (False, _('No'))),
         widget=forms.RadioSelect,
         required=False,
-        label=_('Convert html to plaintext'))
+        label=_('Convert html to plaintext'),
+	help_text=('Should Mailman convert text/html parts to plain text? This conversion happens after MIME attachments have been stripped.'))
     action_choices = (
         ("hold", _("Hold for moderator")),
         ("reject", _("Reject (with notification)")),
@@ -278,7 +289,8 @@
         error_messages={
             'required': _("Please choose a default member action.")},
         required=True,
-        choices=action_choices)
+        choices=action_choices,
+	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. '))
     default_nonmember_action = forms.ChoiceField(
         widget=forms.RadioSelect(),
         label=_('Default action to take when a non-member posts to the'
@@ -286,13 +298,15 @@
         error_messages={
             'required': _("Please choose a default non-member action.")},
         required=True,
-        choices=action_choices)
+        choices=action_choices,
+	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.'))
     description = forms.CharField(
         label=_('Description'),
         help_text=('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.'),
         widget=forms.Textarea())
     digest_size_threshold = forms.DecimalField(
         label=_('Digest size threshold'),
+        help_text=('How big in Kb should a digest be before it gets sent out?')
     )
     digest_last_sent_at = forms.IntegerField(
         label=_('Digest last sent at'),
@@ -324,6 +338,7 @@
     )
     posting_pipeline = forms.CharField(
         label=_('Pipeline'),
+	help_text=('Type of pipeline you want to use for this mailing list')
     )
     post_id = forms.IntegerField(
         label=_('Post ID'),
@@ -347,7 +362,8 @@
         choices=(
             ("no_munging", _("No Munging")),
             ("point_to_list", _("Reply goes to list")),
-            ("explicit_header", _("Explicit Reply-to header set"))))
+            ("explicit_header", _("Explicit Reply-to header set"))),
+	help_text=('Where are replies to list messages directed? No Munging  is strongly recommended for most mailing lists.This 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.  '))
     request_address = forms.EmailField(
         label=_('Request address'),
         required=False)
@@ -356,32 +372,38 @@
         choices=((True, _('Yes')), (False, _('No'))),
         widget=forms.RadioSelect,
         required=False,
-        label=_('Send welcome message'))
+        label=_('Send welcome message'),
+        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.'))
     scheme = forms.CharField(
         label=_('Scheme'),
         required=False)
     acceptable_aliases = forms.CharField(
         widget=forms.Textarea(),
         label=_("Acceptable aliases"),
-        required=False)
+        required=False,
+	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.')) 
     admin_immed_notify = forms.BooleanField(
         widget=forms.RadioSelect(choices=choices),
         required=False,
-        label=_('Admin immed notify'))
+        label=_('Admin immed notify'),
+        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. '))
     admin_notify_mchanges = forms.BooleanField(
         widget=forms.RadioSelect(choices=choices),
         required=False,
-        label=_('Notify admin of membership changes'))
+        label=_('Notify admin of membership changes'),
+        help_text=('Should administrator get notices of subscribes and unsubscribes?'))
     administrivia = forms.BooleanField(
         widget=forms.RadioSelect(choices=choices),
         required=False,
-        label=_('Administrivia'))
+        label=_('Administrivia'),
+	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.'))
     anonymous_list = forms.TypedChoiceField(
         coerce=lambda x: x == 'True',
         choices=((True, _('Yes')), (False, _('No'))),
         widget=forms.RadioSelect,
         required=False,
-        label=_('Anonymous list'))
+        label=_('Anonymous list'),
+	help_text=('Hide the sender of a message, replacing it with the list address (Removes From, Sender and Reply-To fields)'))
     created_at = forms.IntegerField(
         label=_('Created at'),
         widget=forms.HiddenInput(),