mirror of
https://github.com/asterisk/asterisk.git
synced 2025-09-21 04:46:29 +00:00
5b168ee34b
This commit introduces the first phase of an effort to manage documentation of the interfaces in Asterisk in an XML format. Currently, a new format is available for applications and dialplan functions. A good number of conversions to the new format are also included. For more information, see the following message to asterisk-dev: http://lists.digium.com/pipermail/asterisk-dev/2008-October/034968.html git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@153365 65c4cc65-6c06-0410-ace0-fbb531ad65f3
65 lines
2.2 KiB
DTD
65 lines
2.2 KiB
DTD
<!ELEMENT docs (application|function)* >
|
|
|
|
<!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 see-also (ref*)>
|
|
|
|
<!ELEMENT ref (#PCDATA)*>
|
|
<!ATTLIST ref type (application|function|astcli|link|manpage) #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)*>
|
|
<!ATTLIST parameter name CDATA #REQUIRED>
|
|
<!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 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 #REQUIRED>
|
|
|
|
<!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 "">
|
|
|