summaryrefslogtreecommitdiffstats
path: root/docs/manual/style/modulesynopsis.dtd
diff options
context:
space:
mode:
Diffstat (limited to 'docs/manual/style/modulesynopsis.dtd')
-rw-r--r--docs/manual/style/modulesynopsis.dtd92
1 files changed, 92 insertions, 0 deletions
diff --git a/docs/manual/style/modulesynopsis.dtd b/docs/manual/style/modulesynopsis.dtd
new file mode 100644
index 0000000..aa3d6ee
--- /dev/null
+++ b/docs/manual/style/modulesynopsis.dtd
@@ -0,0 +1,92 @@
+<?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>