Merged revisions 340109 via svnmerge from
[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   <!ATTLIST application module CDATA #IMPLIED>
18
19   <!ELEMENT function (synopsis?,syntax?,description?,see-also?)>
20   <!ATTLIST function name CDATA #REQUIRED>
21   <!ATTLIST function language CDATA #REQUIRED>
22   <!ATTLIST function module CDATA #IMPLIED>
23
24   <!ELEMENT agi (synopsis?,syntax?,description?,see-also?)>
25   <!ATTLIST agi name CDATA #REQUIRED>
26   <!ATTLIST agi language CDATA #REQUIRED>
27
28   <!ELEMENT manager (synopsis?,syntax?,description?,see-also?)>
29   <!ATTLIST manager name CDATA #REQUIRED>
30   <!ATTLIST manager language CDATA #REQUIRED>
31
32   <!ELEMENT see-also (ref|xi:include)*>
33
34   <!ELEMENT ref (#PCDATA)>
35   <!ATTLIST ref type (application|function|astcli|link|manpage|filename|agi) #REQUIRED>
36
37   <!ELEMENT synopsis (#PCDATA)>
38
39   <!ELEMENT syntax (parameter|xi:include)*>
40   <!ATTLIST syntax argsep CDATA ",">
41
42   <!ELEMENT description (para|note|warning|variablelist|enumlist|xi:include)*>
43
44   <!ELEMENT parameter (optionlist|enumlist|argument|para|note|warning|parameter|xi:include)*>
45   <!ATTLIST parameter name CDATA "">
46   <!ATTLIST parameter required (yes|no|true|false) "false">
47   <!ATTLIST parameter multiple (yes|no|true|false) "false">
48   <!ATTLIST parameter hasparams (yes|no|true|false|optional) "false">
49   <!ATTLIST parameter literal (yes|no|true|false) "false">
50   <!ATTLIST parameter default CDATA "">
51   <!ATTLIST parameter argsep CDATA ",">
52
53   <!ELEMENT optionlist (option+)>
54   <!ELEMENT option (argument|para|note|warning|variablelist|enumlist|xi:include)*>
55   <!ATTLIST option name CDATA #REQUIRED>
56   <!ATTLIST option argsep CDATA ",">
57   <!ATTLIST option implies CDATA "">
58   <!ATTLIST option hasparams CDATA "">
59
60   <!ELEMENT enumlist (enum+)>
61   <!ELEMENT enum (para|note|warning|parameter|enumlist|xi:include)*>
62   <!ATTLIST enum name CDATA "">
63
64   <!ELEMENT argument (para|note|warning|variablelist|argument|xi:include)*>
65   <!ATTLIST argument name CDATA #REQUIRED>
66   <!ATTLIST argument multiple (yes|no|true|false) "false">
67   <!ATTLIST argument required (yes|no|true|false) "false">
68   <!ATTLIST argument hasparams (yes|no|true|false|optional) "false">
69   <!ATTLIST argument argsep CDATA ",">
70
71   <!ELEMENT para (#PCDATA|astcli|literal|emphasis|filename|directory|replaceable|variable|xi:include)*>
72   <!ELEMENT literal (#PCDATA)>
73   <!ELEMENT emphasis (#PCDATA)>
74   <!ELEMENT filename (#PCDATA)>
75   <!ELEMENT replaceable (#PCDATA)>
76   <!ELEMENT directory (#PCDATA)>
77   <!ELEMENT astcli (#PCDATA)>
78  
79   <!ELEMENT note (para+|xi:include*)>
80   <!ELEMENT warning (para+|xi:include*)>
81
82   <!ELEMENT variablelist (variable+|xi:include*)>
83   <!ELEMENT variable (#PCDATA|value|para|xi:include)*>
84   <!ATTLIST variable name CDATA "">
85
86   <!ELEMENT value (#PCDATA)>
87   <!ATTLIST value name CDATA #REQUIRED>
88   <!ATTLIST value default CDATA "">