350239 - clean up the Using Firefox document (use chrome images, adjust to new searchbar UI, prefwindow changes)

Status: RESOLVED FIXED

(Firefox Graveyard :: Help Documentation, defect)

Description

[Steffen Wilberg]

I started with using chrome images for the portrait and landscape icons and the arrow icons, but then I read through it and discovered some bugs: The searchbar has changed its UI a bit, and the prefwindow changes seem to strike everywhere.

Comment 1

[Steffen Wilberg]

Attachment: patch

Using the chrome images has the advantage that they don't get out of date as long as their paths don't change. I'll post on the themes forum on mozillazine that theme authors shouldn't change the name of these images if we take this.

The location and searchbar images are the only remote images left.

Comment 2

[Jeff Walden (gone starting June 8)]

Comment on attachment 235486 [details] [diff] [review]
patch

>   <li>To go back or forward more than one page, click the small triangles on
>     the <em>Back</em> and <em>Forward</em> buttons. You'll see a list of pages
>     you've recently visited; to return to a page, choose it from the list.</li>
> <li>To see a list of any URLs you've typed into the Location Bar, click the
>-  arrow at the right end of the Location Bar. To view a page, choose it from
>-  the list.<br/>
>+  down arrow at the right end of the Location Bar. To view a page, choose it
>+  from the list.<br/>
>   <br/>
>   <img src="&images.baseURL;/urlbar.png"
>        width="320" height="30" alt=""/><br/>
>   </li>

Correct the bogo indentation here, please?


>   it around within the list or remove it. You can install additional search
>   engines from <a href="https://addons.mozilla.org/search-engines.php"
>   target="_blank">&brandShortName; Add-ons</a>.</p>

"You can install new search engines by clicking the <em>Get more search engines...</em> link."?  This localized URL formatting thing is getting annoying...


>-<h3 id="searching_on_selected_words_in_a_web_page">Searching for Selected Words
>-  in a Web Page</h3>
>+<h3 id="searching_on_selected_words_in_a_web_page">Searching the Web for
>+  Selected Words in a Web Page</h3>

Ugh.  Is "Searching for Selected Words on the Web" any better?


>-<p>&brandShortName; allows you to search for words you select within a web
>-  page:</p>
>+<p>&brandShortName; allows you to search the web for words you select within
>+  a web page:</p>

This probably needs updating if we change the previous wording.


>   <li><strong>Change the orientation of the page</strong>: Choose
>-    <em>Portrait</em> <img alt=""
>-    src="&images.baseURL;/pg-portrait-small.png"/>
>+    <em>Portrait</em><img alt="" src="chrome://global/skin/icons/Portrait.png"/>
>     to position the page with the shorter side facing up. Choose
>-    <em>Landscape</em><img alt=""
>-    src="&images.baseURL;/pg-landscape-small.png"/>
>+    <em>Landscape</em><img alt="" src="chrome://global/skin/icons/Landscape.png"/>
>     to position the page sideways with the longer side facing up.</li>

