[asterisk-dev] XML documentation of apps/functions/the_rest_of_the_world

[Leif Madsen]

Jared Smith wrote:
> On Wed, 2008-07-09 at 07:11 -0500, Russell Bryant wrote:
>> Can we come up with a way to add references in the XML schema, instead 
>> of within the documentation text?
> 
> Yes... It shouldn't be difficult to create something similar to the way
> the <link> and <xref> tags work in DocBook within our XML schema.  In
> essence, you reference the unique node id of what you're referencing...
> something like this:
> 
> <application name="RetryDial" id="app-dial">
> ...
>   <description>For a list of parameters and options to this application,
> see <link linkend="app-dial">the <application>Dial</application>
> application</link>.
>   </description>
> ...
> </application>
> 

Is there also a way we can perform an 'include' of other documentation?

Perhaps when writing something you want to include within the body of 
the documentation some other existing documentation (perhaps a list of 
functions... or whatnot), but don't want to copy/paste it in because 
then you end up with the issue of documentation getting updated in one 
space, and not the other.


-- 
Leif Madsen
http://www.leifmadsen.com
http://www.oreilly.com/catalog/asterisk