Closed Bug 221925 Opened 23 years ago Closed 22 years ago

Different UI changes in MailNews not reflected in help

Categories

(Documentation Graveyard :: Help Viewer, defect)

defect
Not set
normal

Tracking

(Not tracked)

VERIFIED FIXED

People

(Reporter: ch.ey, Assigned: ch.ey)

References

Details

Attachments

(3 files, 6 obsolete files)

With patch for bug 135357 the "Use secure connection" UI in SMTP Settings changed. By changing the help I discovered other UI changes haven't been made it into the help file.
Attached patch proposed patch (obsolete) — — Splinter Review
Patch for this bug. I hope the help text is understandable. Please make any suggestions if not because english isn't my native language.
Attachment #133137 - Flags: review?(rlk)
Comment on attachment 133137 [details] [diff] [review] proposed patch > +<li><strong>Advanced</strong>: Lets you choose a different outgoing > +server (SMTP) for outgoing messages from this account.</li> Can we add information on the "newsrc file:" textbox in Account Settings for News after this? > +<li><strong>Automatically quote the original message when > +replying</strong>: Select this to include the original message text > +in your reply. Then use the drop-down list to select where you want > +to place your reply in the message area and whether it should be > +automatically selected.</li> This should be before the "Compose messages in HTML format" area. > +<p><b>Tip</b>: If you select this option, but you later want to > +compose a message or reply to a message using the plain-text > +editor, hold down the Shift key and click Compose or Reply in the > +Mail toolbar to temporarily choose the plain-text editor. > +Shift-clicking the Compose button or the Reply button switches to > +the other editor.</p> hmm. This sentence is a bit long. Not sure how to rephrase it, though. > +if and when yes what encryption you want to use.<br> > +Use &quot;No&quot; if don't want to use encryption.<br> > +Use &quot;TLS, if available&quot; to use a TLS (Transaction Layer Security) encrypted link if the server is capable of.<br> > +Use &quot;TLS&quot; to always use an TLS (Transaction Layer Security) encrypted link.<br> > +Use &quot;SSL&quot; to always use an SSL (Secure Sockets Layer) encrypted link.<br> > +If you are not sure which option to choose, check with your ISP or > +system administrator. </li> Can we use bullets for this? Do something like this: <li><strong>No</strong>: You do not want to use encryption in your email.</li> something like that. > +as an attachment or <i>inline</i> (in the body of your message).</li> <picky>Can we use <em> tags instead of <i> tags? Thanks!</picky> > +<li><strong>Confirm when using keyboard shortcut to send message</strong>: > +Check this option if want to be asked if you're sure to be ready to send the > +message when you're pressing Ctrl+Return in message editor.</li> where's this pref at? I can't find it.
Attachment #133137 - Flags: review?(rlk) → review-
Blocks: 115601
> Can we add information on the "newsrc file:" textbox in Account Settings for > News after this? Yes. But currently the information on "newsrc file" is displayed as a note, not a point in the list. If we're moving this between "Advanced" and "Local directory" (where it is in the UI), I'd suggest making it a <li> too. > > +<li><strong>Automatically quote the original message when > > +replying</strong>: > > This should be before the "Compose messages in HTML format" area. Er, it currently is before "Compose messages in HTML format" - you mean after (like it is in the UI), yes? > hmm. This sentence is a bit long. Not sure how to rephrase it, though. I just moved this from "Mail & Newsgroups Account Settings - Account Settings" where it was (also in the UI) before. But what about +<p><b>Tip</b>: You can temporarily use the other editor if you hold +down the Shift key and click Compose or Reply in the Mail toolbar.</p> > Can we use bullets for this? Do something like this: > <li><strong>No</strong>: You do not want to use encryption in your email.</li> Of course - done. > > +as an attachment or <i>inline</i> (in the body of your message).</li> > > <picky>Can we use <em> tags instead of <i> tags? Thanks!</picky> Of course. There are another 6 <i></i> pairs. Should I change them too? > > +<li><strong>Confirm when using keyboard shortcut to send message</strong>: > > where's this pref at? I can't find it. Preferences - Mail & Newsgroups - Composition. Not in the Mail & Newsgroups Account Settings - Composition & Addressing!
> Yes. But currently the information on "newsrc file" is displayed as a note, not > a point in the list. If we're moving this between "Advanced" and "Local > directory" (where it is in the UI), I'd suggest making it a <li> too. OK, didn't notice that. > Er, it currently is before "Compose messages in HTML format" - you mean after > (like it is in the UI), yes? In my current build (oct 11, 2003), I see that this section is before "Compose messages in HTML format" in the UI. I'd like to keep them in order with the UI (not sure if they are now, though). > Preferences - Mail & Newsgroups - Composition. Not in the Mail & Newsgroups > Account Settings - Composition & Addressing! Ah! I see it now! Thanks! > Of course. There are another 6 <i></i> pairs. Should I change them too? Yes, please. I'm trying to prevent the help doc's HTML from decaying any more than it has already. Note that documentation changes can be checked in with only a modules owner review (which is me), so once I give you an r= on a patch, I'll check it in for you.
Comment on attachment 133137 [details] [diff] [review] proposed patch quickly, the text is mostly wrong. it doesn't follow the style, later tips contradict preceding passages. you have residual text from previous incarnations of help. but most importantly, your text is not helpful. it doesn't answer any of the questions i had when i filed my bug about the specific security improvements for which you filed your bug. could you connect to irc.mozilla.org #mozilla and ask about this?
> > Yes. But currently the information on "newsrc file" is displayed as a note, not > > a point in the list. If we're moving this between "Advanced" and "Local > > directory" (where it is in the UI), I'd suggest making it a <li> too. > > OK, didn't notice that. And now? Move or not? > In my current build (oct 11, 2003), I see that this section is before "Compose > messages in HTML format" in the UI. I'd like to keep them in order with the UI > (not sure if they are now, though). No, I see "Compose messages" before "Automatically quote" in 1.5rc2, 20031011 and 20031012. See screenshot. I'll chat with timeless later on to see what he means (don't get it at the moment).
See the order of the elements.
Comment on attachment 133137 [details] [diff] [review] proposed patch review -> Daniel Wang. timeless informs me that there's lots of problems that I'm not catching.
Attachment #133137 - Flags: review- → review?(stolenclover)
-> Doc: User
Component: Help → User
Product: Browser → Documentation
Version: Trunk → unspecified
Attachment #133137 - Flags: review?(stolenclover)
Comment on attachment 133137 [details] [diff] [review] proposed patch Daniel. Can you review this? As module owner, I can give you permission to review. As long as I accept your review, I can checkin code using it. CVS access is not required (I've asked).
Attachment #133137 - Flags: review?(stolenclover)
Comment on attachment 133137 [details] [diff] [review] proposed patch oh sorry. Didn't realize that this review request was removed. Sorry for the spam!
Attachment #133137 - Flags: review?(stolenclover)
Attached patch patch v2 (obsolete) — — Splinter Review
Second try with much more changes and better wording.
Attachment #133137 - Attachment is obsolete: true
Note that you need to change the RDF if you're going to change anchor names. If you don't know how, then tell me and I'll do it.
AFAIK I didn't change anchors. But in help-toc.rdf the following line should be changed, right? - <rdf:li> <rdf:Description ID="mail_addressing_settings" nc:name="Addressing" nc:link="chrome://help/locale/mail_help.html#addressing_settings"/> </rdf:li> + <rdf:li> <rdf:Description ID="mail_addressing_settings" nc:name="Composition &amp; Addressing" nc:link="chrome://help/locale/mail_help.html#addressing_settings"/> </rdf:li> I don't have a clue what <a name="new_mail_soundSDX"></a> and <a name="new_mail_alertSDX"></a> are for.
Attached patch patch v3 (obsolete) — — Splinter Review
Some minor changes to v2 and change in help-toc.rdf added. As nobody had complained about v2 this is hopefully the final version.
Attachment #133296 - Attachment is obsolete: true
Attachment #133450 - Flags: review?(stolenclover)
The patch for bug 89212 changed the term "quoted text" to "quote". The old term is only used once in the attached patch and it is not explicitly citing the button in the interface, but only describes it. So it may be not worth the effort to create a new patch just because of this.
Thanks for the info. It's a pitty - I liked "quoted text" in the drop-down. Searching for the term "quoted text" in the help if discovered another paragraph citing this drop-down. Cause this section ("Replying to a Message") was anyway outdated, I updated it. Stefan, would you mind if I continue speaking of "quoted text" in the part you meant?
Status: NEW → ASSIGNED
Let's wait until mail_help.html is converted to XHTML before fixing this bug.
Depends on: 95770
Christian: I think it would be ok to stay with "quoted text" in this case, because it's not explicitly citing the widget. But I'm not the one to decide this. ;-) I just wanted to let you know about the change.
*** Bug 225928 has been marked as a duplicate of this bug. ***
Attachment #133450 - Flags: review?(stolenclover)
Attached patch patch v4 (obsolete) — — Splinter Review
Updated patch, mainly to make it compatible with the XHTML changes from bug 95770.
Attachment #133450 - Attachment is obsolete: true
Attachment #137315 - Flags: review?(rlk)
>+<li><strong>Use secure authentication</strong>: Choose this >+setting if you want to use secure mechanisms for logging in like >+CRAM-MD5. If you are unsure if your server supports this, <li><strong>Use secure authentication</strong>: Choose this setting if you want to log in with secure mechanisms like CRAM-MD5. If you are unsure if your server supports this, >+<li><strong>Advanced</strong>: Lets you choose a different outgoing >+server (SMTP) for outgoing messages from this account. You can also >+reach the <a href="#advanced_imap_server_settings">Advanced IMAP Server Settings</a> >+through this button.</li> remove "You can also reach the ..." part >+<li><strong>Use secure authentication</strong>: Choose this >+setting if you want to use secure mechanisms for logging in like >+CRAM-MD5 and APOP. If you are unsure if your server supports this, >+contact your service provider or system administrator.</li> why do you have two of these? >+computer or move in to another folder. This will only affect messages you grammar. "move to" >+unless you log in. Choose this setting to force Mozilla to authenticate unless you have logged in. use &brandShortName; >+each time it connects to this server although the server doesn't ask >+to (also called &quot;Pushed Authentication&quot;).</li> each time it connects to this server even when the server doesn't ask (also called &quot;Pushed Authentication&quot;).</li> >+the newsgroups to which you are subscribed, and the messages you have the newsgroups to which you are subscribed and what messages you have >+<li><strong>Compose messages in HTML format</strong>: Set the built-in >+HTML editor to be the default editor for writing mail and newsgroup >+messages. Leave this item unchecked to use the plain-text editor by default. (seems to imply you can use external editor) <li><strong>Compose messages in HTML format</strong>: Use the HTML editor for writing mail and newsgroup messages. Leave this item unchecked to use the plain-text editor by default. >+<li>From the Edit menu, choose Mail & Newsgroup Account Settings.</li> &amp; >+<li><strong>Server name</strong>: Server name: The SMTP server that should deliver >+your outgoing mail. To use a different SMTP server, change this field.</li> "should"? >+the mail server is listening for connections on a non standard port.</li> non-standard >+you want Mozilla to select the message you had selected last before leaving use &brandShortName; >+<ul> >+<li style="list-style: none"><a name="WINDOWSETTINGS"></a></li> <ul id="WINDOWSETTINGS"> >+have your changes take effect.</li> change >+<p><strong>Show an alert</strong>: Select this if you want Mozilla Mail >+&amp; Newsgroups to display a sliding alert above your system tray >+in the lower right corner of your screen when new messages arrive. >+The sliding alert only appears once when new messages arrive, and >+won't appear again until you bring the Mail &amp; Newsgroups window >+to the front.</p> use &brandShortName; We need info for Linux & Mac (this can be pushed to future) >+will take you to the first folder that has new mail. If no Mozilla use &brandShortName; >+<p>If any &brandShortName; application is running, then Quick Launch does >+not need to be enabled in order to play a sound when new messages >+arrive. For information on using Quick Launch, see <a href= >+"nav_help.html#nav_quicklaunch">Using Quick Launch</a>.</p> I think mail notification only works if you have opened Mail & Newsgroup at least once. +<p><em>12 December 2003</em></p> let's keep the <i>. same for <i>inline</i>
Attachment #137315 - Flags: review?(rlk) → review-
> remove "You can also reach the ..." part Why that? The help is for describing the elements. And opening the Advanced IMAP Settings is what the button does. > why do you have two of these? One for the IMAP panel and one for the POP panel. > >+computer or move in to another folder. This will only affect messages you > > grammar. "move to" I'd prefer "move them to" (the messages) or "move it to" (the message). "move to" reads like I'm moving to another folder. > &amp; Ups, yes. BTW, why don't we use &quot; instead of "? > We need info for Linux & Mac (this can be pushed to future) The current info would be "This feature is not available on Linux &amp; Mac." Shall I insert this? > I think mail notification only works if you have opened Mail & Newsgroup at > least once. Yes, the text is wrong. Maybe it's supposed to work even only QuickStart is active, but it doesn't. I removed these two paragraphs. > let's keep the <i>. same for <i>inline</i> Hm, now what? See R.J. Keller's comments #2 and #4 to convert all <i> into <em>. The anchors #OFFLINE_IMAP and #OFFLINE_NEWS (and links to them) have been replaced by #offline_and_disk_space_settings so we now have the same id two times. Shall I replace them by #offline_and_disk_space_settingsIMAP and #offline_and_disk_space_settingsNEWS or something like that?
>> remove "You can also reach the ..." part >Why that? The help is for describing the elements. And opening the Advanced IMAP >Settings is what the button does. I don't think the user will be interested in knowing that. Anyway, there are two <li><strong>Advanced</strong>: Lets you choose a different outgoing... and one has "you can also reach..." and one doesn't. Let's be consistent. >> We need info for Linux & Mac (this can be pushed to future) > >The current info would be "This feature is not available on Linux &amp; Mac." >Shall I insert this? okay > Hm, now what? See R.J. Keller's comments #2 and #4 to convert all <i> into > <em>. on second thought, that looks fine to me :-)
> I don't think the user will be interested in knowing that. Oh, you don't think that. So the explanation for this button could also be "The Advanced button" because I don't think it is interesting that it lets the user choose the SMTP server, yes? > Anyway, there are two <li><strong>Advanced</strong>: Lets you choose > a different outgoing... and one has "you can also reach..." and one > doesn't. Let's be consistent. Not only two, there are three. One for IMAP, one for POP3 and one for News. The Advanced buttons for POP3 and News only gives access to SMTP servers, the one for IMAP additionally to the Advance IMAP settings.
Attached patch patch v5 (obsolete) — — Splinter Review
Again new version, addresses most remarks from comment #22 and contains some anchor improvements.
Attachment #137315 - Attachment is obsolete: true
Attachment #137513 - Flags: review?(stolenclover)
+to choose your default format and quoting behaviour when composing a message. dunno about this. Keller, British English or American English? +preferences for <a href="#offline_and_disk_space_settingsIMAP">IMAP</a>, <a Keller, any problem with this anchor? +<p><strong>Play a sound</strong>: Select this if you want Mozilla Mail &amp; oops? &brandShortName; You need to change extensions/help/resources/locale/en-US/help-toc.rdf <rdf:li> <rdf:Description ID="mail_offline_imap" nc:name="IMAP" nc:link="chrome://help/locale/mail_help.xhtml#offline_and_disk_space_settings"/> </rdf:li> <rdf:li> <rdf:Description ID="mail_offline_nntp" nc:name="News" nc:link="chrome://help/locale/mail_help.xhtml#offline_and_disk_space_settings"/> </rdf:li>
> dunno about this. Keller, British English or American English? American. I think that there's another language pack for British English. So "behaviour" should be "behavior" > +preferences for <a href="#offline_and_disk_space_settingsIMAP">IMAP</a>, <a > Keller, any problem with this anchor? No, the anchor is fine. It actually fixes a bug in the mail help.
Ok, I changed this issues. I'd fix a final patch, or are there another remarks?
Blocks: 220695
Attached patch patch v6 (obsolete) — — Splinter Review
As I haven't received further comments on v5 here's the latest and hopefully last patch version against the tip of the trunk.
Attachment #137513 - Attachment is obsolete: true
Attachment #137513 - Flags: review?(stolenclover)
Attachment #138275 - Flags: review?(stolenclover)
> +Edit Card to edit the cards informations (optional).</li> "card information" > +<li><strong>Advanced</strong>: Lets you choose a different outgoing > +server (SMTP) for outgoing messages from this account.</li> nit. "outgoing (SMTP) server" ? > +in, but will silently hide all the &quot;private&quot; groups/postings <em>private</em> > +<li><strong>Bcc these email addresses</strong>: Select whether you > +want to always send a blind carbon copy (bcc) to another addressee, and > +enter the address. If you want to always send a blind carbon copy to > +yourself, just add your address to this list.</li> Add "Separate addresses with comma (,)". >+<li><strong>Compose messages in HTML format</strong>: Use the HTML editor >+as the default editor for writing mail and newsgroup messages. Leave this >+item unchecked to use the plain-text editor by default. >+HTML messages can include formatted text, links, images, and tables, just >+like a web page. However, some recipients may not be able to receive HTML >+messages.</li> >+ >+<li style="list-style: none"> >+<p><strong>Tip</strong>: If you only want to use an editor occasionally, you can >+hold down the Shift key while clicking the Compose or the Reply button >+to switch to the non-default on an as-needed basis.</p> >+</li> hmmm... rlk, <li><p>blah</p> <p><strong>Tip</strong></p> </li> ? >+<li><strong>Automatically quote the original message when >+replying</strong>: Select this to include the original message text >+in your reply.<br /> >+Use the drop-down list to select if the cursor should be positioned below >+or above the quoted text. You can also choose the quoting to be automatically >+selected. preferred style is: * *Automatically quote the...*: Select this .... o *start my reply above the quoted text*: ... o *start my reply below the quoted text*: ... o *select the quoted text* >+<p>The outgoing server will transport your outgoing mails to the grammar. "mail" > +<li><strong>Server name</strong>: Server name: loose the extra "server name:" >+<p><em>2 January 2003</em></p> 2004? :-)
> > +Edit Card to edit the cards informations (optional).</li> > "card information" This was meant to be genitive and plural, so "cards informations". But if that's wrong I'll change it. > nit. "outgoing (SMTP) server" ? The mail help mostly uses "Outgoing Server (SMTP)" as the UI does (e.g. at the bottom of the accounts list in settings). We should be consistent here. > preferred style is: > * *Automatically quote the...*: Select this .... > o *start my reply above the quoted text*: ... > o *start my reply below the quoted text*: ... > o *select the quoted text* And explain each of the three alternatives? The normal style is to list the label of the drop down as sub point but not the text of each drop down line itself. In this case this would be "This," what is not suitable so I didn't use it. To this the drop down text is self explaining, isn't it?
> hmmm... rlk, > <li><p>blah</p> > <p><strong>Tip</strong></p> > </li> ? yes, this definetely needs to be changed in the Patch to this format.
Ok, I changed this. But there are more of these <li>...</li> <li style="list-style: none"> <p>...</p> </li> The disadvantage of the other format is, that <li><p> produces a bigger gap to the upper line. That's ugly if the <li> isn't the first in this list.
The CSS has p:first-child { padding-top: 0; margin-top: 0; } that will prevent this
Er, yes indeed. I viewed the file with an old version of the CSS being active.
I'd like to continue with the work. What about my comment #32, Daniel?
>>> +Edit Card to edit the cards informations (optional).</li> >> "card information" > >This was meant to be genitive and plural, so "cards informations". But if that's >wrong I'll change it. I'm sure it's "card information" >> nit. "outgoing (SMTP) server" ? > The mail help mostly uses "Outgoing Server (SMTP)" as the UI does okay
Attached patch patch v7 — — Splinter Review
Maybe this one will please you. This incorporates the changes from the last comments and takes the changes from file version 1.24 and 1.25 into account.
Attachment #138275 - Attachment is obsolete: true
Comment on attachment 138755 [details] [diff] [review] patch v7 Daniel, review this but ignore the collision problems in the help-toc.rdf section of the Patch. I'll remove that when I apply the patch for checkin.
Attachment #138755 - Flags: review?(stolenclover)
Attachment #138275 - Flags: review?(stolenclover)
Sorry, the help-toc.rdf shouldn't have been included. That's a failure.
Attachment #138755 - Flags: review?(stolenclover) → review+
Fix checked in. Thank you for your contribution, Christian!
Status: ASSIGNED → RESOLVED
Closed: 22 years ago
Resolution: --- → FIXED
It took long time and was nerve-wracking sometimes, but thank you too. :)
Attached patch fix help-toc.rdf — — Splinter Review
rlk, the help-toc.rdf is now out of sync with the help file. Patch of bug 226188 choose ...settings_imap and ...settings_nntp and so I removed my changes from the help file - that's what I meant in comment #41. This patch fixes this.
No longer blocks: 220695
*** Bug 220695 has been marked as a duplicate of this bug. ***
Attachment #138765 - Flags: review+
Help TOC fix checked in.
Status: RESOLVED → VERIFIED
You need to log in before you can comment on or make changes to this bug.

Attachment

General

Created:
Updated:
Size: