[Asterisk-doc] docs extensions.xml,1.22,1.23

websmith asterisk-doc@lists.digium.com
Thu, 15 Jul 2004 01:28:55 +0000


Comments:
Update of /cvsroot/asterisk/docs
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv24097

Modified Files:
	extensions.xml 
Log Message:
More changes to the beginning of this chapter, rewording and expounding on
what I wrote before.
Index: extensions.xml
===================================================================
RCS file: /cvsroot/asterisk/docs/extensions.xml,v
retrieving revision 1.22
retrieving revision 1.23
diff -C2 -d -r1.22 -r1.23
*** extensions.xml	14 Jul 2004 00:43:54 -0000	1.22
--- extensions.xml	15 Jul 2004 01:28:49 -0000	1.23
***************
*** 22,28 ****
  		<para>
  		The majority of the dialplan is specified in the file 
! 		<filename>extension.conf</filename>.  This file is made up of three main 
! 		parts: contexts, extensions, and priorities.  In most Asterisk installations,
! 		the <filename>extensions.conf</filename> file is located in either 
  		<filename class="directory">/etc/asterisk</filename> or 
  		<filename class="directory">/usr/local/asterisk/etc</filename>.  The location
--- 22,35 ----
  		<para>
  		The majority of the dialplan is specified in the file 
! 		<filename>extension.conf</filename>.  This file is made up of four main 
! 		parts: contexts, extensions, priorities, and applications.  
! 		In this section, we'll cover each of these parts, and explain
! 		how they work together to create a dialplan.
! 		</para>
! 		<sidebar>
! 		<title>Finding your <filename>extensions.conf</filename> file</title>
! 		<para>
! 		In most Asterisk installations, the <filename>extensions.conf</filename> 
! 		file is located in either 
  		<filename class="directory">/etc/asterisk</filename> or 
  		<filename class="directory">/usr/local/asterisk/etc</filename>.  The location
***************
*** 30,39 ****
  		installed Asterisk.
  		</para>
  		<para>
  		If you installed the Asterisk sample files, you probably have an existing
! 		<filename>extensions.conf</filename> file.  Instead of explaining or
! 		modifying the existing file, we'll start from scratch in creating an
! 		<filename>extensions.conf</filename> file, so that you can learn about
! 		how each part of the file plays a role in the dialplan.
  		</para>
  		
--- 37,49 ----
  		installed Asterisk.
  		</para>
+ 		</sidebar>
  		<para>
  		If you installed the Asterisk sample files, you probably have an existing
! 		<filename>extensions.conf</filename> file.  Instead of 
! 		modifying the existing file, we recommend your from scratch in creating 
! 		your <filename>extensions.conf</filename> file, so that you can learn 
! 		about how each part of the file plays a role in the dialplan.  (You may
! 		want to rename your existing <filename>extensions.conf</filename> file,
! 		and refer to it later.)
  		</para>
  		
***************
*** 41,71 ****
  			<title>Contexts</title>
  			<para>
! 			Contexts play a central role within the dialplan.  Contexts define scope. 
! 			You can think of contexts as a way to keep different parts of a dialplan 
! 			seperate.  As a simple example, contexts can be used to make Asterisk answer 
! 			one phone line differently than another.  All calls that Asterisk handles 
! 			will begin in a specified context. The instructions defined in this context 
! 			will determine what things may happen to the call. 
  			</para>
  
! <!-- I've commented out the sections of Jared's layout which have some content
! filled in now.  No need to really keep repeating the same stuff over and over.
! This should give us a bit of a better idea if this flows well or not, and which
! sections are still missing - blitzrage -->
! 
! <!--		<para>
! 			[Explain that this is called IVR and that IVR is one of the 
! 			main reasons that people like Asterisk.]
! 			</para>
! -->
! 			<para>		
! 			Contexts can also be used to create "menus" for your callers to follow.  
! 			The menus are what you hear when you call a company that has a recording read 
! 			things you are able to do.  Based on what the voice says, you make choices on 
! 			your keypad by pressing different numbers.  This is referred to as an 
! 			auto-attendant or interactive voice response (IVR) system.  The reason 
! 			Asterisk is so popular is because of the way you are able to customize 
! 			different menu systems based on different situations.
  			</para>
  <!--
  			<para>
