344893 - Align (c) lines between branch and trunk (and minor cleanups)

Status: RESOLVED FIXED

(SeaMonkey :: Help Documentation, defect)

Description

[Giacomo Magnini]

User-Agent:       Mozilla/5.0 (X11; U; Linux i686; it; rv:1.8.0.4) Gecko/20060614 Fedora/1.5.0.4-1.2.fc5 Firefox/1.5.0.4 pango-text
Build Identifier: Mozilla/5.0 (X11; U; Linux i686; it; rv:1.8.0.4) Gecko/20060614 Fedora/1.5.0.4-1.2.fc5 Firefox/1.5.0.4 pango-text

SM 1.0.x has all of the (c) lines aligned to 2006, while trunk has still some files relative to 2005.


Reproducible: Always

Comment 1

[Giacomo Magnini]

Attachment: Update the (c) lines to align the to branch (checked into trunk/1.8 branch)

Missing from patch (but still need updating the (c) lines):
- passwords_help.xhtml
- privacy_help-xhtml
Will address those in separate bugs (they need some changes in the content too).

Comment 2

[Giacomo Magnini]

Attachment: Patch for privacy_help (checked into trunk/1.8 branch)

Changes:
- added link to cs_nav_prefs_popup (as shown in help-toc panel)
- fixed a wrongly named anchor
- aligned (c) line to branch

Comment 3

[Giacomo Magnini]

Attachment: mail_help cleanup after junk mail rewrite

Comment 4

[Giacomo Magnini]

Attachment: Correct mail_help patch

Comment 5

[Giacomo Magnini]

Attachment: passwords_help fix

Changes:
- align (c) line
- reworked description of master passwords dialogs and options

Comment 6

[Giacomo Magnini]

Comment on attachment 229436 [details] [diff] [review]
Update the (c) lines to align the to branch (checked into trunk/1.8 branch)

Ian, could you please review all of the patches? Not a very big deal (except passwords_fix maybe).

Comment 7

[Ian Neal]

Comment on attachment 229622 [details] [diff] [review]
Correct mail_help patch

>@@ -553,13 +553,15 @@
>     no subcategories are visible, double-click Mail & Newsgroups to
>     expand the list.)</li>
>   <li>In the General section, do one of the following:
>-    <ul>To allow all remote content, uncheck <q>Block images and other content
>-      from remote sources</q>.</ul>
>-    <ul>To block all remote content, uncheck <q>but allow if the sender is in
>-      this address book:</q>.</ul>
>-    <ul>To change which address book you use for people who send messages that
>-      are allowed to display remote content, select the correct address book
>-      from the drop down.</ul>
>+    <ul>
>+      <li>To allow all remote content, uncheck <q>Block images and other content
Isn't this over the 80 character limit?

>+        from remote sources</q>.</li>
>+      <li>To block all remote content, uncheck <q>but allow if the sender is in
>+        this address book:</q>.</li>
>+      <li>To change which address book you use for people who send messages that
Isn't this also over the 80 character limit?

>+        are allowed to display remote content, select the correct address book
>+        from the drop down.</li>
>+    </ul>
>   </li>
>   <li>Click OK to have your change take affect.</li>
> </ol>
>@@ -573,10 +575,12 @@
>   <li>Under the Advanced category, click Scripts &amp; Plug-ins. (If no
>     subcategories are visible, double-click Advanced to expand the
>     list.)
>-    <ul>Under <q>Enable JavaScript for</q>, check <q>Mail &amp; Newsgroups</q>
>-      to enable JavaScript.</ul>
>-    <ul>Under <q>Enable Plug-ins for</q>, check <q>Mail &amp; Newsgroups</q>
>-      to enable plug-ins.</ul>
>+    <ul>
>+      <li>Under <q>Enable JavaScript for</q>, check <q>Mail &amp; Newsgroups</q>
Isn't this also over the 80 character limit?

>+        to enable JavaScript.</li>
>+      <li>Under <q>Enable Plug-ins for</q>, check <q>Mail &amp; Newsgroups</q>
>+        to enable plug-ins.</li>
>+    </ul>
>   </li>
>   <li>Click OK to have your changes take affect.</li>
> </ol>

Comment 8

[Giacomo Magnini]

