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] | [Elist Home]

Subject: Re: DOCBOOK: Request for comments: adding a Fileoutput element (RFE613293)

On Sun, Dec 01, 2002 at 04:56:27PM -0600, Paul Grosso wrote:
> At 01:43 2002 11 29 -0800, Bob Stayton wrote:
> >> On Thu, Nov 28, 2002 at 03:35:20PM +0900, Michael Smith wrote:
> >> > The DocBook Technical Committee would like to ask for comments from
> >> > readers of this list about a request for an enhancement to the DocBook
> >> > DTD, RFE 613293, 'Generalize programlisting'[1], which proposes that the
> >> > DTD be enhanced in some way to provide a 'semantically-precise way to
> >> > wrap the contents of files that are not programs'.
> >
> >I support the addition of a filecontents element.
> >But I object to removing programlisting and literallayout.
> I agree with Bob's sentiment.
> However, I also fail to see the usefulness of a "filecontents" 
> element unless it truly allows the incorporation of a file's contents. 
> I'd like to see some element (perhaps filecontents) with an href (or 
> whatever) attribute which, if assigned, means the referenced file's 
> contents should be inserted in "verbatim" mode.  Presumably, if this 
> attribute is set, the filecontents element would be empty (or its
> contents would be ignored).
> This allows the incorporation of whatever is really in the referenced
> file at publication time which is a much better way of guaranteeing
> that the code you print is the code that really works.
> Am I missing an existing DocBook element that allows for this?

Yes, in DocBook 4.2 it got easier with either of
these combinations:

<literallayout><textobject><textdata  fileref="mycode.c" /></textobject>

<programlisting><textobject><textdata  fileref="mycode.c" /></textobject>

Using this mechanism, the wrapper element can contain
literal file text or a textobject to insert it, or a

The issues here are that not all files are programlistings,
and that literallayout is not specific enough.


Bob Stayton                                 400 Encinal Street
Publications Architect                      Santa Cruz, CA  95060
Technical Publications                      voice: (831) 427-7796
The SCO Group                               fax:   (831) 429-1887
                                            email: bobs@sco.com

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

Powered by eList eXpress LLC