Re: FAQ Clean-Up
- From: Dr J R Stockton <jrs@xxxxxxxxxxxxxxxxxx>
- Date: Thu, 2 Oct 2008 18:05:24 +0100
In comp.lang.javascript message <gc0bna$qqh$1@xxxxxxxxxxxxxxxxxxxxxxxxx>
, Wed, 1 Oct 2008 10:23:36, dhtml <dhtmlkitchen@xxxxxxxxx> posted:
Did I miss an announcement of an appointment
while my preferred news service was broken?
There may be some disagreement about including google groups links to
things like Prototype.js or jQuery google group. The reasoning behind
that is we do in fact get a good number of questions on the list where
the OP wants nothing more than to "make it work" using jQuery. A link
to the library's group would help direct those who are looking for
that, so that they can ask their question in a more appropriate place.
A subsection which was a more tactful version of "GO AWAY! <list of
appropriate directions>" would indeed be appropriate.
from: clj
to: c.l.javascript
While the pseudo-word clj should not be used (though CLJ is acceptable),
there seems no point in going three-quarters of the hog to the ugly
c.l.javascript - use comp.lang.javascript, CLJ, or c.l.j for it. I use
CLJ.
Please remove from the FAQ all CSS that affects the display within
ordinary text paragraphs such as in Sec 2.1. In informative technical
material, text formatting should be as the reader has chosen. Also,
don't change the <pre> <tt> <code> font.
Code within paragraphs should always be in <code> or <tt>, as in Sec 4.4
but not as in 2.3 para 2, 4.6, 4.7 end, and maybe elsewhere.
It is rather annoying when text just stops and one has to think, however
briefly, as to whether that's the end. At a minimum, please try <hr>
after "checks the links." I use
body { color: black; background: #FFFFB0; font-size: 100%;
margin: 0; padding: 1ex;
border-top: ridge lime 1ex; border-bottom: ridge lime 1em; }
but please don't use exactly those colours - moderately similar is fine.
<Hn> markup is misused in the list before Section 1; it should be a
List.
Clarify the status of the Notes. Your FAQ should say whether or not you
maintain them, and if not then who does.
Take the whole browser view, and copy'n'paste into Word or similar.
Most of its grammar/spelling suggestions will be wring, but some will be
right.
Omit trailing whitespace !
FAQ 2.2 title is negative; change to "What questions are on-topic for
CLJ?".
FAQ 2.2 "What do I have to do before posting to clj? " to "2.3 What
should I do before posting to CLJ?"
FAQ 2.11 Subject - move first sentence into some paragraph.
FAQ 3.1 "The errata should be considered a must read along with the
book." is ugly. "The errata should be read along with the book.".
FAQ 3.2 : use Lists.
In order not to overload yourself or your reviewers, I suggest that much
of the editing of each section should be done after Bart has posted it
cyclically; once it is known that FAQ updating is in hand, regulars will
be able to propose changes after seeing the daily section.
Firefox 2 is 2.0.0.17.
--
(c) John Stockton, nr London, UK. ?@merlyn.demon.co.uk Turnpike v6.05 MIME.
Web <URL:http://www.merlyn.demon.co.uk/> - FAQish topics, acronyms, & links.
Proper <= 4-line sig. separator as above, a line exactly "-- " (SonOfRFC1036)
Do not Mail News to me. Before a reply, quote with ">" or "> " (SonOfRFC1036)
.
- Follow-Ups:
- Re: FAQ Clean-Up
- From: dhtml
- Re: FAQ Clean-Up
- References:
- FAQ Clean-Up
- From: dhtml
- FAQ Clean-Up
- Prev by Date: Re: Text wrap problem firefox
- Next by Date: Re: What's wrong with arguments.callee ?
- Previous by thread: FAQ Clean-Up
- Next by thread: Re: FAQ Clean-Up
- Index(es):
Relevant Pages
|
