diff options
| author | eliel <eliel@f38db490-d61c-443f-a65b-d21fe96a405b> | 2009-05-22 17:52:35 +0000 |
|---|---|---|
| committer | eliel <eliel@f38db490-d61c-443f-a65b-d21fe96a405b> | 2009-05-22 17:52:35 +0000 |
| commit | cbbfdc573c6f071b12dc665273c0063a0c69ad69 (patch) | |
| tree | e1c6ca80d913c0e0aa3166a40d7b8e4461cd62d1 /doc | |
| parent | c208610d90db5a241e187413c831309cd5f13f32 (diff) | |
Implement a new element in AstXML for AMI actions documentation.
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: http://svn.digium.com/svn/asterisk/trunk@196308 f38db490-d61c-443f-a65b-d21fe96a405b
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/appdocsxml.dtd | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/doc/appdocsxml.dtd b/doc/appdocsxml.dtd index c06f720e1..1de0ea452 100644 --- a/doc/appdocsxml.dtd +++ b/doc/appdocsxml.dtd @@ -1,4 +1,4 @@ - <!ELEMENT docs (application|function|agi)*> + <!ELEMENT docs (application|function|agi|manager)*> <!ATTLIST docs xmlns:xi CDATA #FIXED "http://www.w3.org/2001/XInclude"> <!ELEMENT xi:include (xi:fallback?) > @@ -23,6 +23,10 @@ <!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)> |