[Asterisk-doc] docs extensions.xml,1.16,1.17

blitzrage asterisk-doc@lists.digium.com
Fri, 11 Jun 2004 13:13:00 +0000


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

Modified Files:
	extensions.xml 
Log Message:
 blitzrage
- commented out some of Jared's layout in chapter 4 which have sections
written for them now.  This should give us a bit better idea of how
chapter 4 is coming along.
- added a paragraph explaining how the user should understand the basics
of several applications, and if they don't, to go back and re-read.
Index: extensions.xml
===================================================================
RCS file: /cvsroot/asterisk/docs/extensions.xml,v
retrieving revision 1.16
retrieving revision 1.17
diff -C2 -d -r1.16 -r1.17
*** extensions.xml	1 Jun 2004 20:38:03 -0000	1.16
--- extensions.xml	11 Jun 2004 13:12:53 -0000	1.17
***************
*** 42,53 ****
  			will determine what things may happen to the call. 
  			</para>
! 			
! 			<para>
! 			<!-- I've left this in here because the outline is good, and don't want
! 			to screw with it too much yet -blitzrage -->
  			[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.  
--- 42,56 ----
  			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.  
***************
*** 85,93 ****
  			part of that context, until another context is defined.
  			</para>
! 			
  			<para>
  			[Let's not forget to explain the "global" context, either here or later on.]
  			</para>
! 
  			<para>
  			Near the beginning of the <filename>extensions.conf</filename> there is a context
--- 88,96 ----
  			part of that context, until another context is defined.
  			</para>
! <!--			
  			<para>
  			[Let's not forget to explain the "global" context, either here or later on.]
  			</para>
! -->
  			<para>
  			Near the beginning of the <filename>extensions.conf</filename> there is a context
***************
*** 103,107 ****
  		<sect2>
  			<title>Extensions</title>
! 			<para>
  			[C'mon... we've got to change this.  Odds are that the reader won't have any
  			idea what a "subroutine" is, and I'd be willing to be they have no idea what 
--- 106,110 ----
  		<sect2>
  			<title>Extensions</title>
! <!--			<para>
  			[C'mon... we've got to change this.  Odds are that the reader won't have any
  			idea what a "subroutine" is, and I'd be willing to be they have no idea what 
***************
*** 109,113 ****
  			and not programmer-speak?]
  			</para>
! 
  			<para>
  			The extension definations are how call flow are determined.  These work
--- 112,116 ----
  			and not programmer-speak?]
  			</para>
! -->
  			<para>
  			The extension definations are how call flow are determined.  These work
***************
*** 140,144 ****
  		<sect2>
  			<title>Priorities</title>
! 			<para>
  			[Priorities show which order functions are applied to a specified
           extension.  Priority <emphasis>1</emphasis> is executed before
--- 143,147 ----
  		<sect2>
  			<title>Priorities</title>
! <!--			<para>
  			[Priorities show which order functions are applied to a specified
           extension.  Priority <emphasis>1</emphasis> is executed before
***************
*** 147,151 ****
  			functions and arguments.)]
  			</para>
! 			
  			<para>
  			Priorities show which order functions are applied to a specified extension. 
--- 150,154 ----
  			functions and arguments.)]
  			</para>
! -->			
  			<para>
  			Priorities show which order functions are applied to a specified extension. 
***************
*** 174,183 ****
  		<sect2>
  			<title>The special 's' extension</title>
! 			<para>
  			[Before we get too far into our example, we should explain the 's' extension.  
  			Explain that when calls are answered, they almost always do to the 's' 
  			extension in the context specified by zapata.conf/sip.conf/etc.]
  			</para>
! 
  			<para>
  			The 's' extension is used when we do not have a specific extension we wish 
--- 177,186 ----
  		<sect2>
  			<title>The special 's' extension</title>
! <!--			<para>
  			[Before we get too far into our example, we should explain the 's' extension.  
  			Explain that when calls are answered, they almost always do to the 's' 
  			extension in the context specified by zapata.conf/sip.conf/etc.]
  			</para>
! -->
  			<para>
  			The 's' extension is used when we do not have a specific extension we wish 
***************
*** 195,199 ****
  			and <function>Hangup</function> functions</title>
  			
! 			<para>
  			[A brief explanation of the Answer() function.  Explain that although you 
  			don't always need to call Answer(), it's a good habit to get into.  
--- 198,202 ----
  			and <function>Hangup</function> functions</title>
  			
! <!--			<para>
  			[A brief explanation of the Answer() function.  Explain that although you 
  			don't always need to call Answer(), it's a good habit to get into.  
***************
*** 201,205 ****
  			hasn't already been answered.)]
  			</para>
! 
  			<para>
  			The <function>Answer()</function> function is used to answer a channel 
--- 204,208 ----
  			hasn't already been answered.)]
  			</para>
! -->
  			<para>
  			The <function>Answer()</function> function is used to answer a channel 
***************
*** 212,221 ****
  			</para>
  			
! 			<para>
  			[A brief explanation of the Playback() function.  Explain where it looks for
  			files (maybe we should gloss over the language-specific part for now, but 
  			let's not forget to put it in somewhere.)]
  			</para>
! 
  			<para>
  			The <function>Playback()</function> function is used for playing previously 
--- 215,224 ----
  			</para>
  			
! <!--			<para>
  			[A brief explanation of the Playback() function.  Explain where it looks for
  			files (maybe we should gloss over the language-specific part for now, but 
  			let's not forget to put it in somewhere.)]
  			</para>
! -->
  			<para>
  			The <function>Playback()</function> function is used for playing previously 
***************
*** 231,239 ****
  			</para>
  			
! 			<para>
  			[A very brief explanation of the Hangup() function.  This one should be 
  			really simple. :-) ]
  			</para>
! 
  			<para>
  			The <function>Hangup()</function> does exactly as it's name implies; it 
--- 234,242 ----
  			</para>
  			
! <!--			<para>
  			[A very brief explanation of the Hangup() function.  This one should be 
  			really simple. :-) ]
  			</para>
! -->
  			<para>
  			The <function>Hangup()</function> does exactly as it's name implies; it 
***************
*** 245,256 ****
  		<sect2>
  			<title>Our First Dialplan</title>
! 			<para>
  			[We should probably explain that this example won't work without the other 
  			configuration files setup correctly to send the incoming call into the 
  			"incoming" context.  Again, this isn't meant to be a complete example that 
! 			people can actually use -- it is meant to explain how things in 
  			extensions.conf work.]
  			</para>
! 
  			<para>
  			The following example is not meant to be a complete working, usable example.
--- 248,259 ----
  		<sect2>
  			<title>Our First Dialplan</title>
! <!--			<para>
  			[We should probably explain that this example won't work without the other 
  			configuration files setup correctly to send the incoming call into the 
  			"incoming" context.  Again, this isn't meant to be a complete example that 
! 			people can actually use - it is meant to explain how things in 
  			extensions.conf work.]
  			</para>
! -->
  			<para>
  			The following example is not meant to be a complete working, usable example.
***************
*** 270,274 ****
  			</informalexample>
  			
! 			<para>
  			[This is where we will go through and explain each line in our silly little 
  			example above.  Again, let's err on the side of making this as self-evident 
--- 273,277 ----
  			</informalexample>
  			
! <!--			<para>
  			[This is where we will go through and explain each line in our silly little 
  			example above.  Again, let's err on the side of making this as self-evident 
***************
*** 276,280 ****
  			and priorities.]
  			</para>
! 
  			<para>
  			When a call is sent into this context, it is going to execute the very first line
--- 279,283 ----
  			and priorities.]
  			</para>
! -->
  			<para>
  			When a call is sent into this context, it is going to execute the very first line
***************
*** 331,335 ****
  			</informalexample>
  			
! 			<para>
  			[Don't get too worried about the complexity of this example.  We'll go 
  			through it and explain each item.  Imagine that you've been asked to setup 
--- 334,338 ----
  			</informalexample>
  			
! <!--			<para>
  			[Don't get too worried about the complexity of this example.  We'll go 
  			through it and explain each item.  Imagine that you've been asked to setup 
***************
*** 346,350 ****
  			the movies, but that those will come shortly.]
  			</para>
! 
  			<para>
  			Don't get too worried about the complexity of this example as we will go through
--- 349,353 ----
  			the movies, but that those will come shortly.]
  			</para>
! -->
  			<para>
  			Don't get too worried about the complexity of this example as we will go through
***************
*** 396,400 ****
  		<sect2>
  			<title>The <function>Dial()</function> function</title>
! 			<para>
  			[Add to our movie theater example, and make it so that if someone presses 0 
  			during the playback, it will ring the ticket office.  Tell the reader that 
--- 399,403 ----
  		<sect2>
  			<title>The <function>Dial()</function> function</title>
! <!--			<para>
  			[Add to our movie theater example, and make it so that if someone presses 0 
  			during the playback, it will ring the ticket office.  Tell the reader that 
***************
*** 402,405 ****
--- 405,409 ----
  			and we'll show them how to do that in a different section of the book.]
  			</para>
+ -->
  			<para>
  			We are going to add to our movie theatre example by showing the use of the
***************
*** 432,440 ****
  			</para>
  
! 			<para>
  			[By this section of the chapter, the reader should understand Answer(), 
  			Playback(), Background(), Hangup(), GoTo(), and the basics of Dial().  
  			Not too bad so far.]
  			</para>
  		</sect2>
  	</sect1>
--- 436,454 ----
  			</para>
  
! <!--			<para>
  			[By this section of the chapter, the reader should understand Answer(), 
  			Playback(), Background(), Hangup(), GoTo(), and the basics of Dial().  
  			Not too bad so far.]
  			</para>
+ -->
+ 			<para>
+ 			By this point in the chapter you should understand the basic workings of
+ 			several applications such as <function>Answer()</function>, <function>Playback()
+ 			</function>, <function>Background()</function>, <function>Hangup()</function>, 
+ 			<function>GoTo()</function> and the basics of <function>Dial()</function>.  If
+ 			you are still a little unclear of how these work, please go back and read this
+ 			section again.  The basic understanding of these applications is essencial to
+ 			fully grasp the concepts which will be explored further.
+ 			</para>
  		</sect2>
  	</sect1>