mirror of
https://github.com/asterisk/asterisk.git
synced 2025-11-16 06:48:25 +00:00
6f31fed83f
A new <agi> element is used to describe the XML documentation. We have the usual synopsis,syntax,description and seealso for AGI commands. The CLI 'agi show commands' command was changed to show all the documentation se ctions. git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@156051 65c4cc65-6c06-0410-ace0-fbb531ad65f3
70 lines
2.4 KiB
DTD
70 lines
2.4 KiB
DTD
<!ELEMENT docs (application|function|agi)* >
|
|
|
|
<!ELEMENT application (synopsis?,syntax?,description?,see-also?)>
|
|
<!ATTLIST application name CDATA #REQUIRED>
|
|
<!ATTLIST application language CDATA #REQUIRED>
|
|
|
|
<!ELEMENT function (synopsis?,syntax?,description?,see-also?)>
|
|
<!ATTLIST function name CDATA #REQUIRED>
|
|
<!ATTLIST function language CDATA #REQUIRED>
|
|
|
|
<!ELEMENT agi (synopsis?,syntax?,description?,see-also?)>
|
|
<!ATTLIST agi name CDATA #REQUIRED>
|
|
<!ATTLIST agi language CDATA #REQUIRED>
|
|
|
|
<!ELEMENT see-also (ref*)>
|
|
|
|
<!ELEMENT ref (#PCDATA)*>
|
|
<!ATTLIST ref type (application|function|astcli|link|manpage|filename|agi) #REQUIRED>
|
|
|
|
<!ELEMENT synopsis (#PCDATA)>
|
|
|
|
<!ELEMENT syntax (parameter*)>
|
|
<!ATTLIST syntax argsep CDATA ",">
|
|
|
|
<!ELEMENT description (para|note|warning|variablelist|enumlist)*>
|
|
|
|
<!ELEMENT parameter (optionlist|enumlist|argument|para|note|warning|parameter)*>
|
|
<!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)*>
|
|
<!ATTLIST option name CDATA #REQUIRED>
|
|
<!ATTLIST option argsep CDATA ",">
|
|
<!ATTLIST option implies CDATA "">
|
|
|
|
<!ELEMENT enumlist (enum+)>
|
|
<!ELEMENT enum (para|note|warning)*>
|
|
<!ATTLIST enum name CDATA "">
|
|
|
|
<!ELEMENT argument (para|note|warning|variablelist|argument)*>
|
|
<!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">
|
|
|
|
<!ELEMENT para (#PCDATA|astcli|literal|emphasis|filename|directory|replaceable|variable)*>
|
|
<!ELEMENT literal (#PCDATA)>
|
|
<!ELEMENT emphasis (#PCDATA)>
|
|
<!ELEMENT filename (#PCDATA)>
|
|
<!ELEMENT replaceable (#PCDATA)>
|
|
<!ELEMENT directory (#PCDATA)>
|
|
<!ELEMENT astcli (#PCDATA)>
|
|
|
|
<!ELEMENT note (para+)>
|
|
<!ELEMENT warning (para+)>
|
|
|
|
<!ELEMENT variablelist (variable+)>
|
|
<!ELEMENT variable (#PCDATA|value|para)*>
|
|
<!ATTLIST variable name CDATA "">
|
|
|
|
<!ELEMENT value (#PCDATA)>
|
|
<!ATTLIST value name CDATA #REQUIRED>
|
|
<!ATTLIST value default CDATA "">
|