[Home]

Summary:ASTERISK-14128: AstXML Documentation System Has No Ability To Include Documentation Sections
Reporter:Leif Madsen (lmadsen)Labels:
Date Opened:2009-05-14 10:21:19Date Closed:2009-05-18 08:46:12
Priority:MajorRegression?No
Status:Closed/CompleteComponents:Documentation
Versions:Frequency of
Occurrence
Related
Issues:
Environment:Attachments:
Description:There is no ability with the current AstXML documentation system to include sections multiple times throughout the documentation.

For example, if you have a note that you've written that applies to multiple applications, then you would have to write (and maintain) each of those sections separately. Ideally we would like to be able to write the section once and include it multiple times so that we don't have to maintain the same documentation in multiple places.
Comments:By: Digium Subversion (svnbot) 2009-05-16 15:01:24

Repository: asterisk
Revision: 194982

U   trunk/Makefile
U   trunk/doc/appdocsxml.dtd
U   trunk/main/xml.c

------------------------------------------------------------------------
r194982 | eliel | 2009-05-16 15:01:22 -0500 (Sat, 16 May 2009) | 20 lines

Allow to include sections of other parts of the xml documentation.

Avoid duplicating xml documentation by allowing to include other parts of
the xml documentation using XInclude.
Example:
  <xi:include xpointer="xpointer(/docs/function[@name='CHANNEL']/synopsis)" />
(Insert this line to include the synopsis of the CHANNEL function xml
documentation).

It is also possible to include documentation from other files in the
'documentation/' directory using the href="" attribute inside a xinclude
element.

(closes issue ASTERISK-14128)
Reported by: lmadsen

(issue ASTERISK-13548)
Reported by: ewieling


------------------------------------------------------------------------

http://svn.digium.com/view/asterisk?view=rev&revision=194982
By: Digium Subversion (svnbot) 2009-05-18 08:46:11

Repository: asterisk
Revision: 195093

_U  branches/1.6.2/
U   branches/1.6.2/Makefile
U   branches/1.6.2/doc/appdocsxml.dtd
U   branches/1.6.2/main/xml.c

------------------------------------------------------------------------
r195093 | eliel | 2009-05-18 08:46:10 -0500 (Mon, 18 May 2009) | 26 lines

Merged revisions 194982 via svnmerge from
https://origsvn.digium.com/svn/asterisk/trunk

........
 r194982 | eliel | 2009-05-16 16:01:22 -0400 (Sat, 16 May 2009) | 20 lines
 
 Allow to include sections of other parts of the xml documentation.
 
 Avoid duplicating xml documentation by allowing to include other parts of
 the xml documentation using XInclude.
 Example:
    <xi:include xpointer="xpointer(/docs/function[@name='CHANNEL']/synopsis)" />
 (Insert this line to include the synopsis of the CHANNEL function xml
 documentation).
 
 It is also possible to include documentation from other files in the
 'documentation/' directory using the href="" attribute inside a xinclude
 element.
 
 (closes issue ASTERISK-14128)
 Reported by: lmadsen
 
 (issue ASTERISK-13548)
 Reported by: ewieling
........

------------------------------------------------------------------------

http://svn.digium.com/view/asterisk?view=rev&revision=195093