Merge changes from team/group/appdocsxml
[asterisk/asterisk.git] / doc / appdocsxml.dtd
1   <!ELEMENT docs (application|function)* >
2
3   <!ELEMENT application (synopsis?,syntax?,description?,see-also?)>
4   <!ATTLIST application name CDATA #REQUIRED>
5   <!ATTLIST application language CDATA #REQUIRED>
6
7   <!ELEMENT function (synopsis?,syntax?,description?,see-also?)>
8   <!ATTLIST function name CDATA #REQUIRED>
9   <!ATTLIST function language CDATA #REQUIRED>  
10
11   <!ELEMENT see-also (ref*)>
12
13   <!ELEMENT ref (#PCDATA)*>
14   <!ATTLIST ref type (application|function|astcli|link|manpage) #REQUIRED>
15
16   <!ELEMENT synopsis (#PCDATA)>
17   
18   <!ELEMENT syntax (parameter*)>
19   <!ATTLIST syntax argsep CDATA ",">
20
21   <!ELEMENT description (para|note|warning|variablelist|enumlist)*>
22
23   <!ELEMENT parameter (optionlist|enumlist|argument|para|note|warning)*>
24   <!ATTLIST parameter name CDATA #REQUIRED>
25   <!ATTLIST parameter required (yes|no|true|false) "false">
26   <!ATTLIST parameter multiple (yes|no|true|false) "false">
27   <!ATTLIST parameter hasparams (yes|no|true|false|optional) "false">
28   <!ATTLIST parameter argsep CDATA ",">
29
30   <!ELEMENT optionlist (option+)>
31   <!ELEMENT option (argument|para|note|warning|variablelist|enumlist)*>
32   <!ATTLIST option name CDATA #REQUIRED> 
33   <!ATTLIST option argsep CDATA ",">
34   <!ATTLIST option implies CDATA "">
35
36   <!ELEMENT enumlist (enum+)>
37   <!ELEMENT enum (para|note|warning)*>
38   <!ATTLIST enum name CDATA #REQUIRED>
39
40   <!ELEMENT argument (para|note|warning|variablelist|argument)*>
41   <!ATTLIST argument name CDATA #REQUIRED>
42   <!ATTLIST argument multiple (yes|no|true|false) "false">
43   <!ATTLIST argument required (yes|no|true|false) "false">
44   <!ATTLIST argument hasparams (yes|no|true|false|optional) "false">
45
46   <!ELEMENT para (#PCDATA|astcli|literal|emphasis|filename|directory|replaceable|variable)*>
47   <!ELEMENT literal (#PCDATA)>
48   <!ELEMENT emphasis (#PCDATA)>
49   <!ELEMENT filename (#PCDATA)>
50   <!ELEMENT replaceable (#PCDATA)>
51   <!ELEMENT directory (#PCDATA)>
52   <!ELEMENT astcli (#PCDATA)>
53  
54   <!ELEMENT note (para+)>
55   <!ELEMENT warning (para+)>
56  
57   <!ELEMENT variablelist (variable+)>
58   <!ELEMENT variable (#PCDATA|value|para)*>
59   <!ATTLIST variable name CDATA "">
60   
61   <!ELEMENT value (#PCDATA)>
62   <!ATTLIST value name CDATA #REQUIRED>
63   <!ATTLIST value default CDATA "">
64