145926 - Navigator Preferences - DOM Inspector help content needed

Status: VERIFIED FIXED

(Documentation Graveyard :: Help Viewer, defect)

Description

[David E. Weekly]

Go to Edit>Preferences>Advanced>Help. (Note that "Help" generically comes up but
doesn't direct you to the Advanced Preferences Help page.) Search for
"pipelining". Note that the Help page that comes up on Advanced Preferences does
not include sections for "HTTP Networking" or the "DOM Inspector" that are now
present in the 1.0 build.

The help documentation should be updated to reflect the features found in 1.0,
such as pipelining.

Comment 1

[rudman]

-->jatin.

Comment 2

[Olav Vitters]

*** Bug 161894 has been marked as a duplicate of this bug. ***

Comment 3

[Olav Vitters]

See also bug 143590

Comment 4

[Gabriele Fava]

I have 1.1b. The "HTTP Networking" section is present, but not correctly linked,
;look at the "Advanced Preferences" page. "DOM Inspector" instead still lack of
help.

Comment 5

[Daniel Wang]

change scope of bug (see bug 143590)

Comment 6

[Daniel Wang]

.

Comment 7

[R.J. Keller]

This bug is part of bug 145056.

*** This bug has been marked as a duplicate of 145056 ***

Comment 8

[R.J. Keller]

ah. reopening. I see now what Daniel is doing. This bug is ok. Sorry everyone!

Comment 9

[Daniel Wang]

Attachment: patch

Comment 10

[R.J. Keller]

swapping owner and QA.

Comment 11

[Christopher Aillon (sabbatical, not receiving bugmail)]

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

I'm fine with the changes in general, but I'd rather have timeless take a look
at the grammar.  I'm not sure I like the "type how fast" stuff.  Also I think
the introductory text sounds a bit kludgy (if you are not already viewing it --
it what?)  I think you're also missing a ui span on System.  Timeless may have
some more comments.

Comment 12

[timeless]

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

i'm not particularly happy w/ '(v)type', what if i want to scribble w/ my
peninput device? :)

Comment 13

[Daniel Wang]

Attachment: patch v2

Comment 14

[Daniel Wang]

Comment on attachment 139548 [details] [diff] [review]
patch v2

sorry, wasn't paying attention to this bug. "type" was used because it's used
elsewhere in Help. I change all "type" the verb to "enter". Will update other
files when I have time.

Comment 15

[timeless]

Comment on attachment 139548 [details] [diff] [review]
patch v2

>+<li><b>No Proxy for</b>: Enter the domains and/or IP address that you do not want to use a proxy 
should be addresses, but it's not related to the bug at hand.

> <li><b>Scroll the document by</b>: Choose this to scroll the document by 
>+        the number of lines entered in the field. 
"the field" is wrong, but again, it's not related to the bug at hand.

>+<h2 id="dom_inspector">Advanced Preferences - DOM Inspector</h2>
>+
>+<p>DOM Inspector is an optional
>+<a href="developer_tools.xhtml">Web developement component</a>.
developement (sp)

...

>+<p>The DOM Inspector preferences panel allows you to control how
>+DOM Inspector highlights the selected HTML/XML element:</p>
"the selected ..." hrm, no...
the HTML/XML element that you select, i think.

>+<ul>
>+  <li><b class="ui">Blink Selected Element</b>: Check this option to
>+    automatically flash the selected element when you select an
>+    element node in DOM Inspector.</li>
i don't really like 'flash', i think it has a meaning which doesn't match the
behavior.
It could just be that the ui text is wrong. we don't really blink the item, we
just paint around its edges...

>+  <li><b class="ui">Border Color</b>: Select the border color used to
>+    highlight the flashed element.</li>
flashed, hrm... i don't like it.

>+  <li><b class="ui">Border Width</b>: Select the width of the highlight border.
i like 'highlight'

the following pair is confusing:
>+  <li><b class="ui">Blink Duration</b>: Enter how long you want the flashed
>+    element to flash in milliseconds.</li>
perhaps when to stop flashing

>+  <li><b class="ui">Blink Speed</b>: Enter how fast you want the flashed
>+    element to flash in milliseconds.</li>
perhaps the interval for flashing?

>*****CVS exited normally with code 1*****
can you try to avoid this ^^

Comment 16

[Daniel Wang]

Attachment: patch v3

Comment 17

[timeless]

Comment on attachment 139816 [details] [diff] [review]
patch v3

>+<li><b>Cache</b>: Enter in the amount of disk cache you want to allocate 
> for Mozilla. Disk cache is saved to your hard disk (drive) and can be used again 
	       ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
needs love, but you can file a bug and fix it later.

>+<h2 id="dom_inspector">Advanced Preferences - DOM Inspector</h2>
>+
>+<p>DOM Inspector is an optional
>+<a href="developer_tools.xhtml">Web developement component</a>.
>+This section describes how to use its preferences panel.
>+If you are not already viewing it, follow these steps: </p>
>+
>+<ul>
>+  <li>Open the <span class="ui">Edit</span> menu and choose
>+      <span class="ui">Preferences</span>.</li>
>+  <li>Under the <span class="ui">Advanced</span> category, click System.

System?? Don't you mean dom inspector?

>+      (If no subcategories are visible, double-click 
>+      <span class="ui">Advanced</span> to expand the list.)</li>
>+</ul>

>+  <li><b class="ui">Blink Speed</b>: Enter the interval of blinking

