267108 - Port BobChao's Firefox feature intro articles to English

Status: RESOLVED WORKSFORME

(support.mozilla.org :: Knowledge Base Articles, task)

Description

[Daniel Wang]

http://www.mozilla.org/products/firefox/tabbed-browsing.html
http://www.mozilla.org/products/firefox/live-bookmarks.html

Stupid me, I just discovered Bob Chao has finished up all the feature intro (in
Chinese). Will translate them very quickly.

Comment 1

[Daniel Wang]

checked in.
http://www.mozilla.org/products/firefox/text-zoom
http://www.mozilla.org/products/firefox/ui-customize

draft only. I have added links to these docs.

Comment 2

[Daniel Wang]

> I have added links to these docs.
should be "I have NOT added links to these docs." sorry

Comment 3

[Lachlan Hunt]

*Text Zoom*

This contains very bad grammar.  I don't know whether that was just a direct
translation, or whether it's acceptable in Chinese, but phrases like "Text Zoom
Easy" is exceptionally bad grammar in English.

> Let's say you are doing a presentation using Firefox.
> If the audience in the back cannot see the text, just
> press and hold Ctrl and press + or - to enlarge/shrink
> the text.

That is not a good example because the average user isn't going to be doing a
presentation with Firefox.  Also, we should use "increase" and "decrease" rather
than "enlarge" and "shrink" because that is what Firefox uses in the view menu,
and in the help files.  Although they are synonyms, we should be consistent.

alt="Screenshot of large text"

That is bad alt text [1|2].  Alt text should serve the same purpose of the
image, not describe what it looks like.  Better alt text would be:

alt="Firefox can make text as big as you need it."

I would change the content to the following:
(Headings are marked with asterisks, but they should not be inlcuded in the
final content)

----

*No more eye strain, Resize Text Easily!*

Do you have difficulty reading small text on web sites?  No more squinting at
small text since Firefox puts you in control. and makes it easy to increase or
decrease the text size as you desire through convenient options and keyboard
shortcuts.  Hold down the Ctrl key and press + (plus) to increase, or - (minus)
to decrease the text size.

*Text Resizing in Action*

<img src="../../images/screenshot-ff-text-zoom.gif"
     width: 300px; height: 234px;"
     alt="Firefox can make text as big as you need it."
     title="Screenshot of large text">
<!-- Note: I don't mind if you omit the title attribute -->

Is this large enough?

*Advanced Tips*

  *Text zoom with mouse wheel*
    If your mouse has a mouse wheel, you can press and hold down the
    Ctrl key and use it to zoom text.

  *Return to normal size*
    If you've made the text too small or too large, Press Ctrl+0 to
    return the text back to normal size.

  *Prevent small text*
    Don't let small text bother you again.  You can set the
    minimum and default font sizes as you desire for easier
    reading.    From the Tools menu, select "Options...".
    In the  "General" options, click "Fonts & Colors...".
    You can alter the font settings as you like.

Comment 4

[Lachlan Hunt]

Oops.  I forgot to include these references for the alt text example:
[1] http://hixie.ch/advocacy/alttext
[2] http://hixie.ch/advocacy/alt-tooltips

Comment 5

[Daniel Wang]

text-zoom updated:
http://www.mozilla.org/webtools/bonsai/cvsview2.cgi?diff_mode=context&whitespace_mode=show&file=text-zoom.html&branch=&root=/cvsroot&subdir=mozilla-org/html/products/firefox&command=DIFF_FRAMESET&rev1=1.1&rev2=1.2

I kept some elements to make it more lively (feel free to disagree)

Comment 6

[Lachlan Hunt]

Fix the capitilasation of title [1]:
No More Eye Strain, Resize Text Easily!

If you insist on having "parents with failing eyesights", it should be
"eyesight" without the 's'.

The keys should be marked up with <kbd> elements [2]. I've added the markup to
the three paragraphs that require it and fixed up "eyesight", so you can just
copy and paste each one.

----

<p>Do you have difficulty reading small text on web sites? Or have
   parents with failing eyesight? No more squinting at small text.
   In Firefox, it is easy to increase or decrease the text size as
   you desire through convenient options and keyboard shortcuts. 
   Hold down the <kbd>Ctrl</kbd> key and press <kbd>+</kbd> (plus)
   to increase, or <kbd>-</kbd> (minus) to decrease the text size.</p>

