docbook: markup for shell input
Subject:
Re: markup for shell input
From:
"Martin A. Brown" ####@####.####
Date:
16 Jun 2003 22:00:22 -0000
Message-Id: <Pine.LNX.4.55.0306161655210.25980@enclitic.wonderfrog.net>
Hi there again, Emma Jane,
: This is my current sentence:
: Do a <programlisting>locate <file></programlisting>
: if they're not where I think they should be.
I think this is entirely up to you.
: I don't really want the <prompt> bit in there was well. How should locate
: and file be marked up though? Maybe something like this:
: <programlisting><command>locate</command>
: <userinput><file></userinput></programlisting>
Here's how I would write that, if I were to use the programlisting
tag:
<programlisting><command>locate</command> <replaceable>file</replaceable></programlisting>
Note, that many XSLT processors will treat white space is
significant inside a programlisting element, so you probably do not
want to have a newline in the middle of your programlisting element.
: does that look right?
I think you'll find the userinput element more natural in flowing
text...then you don't have to worry about line breaks.
<userinput><command>locate</command>
<replaceable>file</replaceable></userinput>
Smiles,
-Martin
