#66 Remove %synop.class; from %para.char.mix

v5.0 FU for 6.0
closed-accepted
DocBook (176)
5
2002-01-31
2001-11-17
No

Former RFE 91

We will remove Synopsis from para.char.mix;
CmdSynopsis and FuncSynopsis
will remain, with the processing expectation that they
are inline if used
in an inline context.

The Synopsis element cannot be an inline. CmdSynopsis
and FuncSynopsis
could be, but should they?

/ Eduardo Gutentag <Eduardo.Gutentag@Eng.Sun.COM> was
heard to say:
| On the other hand, I don't see a conceptual problem
with something like:
|
| "The command ls accepts a whole bunch of options and
an optional
| file argument: /usr/bin/ls [ -
aAbcCdfFgilLmnopqrRstux1 ] [ file ... ]"
|
| (the above looks like two lines only by accident)

Norm replies:

But does it need to be a synopsis?

<para>
The command <command>ls</> accepts a whole bunch of
options and an
optional file argument:
<command>/usr/bin/ls</command>
<optional><option>aAbcCdfFgilLmnopqrRstux1</option></op
tional>
<optional>file ...</optional>
</para>

If you've put it inline, do you really need or want to
be able to
point to the whole thing? If it's that important, why
did you run it
inline?

The only downside I see is that there's no way to
generate the ellipsis
in the final optional in that command. (Rep is only
on Arg and Group
which can only occur in a CmdSynopsis.)

Discussion

  • Norman Walsh

    Norman Walsh - 2001-11-30
    • status: open --> closed-accepted
     
  • Norman Walsh

    Norman Walsh - 2002-01-31
    • status: closed-accepted --> pending-accepted
     
  • Norman Walsh

    Norman Walsh - 2002-01-31
    • status: pending-accepted --> open-accepted
     
  • Norman Walsh

    Norman Walsh - 2002-01-31
    • status: open-accepted --> closed-accepted
     

Log in to post a comment.

Get latest updates about Open Source Projects, Conferences and News.

Sign up for the SourceForge newsletter:





No, thanks