Document: GNUstep Documentation Markup Language, DTD
From: http://laplace.snu.ac.kr/~wacko/gnustep/GDML/gdml-1.dtd
Date: 980212
<!--

	Document Type Definition for GNUstep Documentation Markup
	Language (GDML).

	Maintained by Yoo C. Chung <wacko@laplace.snu.ac.kr>


	Copyright (C) 1997 Yoo C. Chung

	This library is free software; you can redistribute it and/or
	modify it under the terms of the GNU Library General Public
	License as published by the Free Software Foundation; either
	version 2 of the License, or (at your option) any later
	version.

	This library is distributed in the hope that it will be
	useful, but WITHOUT ANY WARRANTY; without even the implied
	warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
	PURPOSE.  See the GNU Library General Public License for more
	details.

	You should have received a copy of the GNU Library General
	Public License along with this library; if not, write to the
	Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA
	02139, USA.

-->


<!ENTITY % GDML.Version
        "-//GNUstep//DTD GDML 1.0//EN"

        -- Typical usage:

            <!DOCTYPE GDML PUBLIC "-//GNUstep//DTD GDML 1.0//EN">

            ...

        -- >


<!--***** Character entities. *****-->

<!-- General purpose characters for GDML. -->
<!ENTITY copy SDATA "&copy;" -- copyright symbol -- >
<!ENTITY tm   SDATA "&tm;"   -- trademark symbol -- >
<!ENTITY dots SDATA "&dots;" -- ellipsis (...) -- >
<!ENTITY nbsp SDATA "&nbsp;" -- non breakable space -- >
<!ENTITY amp  CDATA "&"      -- ampersand -- >
<!ENTITY quot CDATA '"'      -- quotation mark (") -- >
<!ENTITY lt   CDATA "<"      -- lesser than symbol -- >
<!ENTITY gt   CDATA ">"      -- greater than symbol -- >

<!-- Smileys. -->
<!ENTITY smile SDATA "&smile;" -- ordinary smile -- >
<!ENTITY wink  SDATA "&wink;"  -- wink -- >
<!ENTITY frown SDATA "&frown;" -- frown -- >


<!--***** Entity declarations. *****-->

<!-- Entity for phrase elements. -->
<!ENTITY % phrase "VAR | EM | CODE | STRONG | FILE | SITE">

<!-- Entity for cross references. -->
<!ENTITY % xref "REF | UREF | URL | EMAIL">

<!-- Entity for anchors. -->
<!ENTITY % anchor "LABEL | ENTRY">

<!-- Entity for text level elements. -->
<!ENTITY % text "#PCDATA | %xref | %anchor | %phrase | FOOTNOTE">

<!-- Entity for definition elements. -->
<!ENTITY % def "CLASS|CATEGORY|PROTOCOL|FUNCTION|MACRO|TYPE|VARIABLE">

<!-- Entity for list elements. -->
<!ENTITY % list "LIST | ENUM | DEFLIST | QALIST">

<!-- Entity for block elements like paragraphs. -->
<!ENTITY % block "%def | %list | P | EXAMPLE | EMBED">

<!--**********-->


<!-- Used for describing something. -->
<!ELEMENT DESC - - (%block)*>

<!-- A footnote. -->
<!ELEMENT FOOTNOTE - - (%text)* -(FOOTNOTE)>


<!--***** Phrase elements. *****-->

<!-- The content is a metasyntactic variable name. -->
<!ELEMENT VAR - - (%text)*>

<!-- Emphasize the content. -->
<!ELEMENT EM - - (%text)*>

<!-- The content is too important that simple emphasizing isn't
     enough. -->
<!ELEMENT STRONG - - (%text)*>

<!-- The content is either a name for code (e.g. class names), or a
     relatively short code fragment. -->
<!ELEMENT CODE - - (%text)*>

<!-- The content is a file name. -->
<!ELEMENT FILE - - CDATA>

<!-- The content is a fully qualified domain name on the Internet. -->
<!ELEMENT SITE - - CDATA>


<!--***** List elements. *****-->

<!-- An item in a list. -->
<!ELEMENT ITEM - O (%block)*>

<!-- An enumerated list. -->
<!ELEMENT ENUM - - (ITEM+)>

<!-- A ordinary, unnumbered list. -->
<!ELEMENT LIST - - (ITEM+)>

<!-- A term to defined in a definition list. -->
<!ELEMENT TERM - - (%text)*>

<!-- A definition list. -->
<!ELEMENT DEFLIST - - (TERM, DESC)+>

<!-- A question for a question and answer list. -->
<!ELEMENT QUESTION - O (%text)*>

<!-- An answer for a question and answer list. -->
<!ELEMENT ANSWER - O (%block)*>

<!-- A question and answer list. -->
<!ELEMENT QALIST - - (QUESTION, ANSWER)+>

<!--**********-->


<!--***** Cross references. *****-->

<!-- A reference.  If TYPE is implied, a reference to a label. -->
<!ELEMENT REF - O EMPTY>
<!ATTLIST REF
	id CDATA #REQUIRED -- ID of the reference --
	type (class|protocol|method|function|type|macro|variable) #IMPLIED
	class CDATA #IMPLIED -- specific class for a method -- >

<!-- An e-mail address. -->
<!ELEMENT EMAIL - - CDATA>

<!-- A URL. -->
<!ELEMENT URL - - CDATA>

<!-- A reference to a URL.  The text contained appears in the output. -->
<!ELEMENT UREF - - (%text)* -(UREF)>
<!ATTLIST UREF
	url CDATA #REQUIRED
	hide (hide) #IMPLIED -- hide URL in output -- >


<!--***** Anchors. *****-->

<!-- An anchor for a general reference.  The text contained appears in
     the ouput. -->
<!ELEMENT LABEL - - (%text)* -(LABEL)>
<!ATTLIST LABEL
	id CDATA #REQUIRED>

<!-- An entry for the general index. -->
<!ELEMENT ENTRY - - (%text)* -(ENTRY)
--
	The text that is contained appears in the index, and never in
	the text itself.
-- >


<!--***** Argument elements. *****-->

<!-- A group of arguments in functions and the like. -->
<!ELEMENT ARGS O O (ARG*, VARARG?)>

<!-- An argument. -->
<!ELEMENT ARG - O (#PCDATA)*>
<!ATTLIST ARG
	type CDATA #IMPLIED>

<!-- Denotes that the rest of the arguments is a variable list, like
     in printf(). -->
<!ELEMENT VARARG - O EMPTY>


<!--***** Method elements. *****-->

<!-- A component for a method selector. -->
<!ELEMENT SEL - O (#PCDATA)*>

<!-- A complete method with the selector and arguments. -->
<!ELEMENT METHCALL O O ((SEL, ARG?), (SEL, ARG)*, VARARG?)>

<!-- A method.  If there is no DESC, it is understood that the element
     is used to override some information from the same method in the
     superclass. -->
<!ELEMENT METHOD - O (METHCALL, DESC?)>
<!ATTLIST METHOD
	type CDATA #IMPLIED
	factory (factory) #IMPLIED -- if not set, instance method --
	override (subclass|never) #IMPLIED
	role (alloc|init|dealloc|copy|mcopy) #IMPLIED>


<!--***** Elements for definitions of classes, functions, etc. *****-->

<!-- A standard that something is compliant with. -->
<!ELEMENT STANDARD - O (%text)*>

<!-- A macro definition. -->
<!ELEMENT MACRO - - (ARGS?, DESC?, STANDARD*)>
<!ATTLIST MACRO
	name CDATA #REQUIRED>

<!-- To be replaced with the name of the type whenever it occurs in a
     prototype. -->
<!ELEMENT TYPENAME - O EMPTY>

<!-- Whenever the element typename occurs, replace it with the name. -->
<!ELEMENT PROTO O O (%text | TYPENAME)*>

<!-- A type definition. -->
<!ELEMENT TYPE - - (PROTO, DESC?, STANDARD*)>
<!ATTLIST TYPE
	name CDATA #REQUIRED>

<!-- Variable definition. -->
<!ELEMENT VARIABLE - O (DESC?, STANDARD*)>
<!ATTLIST VARIABLE
	name CDATA #REQUIRED
	type CDATA #REQUIRED
	value CDATA #IMPLIED -- Possibly constant default value --
	role (except|defaults|notify|key) #IMPLIED>

<!-- A function definition. -->
<!ELEMENT FUNCTION - - (ARGS, DESC?, STANDARD*)>
<!ATTLIST FUNCTION
	name CDATA #REQUIRED
	type CDATA #REQUIRED>

<!-- Protocol definition. -->
<!ELEMENT PROTOCOL - - (DESC?, METHOD*, STANDARD*)>
<!ATTLIST PROTOCOL
	name CDATA #REQUIRED>

<!-- Category definition. -->
<!ELEMENT CATEGORY - - (DESC?, METHOD*, STANDARD*)>
<!ATTLIST CATEGORY
	name CDATA #REQUIRED
	class CDATA #REQUIRED>

<!-- Show a protocol a class conforms to. -->
<!ELEMENT CONFORM - - (#PCDATA)*>

<!-- Class definition. -->
<!ELEMENT CLASS - - (CONFORM*, DESC?, METHOD*, STANDARD*)>
<!ATTLIST CLASS
	name CDATA #REQUIRED
	super CDATA #IMPLIED>


<!--***** Elements for ordinary block level elements. *****-->

<!-- A paragraph. -->
<!ELEMENT P - O (%text)*>

<!-- An example.  The content shows up verbatim. -->
<!ELEMENT EXAMPLE - - RCDATA>
<!ATTLIST EXAMPLE
	id CDATA #IMPLIED
	caption CDATA #IMPLIED>

<!-- An embedded object.  If it is of a type that the SGML processor
     cannot handle, then use the content, which is ignored otherwise. -->
<!ELEMENT EMBED - - (%block)*>
<!ATTLIST EMBED
	id CDATA #IMPLIED
	refer (file|url) file -- method of referring to object --
	src CDATA #REQUIRED -- the reference to the object --
	type CDATA #IMPLIED -- Internet media type of the object--
	title CDATA #IMPLIED -- optional title describing object -- >

<!--***** Elements for document structure such as chapters. *****-->

<!-- A heading for chapters, sections, ... -->
<!ELEMENT HEADING - - (%text)*>

<!-- A subsubsection. -->
<!ELEMENT SSUBSECT - O (HEADING, (%block)*)>
<!ATTLIST SSUBSECT
	id CDATA #IMPLIED>

<!-- A subsection. -->
<!ELEMENT SUBSECT - O (HEADING, (%block)*, SSUBSECT*)>
<!ATTLIST SUBSECT
	id CDATA #IMPLIED>

<!-- A section. -->
<!ELEMENT SECTION - O (HEADING, (%block)*, SUBSECT*)>
<!ATTLIST SECTION
	id CDATA #IMPLIED>

<!-- A chapter. -->
<!ELEMENT CHAPTER - O (HEADING, (%block)*, SECTION*)>
<!ATTLIST CHAPTER
	id CDATA #IMPLIED>


<!--***** Elements that make searching for things easier. *****-->

<!-- Table of contents. -->
<!ELEMENT CONTENTS - O EMPTY>

<!-- Index -->
<!ELEMENT INDEX - O EMPTY>


<!--***** Elements that describe the document itself. *****-->

<!-- Copyright of the document. -->
<!ELEMENT COPY - - (%text)*>

<!-- An abstract. -->
<!ELEMENT ABSTRACT - - (%text)*>

<!-- The version of the document. -->
<!ELEMENT VERSION - - (%text)*>

<!-- The date the document was written. -->
<!ELEMENT DATE - - (%text)*>

<!-- An author. -->
<!ELEMENT AUTHOR - O (EMAIL?, URL?, DESC?)>
<!ATTLIST AUTHOR
	name CDATA #REQUIRED>

<!-- The title of the document. -->
<!ELEMENT TITLE - - (%text)*>


<!--***** The topmost structures for the document body. *****-->

<!-- Unnumbered parts appearing in the front, such as a preface. -->
<!ELEMENT FRONT - - (CONTENTS?, CHAPTER*)>

<!-- The main content for the document. -->
<!ELEMENT MAIN O O (CHAPTER+)>

<!-- Unnumbered parts appearing in the back, such as an afterword or
     indices. -->
<!ELEMENT BACK - - (CHAPTER*, INDEX?)>


<!--***** The topmost structures for the document. *****-->

<!-- The head containing general information about the document. -->
<!ELEMENT HEAD O O (TITLE, AUTHOR+, VERSION?, DATE?, ABSTRACT?, COPY?)>

<!-- The main part of the document. -->
<!ELEMENT BODY O O (FRONT?, MAIN, BACK?)>

<!--**********-->


<!-- The entire document. -->
<!ELEMENT GDML O O (HEAD, BODY)>