Allow to include sections of other parts of the xml documentation.
[asterisk/asterisk.git] / doc / appdocsxml.dtd
1   <!ELEMENT docs (application|function|agi)*>
2   <!ATTLIST docs xmlns:xi CDATA #FIXED "http://www.w3.org/2001/XInclude">
3
4   <!ELEMENT xi:include (xi:fallback?) >
5   <!ATTLIST xi:include 
6   xmlns:xi      CDATA       #FIXED    "http://www.w3.org/2001/XInclude"
7   href          CDATA       #IMPLIED
8   parse         (xml|text)  "xml"
9   xpointer      CDATA       #IMPLIED
10   encoding      CDATA       #IMPLIED 
11   accept        CDATA       #IMPLIED
12   accept-language CDATA  #IMPLIED >
13
14   <!ELEMENT application (synopsis?,syntax?,description?,see-also?)>
15   <!ATTLIST application name CDATA #REQUIRED>
16   <!ATTLIST application language CDATA #REQUIRED>
17
18   <!ELEMENT function (synopsis?,syntax?,description?,see-also?)>
19   <!ATTLIST function name CDATA #REQUIRED>
20   <!ATTLIST function language CDATA #REQUIRED>
21
22   <!ELEMENT agi (synopsis?,syntax?,description?,see-also?)>
23   <!ATTLIST agi name CDATA #REQUIRED>
24   <!ATTLIST agi language CDATA #REQUIRED>
25
26   <!ELEMENT see-also (ref|xi:include)*>
27
28   <!ELEMENT ref (#PCDATA)>
29   <!ATTLIST ref type (application|function|astcli|link|manpage|filename|agi) #REQUIRED>
30
31   <!ELEMENT synopsis (#PCDATA)>
32
33   <!ELEMENT syntax (parameter|xi:include)*>
34   <!ATTLIST syntax argsep CDATA ",">
35
36   <!ELEMENT description (para|note|warning|variablelist|enumlist|xi:include)*>
37
38   <!ELEMENT parameter (optionlist|enumlist|argument|para|note|warning|parameter|xi:include)*>
39   <!ATTLIST parameter name CDATA "">
40   <!ATTLIST parameter required (yes|no|true|false) "false">
41   <!ATTLIST parameter multiple (yes|no|true|false) "false">
42   <!ATTLIST parameter hasparams (yes|no|true|false|optional) "false">
43   <!ATTLIST parameter literal (yes|no|true|false) "false">
44   <!ATTLIST parameter default CDATA "">
45   <!ATTLIST parameter argsep CDATA ",">
46
47   <!ELEMENT optionlist (option+)>
48   <!ELEMENT option (argument|para|note|warning|variablelist|enumlist|xi:include)*>
49   <!ATTLIST option name CDATA #REQUIRED>
50   <!ATTLIST option argsep CDATA ",">
51   <!ATTLIST option implies CDATA "">
52   <!ATTLIST option hasparams CDATA "">
53
54   <!ELEMENT enumlist (enum+)>
55   <!ELEMENT enum (para|note|warning|parameter|enumlist|xi:include)*>
56   <!ATTLIST enum name CDATA "">
57
58   <!ELEMENT argument (para|note|warning|variablelist|argument|xi:include)*>
59   <!ATTLIST argument name CDATA #REQUIRED>
60   <!ATTLIST argument multiple (yes|no|true|false) "false">
61   <!ATTLIST argument required (yes|no|true|false) "false">
62   <!ATTLIST argument hasparams (yes|no|true|false|optional) "false">
63   <!ATTLIST argument argsep CDATA ",">
64
65   <!ELEMENT para (#PCDATA|astcli|literal|emphasis|filename|directory|replaceable|variable|xi:include)*>
66   <!ELEMENT literal (#PCDATA)>
67   <!ELEMENT emphasis (#PCDATA)>
68   <!ELEMENT filename (#PCDATA)>
69   <!ELEMENT replaceable (#PCDATA)>
70   <!ELEMENT directory (#PCDATA)>
71   <!ELEMENT astcli (#PCDATA)>
72  
73   <!ELEMENT note (para+|xi:include*)>
74   <!ELEMENT warning (para+|xi:include*)>
75
76   <!ELEMENT variablelist (variable+|xi:include*)>
77   <!ELEMENT variable (#PCDATA|value|para|xi:include)*>
78   <!ATTLIST variable name CDATA "">
79
80   <!ELEMENT value (#PCDATA)>
81   <!ATTLIST value name CDATA #REQUIRED>
82   <!ATTLIST value default CDATA "">