This is the mail archive of the docbook@lists.oasis-open.org mailing list for the DocBook project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Re: [docbook] how to represent userinput with a command option?


Yann Dirson wrote:

> On Tue, May 13, 2003 at 12:19:28PM -0400, Robert P. J. Day wrote:
[...]
>>also, i'm not sure that, semantically, i should be using a
>><cmdsynopsis>.  i'm not trying to supply a command synopsis,
>>just trying to show a sample *usage* of that command, which
>>i'm convinced shouldn't represent the same thing.
>>
> In that case, probably you should just not try to specify optional
> stuff in this place ?

I agree. In one draft I have:

<section><title>Quick Start</title>
<section><title>Example</title>
<screen><prompt>$</prompt> <userinput><command>saxon7_5</command> <option>-o</option> <filename>index.xhtml</filename> <filename>yourbook.dbx</filename> <filename>/joocs/chunking_express.xslt</filename></userinput></screen>
</section>
</section>


Since it's just an example commandline/screen, I don't use the replaceable element. How would others mark this up? How could I avoid this very long line?

Tobi

--
http://www.pinkjuice.com/


--------------------------------------------------------------------- To unsubscribe, e-mail: docbook-unsubscribe@lists.oasis-open.org For additional commands, e-mail: docbook-help@lists.oasis-open.org


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]