Posted: Fri Jan 07, 2000 10:28 am Post subject: [Asterisk] documentation
Documentation definitely needs work. There is some documentation (very
little_ in the docs directory. Many of the configuration files contain a
lot of commentary. At a minimum I would like to see:
a) For each application, a description of what it does, along with a
synopsis of what the magica "data" that you call it with is, and some
illustrative examples of it, for example:
Description: Attempts to place a call on each Channeltype/Location pair.
If an outgoing call is answered, that call is bridged to Calling channel,
and the function will return -1 when the call is complete (The dial
application supports transfer using the '#' key, so the callee can keep
the call alive). If all locations are busy, or if there is no answer
within the optional timeout period, Dial will return 0, allowing further
processing. Also, if all locations are busy and there exists a priority
n+101, where n is the priority of the dial application, then dial will
setup the channel to proceed to that priority instead of the immediately
following one.
Example:
exten=4200,1,Dial,AdtranVoFR/4200|15 ; Dial 4200 on an AdtranVoFR channel
; for up to 15 seconds
exten=5555,1,Dial,IAX/linux-support.net:4215&Phone/phone0
; Try calling ext. 4215 at linux-support.net and phone0
Anyway, something like that. But, I don't particularly want to do the
documentation myself for two reasons:
a) Look at the documentation I've done so far -- since I'm so familiar
with it, I tend to write lousy docs.
b) Time spent on documentation is time that I'm not spending doing
Asterisk development.
So, I'd love for someone (or some people) to help me come up with
consistent documentation for the built-in and dynamic applications, as
long as we all use a consistent format.
Mark
-------------------------------------------------------------------------
Mark Spencer, President Free and Commercial Linux Support
Linux Support Services, LLC On the web or on the phone
923 Stage Road Suite F
Auburn, AL 36830 http://www.linux-support.net
(334) 887-1042 staff@linux-support.net
Toll free: (877) LINUX-ME
On Fri, 7 Jan 2000, root wrote:
Quote:
I was wondering if there was any documentation for Asterisk. I looked
on the website and in the source and found very little. This seems like
an idea with a lot of potential I would be willing to help however I
can.
Once I get the perl application support done, I'd love to rewrite and
document the present applications in perl; This would also give me an
opportunity to test and debug my code.
On Fri, Jan 07, 2000 at 04:28:57AM -0600, Mark Spencer wrote:
Quote:
So, I'd love for someone (or some people) to help me come up with
consistent documentation for the built-in and dynamic applications, as
long as we all use a consistent format.
--7iMSBzlTiPOCCT2k
Content-Type: application/pgp-signature
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v0.9.9 (GNU/Linux)
Comment: For info see http://www.gnupg.org
You cannot post new topics in this forum You cannot reply to topics in this forum You cannot edit your posts in this forum You cannot delete your posts in this forum You cannot vote in polls in this forum