86ff5585fd
A number of applications/AMI commands in Asterisk have specific behavioral differences depending on the resource or channel technology those applications are executed on. For example, the MessageSend application/ command is technology agnostic, but how the channel drivers that support that functionality behave is dependant on the protocols and channel driver implementation. Prior to this patch, those details were either documented in the application/command documentation itself, or were left undocumented. This patch adds a new element to the documentation schema, <info/>. An info node is essentially a piece of technology specific reference information that can be included by any top level XML documentation node. For example, the MessageSend application can now include XMPP/SIP specific information, where that technology specific information can be defined in chan_motif/res_xmpp/ chan_sip. Likewise, that information can also be included in the MessageSend AMI command. Review: https://reviewboard.asterisk.org/r/2049 git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@370278 65c4cc65-6c06-0410-ace0-fbb531ad65f3
101 lines
3.8 KiB
DTD
101 lines
3.8 KiB
DTD
<!ELEMENT docs (application|function|agi|manager|managerEvent|info)*>
|
|
<!ATTLIST docs xmlns:xi CDATA #FIXED "http://www.w3.org/2001/XInclude">
|
|
|
|
<!ELEMENT xi:include (xi:fallback?) >
|
|
<!ATTLIST xi:include
|
|
xmlns:xi CDATA #FIXED "http://www.w3.org/2001/XInclude"
|
|
href CDATA #IMPLIED
|
|
parse (xml|text) "xml"
|
|
xpointer CDATA #IMPLIED
|
|
encoding CDATA #IMPLIED
|
|
accept CDATA #IMPLIED
|
|
accept-language CDATA #IMPLIED >
|
|
|
|
<!ELEMENT application (synopsis?,syntax?,description?,see-also?)>
|
|
<!ATTLIST application name CDATA #REQUIRED>
|
|
<!ATTLIST application language CDATA #REQUIRED>
|
|
<!ATTLIST application module CDATA #IMPLIED>
|
|
|
|
<!ELEMENT function (synopsis?,syntax?,description?,see-also?)>
|
|
<!ATTLIST function name CDATA #REQUIRED>
|
|
<!ATTLIST function language CDATA #REQUIRED>
|
|
<!ATTLIST function module CDATA #IMPLIED>
|
|
|
|
<!ELEMENT agi (synopsis?,syntax?,description?,see-also?)>
|
|
<!ATTLIST agi name CDATA #REQUIRED>
|
|
<!ATTLIST agi language CDATA #REQUIRED>
|
|
|
|
<!ELEMENT manager (synopsis?,syntax?,description?,see-also?)>
|
|
<!ATTLIST manager name CDATA #REQUIRED>
|
|
<!ATTLIST manager language CDATA #REQUIRED>
|
|
|
|
<!ELEMENT managerEvent (managerEventInstance+)>
|
|
<!ATTLIST managerEvent name CDATA #REQUIRED>
|
|
<!ATTLIST managerEvent language CDATA #REQUIRED>
|
|
|
|
<!ELEMENT managerEventInstance (synopsis?,syntax?,description?,see-also?)*>
|
|
<!ATTLIST managerEventInstance class CDATA #REQUIRED>
|
|
|
|
<!ELEMENT info (para|note|warning|variablelist|enumlist|info|xi:include)*>
|
|
<!ATTLIST info name CDATA #REQUIRED>
|
|
<!ATTLIST info language CDATA #REQUIRED>
|
|
<!ATTLIST info tech CDATA #REQUIRED>
|
|
|
|
<!ELEMENT see-also (ref|xi:include)*>
|
|
|
|
<!ELEMENT ref (#PCDATA)>
|
|
<!ATTLIST ref type (application|function|astcli|link|manpage|filename|agi|manager|managerEvent) #REQUIRED>
|
|
|
|
<!ELEMENT synopsis (#PCDATA)>
|
|
|
|
<!ELEMENT syntax (parameter|xi:include)*>
|
|
<!ATTLIST syntax argsep CDATA ",">
|
|
|
|
<!ELEMENT description (para|note|warning|variablelist|enumlist|info|xi:include)*>
|
|
|
|
<!ELEMENT parameter (optionlist|enumlist|argument|para|note|warning|parameter|info|xi:include)*>
|
|
<!ATTLIST parameter name CDATA "">
|
|
<!ATTLIST parameter required (yes|no|true|false) "false">
|
|
<!ATTLIST parameter multiple (yes|no|true|false) "false">
|
|
<!ATTLIST parameter hasparams (yes|no|true|false|optional) "false">
|
|
<!ATTLIST parameter literal (yes|no|true|false) "false">
|
|
<!ATTLIST parameter default CDATA "">
|
|
<!ATTLIST parameter argsep CDATA ",">
|
|
|
|
<!ELEMENT optionlist (option+)>
|
|
<!ELEMENT option (argument|para|note|warning|variablelist|enumlist|info|xi:include)*>
|
|
<!ATTLIST option name CDATA #REQUIRED>
|
|
<!ATTLIST option argsep CDATA ",">
|
|
<!ATTLIST option implies CDATA "">
|
|
<!ATTLIST option hasparams CDATA "">
|
|
|
|
<!ELEMENT enumlist (enum+)>
|
|
<!ELEMENT enum (para|note|warning|parameter|enumlist|info|xi:include)*>
|
|
<!ATTLIST enum name CDATA "">
|
|
|
|
<!ELEMENT argument (para|note|warning|variablelist|argument|info|xi:include)*>
|
|
<!ATTLIST argument name CDATA #REQUIRED>
|
|
<!ATTLIST argument multiple (yes|no|true|false) "false">
|
|
<!ATTLIST argument required (yes|no|true|false) "false">
|
|
<!ATTLIST argument hasparams (yes|no|true|false|optional) "false">
|
|
<!ATTLIST argument argsep CDATA ",">
|
|
|
|
<!ELEMENT para (#PCDATA|astcli|literal|emphasis|filename|directory|replaceable|variable|xi:include)*>
|
|
<!ELEMENT literal (#PCDATA)>
|
|
<!ELEMENT emphasis (#PCDATA)>
|
|
<!ELEMENT filename (#PCDATA)>
|
|
<!ELEMENT replaceable (#PCDATA)>
|
|
<!ELEMENT directory (#PCDATA)>
|
|
<!ELEMENT astcli (#PCDATA)>
|
|
|
|
<!ELEMENT note (para+|xi:include*)>
|
|
<!ELEMENT warning (para+|xi:include*)>
|
|
|
|
<!ELEMENT variablelist (variable+|xi:include*)>
|
|
<!ELEMENT variable (#PCDATA|value|para|info|xi:include)*>
|
|
<!ATTLIST variable name CDATA "">
|
|
|
|
<!ELEMENT value (#PCDATA)>
|
|
<!ATTLIST value name CDATA #REQUIRED>
|
|
<!ATTLIST value default CDATA "">
|