2021-03-09 10:54:27 -04:00
|
|
|
<!ELEMENT docs (module|application|function|agi|manager|managerEvent|info|configInfo)*>
|
2009-05-16 20:01:22 +00:00
|
|
|
<!ATTLIST docs xmlns:xi CDATA #FIXED "http://www.w3.org/2001/XInclude">
|
|
|
|
|
|
|
|
|
|
<!ELEMENT xi:include (xi:fallback?) >
|
2013-02-15 13:38:12 +00:00
|
|
|
<!ATTLIST xi:include
|
2009-05-16 20:01:22 +00:00
|
|
|
xmlns:xi CDATA #FIXED "http://www.w3.org/2001/XInclude"
|
|
|
|
|
href CDATA #IMPLIED
|
|
|
|
|
parse (xml|text) "xml"
|
|
|
|
|
xpointer CDATA #IMPLIED
|
2013-02-15 13:38:12 +00:00
|
|
|
encoding CDATA #IMPLIED
|
2009-05-16 20:01:22 +00:00
|
|
|
accept CDATA #IMPLIED
|
|
|
|
|
accept-language CDATA #IMPLIED >
|
2008-11-01 21:10:07 +00:00
|
|
|
|
2021-03-10 10:18:48 -04:00
|
|
|
<!ELEMENT module (depend*,use*,conflict*,defaultenabled?,support_level?,replacement?,deprecated_in?,removed_in?)>
|
2021-03-09 10:54:27 -04:00
|
|
|
<!ATTLIST module name CDATA #REQUIRED>
|
|
|
|
|
<!ATTLIST module language CDATA #REQUIRED>
|
|
|
|
|
|
|
|
|
|
<!ELEMENT support_level (#PCDATA)>
|
|
|
|
|
|
|
|
|
|
<!ELEMENT depend (#PCDATA)>
|
|
|
|
|
<!ATTLIST depend type CDATA #IMPLIED>
|
|
|
|
|
|
|
|
|
|
<!ELEMENT defaultenabled (#PCDATA)>
|
|
|
|
|
|
|
|
|
|
<!ELEMENT replacement (#PCDATA)>
|
|
|
|
|
|
|
|
|
|
<!ELEMENT use (#PCDATA)>
|
|
|
|
|
<!ATTLIST use type CDATA #IMPLIED>
|
|
|
|
|
|
|
|
|
|
<!ELEMENT conflict (#PCDATA)>
|
|
|
|
|
|
2021-03-10 10:18:48 -04:00
|
|
|
<!ELEMENT deprecated_in (#PCDATA)>
|
|
|
|
|
|
|
|
|
|
<!ELEMENT removed_in (#PCDATA)>
|
|
|
|
|
|
2022-02-05 01:11:43 +00:00
|
|
|
<!ELEMENT application (since?,synopsis?,syntax?,description?,see-also?)>
|
2008-11-01 21:10:07 +00:00
|
|
|
<!ATTLIST application name CDATA #REQUIRED>
|
|
|
|
|
<!ATTLIST application language CDATA #REQUIRED>
|
2011-10-10 14:16:27 +00:00
|
|
|
<!ATTLIST application module CDATA #IMPLIED>
|
2008-11-01 21:10:07 +00:00
|
|
|
|
2022-02-05 01:11:43 +00:00
|
|
|
<!ELEMENT function (since?,synopsis?,syntax?,description?,see-also?)>
|
2008-11-01 21:10:07 +00:00
|
|
|
<!ATTLIST function name CDATA #REQUIRED>
|
2008-11-12 00:17:43 +00:00
|
|
|
<!ATTLIST function language CDATA #REQUIRED>
|
2011-10-10 14:16:27 +00:00
|
|
|
<!ATTLIST function module CDATA #IMPLIED>
|
2008-11-12 00:17:43 +00:00
|
|
|
|
2022-02-05 01:11:43 +00:00
|
|
|
<!ELEMENT agi (since?,synopsis?,syntax?,description?,see-also?)>
|
2008-11-12 00:17:43 +00:00
|
|
|
<!ATTLIST agi name CDATA #REQUIRED>
|
|
|
|
|
<!ATTLIST agi language CDATA #REQUIRED>
|
2013-01-16 15:33:05 +00:00
|
|
|
<!ATTLIST agi module CDATA #IMPLIED>
|
2008-11-01 21:10:07 +00:00
|
|
|
|
2022-02-05 01:11:43 +00:00
|
|
|
<!ELEMENT manager (since?,synopsis?,syntax?,description?,see-also?,responses?)>
|
2009-05-22 17:52:35 +00:00
|
|
|
<!ATTLIST manager name CDATA #REQUIRED>
|
|
|
|
|
<!ATTLIST manager language CDATA #REQUIRED>
|
2013-01-16 15:33:05 +00:00
|
|
|
<!ATTLIST manager module CDATA #IMPLIED>
|
2009-05-22 17:52:35 +00:00
|
|
|
|
2014-07-24 13:00:59 +00:00
|
|
|
<!ELEMENT responses (list-elements?,(managerEvent|xi:include))>
|
|
|
|
|
|
|
|
|
|
<!ELEMENT list-elements (managerEvent+|xi:include+)>
|
|
|
|
|
|
2012-06-25 17:59:34 +00:00
|
|
|
<!ELEMENT managerEvent (managerEventInstance+)>
|
|
|
|
|
<!ATTLIST managerEvent name CDATA #REQUIRED>
|
|
|
|
|
<!ATTLIST managerEvent language CDATA #REQUIRED>
|
2013-01-16 15:33:05 +00:00
|
|
|
<!ATTLIST managerEvent module CDATA #IMPLIED>
|
2012-06-25 17:59:34 +00:00
|
|
|
|
2022-02-05 01:11:43 +00:00
|
|
|
<!ELEMENT managerEventInstance (since?,synopsis?,syntax?,description?,see-also?)*>
|
2012-06-25 17:59:34 +00:00
|
|
|
<!ATTLIST managerEventInstance class CDATA #REQUIRED>
|
docs: Add "Provided-by" to doc XML and CLI output.
For application, function, manager, managerEvent, managerEventInstance
and info XML documentation nodes, the make_xml_documentation script will
add a "module" attribute if not already present. For XML in separate
"*_doc.xml" files, the script figures out the correct module name. For
documentation in the "main" directory, the module name is set to "builtin".
The CLI handlers for "core show application", "core show function",
"manager show command" and "manager show event", have been updated to
show the following after the Synopsis...
```
[Provided By]
<modulename>
```
For modules that provide additional "info" elements (like the technologies
do for Dial), the providing module has also been added.
```
Technology: WebSocket Provided by: chan_websocket
WebSocket Dial Strings:
...
```
UserNote: The CLI help for applications, functions, manager commands and
manager events now shows the module that provides its functionality.
2026-02-24 14:32:45 -07:00
|
|
|
<!ATTLIST managerEventInstance module CDATA #IMPLIED>
|
2012-06-25 17:59:34 +00:00
|
|
|
|
2013-02-15 13:38:12 +00:00
|
|
|
<!ELEMENT configInfo (synopsis?,description?,configFile+)>
|
|
|
|
|
<!ATTLIST configInfo name CDATA #REQUIRED>
|
|
|
|
|
<!ATTLIST configInfo language CDATA #REQUIRED>
|
|
|
|
|
|
2022-08-18 06:29:09 -06:00
|
|
|
<!ELEMENT configFile (configObject|xi:include)+>
|
2013-02-15 13:38:12 +00:00
|
|
|
<!ATTLIST configFile name CDATA #REQUIRED>
|
|
|
|
|
|
docs: Enable since/version handling for XML, CLI and ARI documentation
* Added the "since" element to the XML configObject and configOption elements
in appdocsxml.dtd.
* Added the "Since" section to the following CLI output:
```
config show help <module> <object>
config show help <module> <object> <option>
core show application <app>
core show function <func>
manager show command <command>
manager show event <event>
agi show commands topic <topic>
```
* Refactored the commands above to output their sections in the same order:
Synopsis, Since, Description, Syntax, Arguments, SeeAlso
* Refactored the commands above so they all use the same pattern for writing
the output to the CLI.
* Fixed several memory leaks caused by failure to free temporary output
buffers.
* Added a "since" array to the mustache template for the top-level resources
(Channel, Endpoint, etc.) and to the paths/methods underneath them. These
will be added to the generated markdown if present.
Example:
```
"resourcePath": "/api-docs/channels.{format}",
"requiresModules": [
"res_stasis_answer",
"res_stasis_playback",
"res_stasis_recording",
"res_stasis_snoop"
],
"since": [
"18.0.0",
"21.0.0"
],
"apis": [
{
"path": "/channels",
"description": "Active channels",
"operations": [
{
"httpMethod": "GET",
"since": [
"18.6.0",
"21.8.0"
],
"summary": "List all active channels in Asterisk.",
"nickname": "list",
"responseClass": "List[Channel]"
},
```
NOTE: No versioning information is actually added in this commit.
Those will be added separately and instructions for adding and maintaining
them will be published on the documentation site at a later date.
(cherry picked from commit c010fd4689e63683b4019582f56da1a912c5862c)
2025-01-09 15:17:14 -07:00
|
|
|
<!ELEMENT configObject (since?|synopsis?|description?|syntax?|see-also?|(configOption|xi:include))*>
|
2013-02-15 13:38:12 +00:00
|
|
|
<!ATTLIST configObject name CDATA #REQUIRED>
|
|
|
|
|
|
docs: Enable since/version handling for XML, CLI and ARI documentation
* Added the "since" element to the XML configObject and configOption elements
in appdocsxml.dtd.
* Added the "Since" section to the following CLI output:
```
config show help <module> <object>
config show help <module> <object> <option>
core show application <app>
core show function <func>
manager show command <command>
manager show event <event>
agi show commands topic <topic>
```
* Refactored the commands above to output their sections in the same order:
Synopsis, Since, Description, Syntax, Arguments, SeeAlso
* Refactored the commands above so they all use the same pattern for writing
the output to the CLI.
* Fixed several memory leaks caused by failure to free temporary output
buffers.
* Added a "since" array to the mustache template for the top-level resources
(Channel, Endpoint, etc.) and to the paths/methods underneath them. These
will be added to the generated markdown if present.
Example:
```
"resourcePath": "/api-docs/channels.{format}",
"requiresModules": [
"res_stasis_answer",
"res_stasis_playback",
"res_stasis_recording",
"res_stasis_snoop"
],
"since": [
"18.0.0",
"21.0.0"
],
"apis": [
{
"path": "/channels",
"description": "Active channels",
"operations": [
{
"httpMethod": "GET",
"since": [
"18.6.0",
"21.8.0"
],
"summary": "List all active channels in Asterisk.",
"nickname": "list",
"responseClass": "List[Channel]"
},
```
NOTE: No versioning information is actually added in this commit.
Those will be added separately and instructions for adding and maintaining
them will be published on the documentation site at a later date.
(cherry picked from commit c010fd4689e63683b4019582f56da1a912c5862c)
2025-01-09 15:17:14 -07:00
|
|
|
<!ELEMENT configOption (since?,synopsis,description?,syntax?,see-also?)*>
|
2013-02-15 13:38:12 +00:00
|
|
|
<!ATTLIST configOption name CDATA #REQUIRED>
|
|
|
|
|
<!ATTLIST configOption regex (yes|no|true|false) "false">
|
|
|
|
|
<!ATTLIST configOption default CDATA #IMPLIED>
|
|
|
|
|
<!ATTLIST configOption type CDATA #IMPLIED>
|
|
|
|
|
|
2021-12-06 12:17:05 +01:00
|
|
|
<!ELEMENT matchInfo (category,field?)>
|
2013-02-15 13:38:12 +00:00
|
|
|
|
2021-04-22 12:07:22 -06:00
|
|
|
<!ELEMENT dataType (#PCDATA)>
|
|
|
|
|
|
2013-02-15 13:38:12 +00:00
|
|
|
<!ELEMENT category (#PCDATA)>
|
|
|
|
|
<!ATTLIST category match (yes|no|true|false) #REQUIRED>
|
|
|
|
|
|
|
|
|
|
<!ELEMENT field (#PCDATA)>
|
|
|
|
|
<!ATTLIST field name CDATA #REQUIRED>
|
|
|
|
|
|
2016-08-12 11:15:38 -05:00
|
|
|
<!ELEMENT info (para|example|note|warning|variablelist|enumlist|info|xi:include)*>
|
2012-07-19 22:17:13 +00:00
|
|
|
<!ATTLIST info name CDATA #REQUIRED>
|
|
|
|
|
<!ATTLIST info language CDATA #REQUIRED>
|
|
|
|
|
<!ATTLIST info tech CDATA #REQUIRED>
|
docs: Add "Provided-by" to doc XML and CLI output.
For application, function, manager, managerEvent, managerEventInstance
and info XML documentation nodes, the make_xml_documentation script will
add a "module" attribute if not already present. For XML in separate
"*_doc.xml" files, the script figures out the correct module name. For
documentation in the "main" directory, the module name is set to "builtin".
The CLI handlers for "core show application", "core show function",
"manager show command" and "manager show event", have been updated to
show the following after the Synopsis...
```
[Provided By]
<modulename>
```
For modules that provide additional "info" elements (like the technologies
do for Dial), the providing module has also been added.
```
Technology: WebSocket Provided by: chan_websocket
WebSocket Dial Strings:
...
```
UserNote: The CLI help for applications, functions, manager commands and
manager events now shows the module that provides its functionality.
2026-02-24 14:32:45 -07:00
|
|
|
<!ATTLIST info module CDATA #IMPLIED>
|
2012-07-19 22:17:13 +00:00
|
|
|
|
2009-05-16 20:01:22 +00:00
|
|
|
<!ELEMENT see-also (ref|xi:include)*>
|
2008-11-01 21:10:07 +00:00
|
|
|
|
2009-05-16 20:01:22 +00:00
|
|
|
<!ELEMENT ref (#PCDATA)>
|
2013-06-24 18:33:13 +00:00
|
|
|
<!ATTLIST ref type (application|function|astcli|link|manpage|filename|agi|manager|managerEvent|configOption) #REQUIRED>
|
2013-01-16 17:46:15 +00:00
|
|
|
<!ATTLIST ref module CDATA #IMPLIED>
|
2008-11-01 21:10:07 +00:00
|
|
|
|
2022-02-05 01:11:43 +00:00
|
|
|
<!ELEMENT since (version+)>
|
|
|
|
|
|
|
|
|
|
<!ELEMENT version (#PCDATA)>
|
|
|
|
|
|
2008-11-01 21:10:07 +00:00
|
|
|
<!ELEMENT synopsis (#PCDATA)>
|
2008-11-12 00:17:43 +00:00
|
|
|
|
2013-08-01 17:07:52 +00:00
|
|
|
<!ELEMENT syntax (parameter|dataType|category|matchInfo|xi:include|channel_snapshot|bridge_snapshot)*>
|
2008-11-01 21:10:07 +00:00
|
|
|
<!ATTLIST syntax argsep CDATA ",">
|
|
|
|
|
|
2013-08-01 17:07:52 +00:00
|
|
|
<!ELEMENT channel_snapshot (#PCDATA)>
|
|
|
|
|
<!ATTLIST channel_snapshot prefix CDATA "">
|
|
|
|
|
|
|
|
|
|
<!ELEMENT bridge_snapshot (#PCDATA)>
|
|
|
|
|
<!ATTLIST bridge_snapshot prefix CDATA "">
|
|
|
|
|
|
2013-12-11 12:31:57 +00:00
|
|
|
<!ELEMENT configOptionToEnum (configOption|xi:include)*>
|
|
|
|
|
<!ATTLIST configOptionToEnum prefix CDATA "">
|
|
|
|
|
|
2014-07-31 11:49:40 +00:00
|
|
|
<!ELEMENT description (para|note|warning|variablelist|enumlist|info|example|xi:include)*>
|
2008-11-01 21:10:07 +00:00
|
|
|
|
2025-03-14 17:05:30 -05:00
|
|
|
<!ELEMENT parameter (optionlist|enumlist|argument|para|note|warning|parameter|info|documentationtype|xi:include)*>
|
2008-11-12 00:17:43 +00:00
|
|
|
<!ATTLIST parameter name CDATA "">
|
2008-11-01 21:10:07 +00:00
|
|
|
<!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">
|
2008-11-12 00:17:43 +00:00
|
|
|
<!ATTLIST parameter literal (yes|no|true|false) "false">
|
|
|
|
|
<!ATTLIST parameter default CDATA "">
|
2008-11-01 21:10:07 +00:00
|
|
|
<!ATTLIST parameter argsep CDATA ",">
|
2025-03-14 17:05:30 -05:00
|
|
|
<!ATTLIST parameter documentationtype CDATA "">
|
2008-11-01 21:10:07 +00:00
|
|
|
|
|
|
|
|
<!ELEMENT optionlist (option+)>
|
2012-07-19 22:17:13 +00:00
|
|
|
<!ELEMENT option (argument|para|note|warning|variablelist|enumlist|info|xi:include)*>
|
2008-11-12 00:17:43 +00:00
|
|
|
<!ATTLIST option name CDATA #REQUIRED>
|
2008-11-01 21:10:07 +00:00
|
|
|
<!ATTLIST option argsep CDATA ",">
|
|
|
|
|
<!ATTLIST option implies CDATA "">
|
2008-11-13 15:46:06 +00:00
|
|
|
<!ATTLIST option hasparams CDATA "">
|
2008-11-01 21:10:07 +00:00
|
|
|
|
2019-12-11 11:52:31 -05:00
|
|
|
<!ELEMENT enumlist (configOptionToEnum|enum)+>
|
2012-07-19 22:17:13 +00:00
|
|
|
<!ELEMENT enum (para|note|warning|parameter|enumlist|info|xi:include)*>
|
2008-11-12 00:17:43 +00:00
|
|
|
<!ATTLIST enum name CDATA "">
|
2008-11-01 21:10:07 +00:00
|
|
|
|
2012-07-19 22:17:13 +00:00
|
|
|
<!ELEMENT argument (para|note|warning|variablelist|argument|info|xi:include)*>
|
2008-11-01 21:10:07 +00:00
|
|
|
<!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">
|
2008-12-17 17:56:25 +00:00
|
|
|
<!ATTLIST argument argsep CDATA ",">
|
2008-11-01 21:10:07 +00:00
|
|
|
|
2009-05-16 20:01:22 +00:00
|
|
|
<!ELEMENT para (#PCDATA|astcli|literal|emphasis|filename|directory|replaceable|variable|xi:include)*>
|
2008-11-01 21:10:07 +00:00
|
|
|
<!ELEMENT literal (#PCDATA)>
|
|
|
|
|
<!ELEMENT emphasis (#PCDATA)>
|
|
|
|
|
<!ELEMENT filename (#PCDATA)>
|
|
|
|
|
<!ELEMENT replaceable (#PCDATA)>
|
|
|
|
|
<!ELEMENT directory (#PCDATA)>
|
|
|
|
|
<!ELEMENT astcli (#PCDATA)>
|
2013-02-15 13:38:12 +00:00
|
|
|
|
2014-07-31 11:49:40 +00:00
|
|
|
<!ELEMENT example (#PCDATA|xi:include)*>
|
|
|
|
|
<!ATTLIST example title CDATA "">
|
|
|
|
|
<!ATTLIST example language CDATA "" >
|
|
|
|
|
|
2009-05-16 20:01:22 +00:00
|
|
|
<!ELEMENT note (para+|xi:include*)>
|
|
|
|
|
<!ELEMENT warning (para+|xi:include*)>
|
2008-11-12 00:17:43 +00:00
|
|
|
|
2009-05-16 20:01:22 +00:00
|
|
|
<!ELEMENT variablelist (variable+|xi:include*)>
|
2012-07-19 22:17:13 +00:00
|
|
|
<!ELEMENT variable (#PCDATA|value|para|info|xi:include)*>
|
2008-11-01 21:10:07 +00:00
|
|
|
<!ATTLIST variable name CDATA "">
|
2008-11-12 00:17:43 +00:00
|
|
|
|
2008-11-01 21:10:07 +00:00
|
|
|
<!ELEMENT value (#PCDATA)>
|
|
|
|
|
<!ATTLIST value name CDATA #REQUIRED>
|
|
|
|
|
<!ATTLIST value default CDATA "">
|