<dd><p>If your mouse has a mouse wheel, you can press and hold down
   the <kbd>Ctrl</kbd> key and use it to zoom text.</p></dd>

<dd><p>Oops, text too small/large now? Press <kbd>Ctrl+0</kbd> and
    the text returns to normal.</p></dd>

----

In Advanced Tips:
Change "Text zoom with mouse wheel" to "Resize text with the mouse wheel"

I don't like having "Oops, text too small/large now?", but since it appears you
didn't like the alternative I provided before, I don't know what to change it to.

The alt text and title of the options dialog screenshot need to be fixed:

<img src="../../images/screenshot-ff-options-fonts.gif"
     alt="The Fonts &amp; Colors options dialog provides options to set the
default font faces, sizes, colours and backgrounds."
     title="Screenshot of Fonts &amp; Colors options dialog"
     width="275" height"268">

The style attribute is banned on mozilla.org (See "No inline styles." [3]).  The
width and height should be set with the width and height attributes, and the
margin be set in the external stylesheet?  The images should be wrapped in a
<div class="figure"> [4], which should take care of that issue appropriately.

[1] http://www.mozilla.org/contribute/writing/guidelines#writing-form
[2] http://www.mozilla.org/contribute/writing/markup#computers
[3] http://www.mozilla.org/contribute/writing/guidelines#style
[4] http://www.mozilla.org/contribute/writing/markup#figures

Comment 7

[Ivan Ičin]

If we want to prove our commitment towards disabled people, then we must take
care of how we call them. 'Parents with failing eyesight' are not a good idea.
First, what if some kid has big glasses? Should he ashame of that? Also, if some
parent read, should he think that this is a child product?

I proposed before: 'Steering at small letters on your screen causes eye strain,
even to those with prefect eyesight', and it fits good instead of your second
and third sentence in the first paragraph. Keep at least second part of my
sentence, as it treats fair disabled people and say that analogue things could
happen to others too.

Also, I don't like using title with images. I know it is according w3c rules,
but I searched Google for alt vs title recently and most of the guys told that
alt fits right in image tag, while title should be used for <a> tag and avoided
for <img>. I am not an expert on this topic, but it seems that at least on
mozilla.org and spreadfirefox.org <img> tags did not use title, so I guess it
should be avoided. 

Comment 8

[Daniel Wang]

http://www.mozilla.org/products/firefox/text-zoom updated
I didn't enclose Ctrl with <kbd> because <kbd>ctrl</kbd> should read "c t r l",
not Control.
I also put the Mozilla Documentation Project as the (more transparent)
contributor. (and welcome to the team!)

Comment 9

[Lachlan Hunt]

Ivan, I agree with you about the "parents with failing eyesight" issue, which is
why I left it out of my first rewrite, I just had difficulty putting my reasons
into words.

Ivan Icin (comment 7) wrote:
>"Steering at small letters on your screen causes eye strain, even to those with
> prefect eyesight"

By "Steering", I assume you mean "Staring", as they are not driving a vehicle
towards letters on the screen, and there is no steering wheel involved in most
browsing.

> Also, I don't like using title with images. I know it is according w3c rules,
> but I searched Google for alt vs title recently

Most of the information, and usage of alt and title attributes on the web is
very poor.  The best resources I found regarding these are those that I linked
to in comment 4, and there are also some good documents on htmlhelp.org [1].

> and most of the guys told that
> alt fits right in image tag, while title should be used for <a> tag and
> avoided for <img>.

That is incorrect.  The title attribute can be used on any element to provide an
advisory title.  In these cases, although "Screenshot of ..." is a perfectly
valid title, it's use is optional, how I recommend it because it provides
additional information about the image for user agents that don't support, or
have images disabled.  Users of these user agents may still view the image by,
for example, launching an external image viewer.  The title attribute gives an
advisory title for the image that helps to put the image into context, and
understand what it is, whereas the alt text provides an equvialent meaning.  So,
both have been used correctly, you just have to decide whether or not you want
to keep the title.

> I am not an expert on this topic, but it seems that at least on
> mozilla.org and spreadfirefox.org <img> tags did not use title, so I guess it
> should be avoided.

Just because it's not used on any of the images you've seen (and I doubt you've
seen them all) on either of those sites, doesn't mean it should be avoided.  It
is not required for all images, nor do I recommend its use for all images, but
in this case I do.  The only descent reference I found on mozilla.org on the use
of the title attribute on images relates to the help viewer documentation [2]
which recommended it's use for more complicated images, and I think in this
case, it is appropriate.

