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: DOCBOOK: Re: Request for comments: adding a Fileoutput element (RFE613293)

Hash: SHA1

/ Michael Smith <smith@xml-doc.org> was heard to say:
|  1. add a new element (for example, 'Filecontents') with a 'class'
|     attribute and enumerated values to indicate what type of file
|     the marked-up content is from (for example, a program file, a config
|     file, a documentation file, etc.)[2]

I really dislike the name 'filecontents'. For one thing, if I use

I put stuff in

My "stuff" is clearly not the content of any file, it's inline in my

I think what this really boils down to is, I want to shove some text
in here that should be displayed just the way it appears. How about

|  2. add a new attribute to Literallayout, with either 'filecontents' or
|     various filetypes being among its enumerated values[3].
|     Example: <literallayout type='configfile'>foo bar</literallayout>

This would be ok, I think, but often when a file is being inserted, the
goal is to have the text presented in a fixed-width font, which means
you have to say

  <literallayout type='configfile' class="monospaced">foo bar</literallayout>

That's a little verbose.

|  3. do nothing; keep things just the way they are.
|     Advantage: Hey, we don't have to change anything. 

Sigh. On the one hand, I like this best, on the other, new users don't
often figure it out.

It really seems like we shouldn't need all of these: programlisting,
screen, synopsis, literallayout, and verbatim.

How does this sound:

1. Add 'verbatim'.

<!ELEMENT verbatim (...)>
<!ATTLIST verbatim
    class    (normal|monospaced) "monospaced"
    contents CDATA               #IMPLIED

Contents is where you can say it's a configfile or a cprogram or
whatever you like.

2. We consider removing 'screen', 'synopsis', and 'literallayout' in
favor of 'verbatim' at some point in the future.

We could remove programlisting too, but I'm very hesitant to do that.

                                        Be seeing you,

- -- 
Norman Walsh <ndw@nwalsh.com>      | Man's great misfortune is that he
http://www.oasis-open.org/docbook/ | has no organ, no kind of eyelid or
Chair, DocBook Technical Committee | brake, to mask or block a thought,
                                   | or all thought, when he wants
                                   | to.--Valéry
Version: GnuPG v1.0.6 (GNU/Linux)
Comment: Processed by Mailcrypt 3.5.7 <http://mailcrypt.sourceforge.net/>


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

Powered by eList eXpress LLC