New FAQ Version for review

[Randy Webb]

There is an updated version of the FAQ at:
<URL: http://jibbering.com/faq/newfaq/>

The changes/modifications to date are:

2.3 Corrected "span" to "spam".
2.3 Updated with a note about not posting copyrighted material.
2.3 Removed paragraph about Google Groups.
2.3 Para 5 Added note about code being executable as transmitted.
2.4 Made an LI list of the answers.
2.7 Updated with a reference to the MS group for JScript.
3.1 Updated to include Fifth Edition.
3.2 (WSH) added to the .wsh newsgroup reference.
3.2 Added links to the MS Debugger and Documentation.
3.2 Updated to refer to microsoft.public.scripting.wsh rather than
Google Groups
4.4 Updated with new links on cookies.
4.6 Updated to refer to 4.7 Wording questionable?
4.9 Retitled "How do I find the size of the browser canvas area?"
4.13 Slightly reworded.
4.20 Updated to refer to the delay in setTimeout and setInterval
4.43 Updated to reflect the new location of the JS Console in Opera
5.1 Updated to request draft proposal for an FAQ Entry.

There are probably some changes I failed to notate when doing it. I
still have 24 more FAQENTRY requests to sort through and then the
discussions on the FAQ since Bart has been posting a section a day.

I think that 3.2 is getting sufficiently lengthy enough that it might
benefit from being moved to a page of it's own.

Thoughts and comments are welcome.

 

[Richard Cornford]

There is an updated version of the FAQ at:
<URL: http://jibbering.com/faq/newfaq/>

The changes/modifications to date are:

4.9 Retitled "How do I find the size of the browser canvas area?"

I take it you did not buy Lee's justification that the question that
actually is frequently asked is about "window" size, even if the
information required, and the answers given, actually relate to client
area size?

4.13 Slightly reworded.

<snip>

I never thought that there was anything wrong with the wording of 4.13
as it was, but while you are enumerating situations where just reading -
contrl.value - is problematic don't <IINPUT type="file"> elements
qualify?

Richard.

 

[Randy Webb]

Richard Cornford said the following on 11/26/2006 6:51 PM:

I take it you did not buy Lee's justification that the question that
actually is frequently asked is about "window" size, even if the
information required, and the answers given, actually relate to client
area size?

I can buy that justification, it is just a misleading title is all. It
is now reworded again:

"How do I find the size of the window/browser canvas area?"

With this note:

While it is often asked about window size, what is more relevant is the
"canvas area" of the browser.

<snip>

I never thought that there was anything wrong with the wording of 4.13
as it was,

The wording, as it was, implied there was One exception, then it says
there is another exception. It was just misleading to me is all and if
it gets to where the way it is now is misleading, it can be changed back.

but while you are enumerating situations where just reading -
contrl.value - is problematic don't <IINPUT type="file"> elements
qualify?

Sure it does, and there is now a small snippet there. I was going to
find a section of <URL:
http://www.jibbering.com/faq/faq_notes/form_access.html> that dealt with
File Inputs but it doesn't appear anywhere in that document.

I am pretty sure the wording of Third Exception leaves a lot to be
desired and is open to be changed again.

 

[RobG]

There is an updated version of the FAQ at:
<URL: http://jibbering.com/faq/newfaq/> [...]
Thoughts and comments are welcome.

Can you update the CSS? The current FAQ looks very, very dated. The
format of the "Javascript Best Practices" page is pretty good[1],
perhaps that (or something similar) can be adopted without too much
effort?

Maybe Matt would volunteer, if not, I'm happy to do it.


1. The text is set too small and the dashed borders are kitsch ;-),
otherwise it's simple, clean and reasonably modern.

 

[Randy Webb]

RobG said the following on 11/27/2006 12:20 AM:

There is an updated version of the FAQ at:
<URL: http://jibbering.com/faq/newfaq/> [...]
Thoughts and comments are welcome.

Can you update the CSS?

Sure can, its a work in progress

The current FAQ looks very, very dated. The format of the "Javascript
Best Practices" page is pretty good[1], perhaps that (or something
similar) can be adopted without too much effort?

It would just be a matter of creating a file call faq.css and uploading it.

Maybe Matt would volunteer, if not, I'm happy to do it.

Save the index.html and faq.css files locally, modify them and email
them to (e-mail address removed) and I can upload it and get it reviewed.
<URL: http://jibbering.com/faq/newfaq/index.html>
<URL: http://jibbering.com/faq/newfaq/faq.css>

 

[Randy Webb]

Randy Webb said the following on 11/26/2006 5:39 PM:

