Files
apache-http-server/docs/manual/style/modulesynopsis.dtd
Luca Toscano 50c86e4f2c doc xsl/dtd: introduce idtype attribute for directivesynopsis
In r1805193 synopsis.xsl was changed to allow two directives
of different type (like <SSLPolicy> and SSLPolicy) to share
the same name but have different ids (and please validate-xml/xhtml).
The downside of this action was that all the quicklinks to
existing directive sections (like <If>, <VirtualHost>, etc..)
were changed, possibly breaking external clients already
referencing them.

This change introduces a new attribute in the directivesynopsis
DTD, namely 'idtype', that will be appended to 'name'
in the id generation by synopsis.xsl. This will rollback
link names to their previous values and will allow documentators
to fine tune directivesynopsis sections as they need
(for example we have recently introduced mod_md's
ManagedDomain/<ManagedDomain>, and modssl's SSLPolicy/<SSLPolicy>).

This approach seems more precise and less invasive to me.
Of course the name of the attribute can be changed later on
to whatever term would fit best, the main concern for me at
the moment is to restore the trunk documentation to its previous
state.



git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1805372 13f79535-47bb-0310-9956-ffa450edef68
2017-08-18 08:21:43 +00:00

93 lines
2.8 KiB
XML

<?xml version='1.0' encoding='UTF-8' ?>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<!ENTITY % sitemap SYSTEM "sitemap.dtd">
%sitemap;
<!ELEMENT modulesynopsis (name , description, status, hint?, sourcefile?,
identifier? , compatibility? , summary? , seealso* , section*,
directivesynopsis*)>
<!ATTLIST modulesynopsis metafile CDATA #REQUIRED
upgrade CDATA #IMPLIED>
<!ELEMENT directivesynopsis (name , description? , syntax? , default?
, contextlist? , override? , modulelist?, status?, compatibility? ,
usage?, seealso*)>
<!ELEMENT name (#PCDATA)>
<!ELEMENT status (#PCDATA)>
<!ELEMENT hint %Inline;>
<!ELEMENT identifier (#PCDATA)>
<!ELEMENT sourcefile (#PCDATA)>
<!ELEMENT compatibility %Inline;>
<!ELEMENT description %Inline;>
<!--
idtype is appended to the directive name when generating links to allow
a directive of type section to share the name with another directive.
The attribute type could have been (re)used instead but it would have broken
pre-existing links.
-->
<!ATTLIST directivesynopsis type CDATA #IMPLIED
idtype CDATA #IMPLIED
location CDATA #IMPLIED >
<!ELEMENT syntax %Inline;>
<!ELEMENT default (#PCDATA | directive | br)*>
<!ELEMENT contextlist (context+)+>
<!ELEMENT context (#PCDATA)>
<!ELEMENT override (#PCDATA)>
<!ELEMENT usage %Block;>
<!-- Used in index.xml -->
<!ELEMENT moduleindex (title, summary, seealso*)>
<!ATTLIST moduleindex metafile CDATA #REQUIRED>
<!-- Used in directive.xml -->
<!ELEMENT directiveindex (title | summary)+>
<!ATTLIST directiveindex metafile CDATA #REQUIRED>
<!-- Used in quickreference.xml -->
<!ELEMENT quickreference (title | summary | legend)+>
<!ATTLIST quickreference metafile CDATA #REQUIRED>
<!ELEMENT legend (table, table)>
<!-- Used in overrides.xml -->
<!ELEMENT overrideindex (title | summary | overridesummary)+>
<!ATTLIST overrideindex metafile CDATA #REQUIRED>
<!ELEMENT overridesummary %Block;>
<!ATTLIST overridesummary class CDATA #IMPLIED
fallback CDATA #IMPLIED>