RE: Quotes/Comma question

["Lauren" <lauren -at- writeco -dot- net>]

I don't quote command line operations or use punctuation with the command
line text because it can get confusing for some users.  Depending on the
style guide and the document requirements, I offset the command, usually in
bold, and sometimes on a separate line.  

One of the things about your example is that you mention that users should
begin typing when the screen appears.  Does the cursor automatically go to
the right place?  Or are users supposed to type in a specific area or text
field of the screen?  If this is a simple example of more involved set of
operations that is consistent with other sets of operations in the document,
then I might take the approach that follows, with screen widgets represented
as they are on the screen (e.g.: Next, NEXT, or Next...) offset in bold and
the command line text offset in italic.  Additionally, I use "select" when
the option is really a list or radio dial option and "click" when the widget
is a button or link.  (I might be a little nitpicky for this little example,
but I tend to do that.)

-------
Perform the steps that follow at the Test Path screen.

1. Click in the <entry box name>
2. Type C:\Applications\test programs\TS3.exe
3. Click NEXT
-------

The use of punctuation inside or outside of quotes is a part of punctuation
controversy.  (So is the use of the term "appears," for that matter.)

Lauren 

> -----Original Message-----
> From: techwr-l-bounces+lauren=writeco -dot- net -at- lists -dot- techwr-l -dot- com 
> [mailto:techwr-l-bounces+lauren=writeco -dot- net -at- lists -dot- techwr-l -dot- com
> ] On Behalf Of Butler, Darren J Ctr 584 CBSS/GBHAC
> Sent: Wednesday, December 12, 2007 9:35 AM
> To: techwr-l -at- lists -dot- techwr-l -dot- com
> Subject: Quotes/Comma question
> 
> Please help settle a debate. Is it correct to follow quotation marks
> with either a comma or a semi colon?
> 
> example: 
> 
> When the Test Path screen appears, type "C:\Applications\test
> programs\TS3.exe", then select NEXT.
> 
>  
> 
> TIA
> 
>  
> 
> Darren J Butler
> 
> Sr  Technical Writer-Editor, Template Wrangler, Mil-Spec Pharisee,
> Sevivon Avatar
> 
> Integrated Data for Maintenance
> 
> Northrop-Grumman Corp
> 
> 542 MSUG/GBMUAC
> 
> darren -dot- butler -at- robins -dot- af -dot- mil
> 
> [478] 222-4694
> 
>  
> 
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> 
> Create HTML or Microsoft Word content and convert to Help 
> file formats or 
> printed documentation. Features include support for Windows 
> Vista & 2007 
> Microsoft Office, team authoring, plus more.
> http://www.DocToHelp.com/TechwrlList
> 
> True single source, conditional content, PDF export, modular help.
> Help & Manual is the most powerful authoring tool for technical
> documentation. Boost your productivity! http://www.helpandmanual.com
> 
> ---
> You are currently subscribed to TECHWR-L as lauren -at- writeco -dot- net -dot- 
> 
> To unsubscribe send a blank email to 
> techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
> or visit 
> http://lists.techwr-l.com/mailman/options/techwr-l/lauren%40wr
> iteco.net
> 
> 
> To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com
> 
> Send administrative questions to admin -at- techwr-l -dot- com -dot-  Visit
> http://www.techwr-l.com/ for more resources and info.
> 

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

Create HTML or Microsoft Word content and convert to Help file formats or 
printed documentation. Features include support for Windows Vista & 2007 
Microsoft Office, team authoring, plus more.
http://www.DocToHelp.com/TechwrlList

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com

---
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-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

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