A new xml element was created to manage the AMI actions documentation, using AstXML. To register a manager action using XML documentation it is now possible using ast_manager_register_xml(). The CLI command 'manager show command' can be used to show the parsed documentation. Example manager xml documentation: <manager name="ami action name" language="en_US"> <synopsis> AMI action synopsis. </synopsis> <syntax> <xi:include xpointer="xpointer(...)" /> <-- for ActionID <parameter name="header1" required="true"> <para>Description</para> </parameter> ... </syntax> <description> <para>AMI action description</para> </description> <see-also> ... </see-also> </manager> git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@196308 65c4cc65-6c06-0410-ace0-fbb531ad65f3
87 lines
3.2 KiB
DTD
87 lines
3.2 KiB
DTD
<!ELEMENT docs (application|function|agi|manager)*>
|
|
<!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>
|
|
|
|
<!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 manager (synopsis?,syntax?,description?,see-also?)>
|
|
<!ATTLIST manager name CDATA #REQUIRED>
|
|
<!ATTLIST manager language CDATA #REQUIRED>
|
|
|
|
<!ELEMENT see-also (ref|xi:include)*>
|
|
|
|
<!ELEMENT ref (#PCDATA)>
|
|
<!ATTLIST ref type (application|function|astcli|link|manpage|filename|agi) #REQUIRED>
|
|
|
|
<!ELEMENT synopsis (#PCDATA)>
|
|
|
|
<!ELEMENT syntax (parameter|xi:include)*>
|
|
<!ATTLIST syntax argsep CDATA ",">
|
|
|
|
<!ELEMENT description (para|note|warning|variablelist|enumlist|xi:include)*>
|
|
|
|
<!ELEMENT parameter (optionlist|enumlist|argument|para|note|warning|parameter|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|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|xi:include)*>
|
|
<!ATTLIST enum name CDATA "">
|
|
|
|
<!ELEMENT argument (para|note|warning|variablelist|argument|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|xi:include)*>
|
|
<!ATTLIST variable name CDATA "">
|
|
|
|
<!ELEMENT value (#PCDATA)>
|
|
<!ATTLIST value name CDATA #REQUIRED>
|
|
<!ATTLIST value default CDATA "">
|