Out of style?

Subject: Out of style?
From: "ghart -at- netcom -dot- ca" <ghart -at- attcanada -dot- ca>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 7 Jun 2001 22:01:26 -0400

Anonymous, writing under a new name, wonders about a few style quirks at
the new job:

<<In chapter titles, all words longer than three letters are set in initial
caps. This includes prepositions. Has anyone ever heard of this style
before?>>

This is a common style called "title case", and the goal is to capitalize
all major words (nouns, verbs, adjectives, adverbs) and leave most function
words (prepositions, conjunctions, and a few other parts of speech) in
lower case. You can find full details in any good style guide; the Chicago
Manual of Style. will almost certainly explain the ins and outs of this
style. The problem with such a style is that some function words are long
enough that they just plain look strange without a capital. So someone
decided that this seeming inconsistency needed to be addressed by modifying
the guideline to permit capitalizing of longer words, irrespective of their
part of speech; some style guides recommend words longer than three letters
as the cutoff point. So the approach your writers are using is correct
according to this particular style. I don't particularly object to title
case, but prefer to capitalize only the first word in a title plus (of
course) any proper nouns. I prefer this approach because it's both visually
and grammatically consistent, but that's a matter of personal preference,
not right or wrong.

<<When introductory statements contain "the following" or "as follows," a
colon is used _only_ when "following" or "follows" are the last words.>>

This is a misapplication of a common style rule that has two variants, the
first based on grammar and the second based on common usage. Strictly
speaking, colons are used only at the end of a complete sentence or clause
(e.g., "For example, consider the following:" is complete, but not "For
example:"). However, there's a very common stylistic rule that extends the
use of colons to any list introduced by a phrase, complete or not. The
rationale is that since colons introduce lists, you should be able to use
them to introduce a list no matter what precedes (introduces) the list.
Thus, of your examples:

>Use the following format.
><information>

Is incorrect by both rules, assuming <information> is in fact a list.

>The format is as follows:
><information>

Is correct according to both styles. Again, details can be found in most
good style guides.


--Geoff Hart @8^{)} ghart -at- netcom -dot- ca

"Arthur C. Clarke had suggested that any sufficiently advanced technology
would be indistinguishable from magic--referring to a possible encounter
with an alien civilization--but if a science journalist had one
responsibility above all else, it was to keep Clarke's Law from applying to
human technology in human eyes."--Greg Egan, "Distress"



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available now at http://www.devahelp.com or info -at- devahelp -dot- com

Sponsored by Cub Lea, specialist in low-cost outsourced development
and documentation. Overload and time-sensitive jobs at exceptional
rates. Unique free gifts for all visitors to http://www.cublea.com

---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit
http://www.raycomm.com/techwhirl/ for more resources and info.


References:
Out of style?: From: Longtime tech writer

Previous by Author: Documenting APIs (belatedly)
Next by Author: need a font similar to Courier to use for code
Previous by Thread: Out of style?
Next by Thread: Re: Out of style?


What this post helpful? Share it with friends and colleagues:


Sponsored Ads