Fix escaping and some of the formattting (closes issue #10285)
[asterisk/asterisk.git] / doc / tex / extensions.tex
1 \subsubsection{The Asterisk dialplan}
2
3 The Asterisk dialplan is divided into contexts. A context is simply a group
4 of extensions. For each "line" that should be able to be called, an extension
5 must be added to a context. Then, you configure the calling "line" to have
6 access to this context.
7
8 If you change the dialplan, you can use the Asterisk CLI command
9 "extensions reload" to load the new dialplan without disrupting
10 service in your PBX.
11
12 Extensions are routed according to priority and may be based on any set
13 of characters (a-z), digits, \#, and *. Please note that when matching a
14 pattern, "N", "X", and "Z" are interpreted as classes of digits.
15
16 For each extension, several actions may be listed and must be given a unique
17 priority. When each action completes, the call continues at the next priority
18 (except for some modules which use explicitly GOTO's). 
19
20 When each action completes, it generally moves to the next priority (except for
21 some modules which use explicitly GOTO's. 
22
23 Extensions frequently have data they pass to the executing application
24 (most frequently a string).  You can see the available dialplan applications
25 by entering the "show applications" command in the CLI.
26
27 In this version of Asterisk, dialplan functions are added. These can
28 be used as arguments to any application. For a list of the installed
29 functions in your Asterisk, use the "show functions" command.
30
31 \subsubsection{Example dialplan}
32
33 The example dial plan, in the configs/extensions.conf.sample file
34 is installed as extensions.conf if you run "make samples" after
35 installation of Asterisk. This file includes many more instructions
36 and examples than this file, so it's worthwhile to read it.
37         
38 \subsubsection{Special extensions}
39
40 There are some extensions with important meanings:
41
42 \begin{itemize}
43   \item s       
44   \begin{itemize}
45     \item What to do when an extension context is entered (unless
46           overridden by the low level channel interface)
47           This is used in macros, and some special cases. 
48           "s" is not a generic catch-all wildcard extension.
49   \end{itemize}
50   \item i
51   \begin{itemize}
52     \item What to do if an invalid extension is entered
53   \end{itemize}
54   \item h
55   \begin{itemize}
56     \item The hangup extension, executed at hangup
57   \end{itemize}
58   \item t
59   \begin{itemize}
60     \item What to do if nothing is entered in the requisite amount
61           of time.
62   \end{itemize}
63   \item T
64   \begin{itemize}
65     \item This is the extension that is executed when the 'absolute'
66           timeout is reached.  See "show function TIMEOUT" for more
67           information on setting timeouts.      
68   \end{itemize}
69 \end{itemize}
70
71 And finally, the extension context "default" is used when either a) an 
72 extension context is deleted while an extension is in use, or b) a specific
73 starting extension handler has not been defined (unless overridden by the
74 low level channel interface).