Space in between "</em>" and "<img" -- looking at the current spacing (and assuming it doesn't change much with chrome images) Portrait survives, but Landscape doesn't have the padding to pull it off.


>+    location to save the file. If you have selected <em>Save all files to (this
>+    folder)</em> in the <em>Main</em> panel of &pref.pluralCaps;,
>+    the file will automatically be saved to the default folder, otherwise
>+    &brandShortName; will ask you where to save it.</li>

s/folder,/folder;/


>+    cache. 50MB to 70MB is a good size.</li>

We're recommending cache sizes???  Good grief.  I'm trying to think of a way to recommend a reasonable number without too much explanation of why the number's good but am failing; why don't we just remove it?


Anyway, this is fine, but I'd like to try to come up with something better than "Searching the Web for Selected Words in a Web Page" before we check it in.

Comment 3

[Steffen Wilberg]

Attachment: patch v1.1

(In reply to comment #2)
> Correct the bogo indentation here, please?
Fixed.

> >   it around within the list or remove it. You can install additional search
> >   engines from <a href="https://addons.mozilla.org/search-engines.php"
> >   target="_blank">&brandShortName; Add-ons</a>.</p>
> 
> "You can install new search engines by clicking the <em>Get more search
> engines...</em> link."?  This localized URL formatting thing is getting
> annoying...
Fixed. Yeah, we need to find a solution for that.

> >-<h3 id="searching_on_selected_words_in_a_web_page">Searching for Selected Words
> >-  in a Web Page</h3>
> >+<h3 id="searching_on_selected_words_in_a_web_page">Searching the Web for
> >+  Selected Words in a Web Page</h3>
> 
> Ugh.  Is "Searching for Selected Words on the Web" any better?
Hmm, that sounds like some very special and carefully selected words are
somewhere on the web because it doesn't refer to the current page.
How about "Searching the Web for Words selected in a Web Page"?

> >+<p>&brandShortName; allows you to search the web for words you select within
> >+  a web page:</p>
> This probably needs updating if we change the previous wording.
Not with this suggestion.

> >+    <em>Portrait</em><img alt="" src="chrome://global/skin/icons/Portrait.png"/>
> >     to position the page with the shorter side facing up. Choose
> >-    <em>Landscape</em><img alt=""
> >-    src="&images.baseURL;/pg-landscape-small.png"/>
> >+    <em>Landscape</em><img alt="" src="chrome://global/skin/icons/Landscape.png"/>
> >     to position the page sideways with the longer side facing up.</li>
> 
> Space in between "</em>" and "<img" -- looking at the current spacing (and
> assuming it doesn't change much with chrome images) Portrait survives, but
> Landscape doesn't have the padding to pull it off.
Fixed.

> >+    location to save the file. If you have selected <em>Save all files to (this
> >+    folder)</em> in the <em>Main</em> panel of &pref.pluralCaps;,
> >+    the file will automatically be saved to the default folder, otherwise
> >+    &brandShortName; will ask you where to save it.</li>
> 
> s/folder,/folder;/
Fixed.

> >+    cache. 50MB to 70MB is a good size.</li>
> We're recommending cache sizes???  Good grief.  I'm trying to think of a way to
> recommend a reasonable number without too much explanation of why the number's
> good but am failing; why don't we just remove it?
Because the "power-user" might change it and then don't know what's a sane size?
How about stating the default size (50MB)?

> Anyway, this is fine, but I'd like to try to come up with something better than
> "Searching the Web for Selected Words in a Web Page" before we check it in.
Here you are, but someone needs to check this in because I'm away for the next two weeks.

Comment 4

[Jeff Walden (gone starting June 8)]

Attachment: Patch as checked in

(In reply to comment #3)
> Hmm, that sounds like some very special and carefully selected words are
> somewhere on the web because it doesn't refer to the current page.
> How about "Searching the Web for Words selected in a Web Page"?

That works with capitalization of "selected" (in checked-in patch); I also had to modify the toc file for this.


> > >+    cache. 50MB to 70MB is a good size.</li>
> > We're recommending cache sizes???  Good grief.  I'm trying to think of a way
> > to recommend a reasonable number without too much explanation of why the
> > number's good but am failing; why don't we just remove it?
> Because the "power-user" might change it and then don't know what's a sane
> size?
> How about stating the default size (50MB)?

Default size is reasonable and has some precedent ("restore to default" for home page), so that looks good.  I switched "50MB is the default size" to "The default size is 50MB" for some gut aesthetic feelings I can't rationalize well, tho.


> someone needs to check this in because I'm away for the next two weeks.

Done.

Comment 5

[Jeff Walden (gone starting June 8)]

Comment on attachment 237378 [details] [diff] [review]
Patch as checked in

This corrects some issues with help documentation related to the new preferences window, and we really want accurate docs.

Comment 6

[Mike Schroepfer]

Comment on attachment 237378 [details] [diff] [review]
Patch as checked in

a=schrep for drivers.

Comment 7

[Steffen Wilberg]

OK, thanks. And greetings from Turkey ;-)

Comment 8

[Jeff Walden (gone starting June 8)]

In on branch.  Note to localizers to be posted in m.d.l10n shortly...

Comment 9

[Steffen Wilberg]

I just posted on the mozillazine themes forum as promised in comment 1.
http://forums.mozillazine.org/viewtopic.php?t=466587

Comment 10

[mcdavis941 (sporadically reading bugmail)]

Thanks for the post to the themes forum.  For the benefit of theme developers who aren't familiar with using_firebird.xhtml, could you please also say where this file is used in the Firefox UI and what actions to perform to bring it up.

This page http://kb.mozillazine.org/Chrome_URLs lists chrome://help/locale/using_firebird.xhtml, but that doesn't (directly at least) display any content in eithe Fx1.5 or 2.0.

Comment 11

[mcdavis941 (sporadically reading bugmail)]

OK, I see this must be one of the pages displayed in the help window.