There is an updated version of the FAQ at:
<URL: http://jibbering.com/faq/newfaq/>

There is a new upload there that reflects some changes based on Richards
thoughts, Evertjan's comma and a section 4.44 entitle "What is AJAX?"

Any thoughts, comments or corrections appreciated.

 

[Bart Van der Donck]

Randy Webb said the following on 11/26/2006 5:39 PM:

There is a new upload there that reflects some changes based on Richards
thoughts, Evertjan's comma and a section 4.44 entitle "What is AJAX?"

Any thoughts, comments or corrections appreciated.

Thanks for the good work !

 

[Richard Cornford]

Richard Cornford said the following on 11/26/2006 6:51 PM:

The wording, as it was, implied there was One exception,
then it says there is another exception.

<snip>

No it did not. It gave two examples of exceptions form an indefinite
set.

Richard.

 

[Randy Webb]

Richard Cornford said the following on 11/27/2006 6:36 PM:

<snip>

No it did not.

Yes it did.

It gave two examples of exceptions form an indefinite set.

The set of form elements and the ways of accessing them is not an
indefinite set, nor are the problems associated with it. So a subset of
a fixed set can't be an indefinite set.

 

[Dr J R Stockton]

In comp.lang.javascript message <[email protected]>,

There is an updated version of the FAQ at:
<URL: http://jibbering.com/faq/newfaq/>

It (unlike 8.1) lacks a clear statement as to who maintains it.

Also, it's not clear what the present status of the FAQ Notes is.
Are they still maintained?
Are they abandonware, (c) RC?
Are they detached parts of the FAQ, similarly maintained, (c)
newsgroup?

IMHO, each Note should be annotated with the name of its author, its
maintainer if different, and its date; the link to the index page should
be dejargonised and repeated at the top, and the Notes index page should
enlarge a little on such matters. The final link at the top of Notes
Index, to zipped Notes & FAQ, needs consideration.

<FAQENTRY>FAQ section 1, or thereabouts, should contain a link to each
individual Note, as a list.
</FAQENTRY>

If they are not now maintained, the FAQ should make that clear.

4.20 Updated to refer to the delay in setTimeout and setInterval

The added sentence includes "generally". ISTM that, for the common case
where the requested delay is a multiple of the tick interval, IE6 in
WinXP does not do that; and if IE6 (so, probably, IE7?) does not do it,
can "generally" be right?

The delay is not *caused* by the difference.

"The delay ... may exceed ... (browsers differ)."


TIDY checker reports missing <li> in 4.29. Probably four are missing
(see issue 8.1, 4.29).


2.1 : Subject now ungrammatical.


4.12 Subject : but parseInt('09') does not give an error. It gives, as
it should, a Number of value 0.

"4.12 Why does K = parseInt('09') set K to 0?

Function parseInt(S, B) accepts two arguments, string S and base B; the
first character (leading whitespace excepted) in S which in that
position cannot be part of a base-B number terminates number reading.

If B is not given : S with leading "0x" or "0X" is read as Hexadecimal,
else S with leading "0" is read as Octal, otherwise S is read as
Decimal. Generally, it is better to use unary + : K = +S ."



N.B. When an entry's Subject is a question, the entry's body should
*always* explicitly answer that question. It should usually, but should
not only, present a solution to any implied problem. If necessary,
change the Subject.


4.16 How do I trim whitespace ...

String "aaa zzz" contains trimmable whitespace; but the entry ignores
that case. ASCII should read Unicode.


Count : "enviroment" 3, "environment" 1.

I think that 3.2 is getting sufficiently lengthy enough that it might
benefit from being moved to a page of it's own.

Can one have confidence in an author who, seemingly having lived for
many years in a nominally English-speaking country, and in spite of
frequently-presented examples in this newsgroup, still apparently
believes "it's" to be a genitive? Also FAQ 4.44.

It's a good idea to read the newsgroup and its old FAQ. See below.

 

[Martin Honnen]

Randy Webb said the following on 11/26/2006 5:39 PM:

There is a new upload there that reflects some changes based on Richards
thoughts, Evertjan's comma and a section 4.44 entitle "What is AJAX?"

Nit on spelling in the AJAX explanation, the object is named
"XMLHttpRequest" and not "XMLHTTPRequest".

You could also add links to the Mozilla documentation
<http://developer.mozilla.org/en/docs/XMLHttpRequest>
and the IE documentation of the object
<http://msdn.microsoft.com/library/d...html/reference/objects/obj_xmlhttprequest.asp>
<http://msdn.microsoft.com/library/d...html/63409298-0516-437d-b5af-68368157eae3.asp>

 

[Randy Webb]

