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: Vars in API docs & code formatting From:John Cornellier <John -dot- Cornellier -at- PARIS -dot- IE -dot- PHILIPS -dot- COM> Date:Tue, 6 May 1997 10:43:05 +0200
I reason that italics are best to denote variables, because:
a) using extra chars, (e.g. rm <filename>) clutters up the page & is
ambiguous. If users didn't read "text conventions" blurb at beginning
of manual, they might think they're meant to type the angle brackets,
quotation marks, whatever.
b) italics cannot be used in a command line prompt, so cannot be
construed to be something the user should enter.
c) not marking them at all would be confusing.
d) Checking the "text conventions" in a random selection of manuals
within 3 metres of my desk, I see the MS stuff has bold for menu items
& buttons, and italics for variables. Ditto ProComm Plus (1991
version).... I have an HP scanner manual with italics for menu items &
buttons, and bold for variables.
e) angle brackets or whatever might conflict with a char in syntax,
i.e. what if they actually have to put an angle bracket in a variable?
IMO using chars to denote vars is old & has been replaced by the above
described char formatting.
BTW you might put lines of code in courier or monospace font to make
it look like it looks on screen. Good side effect: if you're using
Frame the spell checker does NOT check spelling in txt in
ZapfDingbats, Symbol, WingDings, Monotype Sorts, as defined in
maker.ini.
John -dot- Cornellier -at- Paris -dot- IE -dot- philips -dot- com
____________________________ Separateur Reponse ________________________________
Objet : Variables in API documentation
Auteur : TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU a #SMTP
Date : 06/05/1997 00:03
I've gotten into heated debates with co-workers over this one and
wanted some opinions.
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
command)
b) rm *filename*
(where the asterisks here are denoting italicized text)
c) rm filename
(no special demarcation)
Thanks,
--Lynn
TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html
TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html
