TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:Re: Code screens From:Bill Burns <BillDB -at- ILE -dot- COM> Date:Fri, 7 Nov 1997 14:15:20 -0700
John writes:
> Question. When you are placing a frame in your document that contains
> sample code, do you allow the page to break in the middle of the code
> and have it split between pages or do you make sure that if it can fit
> on one page, it all stays on the same page, even if it means having a
> large space of information at the bottom of the previous page. In
> other
> words, do you treat it as a list or a graphic?
>
I don't wory about page breaks, since a piece of code can go on for
quite a while, depending on how many subprocedures it may have embedded
in it and how many routines have to be run. I DO worry about line length
and word wrap. For some code, distinguishing between a line break and a
piece of code that wouldn't fit on a single line is crucial. That said,
if the code is going to leave a single line at the top of the next page,
I try to adjust it to break more gracefully.
One question about your last query--do you really mean you're using
Arial to avoid alignment issues while formatting the code? I typically
use a monospaced typeface like Courier for this reason.
Bill Burns
Senior Technical Writer
ILE Communications Group
billdb -at- ile -dot- com