Martin Honnen said the following on 11/28/2006 12:21 PM:

Nit on spelling in the AJAX explanation, the object is named
"XMLHttpRequest" and not "XMLHTTPRequest".

You could also add links to the Mozilla documentation
<http://developer.mozilla.org/en/docs/XMLHttpRequest>
and the IE documentation of the object
<http://msdn.microsoft.com/library/d...html/reference/objects/obj_xmlhttprequest.asp>

<http://msdn.microsoft.com/library/d...html/63409298-0516-437d-b5af-68368157eae3.asp>

Is it worth using the non-framed URL for the MSDN articles? It makes it
even longer for the FAQ:

<URL:
http://msdn.microsoft.com/library/d...bj_xmlhttprequest.asp?frame=true&hidetoc=true>

I tried this one:

<URL:
http://msdn.microsoft.com/workshop/author/dhtml/reference/objects/obj_xmlhttprequest.asp>

And it takes you to the page but then MS automatically puts it back in
the frameset with the tree view :\

 

[Martin Honnen]

Is it worth using the non-framed URL for the MSDN articles?

Hard to answer in general, I prefer having the toc tree on the left to
be able to navigate easily to e.g. objects/properties/methods. But I am
usually sitting in front of a desktop system with a large enough monitor
not to be hurt by frames taking up space. A laptop user might have other
preferences.

 

[Dr J R Stockton]

In comp.lang.javascript message

<snip>

No it did not. It gave two examples of exceptions form an indefinite
set.

We cannot expect a Merkin to be able to understand English.

By "One exception ..." ... "Another exception ..." you clearly suggested
that at least one other exception was possible or likely or certain.

Randy asserts that there are exactly three exceptions - which is
egg-on-his-face if anyone demonstrates another,


But, you being a Failed FAQ writer, it ill behoves you to criticise one
who is at least trying.

It's a good idea to read the newsgroup and its old FAQ. See below.

 

[RobG]

RobG said the following on 11/27/2006 12:20 AM:

There is an updated version of the FAQ at:
<URL: http://jibbering.com/faq/newfaq/> [...]
Thoughts and comments are welcome.

Can you update the CSS?

[...]

Save the index.html and faq.css files locally, modify them and email
them to clj...net and I can upload it and get it reviewed.

OK, done that.

Mac users (Safari users in particular) should change their monospace
font to Monaco 14pt, the default Courier (new) 13pt is way too small on
all browsers and monitors.

 

[Peter Michaux]

There is an updated version of the FAQ at:
<URL: http://jibbering.com/faq/newfaq/>

Thoughts and comments are welcome.

Below are a few.

Peter

------------

There seem to be two leading spaces at the start of each code example.

------------

In section 4.9

When using IE6 with in CSS1Compat mode (with a Formal DOCTYPE)

Would this be clearer as the following?

When using IE6 with in CSS1Compat mode (i.e. with a Formal DOCTYPE)

------------

In section 4.13

In HTML documents, named forms may be referred to as named properties of the document.forms collection

It seems to me that named forms are also available as properties of the
document object.

------------

In section 4.15

Using the DOM and Microsoft's innerHTML extension

This could be interpreted as innerHTML is only available in IE. Could
"Microsoft's" be replaced with "the non-standard but widely
implemented"

The code example in this section seems to be for browsers without
function literals. To which browsers does this cater? Does this example
deserve updating?

------------

In Section 4.18

The last sentance in section 4.18 could be moved to 4.44

------------

In Section 4.22

The function name "Random" is capitalized which is usually reserved for
constructor functions. Perhaps this should be lower case

The featured code in the yellow box doesn't answer the section's title
question. The actual answer is added like an after thought.

gives a random number in the range 0..(x-1); Random(N)+1 for [1..N]

The range notation is not consistent in this sentence. I suggest the
use standard range notation: [1, N] and [1, N) or [1, N-1]


------------

Could sections 4.25 and 4.39 should be close together or merged?

------------

In Section 4.31

Could a mention of preloading images be added. Something like

(new Image()).src = "http://example.com/maui.gif"

If the image is served with correct headers when this JavaScript runs
then the first time the roll over is used it won't be slow, at least in
some browsers.

Perhaps mentioning that sliding images can be used instead like RobG (I
believe) mentioned within the last weeks.

------------

In Section 4.34

Mozilla, Safari, and the Windows version of IE (and Opera 7.6+)

I think Opera deserves to be outside of parentheses. Something like
this with the correct version numbers. (I'll research the correct
numbers if someone doesnt know off the top of their more knowing head.)
Something more like this...

