OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.

 


Help: OASIS Mailing Lists Help | MarkMail Help

docbook message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]


Subject: 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/



[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]