489169 - Help update for signature-related settings in Composition & Addressing

Status: RESOLVED FIXED

(SeaMonkey :: Help Documentation, defect)

Description

[rsx11m]

This covers recent changes in the Composition & Addressing settings introduced
by bug 167319 and bug 273114 for signature placement and new options to omit
the signature when replying to or forwarding a message. It also extends the
additions made already in bug 324495 by a link to these new settings.

Comment 1

[rsx11m]

Attachment: Proposed updates

Note that the "Include signature for..." descriptions are grouped into their
own <ul>, to get some distance to the reply options above. For the latter, this also changes "selectable" to "applicable" to be neutral to the still pending
bug 277187, thus no further updates would be needed once that bug has landed.

Comment 2

[Stefan [:stefanh]]

Thanks for the patch. I'll have a look at it later this week.

Comment 3

[Stefan [:stefanh]]

+  <li>You can optionally <a href="#addressing">omit the signature</a>
+    when replying.</li>
   <li>Click OK.</li>
 </ol>

I don't think we should have this as a list item, better just use "<strong>Note<strong/>: ". Maybe also say "Replying to a message"

+  <li>You can optionally <a href="#addressing">omit the signature</a>
+    when forwarding. The placement of the signature if forwarding inline
+    depends on the respective reply setting.</li>

Same as above (no list item). I've been looking at the last sentense for a while and I think it would be better if it started with "When forwarding...". Of course, the problem here is that you don't want to repeat "forwarding". However, I think we can fix this if you put "You can optionally..." last. Then you can start the seciton like this: "When forwarding a message inline, the placement of the signature depends on the respective reply settings." Note also that we should probably say something like "If you have created..." like in the replying section.

-    the signature box. Click Choose to locate the signature file (optional).</li>
+    the signature box. Click Choose to locate the signature file (optional).
+    <p>
+      More signature options are located in <a href="#addressing">Composition
+      &amp; Addressing</a>.
+    </p>
+  </li>

Put one blank line above the <p> and start the sentense just after the <p>

+<ul>
+  <li><strong>Include signature for replies</strong>: When replying and a
+    signature is defined, it will be added if this box is checked.
I think it'll feel more active if you wrote something like "If a signature is defined, select this to include it in your reply." or maybe "If you have created a signature, select this..." or "Select this to add a already defined signature to messages you're replying to."
+    Your signature is placed according to selection for quote and signature
+    placement. Uncheck this box to omit the signature.</li>
Do we need the "Uncheck..." part?

+  <li><strong>Include signature for forwards</strong>: When forwarding a
+    message and this box is checked, the signature is added if defined.
Something similar to the above, I think (more active).

+    When <a href="#composition">forwarding inline</a>, the signature is added
+    according to your reply settings. Uncheck this box to omit the signature.

See previous comment about the "Uncheck" part.

I see that the Composition & Addressing section lacks an intro. That is, some sentence about what the settings does and a "If you're not already viewing... part" - for some odd reason the Addressing part has this instead. But we can do that in another bug.

Comment 4

[Stefan [:stefanh]]

Comment on attachment 373657 [details] [diff] [review]
Proposed updates

I'm minusing this for now - will need a new patch.

Comment 5

[rsx11m]

Attachment: Proposed updates (v2)

(In reply to comment #3)
> I see that the Composition & Addressing section lacks an intro. That is, some
> sentence about what the settings does and a "If you're not already viewing...
> part" - for some odd reason the Addressing part has this instead. But we can do
> that in another bug.

The initial description was there already and only needed the signature part added, thus only the enumerated list was needed which is rather standard.
I've copy-pasted those items to the right place in the Composition intro.

Comment 6

[rsx11m]

Having had another look at the patch, this is a bit inconsistent (2nd parts):

> +  <li><strong>Include signature for replies</strong>: If you have created a
> +    signature, check this box to include it in your reply to a message. Your
> +    signature is added according to selections for quote and signature
> +    placement.</li>
> +  <li><strong>Include signature for forwards</strong>: If you have created a
> +    signature, check this box to include it when you forward a message.
> +    The signature is placed according to your reply settings when
> +    <a href="#composition">forwarding inline</a>.</li>

Do you prefer "The signature ... according to your settings" or "Your signature ... according to the settings" instead? The former emphasizes the settings, the latter the signature as being yours.

Comment 7

[Stefan [:stefanh]]

(In reply to comment #6)
> Having had another look at the patch, this is a bit inconsistent (2nd parts):
> 
> > +  <li><strong>Include signature for replies</strong>: If you have created a
> > +    signature, check this box to include it in your reply to a message. Your
> > +    signature is added according to selections for quote and signature
> > +    placement.</li>
> > +  <li><strong>Include signature for forwards</strong>: If you have created a
> > +    signature, check this box to include it when you forward a message.
> > +    The signature is placed according to your reply settings when
> > +    <a href="#composition">forwarding inline</a>.</li>
> 
> Do you prefer "The signature ... according to your settings" or "Your signature
> ... according to the settings" instead? The former emphasizes the settings, the
> latter the signature as being yours.

I think I prefer "The signature ... according to your settings"

Comment 8

[rsx11m]

Attachment: Proposed updates (v3)

Updated patch per comment #7.

Comment 9

[Stefan [:stefanh]]

Comment on attachment 374620 [details] [diff] [review]
Proposed updates (v3)

Just a few nits:

+    <p>More signature options are located in <a href="#addressing">Composition
+      &amp; Addressing</a>.
+    </p>

Put the </p> after the </a> ;-)

+    signature, check this box

we don't use "check this box" in any other place, so I'd prefer something else here, like "select this option" (2 instances) instead.

+    The signature is placed according to your reply settings when
+    <a href="#composition">forwarding inline</a>.</li>

Since the condition for placement according to the reply setting is that you forward the message inline, I wonder if we should emphasize that a bit more? What do you think about saying "When forwarding a message inline, the signature is placed according to your ..."? It could be me, so it's OK if you want to keep the current text.

Comment 10

[rsx11m]

Attachment: Final patch

(In reply to comment #9)
> Since the condition for placement according to the reply setting is that you
> forward the message inline, I wonder if we should emphasize that a bit more?
> What do you think about saying "When forwarding a message inline, the signature
> is placed according to your ..."?

I had switched those to avoid "When forwarding..." back to back with the previous sentence. Since "forwarding inline" is emphasized by the link, I don't think it would get lost in its current way.

All other comments on v3 addressed, so that should be it now.

Comment 11

[rsx11m]

Push attachment 374666 [details] [diff] [review] for comm-central, please.

Comment 12

[Stefan [:stefanh]]

Pushed as http://hg.mozilla.org/comm-central/rev/40874eb5be0f. Thanks!