Variants of spelling (cancelled, color, etc.)
Where variant forms of a word or phrase exists, the most commonly
used form will be used.
(Some dictionaries indicate which form is the most commonly used.
We should choose one as our reference basis.)
Dash and hyphen
need something on the use of dash, hyphen, and spacing.
more words
tag
/pp/ part of speech (verb, noun, adjective, etec)
/dontuse/ don't use. A preferred word or phrase is given.
/avoid/ avoid. A preferred word or phrase is given.
/spell/ easily mis-spelled word or phrase
/proper/ proper name. Spell as is.
/comp/ compound phrase, such as "log-out" or "home page"
/var/ variant form
/ambig/ potentially ambiguous word
/use/ note on how to use the word (or phrase) in a given context
/def/ definition
/case/ case sensitive
note: compound noun or verb used as an adjective is always hyphenated
(e.g. end-user agreement)
please help define the following: add-on, plug-in, helper application,
help file, documentation
*home page* /comp/
Two words.
*log-in* /pp,comp/ [noun]
*log in* /pp/ [verb]
*log-off* /dontuse/
Don't use; use *log-out*
*log off* /dontuse/
Don't use; use *log out*
*log-on* /dontuse/
Don't use; use *log-in*
*log on* /dontuse/
Don't use; use *log in*
*log-out* /pp,comp/ [n]
*log out* /pp/ [v]
*performance* /ambig,avoid/
Avoid. Use more descriptive word or phrase such as "processing speed,"
"efficiency," or "robustness"
*Web site* /comp,def,case/ <- *request comment*
a domain, or part of a domain, consisting of a collection of hyperlinked
*Web pages*
*Web page* /comp,def,case/ <- *request comment*
a text document on the Web
[the following is based on a message from Jay Garcia in a thread called
"Tabbed Browsing?"]
*end user* /comp,def/
[n] the ultimate user of a product who is not a developer
"developer" /def/
[n] programmer, tester, documentation author, patch writer, etc.
[the following is from "Mac OS X Terminology Guidelines"
<http://developer.apple.com/techpubs/macosx/Essentials/AquaHIGuidelines/AppBTerms/index.html>]
*abort* /dontuse/
Don't use; use *cancel*.
*application* /spell/
It is not necessary to say "application program" on first use.
"Application" is OK to use alone.
*cancel*
Preferred form of *abort*
*cancelled* /var/
Note two "l."
*canceling* /var/
Note two "l."
*dialog* /use/
Use instead of "dialog box.
*directory* /ambig/
In user documentation, don't use directory when you can say folder.
*disable* /avoid/
Avoid in user documentation; say dimmed or turned off (or simply off).
(see *enable*)
*enable* /avoid/
Avoid in user documentation; say available or turned on (or simply on) or
selected. (see *disable*)
*filename* /comp,spell/
One word.
*Mac OS 9* /spell,proper,case/
Always use the full name; don't shorten to "OS 9" or "9." Note spacing
between each "word." Don't say "Mac OS 8/9"; instead say
"Mac OS 8 and Mac OS 9."
*Mac OS X* /spell,proper,case/
Always say "Mac OS X"; don't shorten to "OS X" or "X." Note spacing
*menu bar* /comp,spell/
Two words
*pane* /all/ *important*
Use to refer to different views within a window (views that can be changed with
a tab, a pop-up menu, a button, or by selecting an item, or views that change
automatically, as in Installer). In most cases in user documentation, you can
avoid using "pane" by describing how to get to a particular place: "Click System
Preferences, click Network, click AppleTalk...."
Examples of how to use "pane":
- [omit]
*panel* /dontuse/
Don't use; see pane and dialog.
*path* /use/
see *pathname*
*pathname* /use/
Most user documentation does not need to refer to specific pathnames ("[plug-ins
are in the Internet Plug-Ins folder in the System folder](edited)"). But when
necessary�if a user has to type a pathname in a dialog, for example�you can
refer to it as "the path" or "the pathname."
*screen shot* /comp,spell/
Two words. Don't use "screen dump."
*tab* /use/
In a *dialog*, the tab itself is called the "<tabname> tab," but the content you
see when you click a tab is the "*pane*." Don't say "under the <tabname> tab."
Examples:
You can specify your home page in the Web pane of Internet preferences.
To set up automatic login, click Login, then click the Login Window tab.
