Re: [AD] Re: [AL] allegro DTD

[Stepan Roh <stepan@xxxxxxxxxx>]

On Sun, 28 Nov 2004, Elias Pschernig wrote:

> Oh, I sent this to the wrong list. But luckily you read this one as
> well :)

Yes, I scan them both.

> > > - If point 1 above isn't resolved, the following will need to be added
> > > to the DTD at some point I think: retval section, example section,
> > > example reference
> > >
> > > - header/footer/front-page: They seem too output-format specific. I'd
> > > like the XML to contain the contents, and nothing else. So probably
> > > should remove them at some point I think.
> >
> > What's the replacement?
>
> The output plugins. The HTML plugin can decide to put some sort of
> Prev/Up/Next buttons, PDF will have maybe the current section as header
> and the page number as footer, the man plugin will make it look like a
> man page, and so on. The XML itself will contain the documentation only.
> This gives maybe up a bit of flexibility, but I think it makes sense.
>
> One of the things making the current makedoc so complicated is that it
> has to deal with all the output specifics while reading in the ._tx file
> (instead of leaving it to the output generators). And I don't see how
> the docs have any advantage from it.

Header and footer can go, but front-page with big Allegro ASCII-logo and 
std_disclaimer should stay.

> > > - what is the block-quote element? It is there, without comments..
> >
> > Some elements are derived from DocBook:
> > http://www.docbook.org/tdg/en/html/docbook.html. This one is 'blockquote':
> >
> > Block quotations are set off from the main text, as opposed to occurring
> > inline.
>
> Ah. My ._tx->.xml converter will have no use of it right now I think,
> but could later add something to ._tx which translates to it, since it
> looks like it could be useful.

To be honest, block-quote has only one purpose: to hold std_disclaimer on 
front-page.

Have a nice day.

Stepan Roh