diff options
| author | russell <russell@f38db490-d61c-443f-a65b-d21fe96a405b> | 2008-11-01 21:10:07 +0000 |
|---|---|---|
| committer | russell <russell@f38db490-d61c-443f-a65b-d21fe96a405b> | 2008-11-01 21:10:07 +0000 |
| commit | b1f91b97d2085cc845d0f57bd9907de50c995105 (patch) | |
| tree | 9c836ac808552d20be6bd2baa3a3c29f642eda53 /doc | |
| parent | c5d084051f21e943fcbcc347fc80b166885f298d (diff) | |
Merge changes from team/group/appdocsxml
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: http://svn.digium.com/svn/asterisk/trunk@153365 f38db490-d61c-443f-a65b-d21fe96a405b
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/appdocsxml.dtd | 64 | ||||
| -rw-r--r-- | doc/tex/asterisk-conf.tex | 3 |
2 files changed, 67 insertions, 0 deletions
diff --git a/doc/appdocsxml.dtd b/doc/appdocsxml.dtd new file mode 100644 index 000000000..67e86d642 --- /dev/null +++ b/doc/appdocsxml.dtd @@ -0,0 +1,64 @@ + <!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 ""> + diff --git a/doc/tex/asterisk-conf.tex b/doc/tex/asterisk-conf.tex index f39d4dc05..4b08023a6 100644 --- a/doc/tex/asterisk-conf.tex +++ b/doc/tex/asterisk-conf.tex @@ -82,6 +82,9 @@ rungroup = asterisk ; Enable internal timing support (-I) internal_timing = yes | no +; Language Options +documentation_language = en | es | ru + ; These options have no command line equivalent ; Cache record() files in another directory until completion |