304947 - Some mistakes in nav_help.xhtml

Status: RESOLVED FIXED

(SeaMonkey :: Help Documentation, defect)

Description

[Michael Opitz]

While translating the current nav_help to german in notice some
things.

There is one hardcoded "Mozilla" instead &brandShortName;

The URL:
http://home.netscape.com/bookmark/6_2/hinter.html
should be replaced with:
http://www.mozilla.org/projects/l10n/mlp_status.html

And in the section:
<h2 id="custom_keywords">Using Custom Bookmark Keywords</h2>
the entry:
<li>In the bookmark Properties dialog box window, click the Info tab.</li>
need to be changed, i don't see a Info-Tab on my current build 
(1.9a1 Build 2005081623 Win32)

I've a path in hand for the first 2 issues and if the 3 issue is correct i'll
create one for that issue.

Comment 1

[Michael Opitz]

Attachment: first 2 issues

Comment 2

[[e-mail]]

(In reply to comment #0)
> <li>In the bookmark Properties dialog box window, click the Info tab.</li>
Yeah, this was removed a couple of years ago as part of bug 117026.

Comment 3

[Stefan [:stefanh]]

Comment on attachment 192921 [details] [diff] [review]
first 2 issues

 <p>For information about &brandShortName; in multiple languages, see the
online
   document
-  <a href="http://home.netscape.com/bookmark/6_2/hinter.html">International
+  <a href="http://www.mozilla.org/projects/l10n/mlp_status.html">International
   Users Page</a>.</p>

Obviously Netscape called it "International Users Page", but I wonder if we
should call it somthing else.

Comment 4

[Michael Opitz]

Attachment: include last issue

Updated patch to remove the Info-Tab-Part

Stefan:
How about "Localisation Project" instead?

Comment 5

[Michael Opitz]

Attachment: wrong file

Comment 6

[Stefan [:stefanh]]

 
> Stefan:
> How about "Localisation Project" instead?
> 

Hmm, I just realize that it's quite possible that the localized SeaMonkey
material  will end up in another page. Atm we don't have any localized SeaMonkey
builds... KaiRo?

The MLP page just gives you info on what localized versions you can get and what
the teams are (the Netscape page gave you info of the type "Bidi support is
available in ..."). So, if we want to change the link, I think we need to change
the sentence to something that better describes the content of our new page:

"If you're looking for a version of &brandShortName; in another language than
American English, you can download it from ..."

However, since you only just find old MAS versions on that page, I don't know if
we should change the link atm. Ian, any idea?

The heading just above sounds a bit mis-leading:

<h2 id="finding_international_web_content">Finding International Web            

  Content</h2>                                                                 

Comment 7

[Robert Kaiser]

> "If you're looking for a version of &brandShortName; in another language than
> American English, you can download it from ..."

Sounds good to me, but the page you mentioned is just about the old Mozilla
suite, and new pages will be completely different once we have them, so link
http://www.mozilla.org/projects/l10n/ instead and title it "Mozilla Localization
Project" or similar.

We will get pages referencing localized SeaMonkey in the subpages of MLP, but
this won't happen before 1.0 Alpha, I think (though I hope we get the new MLP
page structure soon).

Comment 8

[Michael Opitz]

(In reply to comment #6)
> The heading just above sounds a bit mis-leading:
> 
> <h2 id="finding_international_web_content">Finding International Web            
> 
>   Content</h2>                                                                 

So, should we change that to something more meaningfull like "Finding Localized
Seamonkey-Builds"?
I can attach an updated patch tomorrow

Comment 9

[Stefan [:stefanh]]

> So, should we change that to something more meaningfull like "Finding Localized
> Seamonkey-Builds"?

Yeah, perhaps something like "Finding a &brandShortname; version in your own
language"?

> I can attach an updated patch tomorrow

Sounds great (note that Ian is the peer). Thanks for catching those errors :)

Comment 10

[Michael Opitz]

Attachment: as promised

here the promised new patch.
I changed the id into "finding_localised_version" since this is the
meaning of the section and updated the toc-rdf according.

Also requesting a18b4 since 1.8 will be out there for a long time
and shipping with such mistakes in help doesn't look good.

Comment 11

[Ian Neal]

Comment on attachment 193055 [details] [diff] [review]
as promised

>Index: nav_help.xhtml
>===================================================================
>@@ -1244,13 +1244,13 @@
.
.
>-<p>For information about &brandShortName; in multiple languages, see the online
>-  document
>-  <a href="http://home.netscape.com/bookmark/6_2/hinter.html">International
>-  Users Page</a>.</p>
>+<p>If you're looking for a version of &brandShortName; in another language than
>+   American English, you can download it from ...
>+  <a href="http://www.mozilla.org/projects/l10n/">Mozilla Localization
>+Project</a>.</p>

This should probably be:
+<p>If you're looking for a version of &brandShortName; in language other than
+   American English, you can download it from ...

>@@ -1481,11 +1481,11 @@
>   <li>Open the Bookmarks menu and choose Manage Bookmarks.</li>
>   <li>In the Bookmarks window, click on the bookmark that you created.</li>
>   <li>Click Properties.</li>
>-  <li>In the bookmark Properties dialog box window, click the Info tab.</li>
>-  <li>Enter a short string to the Keyword field. Close that dialog.</li>
>+  <li>In the bookmark Properties dialog box window, enter a short string to 
>+  the Keyword field and close that dialog.</li>

This should be "into" instead of "to" giving:
+  <li>In the bookmark Properties dialog box window, enter a short string into 
+  the Keyword field and close that dialog.</li>

r= with those changes

Comment 12

[Ian Neal]

(In reply to comment #11)
> This should probably be:
> +<p>If you're looking for a version of &brandShortName; in language other than
> +   American English, you can download it from ...

Even:
+<p>If you're looking for a version of &brandShortName; in a language other than
+   American English, you can download it from ...

Sorry

Comment 13

[Michael Opitz]

Attachment: another try

review-comments adressed

Comment 14

[Ian Neal]

Comment on attachment 193065 [details] [diff] [review]
another try

Sorry I missed you had not indented the new bits correctly.

>Index: nav_help.xhtml
>===================================================================
>@@ -1066,8 +1066,8 @@
>       Encodings and Fonts</a></li>
>     <li><a href="#setting_language_preferences">Setting Language
>       Preferences</a></li>
>-    <li><a href="#finding_international_web_content">Finding International Web
>-      Content</a></li>
>+    <li><a href="#finding_localised_version">Finding a &brandShortname; version in your own
>+language</a></li>

"language" needs to be under the i of <li> like "Content" was

>@@ -1244,13 +1244,13 @@
> <p>[<a href="#using_languages_and_international_content">Return to beginning
>   of section</a>]</p>
> 
>-<h2 id="finding_international_web_content">Finding International Web
>-  Content</h2>
>+<h2 id="finding_localised_version">Finding a &brandShortname; version in your own
>+language</h2>

"language" needs to be under the 2 of <h2 like "Content" was

>-<p>For information about &brandShortName; in multiple languages, see the online
>-  document
>-  <a href="http://home.netscape.com/bookmark/6_2/hinter.html">International
>-  Users Page</a>.</p>
>+<p>If you're looking for a version of &brandShortName; in a language other than
>+   American English, you can download it from

You have indented American by one space too many.

>+  <a href="http://www.mozilla.org/projects/l10n/">Mozilla Localization
>+Project</a>.</p>

"Project" needs to be indented so it is under the space between <a and href.

>@@ -1481,11 +1481,11 @@
>   <li>Open the Bookmarks menu and choose Manage Bookmarks.</li>
>   <li>In the Bookmarks window, click on the bookmark that you created.</li>
>   <li>Click Properties.</li>
>-  <li>In the bookmark Properties dialog box window, click the Info tab.</li>
>-  <li>Enter a short string to the Keyword field. Close that dialog.</li>
>+  <li>In the bookmark Properties dialog box window, enter a short string into 
>+  the Keyword field and close that dialog.</li>

"the" needs to be indented so it is under the i of <li>

Comment 15

[Stefan [:stefanh]]

Comment on attachment 193065 [details] [diff] [review]
another try

+<h2 id="finding_localised_version">

I think we want the 'z, ie 'localized', since that is the most common used in
the help files. Can you change that while you're doing the other stuff, please?

Comment 16

[Michael Opitz]

Attachment: whitespace

adressed whitespace changes and changed 'localiced' to 'localized' 
on Stefan's request

Comment 17

[Ian Neal]

Comment on attachment 193092 [details] [diff] [review]
whitespace

Another rule for help files is that you should wrap all lines over 80 columns.

>Index: nav_help.xhtml
>===================================================================
>@@ -1066,8 +1066,8 @@
>       Encodings and Fonts</a></li>
>     <li><a href="#setting_language_preferences">Setting Language
>       Preferences</a></li>
>-    <li><a href="#finding_international_web_content">Finding International Web
>-      Content</a></li>
>+    <li><a href="#finding_localized_version">Finding a &brandShortname; version in your own
>+      language</a></li>

The part of the line after "version" needs moving onto the next line because of
the 80 column rule.

>@@ -1244,13 +1244,13 @@
> <p>[<a href="#using_languages_and_international_content">Return to beginning
>   of section</a>]</p>
> 
>-<h2 id="finding_international_web_content">Finding International Web
>-  Content</h2>
>+<h2 id="finding_localized_version">Finding a &brandShortname; version in your own
>+ language</h2>

"own" needs to be moved onto the next line and then "own language" needs
indenting by one more space.

>@@ -1481,11 +1481,11 @@
>   <li>Open the Bookmarks menu and choose Manage Bookmarks.</li>
>   <li>In the Bookmarks window, click on the bookmark that you created.</li>
>   <li>Click Properties.</li>
>-  <li>In the bookmark Properties dialog box window, click the Info tab.</li>
>-  <li>Enter a short string to the Keyword field. Close that dialog.</li>
>+  <li>In the bookmark Properties dialog box window, enter a short string into 
>+    the Keyword field and close that dialog.</li>
> </ol>
> 
>-<p>Now, you can enter the keyword in the Location Bar, and Mozilla will load
>+<p>Now, you can enter the keyword in the Location Bar, and &brandShortName; will load
>   that URL.</p>

"will load" needs to be moved onto the next line.

Comment 18

[Michael Opitz]

Attachment: wrapped long lines (Checked into trunk and 1.8 branch)

Comment 19

[Ian Neal]

Comment on attachment 193165 [details] [diff] [review]
wrapped long lines (Checked into trunk and 1.8 branch)

Checking in (trunk)
help-toc.rdf;
new revision: 1.79; previous revision: 1.78
nav_help.xhtml;
new revision: 1.54; previous revision: 1.53
done
Checking in (1.8 branch)
help-toc.rdf;
new revision: 1.78.4.1; previous revision: 1.78
nav_help.xhtml;
new revision: 1.53.8.1; previous revision: 1.53
done

Comment 20

[Michael Opitz]

the checkin for this bug broke seamonkey-help

The entity "brandShortName" is mispelled.

It is "brandShortname" in the checked in version and should be "brandShortName".

i'm going to attach a followup patch for this issue in a sec

Comment 21

[Michael Opitz]

Attachment: fix Help (Checked into trunk and 1.8 branch)

Comment 22

[Ian Neal]

Comment on attachment 193946 [details] [diff] [review]
fix Help (Checked into trunk and 1.8 branch)

Checking in (trunk)
nav_help.xhtml;
new revision: 1.55; previous revision: 1.54
help-toc.rdf;
new revision: 1.80; previous revision: 1.79
done
Checking in (1.8 branch)
nav_help.xhtml;
new revision: 1.53.8.2; previous revision: 1.53.8.1
help-toc.rdf;
new revision: 1.78.4.2; previous revision: 1.78.4.1
done