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: periods inside quotation marks? From:"D. Margulis" <ampersandvirgule -at- WORLDNET -dot- ATT -dot- NET> Date:Tue, 9 Jun 1998 12:14:10 -0400
Shannon,
The rule to put button text in quotes is one you should endeavor to
change. (I know you say you are bound by it, but I think you can make a
case to treat buttons another way.)
Do you put keys in quotes, too? Do you tell people to type "A" and then
press "Enter"?
If you need to distinguish between the typographic treatment of keys and
buttons, do it with fonts--maybe bold for one and italic for the other.
However, I think even this is silly and cluttered. If you are consistent
with using the verb _press_ for keys and the verb _click_ for buttons,
you should be able to type everything in plain roman text, with no
quotes at all. Just use an initial cap to name each key or button.
Point to Microsoft style (in their manuals, in their style guide, in
their Office Help, etc.), if you need to provide evidence to satisfy
your boss. (You don't have to _like_ Microsoft; just pretend you're
collecting a debt for a bookie, and you're bringing along Big Bill the
Enforcer for backup.)
Dick
Shannon White wrote:
>
> I am doing online Help for an application that has several buttons
> that use odd terminology. The interface design (due to egos) will not
> be changed, so I have to make do.
>
> Question: in referring to a button, where does the punctuation go?
>
> Example: If the name of the button is Remove, do I use show the
> command as
>
> 1. Click "Remove."
> OR
> 1. Click "Remove".
>
> I know that sentence rules say punctuation goes inside the quotation
> marks, but here I am emphasizing the button name and not an actual
> quote.
>
> If you think you have it figured out, here is the kicker. I have
> several buttons that use punctuation within the button name, such as
> Modify. . .
>
> Then, would I use
>
> 1. Click "Modify. . . ."
>
> OR
>
> 1. Click "Modify. . .".
>
> I am bound by screen design and the requirement to put the button in
> quotation marks. My only question is, where does the ending period
> go? For clearest communication, it would seem to go outside the marks
> since the buttons do NOT contain the ending period.
>
> Please, sway me one way or the other.
>
> Thanks,
>
> Shannon White
>