Mozilla (NN6+, Firefox, Ice Weasle etc), Opera 7.6+, Safari, the
Windows version of IE versions 5+, and some other browsers

------------

In Section 4.39

There are two equivalent ways to access properties

I suggest the removal of the word equivalent

------------

In Section 4.43

The Firebug extension in Firefox is so valuable I think it is worth a
mention. Firebug is just going to version 1.0

http://www.getfirebug.com/

------------

In Section 4.44

Ajax only has one capital letter. It may be an acronym but Ajax was
also a Greek God or something.

http://www.adaptivepath.com/publications/essays/archives/000385.php

 

[RobG]

Randy Webb wrote:
[...]

Check your email for an alternative email address. After checking it
from some other email addresses I don't think ctvea.net likes the file
attachments. It wouldn't even let me send myself an attachment. What a
service that is there!

Thanks, done that. I may not have properly attached the files.

 

[Randy Webb]

RobG said the following on 11/28/2006 8:39 PM:

Randy Webb wrote:
[...]

Check your email for an alternative email address. After checking it
from some other email addresses I don't think ctvea.net likes the file
attachments. It wouldn't even let me send myself an attachment. What a
service that is there!

Thanks, done that. I may not have properly attached the files.

I am not sure it was you. I tried sending myself an email with an
attachment and the email went through but without the attachment. I have
to call them and find out what happened and why.

 

[Randy Webb]

Peter Michaux said the following on 11/28/2006 8:28 PM:

Below are a few.

Peter

Fixed. I am not sure how it happened but the file that processes the XML
file was adding a leading space. The original has that leading space
added but I don't see it in the FAQ itself so not sure what is going on
with that one.

------------

In section 4.9


Would this be clearer as the following?

When using IE6 with in CSS1Compat mode (i.e. with a Formal DOCTYPE)

Not sure but it is added.

------------

In section 4.13


It seems to me that named forms are also available as properties of the
document object.

They are. But the FAQ was stressing using the FORMS collection.

------------

In section 4.15


This could be interpreted as innerHTML is only available in IE. Could
"Microsoft's" be replaced with "the non-standard but widely
implemented"

Not sure why it was worded that way in the past, sure there was a reason
but it's modified. If there was a good reason that is still there now, I
am sure we will hear about it

The code example in this section seems to be for browsers without
function literals. To which browsers does this cater? Does this example
deserve updating?

What do you propose updating it to? And, what is wrong with what is
there now?

------------

In Section 4.18

The last sentance in section 4.18 could be moved to 4.44

I'm not too sure that sentence should appear at all except in 4.44 so I
moved the last sentence, along with the link, to 4.44 as an alternative
to the XMLHttpRequest Object.

------------

In Section 4.22

The function name "Random" is capitalized which is usually reserved for
constructor functions. Perhaps this should be lower case

Almost except that it uses Math.random() in the code. IIRC it was
capitalized to prevent confusion with Math.random()

The featured code in the yellow box doesn't answer the section's title
question. The actual answer is added like an after thought.

True :\

gives a random number in the range 0..(x-1); Random(N)+1 for [1..N]

The range notation is not consistent in this sentence. I suggest the
use standard range notation: [1, N] and [1, N) or [1, N-1]
Modified.

They are closely related but different. One deals with forms with []
characters in the name while the other deals with Bracket Notation in
general. Of which I have never agreed with terming it "illegal
characters" as [] are perfectly valid in HTML attributes. The problem
comes when trying to access them via script. But, it was agreed to the
wording with regards to being illegal.

The problem with merging them is historical links in the archives. Right
now I want to try to update what is there and get it live. Then it will
be time to try to go through this again with another layout/format after
there is an updated FAQ on-line.

------------

In Section 4.31

Could a mention of preloading images be added.

I have always thought it should mention it. The word "preload" nor
"pre-load" appear in the FAQ anywhere and typically when people ask
about that entry they are generally wanting to know how to preload
images. Whenever a preload entry has come up someone always beckons
about "It might not work in browser KYJ so don't do it".

The last line in that entry implies that headers are the only way to
overcome that problem and I have never seen a browser where preloading
them using new Image() didn't do the trick.

Personally, I think the whole entry needs to be retitled and re-written
as a "How do I preload images" entry along with the notes/links about
headers.

Something like
(new Image()).src = "http://example.com/maui.gif"

If the image is served with correct headers when this JavaScript runs
then the first time the roll over is used it won't be slow, at least in
some browsers.

Perhaps mentioning that sliding images can be used instead like RobG (I
believe) mentioned within the last weeks.
------------

In Section 4.34


I think Opera deserves to be outside of parentheses. Something like
this with the correct version numbers. (I'll research the correct
numbers if someone doesnt know off the top of their more knowing head.)

