Re: Punctuation in quotes -- American style

Subject: Re: Punctuation in quotes -- American style
From: David Farbey <dfarbey -at- yahoo -dot- co -dot- uk>
To: TECHWR-L Writers <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Mon, 19 Aug 2013 20:43:38 +0100

Have you considered using a different typeface for code samples or for the
words the user needs to type in? If you did that you would not need to use
quotation marks at all:

Set the value of the mode attribute to titleBelow

(If you can't see the formatting in your mail client, I set the value
titleBelow in Courier)

I would even go so far as to say that you can leave the punctuation off the
end of that sentence entirely. You're not writing a novel, or an editorial
for the Times, you're writing instructions to help your customers get their
work done.

David
iconoclasts'r'us


David Farbey - david -at- farbey -dot- co -dot- uk
Mobile 07538 420 800
http://about.me/davidfarbey



On 19 August 2013 19:08, Lynne Wright <Lynne -dot- Wright -at- tiburoninc -dot- com> wrote:

> This is one of these issues that can inspire vigorous debate on finding
> the middle ground between honoring punctuation rules versus aiming for
> ultimate clarity. But in reality, its not going to make much different to
> the end user.
>
> If you follow the punctuation rule, I don't think users will be confused
> about what to do, since, if I understand this correctly, they are selecting
> options from a list, rather than entering values by typing. In other words,
> readers will ignore the period.
>
> Putting the period after the 2nd quotation mark keeps the name of the
> value distinct and accurate; and I doubt readers will give a toss... or
> even notice... that strictly speaking, the period is out of place.
>
> So its really your call. Personally, I'd put the period outside the marks.
>
> To avoid this type of issue, I format references to UI components that you
> perform actions on, or that you select, in bold, instead of using quotation
> marks.
>
>
> -----Original Message-----
> From: techwr-l-bounces+lynne -dot- wright=tiburoninc -dot- com -at- lists -dot- techwr-l -dot- com[mailto:
> techwr-l-bounces+lynne -dot- wright=tiburoninc -dot- com -at- lists -dot- techwr-l -dot- com] On
> Behalf Of Richard Hamilton
> Sent: Monday, August 19, 2013 1:51 PM
> To: TECHWR-L Writers
> Subject: Punctuation in quotes -- American style
>
> American-style punctuation calls for periods and commas to appear inside
> quotation marks.
>
> No question on the general rule.
>
> The question is, are there circumstances where you would break that rule?
>
> For example, consider the following sentences:
>
> Set the value of the mode attribute to "titleBelow."
>
> Do not use the mode attribute when type="note."
>
> I'm still inclined to bring the punctuation inside the quote, thought that
> second one gives me pause, but I'm open to other interpretations and your
> thoughts on when this rule can/should be broken.
>
> Best Regards,
> Richard Hamilton
> -------
> XML Press
> XML for Technical Communicators
> http://xmlpress.net
> hamilton -at- xmlpress -dot- net
>
>
>
>
> -------
> XML Press
> XML for Technical Communicators
> http://xmlpress.net
> hamilton -at- xmlpress -dot- net
>
>
>
>
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> New! Doc-to-Help 2013 features the industry's first HTML5 editor for
> authoring.
>
> Learn more: http://bit.ly/ZeOZeQ
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> You are currently subscribed to TECHWR-L as Lynne -dot- Wright -at- tiburoninc -dot- com -dot-
>
> To unsubscribe send a blank email to
> techwr-l-leave -at- lists -dot- techwr-l -dot- com
>
>
> Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
> http://www.techwhirl.com/email-discussion-groups/ for more resources and
> info.
>
> Looking for articles on Technical Communications? Head over to our online
> magazine at http://techwhirl.com
>
> Looking for the archived Techwr-l email discussions? Search our public
> email archives @ http://techwr-l.com/archives
>
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> New! Doc-to-Help 2013 features the industry's first HTML5 editor for
> authoring.
>
> Learn more: http://bit.ly/ZeOZeQ
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> You are currently subscribed to TECHWR-L as dfarbey -at- yahoo -dot- co -dot- uk -dot-
>
> To unsubscribe send a blank email to
> techwr-l-leave -at- lists -dot- techwr-l -dot- com
>
>
> Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
> http://www.techwhirl.com/email-discussion-groups/ for more resources and
> info.
>
> Looking for articles on Technical Communications? Head over to our online
> magazine at http://techwhirl.com
>
> Looking for the archived Techwr-l email discussions? Search our public
> email archives @ http://techwr-l.com/archives
>


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
New! Doc-to-Help 2013 features the industry's first HTML5 editor for authoring.

Learn more: http://bit.ly/ZeOZeQ

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

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com


Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


Follow-Ups:

References:
Punctuation in quotes -- American style: From: Richard Hamilton
RE: Punctuation in quotes -- American style: From: Lynne Wright

Previous by Author: Re: spec writing - is simple ever wrong ?
Next by Author: Weird HTML problem
Previous by Thread: RE: Punctuation in quotes -- American style
Next by Thread: Re: Punctuation in quotes -- American style


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

Sponsored Ads


Sponsored Ads