Re: Code screens

Subject: Re: Code screens
From: Joe Miller <joemiller -at- CANBERRA -dot- COM>
Date: Fri, 7 Nov 1997 16:20:09 -0500

Hey, John!

>do you treat it [code] as a list or a graphic?

Since we use half-size (5.5 X 8.5) manuals for PC software,
code not only crosses page boundaries, one line of code
will often not fit on a single printed line. The code therefore
must often break across lines and pages.

The "official" (programmer's) way of breaking a single line of
code is to indent the continued line to show it isn't a new line,
like so:

code, code, code, code, code, code, code, code
code, code.
code, code, code, code, code, code, code, code
code, code, code, code, code, code, code, code
code, code, code, code.

Whether we start the code at the top of a new page depends
on how much there is and how it looks, decided on a case by
case basis.

HTH, Joe
joemiller -at- canberra -dot- com


Posts: mailto:techwr-l -at- listserv -dot- okstate -dot- edu
Commands: mailto:listserv -at- listserv -dot- okstate -dot- edu (e.g. SIGNOFF TECHWR-L)
Archives: http://listserv.okstate.edu/archives/techwr-l.html,
http://www.documentation.com/, or http://www.dejanews.com/
Subjects: JOB:, QUESTION:, SUMMARY:, ANNOUNCE:, or none of these.


Previous by Author: Hyperlinks: Word to PDF
Next by Author: New Spam Trick
Previous by Thread: Re: Code screens
Next by Thread: Re: What is a tech writer (humor cont.)


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


Sponsored Ads