httpd-docs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Astrid Ke├čler <>
Subject Re[3]: dtd for non-module documentation pages
Date Sat, 15 Jun 2002 18:29:21 GMT
> I still don't like the index.  My opinion is that:

> - Every page should have an index
> - The location of that index should be the same on every page (perhaps
> just after the summary)
> - The index should be generated from the <section>s, and should not need
> manual intervention.  (ie any section with an "id" should be included)

> This is not how things are in the existing docs, but we don't need to
> replicate the exact format of the existing docs.

Well, this makes it much easier. Then the differences to
modulesynopsis.dtd are restricted to the following:

<?xml version='1.0' encoding='UTF-8' ?>
<!-- include common.dtd -->

<!-- <manualpage> is the root element -->
<!ELEMENT manualpage (title, summary?, seealso*, section*)>

<!-- a page may have one or more sections. Each section is named by an
     unique id. A section must have a title and some text. It may have
     subsections and a list of related modules and directives -->
<!ELEMENT section (title, (section | related | %blocktags;)*)>
<!ATTLIST section id ID #IMPLIED>

<!-- the lists of related modules and/or related directives -->
<!ELEMENT related (modulelist | directivelist)+>

<!-- list of related directives -->
<!ELEMENT directivelist (directive)+>

> Other than that, I am ready for this to go into the docs.  Astrid, do you
> have commit access?

No, I have not.

View raw message