RE: code examples in a document - RESOLUTION

Subject: RE: code examples in a document - RESOLUTION
From: John Posada <JPosada -at- book -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 6 Nov 2002 09:29:41 -0500


Hi, guys....thanks to everyone who responded to this question. I received
lots of good (and varied) ideas.

The way I handled it (right or wrong) is to place a hard return at a logical
break, then allow the next line to indent a couple of spaces, but not enough
to resemble an indented line. I've included a small clip of the code below
to show what I mean

...
md F:\xx\xx\logs\stamped\custlogs\%%x\%%y\%%z\%%d_%%e%%f%%g_%%j
for /F "usebackq" %%l in (`dir F:\xx\xx\logs\custlogs\%%x\%%y\%%z\ /b`) do (

XCOPY F:\xx\xx\logs\custlogs\%%x\%%y\%%z\%%l
F:\xx\xx\logs\stamped\custlogs\%%x\%%y\%%z\%%d_%%e%%f%%g_%%j\ /Y /C
/H /R /F /V
ren F:\xx\xx\logs\stamped\custlogs\%%x\%%y\%%z\%%d_%%e%%f%%g_%%j\%%l
%%e%%f%%g_%%h%%i_%%j.%%l
...

Of the several hundred lines, this only occurs less than 10 times. The
original code is available on VSS and I've included a link to that code. I'm
not too concerned about anyone trying to cut/paste the code in the form that
I'm displaying since a warning has been put in that the code may have been
modified by developers since documented, therefore, they are only to use the
VSS files.

I would be interested in input if the way I've it is going to cause any
developers real (not imagined) grief.

John Posada
Senior Technical Writer
Barnes&Noble.com
jposada -at- book -dot- com
212-414-6656
"Available for next gig Feb 01, 2003"



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Check out SnagIt - The Screen Capture Standard!
Download a free 30-day trial from http://www.techsmith.com/rdr/txt/twr
Find out what all the other tech writers, including Dan, already know!

Order RoboHelp X3 in November and receive $100 mail in rebate, FREE WebHelp
Merge Module and the new RoboPDF - add powerful PDF output functionality
to RoboHelp X3. Order online today at http://www.ehelp.com/techwr-l

---
You are currently subscribed to techwr-l as:
archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit
http://www.raycomm.com/techwhirl/ for more resources and info.



Previous by Author: code examples in a document
Next by Author: RE: Code examples in a document?
Previous by Thread: Re: AW: MS Manual of Style for Tech Pubs?
Next by Thread: RE: code examples in a document - RESOLUTION


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


Sponsored Ads