(In reply to comment #7)
> >+      <li>To allow all remote content, uncheck <q>Block images and other content
> Isn't this over the 80 character limit?

Nope. It's exactly 80 columns... You probably got confused by the + in the diff file. Same goes for the others two.

Comment 9

[Giacomo Magnini]

(In reply to comment #8)
> Nope. It's exactly 80 columns... You probably got confused by the + in the diff
> file. Same goes for the others two.

I take it back. Seems like the updated gedit has decided to put the right column at 81st character, instead of 80th. I apologize, patch coming.

Comment 10

[Giacomo Magnini]

Attachment: What Ian said. (checked into trunk/1.8 branch)

Comment 11

[Robert Kaiser]

Comment on attachment 229436 [details] [diff] [review]
Update the (c) lines to align the to branch (checked into trunk/1.8 branch)

Checked into trunk.

Comment 12

[Robert Kaiser]

Comment on attachment 229439 [details] [diff] [review]
Patch for privacy_help (checked into trunk/1.8 branch)

Checked into trunk.

Comment 13

[Michael Opitz]

(In reply to comment #12)
> (From update of attachment 229439 [details] [diff] [review] [edit])
> Checked into trunk.
> 

The Link ("how_do_i_make_sure...") in help-toc.rdf was not change to the new one ("how_can_i_make_sure...")
Patch in a sec

Comment 14

[Michael Opitz]

Attachment: Fix missing Link-chance in help-toc.rdf (checked into trunk/1.8 branch)

Comment 15

[Ian Neal]

Comment on attachment 230315 [details] [diff] [review]
Fix missing Link-chance in help-toc.rdf (checked into trunk/1.8 branch)

Thanks for the catch

Comment 16

[Ian Neal]

Comment on attachment 229623 [details] [diff] [review]
passwords_help fix

>Index: extensions/help/resources/locale/en-US/passwords_help.xhtml
>===================================================================
>@@ -99,8 +100,8 @@
>     periodically, which can be inconvenient. (For information about controlling
>     how often it is requested, see the discussion of the Master Password
>     timeout at
>-    <a href="#master_passwords">Privacy &amp;
>-    Security Preferences - Master Passwords</a>.)</li>
>+    <a href="#master_passwords">Privacy &amp; Security Preferences -
>+    Master Passwords</a>.)</li>
"Master" could go on the line above, I suppose keeping it on the same line as "Passwords" helps searching within this file when editting it.

>@@ -182,8 +183,8 @@
>   "using_priv_help.xhtml#using_the_password_manager">Using the Password
>   Manager</a>.</p>
> 
>-<h2 id="master_passwords">Privacy &amp;
>-  Security Preferences - Master Passwords</h2>
>+<h2 id="master_passwords">Privacy &amp; Security Preferences -
>+  Master Passwords</h2>
Again "Master" could go on the line above, though see my previous comment.

>+  <li>You can control how often the browser requests your master password:
>+    <ul>
>+      <li><strong>The first time it is needed.</strong> This setting
>+        (selected by default) causes the browser to request your master password
This line is too long, "password" needs to go on the next line, this means the rest of the paragraph needs to be reformated too.

>+        only the first time it needs access to the private key database after
>+        launching. The browser will not request the master password again until
>+        after you exit and relaunch it. This setting provides the lowest level
>+        of protection.</li>
>+      <li><strong>Every time it is needed.</strong> This setting ensures that
>+        the browser will never access your saved personal information without
>+        first requesting your master password. This setting provides the highest
This line is too long again, "highest" needs to go on the next line.


>+<p><strong>Warning:</strong> If you reset your master password, you will
>+  permanently erase all the encrypted web passwords, email passwords, and form
>+  data saved on your behalf by Password Manager and Form Manager. You will also
>+  lose all your personal certificates associated with the
>+  <a href="glossary.xhtml#software_security_device">Software
>+  Security Device</a>.</p>
"Security" could go on the line above.

Comment 17

[Giacomo Magnini]

Attachment: Fixed review comments (checked into trunk/1.8 branch)

Comment 18

[Giacomo Magnini]

(In reply to comment #14)
> Created an attachment (id=230315) [edit]
> Fix missing Link-chance in help-toc.rdf

Thanks. I actually made the change because I had this change already in my tree (probably a left over since who knows when) and the link was not working... :)

Comment 19

[Giacomo Magnini]

One last remark: Karsten used [__] for numberic fields inside pref options, while we used only __ in the past. I think the new form is much more clean, so I was thinking if a new patch to address this would be nice to have to make everything consistent, or we should revert Mnyromyr's changes...

Comment 20

[Ian Neal]

(In reply to comment #19)
> One last remark: Karsten used [__] for numberic fields inside pref options,
> while we used only __ in the past. I think the new form is much more clean, so
> I was thinking if a new patch to address this would be nice to have to make
> everything consistent, or we should revert Mnyromyr's changes...
> 
Well we should be consistent, may be worth checking with Neil online or something to see what he reckons just incase he is aware of any issues [__] would cause. If he's okay with it raise a new bug and patch away.

Comment 21

[Giacomo Magnini]

(In reply to comment #20)
> Well we should be consistent, may be worth checking with Neil online or
> something to see what he reckons just incase he is aware of any issues [__]
> would cause. If he's okay with it raise a new bug and patch away.

He has nothing for or against this, while he likes the [account] approach for drodowns. I'll add 2 more pro's:
- makes our docs more similar to ff/tb ones (in case someone learns... ;) )
- ___ is only used in mail_help, so it's a very easy patch (together with some 80-col alignments).
 

Comment 22

[[e-mail]]

(In reply to comment #19)
>One last remark: Karsten used [__] for numberic fields inside pref options,
Actually he told me he was just moving stuff introduced in rev 1.25 around...

Comment 23

[Giacomo Magnini]

(In reply to comment #22)
> (In reply to comment #19)
> >One last remark: Karsten used [__] for numberic fields inside pref options,
> Actually he told me he was just moving stuff introduced in rev 1.25 around...

He changed ___ to [__] in bug 335846 attachment 224619 [details] [diff] [review] (rev 1.71), while moving stuff around, yes. The use of [account] was introduced in rev 1.25...

Comment 24

[Karsten Düsterloh]

> He changed ___ to [__] in bug 335846 attachment 224619 [details] [diff] [review] [edit] (rev 1.71),
> while moving stuff around, yes. The use of [account] was introduced in
> rev 1.25...

Oh, now I see. Sorry about that. :-/

Comment 25

[Ian Neal]

(In reply to comment #21)
> (In reply to comment #20)
> - ___ is only used in mail_help, so it's a very easy patch (together with some
> 80-col alignments).
> 
So what is the new bug number and can this bug be closed now? Are you planning to have this patch going onto 1.8 branch?

Comment 26

[Giacomo Magnini]

(In reply to comment #25)
> So what is the new bug number and can this bug be closed now? Are you planning
> to have this patch going onto 1.8 branch?

The last 3 patchs here need checkin, then this bug can be closed.
Bug 347110 is the follow-up for the other fixes.
Not sure we want all of this for 1.8.1... For sure there would be some checkin problems on the branch, since the (c) line there is already up to date.
If the Council thinks this is worthwhile, go for the branch: the patch in the followup will be ready later today (after the patch for mail_help goes in).

Comment 27

[Robert Kaiser]

Comment on attachment 230397 [details] [diff] [review]
Fixed review comments (checked into trunk/1.8 branch)

Checked in those three patches into both extensions/ and suite/ help versions.

Giacomo, please resolve the bug as FIXED if everything's done that needs to be done here.

Comment 28

[Giacomo Magnini]

This is so embarassing, it is not even funny... Missed so many (c) lines: sorry about the spam! :(
Patch attached (even for suiterunner).

Comment 29

[Giacomo Magnini]

Attachment: Fix the last bunch of files, even for suiterunner. (checked into trunk/1.8 branch)

Comment 30

[Robert Kaiser]

Comment on attachment 232882 [details] [diff] [review]
Fix the last bunch of files, even for suiterunner. (checked into trunk/1.8 branch)

Checked this in as well - as before, Giacomo, please mark [e-mail] if everything needed is done here.

Comment 31

[Giacomo Magnini]

Asking approval for SM 1.1b: we need aligned (c) lines on that branch too.

Comment 32

[Ian Neal]

a=me for SM1.1b

Comment 33

[Giacomo Magnini]

Ian, can you please check all of these files on the branch?
TIA, Giacomo.

Comment 34

[Ian Neal]

Comment on attachment 232882 [details] [diff] [review]
Fix the last bunch of files, even for suiterunner. (checked into trunk/1.8 branch)

Checking in (1.8 branch)
cert_dialog_help.xhtml;
new revision: 1.15.8.2; previous revision: 1.15.8.1
certs_help.xhtml;
new revision: 1.45.8.2; previous revision: 1.45.8.1
composer_help.xhtml;
new revision: 1.31.6.1; previous revision: 1.31
cs_nav_prefs_advanced.xhtml;
new revision: 1.41.8.4; previous revision: 1.41.8.3
cs_nav_prefs_navigator.xhtml;
new revision: 1.29.6.8; previous revision: 1.29.6.7
cs_priv_prefs_popup.xhtml;
new revision: 1.11.8.1; previous revision: 1.11
forieusers.xhtml;
new revision: 1.14.8.1; previous revision: 1.14
help-toc.rdf;
new revision: 1.78.4.9; previous revision: 1.78.4.8
help_help.xhtml;
new revision: 1.23.8.2; previous revision: 1.23.8.1
mail_help.xhtml;
new revision: 1.62.2.13; previous revision: 1.62.2.12
mail_sec_help.xhtml;
new revision: 1.30.8.3; previous revision: 1.30.8.2
page_info_help.xhtml;
new revision: 1.18.8.1; previous revision: 1.18
passwords_help.xhtml;
new revision: 1.40.8.2; previous revision: 1.40.8.1
privacy_help.xhtml;
new revision: 1.42.6.2; previous revision: 1.42.6.1
privsec_help.xhtml;
new revision: 1.34.8.1; previous revision: 1.34
shortcuts-composer.xhtml;
new revision: 1.5.20.1; previous revision: 1.5
shortcuts-mailnews.xhtml;
new revision: 1.12.18.2; previous revision: 1.12.18.1
shortcuts-navigator.xhtml;
new revision: 1.10.6.5; previous revision: 1.10.6.4
shortcuts.xhtml;
new revision: 1.17.4.1; previous revision: 1.17
using_certs_help.xhtml;
new revision: 1.48.8.1; previous revision: 1.48
validation_help.xhtml;
new revision: 1.33.8.1; previous revision: 1.33
done