"This Multi-Line Actually Is One Line" graphics?

Subject: "This Multi-Line Actually Is One Line" graphics?
From: "techwrl-list-only -at- doitall -dot- com" <techwrl-list-only -at- doitall -dot- com>
To: TECHWR L <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 06 Aug 2003 15:55:27 -0400


There some cases for code snippets and configuration files that I must show
example lines and there is no way that all lines will fit one line within
the manual.

Yes, there are MANY cases that can I can finesse so there is no problem. For
instance, simplifying the example or changing variable names in examples to
be shorter. In some computer languages, white space is *ignored* so I can
safely show the second half of the line on the next physical line and there
is no big deal.

But some computer languages and systems DO care about the type of white
space and moving the second half of a line to the next line makes it
syntactically invalid!

Also, some configuration ".ini" file lines must be quite long for our
product and cannot contain new line characters at all!

1) Is there a True Standard (either typographically, graphically, or
descriptively) for this type of cases where it *cannot* be avoided?

2) If I were to want to use a special symbol for "this wraps to the next
line in the example, but not in the real thing", are there STANDARD symbols
or at least non-ugly ones that people can send to me or point me to? :-)

I would include this symbol in my Typographical Conventions section at the
beginning, and also make intratextual comments about it where appropriate
and not too clunky style-wise.

Any URLs or books on this subject would be appreciated.


-- JX

P.S. Please assume for the context of this question that I cannot go to
landscape mode, change the font or font size, or change the basic page

Previous by Author: Re: Indexing style refs
Next by Author: Re: testing candidates
Previous by Thread: Re: Table of Contents Numbering Problem
Next by Thread: RE: "This Multi-Line Actually Is One Line" graphics?

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

Sponsored Ads