Add the ability to specify technology specific documentation
[asterisk/asterisk.git] / doc / appdocsxml.dtd
1   <!ELEMENT docs (application|function|agi|manager|managerEvent|info)*>
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 managerEvent (managerEventInstance+)>
33   <!ATTLIST managerEvent name CDATA #REQUIRED>
34   <!ATTLIST managerEvent language CDATA #REQUIRED>
35
36   <!ELEMENT managerEventInstance (synopsis?,syntax?,description?,see-also?)*>
37   <!ATTLIST managerEventInstance class CDATA #REQUIRED>
38
39   <!ELEMENT info (para|note|warning|variablelist|enumlist|info|xi:include)*>
40   <!ATTLIST info name CDATA #REQUIRED>
41   <!ATTLIST info language CDATA #REQUIRED>
42   <!ATTLIST info tech CDATA #REQUIRED>
43
44   <!ELEMENT see-also (ref|xi:include)*>
45
46   <!ELEMENT ref (#PCDATA)>
47   <!ATTLIST ref type (application|function|astcli|link|manpage|filename|agi|manager|managerEvent) #REQUIRED>
48
49   <!ELEMENT synopsis (#PCDATA)>
50
51   <!ELEMENT syntax (parameter|xi:include)*>
52   <!ATTLIST syntax argsep CDATA ",">
53
54   <!ELEMENT description (para|note|warning|variablelist|enumlist|info|xi:include)*>
55
56   <!ELEMENT parameter (optionlist|enumlist|argument|para|note|warning|parameter|info|xi:include)*>
57   <!ATTLIST parameter name CDATA "">
58   <!ATTLIST parameter required (yes|no|true|false) "false">
59   <!ATTLIST parameter multiple (yes|no|true|false) "false">
60   <!ATTLIST parameter hasparams (yes|no|true|false|optional) "false">
61   <!ATTLIST parameter literal (yes|no|true|false) "false">
62   <!ATTLIST parameter default CDATA "">
63   <!ATTLIST parameter argsep CDATA ",">
64
65   <!ELEMENT optionlist (option+)>
66   <!ELEMENT option (argument|para|note|warning|variablelist|enumlist|info|xi:include)*>
67   <!ATTLIST option name CDATA #REQUIRED>
68   <!ATTLIST option argsep CDATA ",">
69   <!ATTLIST option implies CDATA "">
70   <!ATTLIST option hasparams CDATA "">
71
72   <!ELEMENT enumlist (enum+)>
73   <!ELEMENT enum (para|note|warning|parameter|enumlist|info|xi:include)*>
74   <!ATTLIST enum name CDATA "">
75
76   <!ELEMENT argument (para|note|warning|variablelist|argument|info|xi:include)*>
77   <!ATTLIST argument name CDATA #REQUIRED>
78   <!ATTLIST argument multiple (yes|no|true|false) "false">
79   <!ATTLIST argument required (yes|no|true|false) "false">
80   <!ATTLIST argument hasparams (yes|no|true|false|optional) "false">
81   <!ATTLIST argument argsep CDATA ",">
82
83   <!ELEMENT para (#PCDATA|astcli|literal|emphasis|filename|directory|replaceable|variable|xi:include)*>
84   <!ELEMENT literal (#PCDATA)>
85   <!ELEMENT emphasis (#PCDATA)>
86   <!ELEMENT filename (#PCDATA)>
87   <!ELEMENT replaceable (#PCDATA)>
88   <!ELEMENT directory (#PCDATA)>
89   <!ELEMENT astcli (#PCDATA)>
90  
91   <!ELEMENT note (para+|xi:include*)>
92   <!ELEMENT warning (para+|xi:include*)>
93
94   <!ELEMENT variablelist (variable+|xi:include*)>
95   <!ELEMENT variable (#PCDATA|value|para|info|xi:include)*>
96   <!ATTLIST variable name CDATA "">
97
98   <!ELEMENT value (#PCDATA)>
99   <!ATTLIST value name CDATA #REQUIRED>
100   <!ATTLIST value default CDATA "">