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.
Re: documenting Unix command lines; more than one line
Subject:Re: documenting Unix command lines; more than one line From:"Stephen D. Martin" <smartin -at- RC -dot- GC -dot- CA> Date:Tue, 9 Sep 1997 10:00:46 -0400
Harrison Brace wrote:
> How do you indicate that the two lines in your document do not
> represent two separate Unix command lines (rather than by changing
> margins, fonts, etc.)
1) In my current (and previous document) I used the convention of
italicizing such references.
2) You don't specify what package you're using but on my previous job I
was forced to use MS-Word 4.x. As with my current document I was
defining an existing Unix network, including configuration files and
some source code.
What my partner and I ended up doing was creating a style (code2 and
code3), which indented the text (one or two indents), and any text which
wrapped around to the next line was further indented four or five
spaces.
For example:
abcdefghijklmnop
qrstuvwxyz123
4567890<etc>
Cheers!
TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html
