[Asterisk-doc] channel drivers vs configuration files

[Martin List-Petersen]

On Mon, 2004-06-14 at 14:42, Leif Madsen wrote:
> Chapter 3 at this point is supposed to be changed to explain what each file
> does.  Right now it has some "advanced" information in  it which needs to be
> moved.  I am definitely intrigued by your idea, and even if it isn't placed
> in chapter 3, I think it could be a good section / chapter.
> 
> Would you be willing to write up some sort of outline to give us a better
> idea (mostly me :)) of how you envision this?
> 

Sure.

When i started rewriting the ISDN stuff that is in section H.2 now and
originally was in the introduction i found it not realy meaningful that
the channel drivers are explained down there, since it is a major part
of * and it's configuration.

So i started looking in chapter 3 (most obviously) but that didn't
really fit in there either, because there actually are more than one
channel driver that can use the same configuration file (and the other
way around, one channel driver, more configuration files).

So my idea is basically this:

We create a chapter where we go through the channel drivers, their
configuration, which configuration files they use and how they look
like, ordered by purpose "ZAP, SIP, H.323, ISDN, etc." and subordered
by channel driver name.

Each channel driver section should include information like it's name, a
description of what it does, how it is configured, nogo's, caveat's and
goodies and where they can be downloaded, if they are 3rd party.

As you said, chapter 3 is supposed to be changed to explain, what each
file does. I think actually it might be better to have an appendix, that
tells you what channel driver or part of asterisk belongs to and in what
chapter/at what page the description for that can be found, simply
because you are not going to configure asterisk "configfile" by
"configfile" (yes ... that is what you do now, most of the time) but you
will be looking for exactly the features that you want to use, configure
these and then maybe give the rest of the configfiles a security check.

Just my .02$

/Martin