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: Userinput content model, v 5.0

/ <Jonas.Haulin@ssabox.com> was heard to say:
| A question concerning the reduced content models in docbook v 5.0:
| KDE in their author guide (docbook 4.x) suggest markups like 
| <userinput><command>ls</command>
| <option>-l</option>
| <parameter>$<envar>KDEDIR<envar></parameter>
| </userinput>
| and
| <userinput>
| <command>export</command>
| <parameter>$<envar>KDEDIR</envar>=<filename>
| /usr/local/kde</filename></parameter></userinput>
| (http://i18n.kde.org/docs/markup/markup-guide.html)
| Which is not valid in 5.0, since userinput cannot have a parameter
| child, and also, parameter cannot have a filename child.
| (Although xsltproc indeed produces the desired html output from the
| 1.69.1 stylesheets). 
| Separating the 'command' part from the 'parameter' part in a userinput
| allows for separate formatting in the css (which is what KDE does). 
| Any suggestions on how to do this in v 5.0? Or should the content models
| be expanded? 

I'd have been inclined to user replaceable where you're using parameter,
I think. But after some consideration, I think the right thing to do is
add db.parameter to db.technical.inlines:

db.technical.inlines =
 | db.systemitem
 | db.option
 | db.optional
 | db.package
 | db.property
 | db.termdef

My reasoning being that if you've got something that's optional, it
might reasonably be a parameter. Maybe that's stretching a point, but
I don't see any point in making all the KDE documentation invalid! :-)

                                        Be seeing you,

Norman Walsh <ndw@nwalsh.com>      | We make out of the quarrel with
http://www.oasis-open.org/docbook/ | others, rhetoric, but out of the
Chair, DocBook Technical Committee | quarrel with ourselves,
                                   | poetry.--W. B. Yeats

PGP signature

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