doc/appdocsxml.dtd

   1   <!ELEMENT docs (application|function|agi|manager|managerEvent|info|configInfo)*>
   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   <!ATTLIST agi module CDATA #IMPLIED>
  28
  29   <!ELEMENT manager (synopsis?,syntax?,description?,see-also?)>
  30   <!ATTLIST manager name CDATA #REQUIRED>
  31   <!ATTLIST manager language CDATA #REQUIRED>
  32   <!ATTLIST manager module CDATA #IMPLIED>
  33
  34   <!ELEMENT managerEvent (managerEventInstance+)>
  35   <!ATTLIST managerEvent name CDATA #REQUIRED>
  36   <!ATTLIST managerEvent language CDATA #REQUIRED>
  37   <!ATTLIST managerEvent module CDATA #IMPLIED>
  38
  39   <!ELEMENT managerEventInstance (synopsis?,syntax?,description?,see-also?)*>
  40   <!ATTLIST managerEventInstance class CDATA #REQUIRED>
  41
  42   <!ELEMENT configInfo (synopsis?,description?,configFile+)>
  43   <!ATTLIST configInfo name CDATA #REQUIRED>
  44   <!ATTLIST configInfo language CDATA #REQUIRED>
  45
  46   <!ELEMENT configFile (configObject+)>
  47   <!ATTLIST configFile name CDATA #REQUIRED>
  48
  49   <!ELEMENT configObject (synopsis?|description?|syntax?|see-also?|configOption)*>
  50   <!ATTLIST configObject name CDATA #REQUIRED>
  51
  52   <!ELEMENT configOption (synopsis,description?,syntax?,see-also?)*>
  53   <!ATTLIST configOption name CDATA #REQUIRED>
  54   <!ATTLIST configOption regex (yes|no|true|false) "false">
  55   <!ATTLIST configOption default CDATA #IMPLIED>
  56   <!ATTLIST configOption type CDATA #IMPLIED>
  57
  58   <!ELEMENT matchInfo (category|field?)>
  59
  60   <!ELEMENT category (#PCDATA)>
  61   <!ATTLIST category match (yes|no|true|false) #REQUIRED>
  62
  63   <!ELEMENT field (#PCDATA)>
  64   <!ATTLIST field name CDATA #REQUIRED>
  65
  66   <!ELEMENT info (para|note|warning|variablelist|enumlist|info|xi:include)*>
  67   <!ATTLIST info name CDATA #REQUIRED>
  68   <!ATTLIST info language CDATA #REQUIRED>
  69   <!ATTLIST info tech CDATA #REQUIRED>
  70
  71   <!ELEMENT see-also (ref|xi:include)*>
  72
  73   <!ELEMENT ref (#PCDATA)>
  74   <!ATTLIST ref type (application|function|astcli|link|manpage|filename|agi|manager|managerEvent|configOption) #REQUIRED>
  75   <!ATTLIST ref module CDATA #IMPLIED>
  76
  77   <!ELEMENT synopsis (#PCDATA)>
  78
  79   <!ELEMENT syntax (parameter|dataType|category|matchInfo|xi:include|channel_snapshot|bridge_snapshot)*>
  80   <!ATTLIST syntax argsep CDATA ",">
  81
  82   <!ELEMENT channel_snapshot (#PCDATA)>
  83   <!ATTLIST channel_snapshot prefix CDATA "">
  84
  85   <!ELEMENT bridge_snapshot (#PCDATA)>
  86   <!ATTLIST bridge_snapshot prefix CDATA "">
  87
  88   <!ELEMENT configOptionToEnum (configOption|xi:include)*>
  89   <!ATTLIST configOptionToEnum prefix CDATA "">
  90
  91   <!ELEMENT description (para|note|warning|variablelist|enumlist|info|xi:include)*>
  92
  93   <!ELEMENT parameter (optionlist|enumlist|argument|para|note|warning|parameter|info|xi:include)*>
  94   <!ATTLIST parameter name CDATA "">
  95   <!ATTLIST parameter required (yes|no|true|false) "false">
  96   <!ATTLIST parameter multiple (yes|no|true|false) "false">
  97   <!ATTLIST parameter hasparams (yes|no|true|false|optional) "false">
  98   <!ATTLIST parameter literal (yes|no|true|false) "false">
  99   <!ATTLIST parameter default CDATA "">
 100   <!ATTLIST parameter argsep CDATA ",">
 101
 102   <!ELEMENT optionlist (option+)>
 103   <!ELEMENT option (argument|para|note|warning|variablelist|enumlist|info|xi:include)*>
 104   <!ATTLIST option name CDATA #REQUIRED>
 105   <!ATTLIST option argsep CDATA ",">
 106   <!ATTLIST option implies CDATA "">
 107   <!ATTLIST option hasparams CDATA "">
 108
 109   <!ELEMENT enumlist (configOptionToEnum|enum+)>
 110   <!ELEMENT enum (para|note|warning|parameter|enumlist|info|xi:include)*>
 111   <!ATTLIST enum name CDATA "">
 112
 113   <!ELEMENT argument (para|note|warning|variablelist|argument|info|xi:include)*>
 114   <!ATTLIST argument name CDATA #REQUIRED>
 115   <!ATTLIST argument multiple (yes|no|true|false) "false">
 116   <!ATTLIST argument required (yes|no|true|false) "false">
 117   <!ATTLIST argument hasparams (yes|no|true|false|optional) "false">
 118   <!ATTLIST argument argsep CDATA ",">
 119
 120   <!ELEMENT para (#PCDATA|astcli|literal|emphasis|filename|directory|replaceable|variable|xi:include)*>
 121   <!ELEMENT literal (#PCDATA)>
 122   <!ELEMENT emphasis (#PCDATA)>
 123   <!ELEMENT filename (#PCDATA)>
 124   <!ELEMENT replaceable (#PCDATA)>
 125   <!ELEMENT directory (#PCDATA)>
 126   <!ELEMENT astcli (#PCDATA)>
 127
 128   <!ELEMENT note (para+|xi:include*)>
 129   <!ELEMENT warning (para+|xi:include*)>
 130
 131   <!ELEMENT variablelist (variable+|xi:include*)>
 132   <!ELEMENT variable (#PCDATA|value|para|info|xi:include)*>
 133   <!ATTLIST variable name CDATA "">
 134
 135   <!ELEMENT value (#PCDATA)>
 136   <!ATTLIST value name CDATA #REQUIRED>
 137   <!ATTLIST value default CDATA "">