src/documentation/content/xdocs/dtd/document-v13.dtd

   1 <!--
   2   Copyright 1999-2004 The Apache Software Foundation
   3
   4   Licensed under the Apache License, Version 2.0 (the "License");
   5   you may not use this file except in compliance with the License.
   6   You may obtain a copy of the License at
   7
   8       http://www.apache.org/licenses/LICENSE-2.0
   9
  10   Unless required by applicable law or agreed to in writing, software
  11   distributed under the License is distributed on an "AS IS" BASIS,
  12   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13   See the License for the specific language governing permissions and
  14   limitations under the License.
  15 -->
  16 <!-- ===================================================================
  17
  18      Apache Documentation DTD (Version 1.2)
  19
  20 PURPOSE:
  21   This DTD was developed to create a simple yet powerful document
  22   type for software documentation for use with the Apache projects.
  23   It is an XML-compliant DTD and it's maintained by the Apache XML
  24   project.
  25
  26 TYPICAL INVOCATION:
  27
  28   <!DOCTYPE document PUBLIC
  29        "-//APACHE//DTD Documentation Vx.y//EN"
  30        "document-vxy.dtd">
  31
  32   where
  33
  34     x := major version
  35     y := minor version
  36
  37 NOTES:
  38   Many of the design patterns used in this DTD were take from the
  39   W3C XML Specification DTD edited by Eve Maler <elm@arbortext.com>.
  40
  41   Where possible, great care has been used to reuse HTML tag
  42   names to reduce learning efforts and to allow HTML editors to be
  43   used for complex authorings like tables and lists.
  44
  45 EXTENSIBILITY:
  46   This DTD includes several empty placeholders that can be used to
  47   extend it. These placeholders are implemented with empty entities. Here
  48   is the list of those empty entities and what they are used for:
  49
  50     - local.inline: this entity should contain extended definitions of
  51                     elements that can be used 'inline', or directly inside
  52                     the content. An example for this entity could be
  53
  54                         <!ENTITY % local.inline "|citation">
  55
  56     - local.blocks: this entity should contain extended definitions of
  57                     elements that behave as 'blocks', thus can be visually
  58                     rendered as areas on the canvas. An example for this
  59                     entity could be:
  60
  61                         <!ENTITY % local.blocks "|poem">
  62
  63     - local.sections: this entity should contain extended definitions of
  64                       elements that behave as 'sections', thus can be considered
  65                       containers of block-level elements. An example for
  66                       this entity could be:
  67
  68                         <!ENTITY % local.sections "|chapter">
  69
  70     - local.headers: this entity should contain extended definitions of
  71                      elements that behave as parts of the document header.
  72                      An example for this header could be:
  73
  74                         <!ENTITY % local.headers ", notes?">
  75
  76     - local.footers: this entity should contain extended definitions of
  77                      elements that behave as parts of the document footer.
  78                      An example for this header could be:
  79
  80                         <!ENTITY % local.footers ", annotations*">
  81
  82 FIXME:
  83   - should "form" tags be included?
  84
  85 CHANGE HISTORY:
  86 [Version 1.0]
  87   19991121 Initial version. (SM)
  88   19991123 Replaced "res" with more standard "strong" for emphasis. (SM)
  89   19991124 Added "fork" element for window forking behavior. (SM)
  90   19991124 Added "img-inline" element to separate from "img". (SM)
  91   19991129 Removed "affiliation" from "author". (SM)
  92   19991129 Made "author" empty and moved "name|email" as attributes. (SM)
  93   19991215 Simplified table section. (SM)
  94   19991215 Changed "img-block" in more friendly "figure". (SM)
  95   20000125 Added the "icon" image. (SM)
  96   20000126 Allowed "anchor" in all levels. (SM)
  97   20000404 Removed the "role" attribute from common-xxx.att. (SM)
  98   20000815 Allowed "code" inside "strong" and "em". (SM)
  99 [Version 1.1]
 100   20011212 Used public identifiers for external entities. (SM)
 101   20011212 Removed xlink attributes since not used. (SM)
 102   20011212 Removed "connect" since not required at this level. (SM)
 103   20011218 Added "warning" as a block level object. (SM)
 104   20011218 Removed explicitly numbered sections ("s1|s2|s3|s4"). (SM)
 105   20011218 Added "section" element. (SM)
 106   20011218 Allowed "body" to have blocks without a section. (SM)
 107   20011218 Removed "sl" since not really different from "ul". (SM)
 108   20020214 Moved empty placeholder entity declarations up front (SNS)
 109   20020214 Corrected content model of content.mix parameter entity (SNS)
 110   20020519 The DTDs are now modular so various parts can be re-used (SNS)
 111   20020606 Made title into an child element of its parent instead of an attribute (SNS)
 112   20020613 Move the declarations of ISO character entity sets to module (DC)
 113 [Version 1.2]
 114   20030320 Make @href required for link elements. (SNS)
 115   20030320 Allow links (link|jump|fork) and inline elements (br|img|icon|acronym) inside title. (SNS)
 116   20030419 Allow inline content (strong|em|code|sub|sup|br|img|icon|acronym|link|jump|fork) in strong and em. (JT)
 117   20030419 Allow paragraphs (p|source|note|warning|fixme), table and figure|anchor inside li. (JT)
 118   20030419 Allow paragraphs (p|source|note|warning|fixme), lists (ol|ul|dl), table, figure|anchor inside dd. (JT)
 119   20030419 Allow paragraphs (p|source|note|warning|fixme), lists (ol|ul|dl), table, figure|anchor inside tables (td|dh). (JT)
 120   20040614 The attribute "class" is now defined on every element. (RT)
 121
 122 ==================================================================== -->
 123
 124
 125 <!-- =============================================================== -->
 126 <!-- Include the Common ISO Character Entity Sets -->
 127 <!-- =============================================================== -->
 128
 129 <!ENTITY % common-charents PUBLIC
 130     "-//APACHE//ENTITIES Common Character Entity Sets V1.0//EN"
 131     "common-charents-v10.mod">
 132 %common-charents;
 133
 134 <!-- =============================================================== -->
 135 <!-- Document -->
 136 <!-- =============================================================== -->
 137
 138 <!ENTITY % document PUBLIC
 139     "-//APACHE//ENTITIES Documentation V1.3//EN"
 140     "document-v13.mod">
 141 %document;
 142
 143 <!-- =============================================================== -->
 144 <!-- End of DTD -->
 145 <!-- =============================================================== -->