Dare I ask? I'm new to Asterisk. I like what it has to offer, however, I'm having a hard time finding documentation to configure it correctly. Can anyone tell me where I can get good Asterisk documents? Here's what I have put together: http://www.simplifiednetwork.com/asterisk. Seng -------------- next part -------------- An HTML attachment was scrubbed... URL: http://lists.digium.com/pipermail/asterisk-users/attachments/20030605/2c632890/attachment.htm
Goto http://www.digium.com/index.php?menu=documentation and download the Handbook, and all will be reviled (I hope). -----Original Message----- From: asterisk-users-admin@lists.digium.com [mailto:asterisk-users-admin@lists.digium.com] On Behalf Of Seng Sent: 05 June 2003 21:21 To: asterisk-users@lists.digium.com Subject: [Asterisk-Users] Asterisk Documentation Dare I ask? I'm new to Asterisk. I like what it has to offer, however, I'm having a hard time finding documentation to configure it correctly. Can anyone tell me where I can get good Asterisk documents? Here's what I have put together: http://www.simplifiednetwork.com/asterisk. Seng -------------- next part -------------- An HTML attachment was scrubbed... URL: http://lists.digium.com/pipermail/asterisk-users/attachments/20030605/43d7e611/attachment.htm
I've spent the last couple of days learning Doxygen and getting at least basically familiar with the Asterisk source code. I'm starting to write up comments for Doxygen to generate API docs from, and I've also started looking at ways to use Doxygen to generate a configuration reference with configuration examples, and some 'how to' guides like 'how to write an application' and 'how to write a channel driver'. I've seen many other people talk about doing documentation for Asterisk - most of it seems to have fallen by the wayside for one reason or another. Doxygen is a nice documentation tool, and with the right sort of comments in the code, it generates excellent API documentation, in PDF, HTML, CHM, RTF/DOC, MAN, and Latex formats. For website docs, it has a search engine facility, and its appearance is to some degree customizable. You can include images, code snippets, graphs, and so on. My plan of attack is as follows: 1. Develop a better 'progdocs' target that will build a variety of formats in probably two sections - Developers Reference and Users Ref. The Developers Reference would be the API docs with some howtos and so on for writing modules, etc. The Users Reference would be the config reference and guides, and some howtos on setting up a * server. Both would be at least partly or mostly sourced from structured commenting in the source code. 2. Start with writing a section in the Developers Reference on "How to use Doxygen to document * code" :-) 3. If its possible, it would be really great to have the docs hosted on the Asterisk website. Might also be pretty cool to have a cron that regularly checks out the CVS, and does a documentation build, generating the HTML to update the website docs (at least until Asterisk reaches a version number with more than a 0 at the beginning :-). If it can be hosted at asterisk.org, great. If not, I'll find somewhere else for it. 4. Improve code commenting where I understand it in Asterisk. 5. Get other people to improve code commenting where I don't. Does anybody have any thoughts on this plan, or better ideas? Negative/positive thoughts about Doxygen? Most importantly, is anyone else working on something along these lines already? Cheers.
----- Original Message ----- From: Roderick Montgomery <rod@thecomplex.com> Date: Wednesday, October 1, 2003 10:46 pm Subject: Re: [Asterisk-Users] Asterisk Documentation> ... <snip> ... > > integration with basic scripting languages, I'm not focusing at all on > documenting Asterisk code development. It's not something I understandwell> myself, the target audience of Asterisk developers is small relative to > admins and users, and development is already well-supported with theAsterisk-Dev list. Well, that fits in quite nicely since my primary drive is to get the various APIs well-documented. My goal is to make it easier to write good modules and extensions to Asterisk, and to make it easier to see where there is room for improvement in the core source code. In a more general query to Mark or whoever maintains the website for Asterisk, is there a chance of putting all of this up on the website when it matures a little?> Printed documentation seems most lacking for new users wanting to > install Asterisk and set up a basic dialplan. By my estimation, manyof the> newcomers interested to Asterisk will have some basic knowledge of Unix or > Linux, familiarity with the concept of OpenSource, and a willingnessto try.> I plan to provide a book that will guide them to a successful, usable > installation with diagrams, examples, and design hints. The handbook, the > wiki, the mailing list, and various personal websites with asterisktips and Here's a good example: wiki? there is a wiki? :-) I saw a broken link once but heard no more...does it still exist?