Implement a new element in AstXML for AMI actions documentation.
[asterisk/asterisk.git] / doc / appdocsxml.dtd
1   <!ELEMENT docs (application|function|agi|manager)*>
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 manager (synopsis?,syntax?,description?,see-also?)>
27   <!ATTLIST manager name CDATA #REQUIRED>
28   <!ATTLIST manager language CDATA #REQUIRED>
29
30   <!ELEMENT see-also (ref|xi:include)*>
31
32   <!ELEMENT ref (#PCDATA)>
33   <!ATTLIST ref type (application|function|astcli|link|manpage|filename|agi) #REQUIRED>
34
35   <!ELEMENT synopsis (#PCDATA)>
36
37   <!ELEMENT syntax (parameter|xi:include)*>
38   <!ATTLIST syntax argsep CDATA ",">
39
40   <!ELEMENT description (para|note|warning|variablelist|enumlist|xi:include)*>
41
42   <!ELEMENT parameter (optionlist|enumlist|argument|para|note|warning|parameter|xi:include)*>
43   <!ATTLIST parameter name CDATA "">
44   <!ATTLIST parameter required (yes|no|true|false) "false">
45   <!ATTLIST parameter multiple (yes|no|true|false) "false">
46   <!ATTLIST parameter hasparams (yes|no|true|false|optional) "false">
47   <!ATTLIST parameter literal (yes|no|true|false) "false">
48   <!ATTLIST parameter default CDATA "">
49   <!ATTLIST parameter argsep CDATA ",">
50
51   <!ELEMENT optionlist (option+)>
52   <!ELEMENT option (argument|para|note|warning|variablelist|enumlist|xi:include)*>
53   <!ATTLIST option name CDATA #REQUIRED>
54   <!ATTLIST option argsep CDATA ",">
55   <!ATTLIST option implies CDATA "">
56   <!ATTLIST option hasparams CDATA "">
57
58   <!ELEMENT enumlist (enum+)>
59   <!ELEMENT enum (para|note|warning|parameter|enumlist|xi:include)*>
60   <!ATTLIST enum name CDATA "">
61
62   <!ELEMENT argument (para|note|warning|variablelist|argument|xi:include)*>
63   <!ATTLIST argument name CDATA #REQUIRED>
64   <!ATTLIST argument multiple (yes|no|true|false) "false">
65   <!ATTLIST argument required (yes|no|true|false) "false">
66   <!ATTLIST argument hasparams (yes|no|true|false|optional) "false">
67   <!ATTLIST argument argsep CDATA ",">
68
69   <!ELEMENT para (#PCDATA|astcli|literal|emphasis|filename|directory|replaceable|variable|xi:include)*>
70   <!ELEMENT literal (#PCDATA)>
71   <!ELEMENT emphasis (#PCDATA)>
72   <!ELEMENT filename (#PCDATA)>
73   <!ELEMENT replaceable (#PCDATA)>
74   <!ELEMENT directory (#PCDATA)>
75   <!ELEMENT astcli (#PCDATA)>
76  
77   <!ELEMENT note (para+|xi:include*)>
78   <!ELEMENT warning (para+|xi:include*)>
79
80   <!ELEMENT variablelist (variable+|xi:include*)>
81   <!ELEMENT variable (#PCDATA|value|para|xi:include)*>
82   <!ATTLIST variable name CDATA "">
83
84   <!ELEMENT value (#PCDATA)>
85   <!ATTLIST value name CDATA #REQUIRED>
86   <!ATTLIST value default CDATA "">