RE: code examples in a document - RESOLUTION

[Chris Gooch <chris -dot- gooch -at- lightworkdesign -dot- com>]

John Posoda wrote:

+++
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. 
+++


Most programming languages provide a character to mark
that something is being "continued" onto another line even where
the syntax of the language wouldn't ordinarily allow a break.
In C for example the \ (backslash) character provides this;

#define LiPointInitialise( _p, _x, _y, _z )  \
   do                                        \ 
   {  (_p)[0] = _x ;                         \
      (_p)[1] = _y ;                         \
      (_p)[2] = _z ;                         \
   } while ( 0 )

(You'd want to use a fixed-width font and line the \ up).

Might be worth finding out if there is such a continuation character
for whatever language you are using - then you can lay things
out nicely.

hth,
Chris.

Christopher Gooch, Technical Author
LightWork Design, Sheffield, UK.
chris -dot- gooch -at- lightworkdesign -dot- com   www.lightworkdesign.com



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.