1271134 - nav_help.xhtml: Typos

Status: RESOLVED FIXED

(SeaMonkey :: Help Documentation, defect)

Description

[Rainer Bielefeld]

Steps how to reproduce with  SeaMonkey 2.41a1 Mozilla/5.0 ( Windows NT 6.1; WOW64; rv:44.0 from akalla download area)  Gecko/20100101  Firefox/ 44.0  Build 20160201082047, (Default Classic Theme)  on German WIN7 64bit:

1. Browser → F1
   » Help appears
2. Type search string "viewing home" → Click hit 
  "Viewing Your Home Page"
   » Related Help appears
3. Search page for Typos listed below

You will find:
a) "ReturnEnter"  (or should this mean “Return or Enter”?) 
   (only 2.41, o.k. with 2.45)
b) SeaMonkeyEdit (only 2.41, o.k. with 2.45) should be "SeaMonkey Edit"?
c) "oropen" should be "or open"
d) "occurence" should be "occurrence"
e) "drop-dop" should be "drop-down" 
f) "URL's"  should be "URLs"

Comment 1

[Stefan [:stefanh]]

(In reply to Rainer Bielefeld from comment #0)
> You will find:
> a) "ReturnEnter"  (or should this mean “Return or Enter”?) 
>    (only 2.41, o.k. with 2.45)
> b) SeaMonkeyEdit (only 2.41, o.k. with 2.45) should be "SeaMonkey Edit"?

We have code that hides/shows words/sentences depending on the platform and the above looks like an example of that code not working (traditionally Mac uses "Return" key instead of "Enter" key and the preferences menuitem is in the "SeaMonkey" menu, not in the "Edit" menu). I can't find any recent changes in the help files that could have affected this, though - maybe it's something on the toolkit side that changed and fixed it? In that case, there might be a lot of those errors in the 2.41 help files.

Comment 2

[Rainer Bielefeld]

(In reply to Stefan [:stefanh] from comment #1)
>  I can't find any recent ...

My mistake?! My step by step instruction is not 100% correct, for 2.41 I used an en-US Language Pack unzipped on my PC, for 2.45 the original SeaMonkey Help following the step by step instruction. That might be related to the fact that you can't reproduce some of my observations?

Comment 3

[Rainer Bielefeld]

(In reply to Stefan [:stefanh] from comment #1)
> We have code that hides/shows words/sentences depending on the platform 

Thanks, I see in the help page source.
a): <kbd class="mac">Return</kbd><kbd class="noMac">Enter</kbd>
    This is not a real bug, only looks like a book viewing the .xhtml
    in browser instead of Help Viewer
b): <span class="mac">&brandShortName;</span> <span class="noMac">Edit</span>
    This might not be a real bug. Is there a "SeaMonkey" menu containing
    'Preferences' item for Mac?
c): <span class="noMac">press <kbd>F9</kbd> or </span>open
    Probably not a real bug, only looks like a book viewing the .xhtml

Remaining Bugs:
d, e, f

Comment 4

[Frank-Rainer Grahl (:frg)]

Attachment: 1271134-nav_help-typos.patch

I think c is still valid. If you use the span tag the trailing blank seems to be get lost. Not sure how this is rendered on mac but 2 blanks on mac are imho better than no blanks in Windows.

Comment 5

[Stefan [:stefanh]]

Comment on attachment 8750232 [details] [diff] [review]
1271134-nav_help-typos.patch

>-    handle is missing, <span class="noMac">press <kbd>F9</kbd> or </span>open
>+    handle is missing, <span class="noMac">press <kbd>F9</kbd> or</span> open

I wonder if it works if you instead put "or </span>open ..." on a new line.

Comment 6

[Philip Chee]

Comment on attachment 8750232 [details] [diff] [review]
1271134-nav_help-typos.patch

Looks reasonable (I don't have a Mac to test)
r=me

Comment 7

[Frank-Rainer Grahl (:frg)]

>> I wonder if it works if you instead put "or </span>open ..." on a new line.

I will try this out before checking it in. This sequence can also be found in some other help files and putting it on a new line might be preferable. Not before Friday unfortunately.

Comment 8

[Stefan [:stefanh]]

(In reply to Frank-Rainer Grahl from comment #7)
> >> I wonder if it works if you instead put "or </span>open ..." on a new line.
> 
> I will try this out before checking it in. This sequence can also be found
> in some other help files and putting it on a new line might be preferable.
> Not before Friday unfortunately.

I think it would be preferable with a new line if it works. You could test this by switching the classes if you don't have access to a mac. I haven't had the time to test this myself, but it's possible that your patch with 2 whitespaces will be rendered as one whitespaces. OTOH, printing the page will probably result in 2 whitespaces.

Comment 9

[Frank-Rainer Grahl (:frg)]

Attachment: 1271134-nav_help-typos-V2.patch

Actually the oropen was only in one location and the /span did preserve the space. So I rolled back part of the previous patch. Must have been late when I thought it did occur in both locations :)

Comment 10

[Stefan [:stefanh]]

-          <li><strong>URL</strong>: Show the web page URL (URL&apos;s usually
+          <li><strong>URL</strong>: Show the web page URL (URLs usually
This change is wrong. This is the way it's done in the help files (there are 300 occurences of '&apos;s' in the help files).

Comment 11

[Frank-Rainer Grahl (:frg)]

Completely indifferent here. We should just specify in which way we want it.

Using google the term URLs seem to be more common:

https://en.wikipedia.org/wiki/Uniform_Resource_Locator

Comment 12

[Stefan [:stefanh]]

Actually, now when I looked at it a bit more, I think you're right.

This is from the NYTimes style guide, it's just one example, but it makes sense.

"... do not use apostrophes for plurals of abbreviations without periods, or for plurals formed from figures: TVs, PCs, DVDs; 1990s, 747s, size 7s."

Comment 13

[Stefan [:stefanh]]

Comment on attachment 8752525 [details] [diff] [review]
1271134-nav_help-typos-V2.patch

Stealing this from Philip.

Comment 14

[Frank-Rainer Grahl (:frg)]

c-c is approval only. Need an approval or someone else needs to check it in.

Thanks
FRG

Comment 15

[Philip Chee]

Comment on attachment 8752525 [details] [diff] [review]
1271134-nav_help-typos-V2.patch

(In reply to Frank-Rainer Grahl from comment #14)
> c-c is approval only. Need an approval or someone else needs to check it in.

a=me

Comment 16

[:aceman]

https://hg.mozilla.org/comm-central/rev/e3627edf10e63e9ac9bf8cb72246c3291686655e