[asterisk-bugs] [Asterisk 0015107]: AstXML Documentation System Has No Ability To Include Documentation Sections

[Asterisk Bug Tracker]

A NOTE has been added to this issue. 
====================================================================== 
https://issues.asterisk.org/view.php?id=15107 
====================================================================== 
Reported By:                lmadsen
Assigned To:                eliel
====================================================================== 
Project:                    Asterisk
Issue ID:                   15107
Category:                   Documentation
Reproducibility:            always
Severity:                   feature
Priority:                   normal
Status:                     assigned
Asterisk Version:           1.6.2.0-beta1 
Regression:                 No 
SVN Branch (only for SVN checkouts, not tarball releases): N/A 
SVN Revision (number only!):  
Request Review:              
====================================================================== 
Date Submitted:             2009-05-14 10:21 CDT
Last Modified:              2009-05-16 15:01 CDT
====================================================================== 
Summary:                    AstXML Documentation System Has No Ability To
Include Documentation Sections
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.
======================================================================
Relationships       ID      Summary
----------------------------------------------------------------------
parent of           0014444 M() Docs
====================================================================== 

---------------------------------------------------------------------- 
 (0104886) svnbot (reporter) - 2009-05-16 15:01
 https://issues.asterisk.org/view.php?id=15107#c104886 
---------------------------------------------------------------------- 
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 https://issues.asterisk.org/view.php?id=15107)
Reported by: lmadsen

(issue https://issues.asterisk.org/view.php?id=14444)
Reported by: ewieling


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

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

Issue History 
Date Modified    Username       Field                    Change               
====================================================================== 
2009-05-16 15:01 svnbot         Checkin                                      
2009-05-16 15:01 svnbot         Note Added: 0104886                          
======================================================================