RE: Boxes for Code, Screens?

["Hager, Harry (US - East Brunswick)" <hhager -at- dc -dot- com>]

Janice,

I'd be willing to bet that the history of drawing lines around code examples
and maybe even screen input goes back to the days when actual sample code,
output from a line printer, was literally pasted (as in waxed) onto the
galley sheets. Then the editors and production people wanted some emphasis
so they drew a line around this stuff. I remember seeing this done up 'til
the late 80's. 

When screens were all text-based (let's face it, graphics on end user
computer screens are a recent development), it was common to do the same
thing. That is draw lines either by hand or with the aid of your text
editor, if it was sophisticated enough.

Lately, I don't think I've seen this technique with lines used much.
Typically, the use of a courier font of some other monospace font is
employed. If this is defined up front in your typographical conventions
section, I don't see any need for lines around code samples or screen input.
Not that there's anything wrong with it. 

I'd bet it has more to do with how long the programmers and system
administrators have been around as to whether they expect to see lines
around sample code and screen input. 

Good Luck.

Jim Hager
Hhager -at- dc -dot- com



We are currently engaged in a discussion at Sun about 
whether to put boxes around code examples or screen input/
output listings. Opinions vary as to whether programmers 
or system administrators like or expect boxes, or 
whether just using an alternate font and indenting 
is enough of an indicator.

Could you write and let me know how your company 
treats these items and how you distinguish them 
from surrounding text?

I'll summarize to the list.

Thanks!