----

Daniel Wang (comment 8) wrote:
> I didn't enclose Ctrl with <kbd> because <kbd>ctrl</kbd> should read
> "c t r l", not Control.

I don't understand what you mean by that, but that is incorrect.  If you take a
look at the documentation I linked to previously, one of the examples is this:

# Push <kbd>Esc</kbd> and type <kbd>:wq</kbd>.

Are you trying to tell me that that means "e s c" and not escape?  I don't think
so, and I think you should mark up Ctrl correctly as I said.

[1] http://www.htmlhelp.com/feature/art3.htm
[2]
http://www.mozilla.org/projects/help-viewer/documentation_coding-style.php#images

Comment 10

[Lachlan Hunt]

*User Interface Customization*

User Interface is a technical term.  I asked my mum if she new what it meant,
and she had no idea what I was talking about, so it needs to go.  This document
also contains very bad grammar.

> Do you want to save even more space? Just drag the bookmark toolbar
> to the right of the menu bar, and then hide the bookarmk tool
> (View > Toolbars > Bookmark Toolbar). Now you are one less toolbar!

I had to read that several times before I understood what it was trying to say,
and how to follow those instructions.  I don't think it's necessary, and I would
move the second paragraph to this section instead.


alt="UI Customization Screenshot"

Again, that is bad alt text.

alt="The customization panel shows all the additional buttons you can add and
arrange however you like on the toolbars."

Also remove the style attribute and replace the style attribute with height and
width attributes, and add the <div class="figure">. the same as before.

I've written my revised version below, but I think it needs more.  Should this
page include anything about themes and/or extensions?

----

*Customise the Look and Feel*

Don't like the arrangment of the toolbar buttons?  Are the bookmarks in the
wrong place?  Do you want additional buttons for more features?  Well, you
easily customise the look and feel of the Firefox window to suit your needs.

*Customization in Action*

Right-click on the toolbar (<kbd>Ctrl</kbd>+Click on Mac), and select
"Customize&#20046;".  Using your mouse, you can drag additional, or move
existing buttons and toolbars to whereever you like.  To remove a button, just
drag it off the toolbar to the customization panel.

(Note: &#20046; is a horizontal elipsis.)

<div class="figure">
<img src="../../images/screenshot-ff-customization.gif"
     alt="The customization panel shows all the additional buttons
          and toolbars that you can add and arrange however you like"
     height="234" width="300">
</div>

Comment 11

[Lachlan Hunt]

The character reference I included for the horizontal elipsis in comment 10
(乎) is incorrect.  I accidentally selected octal, instead of decimal.  It
should have read "Customise…".

Comment 12

[Daniel Wang]

http://www.mozilla.org/products/firefox/ui-customize updated.
I've incorporated some of Lachlan Hunt's suggestions but leave some content from
Bob Chao. I've also list Bob Chao and Lachlan Hunt as the contributors (instead
of the rather opaque moztw.org/mdp names)

Comment 13

[Daniel Wang]

Attachment: no more nuisance v0.1

incredibly, daniel has some original thoughts ;-)

Comment 14

[Ivan Ičin]

Customization:

Should instead of: 'Right click on the toolbar' in 2nd paragraph be 'Right click
on Navigation toolbar'? Right-clicking on Bookmark toolbar does not have desired
effect, and may confuse.


Shouldn't this all go under themes section? I think that it is not for the front
page as most users never change layout of toolbar even when it is possible
(turning the toolbars on and off is a different story). Those that have need to
do that will certanly succeed in that as every program has such options, though
they may not be too user-friendly.

I would more hold on default look and its qualities. That's what average users
are interested in. And Firefox has advantages there. Well, can customization be
put into the same section as themes, and instead of that new section be added
like 'clear and easy to use interface' (well, customization may be included in
this topic instead of themes, but I think that it is not the best solution)?

P.S. Nice text about pop-ups Daniel :)

Comment 15

[Daniel Wang]

Attachment: patch to link to the new docs

Minor edits to text-zoom and ui-customize pages. Add links to these pages from
product page. + other misc. changes.

rebron, can you review this patch?

Comment 16

[Daniel Wang]

Attachment: mozilla.org/products/firefox/popup-blocker

HTML page for No More Nuisance (popup blocker)