I moved the code line there to a box of it's own. Even in the old
version it starts at the end of the paragraph.

Something more like this...

Mozilla (NN6+, Firefox, Ice Weasle etc), Opera 7.6+, Safari, the
Windows version of IE versions 5+, and some other browsers

Updated, as you have it. If you can find version numbers for the first
level of each browser that supports it I can add the version numbers to it.


Section 4.38:

I added a link to <URL: http://www.ajaxtoolbox.com> and removed the link
to Laurents Java page. In this thread:

<URL:
http://groups-beta.google.com/group...st&q=Laurent+FAQ+Java&rnum=1#0f859a94afc95598>

Laurent recommended against using it so it's removed.

------------

In Section 4.39


I suggest the removal of the word equivalent

Done. They have never been equivalent and never will

------------

In Section 4.43

The Firebug extension in Firefox is so valuable I think it is worth a
mention. Firebug is just going to version 1.0

http://www.getfirebug.com/

Added. It probably needs to be reworded but it is there.

------------

In Section 4.44

Ajax only has one capital letter. It may be an acronym but Ajax was
also a Greek God or something.

http://www.adaptivepath.com/publications/essays/archives/000385.php

Ajax has been so many things nobody is sure anymore But, it is changed.

Thank you.

 

[Randy Webb]

Dr J R Stockton said the following on 11/28/2006 7:43 AM:

In comp.lang.javascript message <[email protected]>,


It (unlike 8.1) lacks a clear statement as to who maintains it.

It is added back but it didn't make a hill of beans to me so I removed
it. But, it's back in there now.

Also, it's not clear what the present status of the FAQ Notes is.
Are they still maintained?

What has indicated that they aren't?

Are they abandonware, (c) RC?
Are they detached parts of the FAQ, similarly maintained, (c)
newsgroup?

<shrug>

Do you have a proposed Notes page to add? If so, URL to it and it will
get reviewed, uploaded, and a link added to the Notes page.

IMHO, each Note should be annotated with the name of its author, its
maintainer if different, and its date;

The date, perhaps. But Author and Maintainer? The FAQ is for
information, not personal glorification.

the link to the index page should be dejargonised and repeated at the top,
and the Notes index page should enlarge a little on such matters.

What is so "jargonized" about the link and what is a proposed re-wording?

The final link at the top of Notes Index, to zipped Notes & FAQ, needs
consideration.
<FAQENTRY>FAQ section 1, or thereabouts, should contain a link to each
individual Note, as a list.
</FAQENTRY>

Why? There is already a TOC to the Notes.

If they are not now maintained, the FAQ should make that clear.

I have seen nothing to indicate they aren't maintained.

The added sentence includes "generally". ISTM that, for the common case
where the requested delay is a multiple of the tick interval, IE6 in
WinXP does not do that; and if IE6 (so, probably, IE7?) does not do it,
can "generally" be right?

The delay is not *caused* by the difference.

"The delay ... may exceed ... (browsers differ)."


TIDY checker reports missing <li> in 4.29. Probably four are missing
(see issue 8.1, 4.29).

Fixed the LI issue. It was the result of an errant search/replace.

2.1 : Subject now ungrammatical.
Whatever.


4.12 Subject : but parseInt('09') does not give an error. It gives, as
it should, a Number of value 0.
"4.12 Why does K = parseInt('09') set K to 0?

Function parseInt(S, B) accepts two arguments, string S and base B; the
first character (leading whitespace excepted) in S which in that
position cannot be part of a base-B number terminates number reading.

If B is not given : S with leading "0x" or "0X" is read as Hexadecimal,
else S with leading "0" is read as Octal, otherwise S is read as
Decimal. Generally, it is better to use unary + : K = +S ."

I won't have this argument with you again. It has been had in the past
and when it was had you simply ducked around the argument.

N.B. When an entry's Subject is a question, the entry's body should
*always* explicitly answer that question. It should usually, but should
not only, present a solution to any implied problem. If necessary,
change the Subject.

There is nothing wrong with the Subject though.

4.16 How do I trim whitespace ...

String "aaa zzz" contains trimmable whitespace; but the entry ignores
that case. ASCII should read Unicode.

Proposed alternative?

Count : "enviroment" 3, "environment" 1.



Can one have confidence in an author who, seemingly having lived for
many years in a nominally English-speaking country, and in spite of
frequently-presented examples in this newsgroup, still apparently
believes "it's" to be a genitive? Also FAQ 4.44.

Mea bouws doun befoor yer majisty an beags fer fergiveness fer mi
transgreshuns.

NGFY