This is the mail archive of the
docbook@lists.oasis-open.org
mailing list for the DocBook project.
Re: [docbook] how to represent userinput with a command option?
- From: "Robert P. J. Day" <rpjday at mindspring dot com>
- To: Yann Dirson <ydirson at fr dot alcove dot com>
- Cc: docbook mailing list <docbook at lists dot oasis-open dot org>
- Date: Tue, 13 May 2003 12:19:28 -0400 (EDT)
- Subject: Re: [docbook] how to represent userinput with a command option?
On Tue, 13 May 2003, Yann Dirson wrote:
> On Tue, May 13, 2003 at 11:29:41AM -0400, Robert P. J. Day wrote:
> > let's say i wanted to, as part of a <screen>, show a sample command
> >
> > $ wc [-w] letter
> >
> > now, the standard way to represent userinput is to display it in
> > bold, to emphasize that it's typed by the user. so, as a first
> > attempt:
> >
> > <pr>$</pr> <ui>wc <op><o>-w</o></op> letter</ui>
>
> This looks much more like a <cmdsynopsys> use case - did you try to
> use that ?
>
> <cmdsynopsis>
> <command>wc</command>
> <arg choice="opt"><option>-w</option></arg>
> <arg choice="req" rep="repeat">
> <replaceable>file</replaceable>
> </arg>
> </cmdsynopsis>
nice idea, but wrapping the above in a <userinput> causes everything
to be bolded, which is what i'm trying to avoid.
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.
i'm just going to cheat for now and put in the "[]" explicitly.
it's not like this is a major issue, i was just curious.
rday
---------------------------------------------------------------------
To unsubscribe, e-mail: docbook-unsubscribe@lists.oasis-open.org
For additional commands, e-mail: docbook-help@lists.oasis-open.org