Comment 17

[Daniel Wang]

Attachment: mozilla.org/images/screenshot-ff-adv-js-options.png

screenshot for popup-blocker.html

Comment 18

[Daniel Wang]

Attachment: mozilla.org/images/screenshot-ff-popup-info-bar.gif

Comment 19

[Daniel Wang]

Attachment: mozilla.org/images/screenshot-ff-popup-status-icon.png

Comment 20

[Grey Nicholson (they/them)]

Some miscellaneous comments based on the previous comments here and on the
documents as found on mozilla.org:

> No More Eye Strain, Resize Text Easily!
The comma there should probably be a dash. Also if the exclamation mark must be
kept, I'd put it with "No More Eye Strain", rather than with "Resize Text
Easily": "Resize Text Easily - No More Eye Strain!".

Alternatively, just use "Resize Text Easily" as the title, as it fits better
with the other tips documents.

(Also, the demonstratory image needs updating, but that should probably be left
until the document is closer to being finished.)


> If your mouse has a mouse wheel, you can press and hold down the Ctrl key and
> use it to zoom text.

I'd change this to "If your mouse has a scroll wheel, you can hold Ctrl and use
the wheel to resize text.".


> Return to normal size
>
> If you've made the text too small or too large, Press Ctrl+0 to return the text
> back to normal.

I suggest the title "Reset the text size"; "Press Ctrl+0" doesn't need a capital
"P"; "Ctrl" still needs <kbd>-ifying.


> From the Tools menu, select "Options...". In the "General" options

I don't think a sentence break is needed - I'd change this to:
From the Tools menu, select "Options...", then in the "General" options

For the "ui-customize" document:

> Don't like the arrangment of the toolbar buttons?
"arrangment" should be "arrangement".

> Right click on the toolbar (Ctrl+click on Mac)
Apple uses the term "control-click", so we should use that instead.


Finally, I'd add "good" before "English" in this bug's summary.

Comment 21

[Daniel Wang]

Attachment: update text-zoom.html

(note: text-zoom.html still not linked from anywhere)

Comment 22

[Anne (:annevk)]

Comment on attachment 185110 [details] [diff] [review]
update text-zoom.html

> <html>

Could you add a LANG attribute?


>+  <ul id="nav">

This ID already exists. You have to integrate it with the other one or drop the
idea.

The rest looks ok. r=annevankesteren with this fixed.

Comment 23

[Mike Connor [:mconnor]]

We really need to find a real home for user docs (vs. product site stuff)

Comment 24

[Reed Loden [:reed]]

--> mozilla.org :: www.mozilla.org

Pages still seem to be on w.m.o but not w.m.c.

Comment 25

[Reed Loden [:reed]]

Comment on attachment 185110 [details] [diff] [review]
update text-zoom.html

Rerequesting r? due to bug move.

Comment 26

[Chris Ilias [:cilias]]

This bug was recently assigned to me; but I'm not sure what you want me to do.
- update the pages?
- move the pages to the support directory?
- add links to these pages to the support site?

The URLs in comment 0 redirect to other pages on mozilla.com:
http://www.mozilla.com/firefox/tabs
http://www.mozilla.com/firefox/livebookmarks.html

Should this not be given to pkim?

Comment 27

[David Boswell]

Adding Pascal to bug.  Since this is a few years old, it's entirely possible this content has already been posted somewhere.  If not, Pascal might want to take this content and do something with it.  Either way this sort of Firefox related content is no longer hosted on www.mozilla.org so we should move this to a different component if it's still an open bug.

Comment 28

[Samuel Sidler (old account; do not CC)]

If anything, this belongs on SUMO now.

Comment 29

[Pascal Chevrel:pascalc (PTO until April 26)]

agreed that this is for Sumo, David should see if it is interesting content for him, CCing him.

Comment 30

[David Boswell]

Re comments #28 and #29, moving to SUMO product for discussion.

Comment 31

[Chris Ilias [:cilias]]

There are a lot of docs in this bug, but I think there is already a KB article for each.
https://support.mozilla.com/en-US/kb/Tabbed+browsing
https://support.mozilla.com/en-US/kb/Live+Bookmarks
https://support.mozilla.com/en-US/kb/Text+Zoom
https://support.mozilla.com/en-US/kb/How+to+customize+the+toolbar
https://support.mozilla.com/en-US/kb/Pop-up+blocker