TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:Re: Variables in API documentation From:Maynard Hogg <maynard -at- GOL -dot- COM> Date:Tue, 6 May 1997 10:46:39 +0900
At [Mon, 5 May 1997 15:01:21 -0700]
Lynn Gold <figmo -at- RAHUL -dot- NET> wrote:
> When referring to a variable such as a filename, do people still use
> angle-brackets, do they use italics, nothing at all, or do they use
> something else?
> For example, would you use:
> a) rm <filename>
> (using angle brackets that are not supposed to be typed as part of the
> b) rm *filename*
> (where the asterisks here are denoting italicized text)
> c) rm filename
> (no special demarcation)
My Unix/DOS bias (note that rm is a Unix shell command) rules the first
two out immediately since they already have a predefined meaning to
One dodge that works for DOS is to use upper case for tokens that have
to be typed as is and lower case for variables. (This doesn't work for
Unix shells because RM and rm are two different animals.)
#306, 4-30-10 Yoga, Setagaya-ku, Tokyo, Japan 158
Internet: maynard -at- gol -dot- com http://www2.gol.com/users/maynard/
$BF|K\8l$N%a!<%k$b4?7^$7$^$9 (B (Japanese e-mail welcome)
Unsolicited commercial electronic mail sent to this address will be
proofread at a cost of US$200/hour (half-hour minimum).