|interval of| sounds really awkward.

Comment 18

[Stefan [:stefanh]]

Attachment: Slightly different patch

Here's a new, updated patch - adds only DOM Inspector content. Slightly changed
wording compared to Daniel's patch.

Comment 19

[Stefan [:stefanh]]

Comment on attachment 162221 [details] [diff] [review]
Slightly different patch

Neil, please tell me what you think.

Comment 20

[Stefan [:stefanh]]

Comment on attachment 162221 [details] [diff] [review]
Slightly different patch

Neil, please tell me what you think.

Hmm, Daniel - you're not working on this, right?

Comment 21

[Daniel Wang]

+      <li><strong>Invert Color</strong>: Check this option to color the
+        selected element with the inverted border-color.</li>

this is a bit confusing. How about "...to draw/paint the selected element..."?

Comment 22

[Stefan [:stefanh]]

Attachment: New version

> +	 <li><strong>Invert Color</strong>: Check this option to color the
> +	   selected element with the inverted border-color.</li>
> 
> this is a bit confusing. How about "...to draw/paint the selected
element..."?

Yes, color and border-color might be bit confusing.

Comment 23

[Stefan [:stefanh]]

Comment on attachment 162243 [details] [diff] [review]
New version

OK, this should be the one (found a missing whitespace as well)...

Comment 24

[Giacomo Magnini]

Very minor nit: useless space before the first </p> (after ":")

Comment 25

[Stefan [:stefanh]]

Attachment: Same as above but without the whitespace

OK, here's a new version without the whitespace. I don't want to spam Neil with
a new review request, though.

Comment 26

[[e-mail]]

Comment on attachment 162243 [details] [diff] [review]
New version

>+<p>The DOM Inspector preferences panel allows you to configure DOM Inspector
>+  to blink an element that you select:</p>
What about the DOM Inspector sidebar? As it is, this text on its own looks a
bit repetitive. And it doesn't really define what blinking an element means,
you have to guess from the options. In fact, you don't actually have to use the
word blink yourself, except in the titles for the descriptions. How about,
"When you select an element DOM Inspector can automatically highlight it by
flashing its border."

>+    automatically blink the selected element when you select an element node in
You've selected the element twice here too, it's overkill.

>+      <li><strong>Border Color</strong>: Select the color of the blinking
>+        border around the element.</li>
>+      <li><strong>Border Width</strong>: Select the width of the blinking
>+        border around the element.</li>
I don't like using "blinking" as an adjective, please try to rephrase this.

>+      <li><strong>Blink Duration</strong>: Enter how long time
>+        (in milliseconds) you want the blinking to occur.</li>
Well, the most grammatical phrase I could come up with was "Enter the length of
time (in milliseconds) for which you want the blinking to occur" but you could
probably get away with leaving out the "for which".

>+      <li><strong>Blink Speed</strong>: Enter how fast (in milliseconds) you
Should be Enter how quickly (in milliseconds)
[You need an adverb here but fast is an adjective. This error is frequent even
amongst native English speakers.]

>+        selected element with the inverted border-color.</li>
No "-" please, border color will do.

Comment 27

[Stefan [:stefanh]]

Attachment: New version with different wording

This version uses different wording. Found another (2.5 years old) error.

"Choose this to override the number of lines entered and instead the system
default setting"

is now "Choose this to use your system's default setting葉he number of lines
you may have previously entered will be overridden" with some help of IanN.

Comment 28

[Ian Neal]

Comment on attachment 163158 [details] [diff] [review]
New version with different wording

>+<p>DOM Inspector is an optional <a href="developer_tools.xhtml">Web development
>+  component</a>. This section describes how to use its preferences panel.
>+  If you are not already viewing it, follow these steps:</p>
This sounds awkward, perhaps:
"If you do not already have it open, follow these steps:"

+<p>When you select an element, DOM Inspector can automatically highlight it by
+  flashing its border:</p>
You start off well and then go back to elements that blink - some suggestions
below.

>+  <li><strong>Blink Selected Element</strong>: Check this option to
>+    automatically blink an element that you select.
automatically flash its border

>+      <li><strong>Blink Duration</strong>: Enter the length of time
>+        (in milliseconds) you want the blinking to occur.</li>
Enter the length of time (in milliseconds) for the flashing to continue for.

>+      <li><strong>Blink Speed</strong>: Enter how quickly (in milliseconds) you
>+        want the element to blink.</li>
Enter how quickly (in milliseconds) you want the border to flash.

Comment 29

[Stefan [:stefanh]]

Attachment: New version

New version based on discussion with Ian.

Comment 30

[Ian Neal]

Comment on attachment 163221 [details] [diff] [review]
New version

r=[e-mail]

Comment 31

[Ian Neal]

Checking in cs_nav_prefs_advanced.xhtml;
/cvsroot/mozilla/extensions/help/resources/locale/en-US/cs_nav_prefs_advanced.xhtml,v
 <--  cs_nav_prefs_advanced.xhtml
new revision: 1.29; previous revision: 1.28
done
Checking in help-toc.rdf;
/cvsroot/mozilla/extensions/help/resources/locale/en-US/help-toc.rdf,v  <-- 
help-toc.rdf
new revision: 1.66; previous revision: 1.65
done

Comment 32

[Stefan [:stefanh]]

--> Fixed.

Comment 33

[Stefan [:stefanh]]

v