--- 51,71 ----
  			<title>Contexts</title>
  			<para>
! 			Contexts play an organizational role within the dialplan.  Contexts also
! 			define scope.  You can think of contexts as a way to keep different parts 
! 			of the dialplan seperate.  As a simple example, contexts can be used to 
! 			make Asterisk answer one phone line differently than another.  All calls 
! 			that Asterisk handles will begin in a certain context. The instructions 
! 			defined in this context will determine what things may happen to the call. 
  			</para>
  
! 			<note>
! 			<title>Contexts and IVR</title>
! 			<para>
! 			Contexts are often used to create "voice menus" that give callers a list
! 			of extensions to choose from by pressing keys on a touch-tone phone.
! 			This functionality is commonly called IVR, which stands for Interactive 
! 			Voice Response.  We'll cover IVR in more depth later in the chapter.
  			</para>
+ 			</note>
  <!--
  			<para>
***************
*** 89,93 ****
  				</informalexample>
  			</para>
- 			
  			<para>
  			All of the instructions placed after a context definition are considered 
--- 89,92 ----
***************
*** 100,110 ****
  -->
  			<para>
! 			Near the beginning of the <filename>extensions.conf</filename> there is a context
! 			called [globals].  The globals context is where variables can be defined that can
! 			be used through your dialplan.  This may be any number of things which may contain
! 			things like channels, usernames, passwords or extensions.  Global variables are
! 			handy so that if we need to change something like an extension number, we only 
! 			need to change it in one spot.  Another advantage is it can make your dialplan
! 			a bit easier to read.
  			</para>
  		</sect2>
--- 99,116 ----
  -->
  			<para>
! 			At the very beginning of the <filename>extensions.conf</filename> 
! 			file, there is a special context called [globals].  The globals context 
! 			is where certain settings can be defined that can be used throughout 
! 			your dialplan.  For right now, we won't use the [globals] context,
! 			but you should be aware of why it exists. 
! <!--
! 			[I'm taking this out for now... let's not confuse them with
! 			variables yet. Think simple!]
! 			This may be any number of things which may contain
! 			things like channels, usernames, passwords or extensions.  Global 
! 			variables are handy so that if we need to change something like an 
! 			extension number, we only need to change it in one spot.  Another 
! 			advantage is it can make your dialplan a bit easier to read.
! -->
  			</para>
  		</sect2>
***************
*** 120,137 ****
  -->
  			<para>
! 			The extension definations are how call flow are determined.  These work
! 			in a very linear fashion which makes them easy to understand and follow.
! 			You will define them as the steps a call will take as it progresses through
! 			your dial plan.  A single extension line will contain the extension number or
! 			special letter you are defining, the priority number, the function you wish
! 			to be applied and any arguments to be passed to the function.
  			</para>
  			
  			<para>
! 			Functions allow us to perform various actions within our dial plan.  These 
! 			functions or "commands" can be passed information also referred to as 
! 			"arguments".  With this information our function is able to manipulate the 
! 			call somehow so that something happens.  To see a listing of the possible 
! 			functions you are able to use in Asterisk, see Appendix C.
  
  <!--			The extension definitions are very much like subroutines in
--- 126,150 ----
  -->
  			<para>
! 			Within each context, we will definie one or more extensions.  Extensions
! 			determine how the call flows.  Although extensions can be used to 
! 			specify phone extensions in the traditional sense (i.e. Please call John 
! 			is at extension 153), they can be used for more than that in Asterisk.
! 			In our <filename>extensions.conf</filename> file, an extensions is
! 			declared by the word "exten", followed by an arrow formed by the equal
! 			sign and the greater-than sign like this:
! 				<informalexample>
! 				<programlisting>
! 				exten=>
! 				</programlisting>
! 				</informalexample>
! 			<!-- more extension syntax goes here -->
  			</para>
  			
  			<para>
! 			Applications allow us to perform various actions within our dial plan.  These 
! 			applications or "commands" can be passed information also referred to as 
! 			"arguments".  With this information the application is able to manipulate the 
! 			call so that something happens.  To see a listing of the possible 
! 			applications that are built into Asterisk, see Appendix C.
  
  <!--			The extension definitions are very much like subroutines in