Re: Release.sgml markup

On Thu, 2003-07-17 at 08:16, Peter Eisentraut wrote:
> On Tue, 15 Jul 2003, Rod Taylor wrote:
>
> > Replace <sectN> with <section>,
>
> Why?

Actually, primarily so that I can run xinclude on it and get reasonable
results that can be dumped directly within other parts of other
documents at different levels without having to transform it.

sectN style was created due to the limitations of the tools available at
the time -- it was never an overly good idea.

> > update older style formatting to match
> > the newer style, escape all the appropriate places with <![CDATA[ ...
> > ]]> (easier than properly converting characters to escaped format).
>
> Better replace all those with real <itemizedlist> elements, because the
> current markup is kind of silly and leads to problems when formatting the
> plain-text renditions.

I debated doing that but figured I would be better off writing an XSL
transform to do it for me since Bruce will find the file more difficult
to edit.

Anyway, I will send in another copy with everything in itemizedlist
elements.

<listitem>
<para>
Release note entry
(<personname><firstname>Name</firstname></personname>)
</para>
</listitem>

Would you prefer that the <personname> elements be inside of a
<simplelist type="inline"> when there are several people involved in the
note?

If that was done, the brackets could be applied by the stylsheet based
on all simplelists inside listitems within that appendix ID.

> > All of this was done to make it possible to run some automated
> > processing on the file.
>
> What stops you from automated processing now?

Nothing if the file is consistent. Basically, what I working with
individual items in the release notes.

- The differences in prefix spacing was making it difficult to find
where an item began or finished.

- The differences in header formatting made it very difficult to grab
titles for content sections. Some were text inline a programlisting,
others were section/title/text().

- Lack of a space before the (Developer) postfix made it difficult to
separate a name assignment from arbitrary comments attached to the note.