[asterisk-commits] seanbright: branch group/newcdr r202676 - /team/group/newcdr/doc/tex/cel-doc.tex

SVN commits to the Asterisk project asterisk-commits at lists.digium.com
Tue Jun 23 11:59:14 CDT 2009


Author: seanbright
Date: Tue Jun 23 11:59:11 2009
New Revision: 202676

URL: http://svn.asterisk.org/svn-view/asterisk?view=rev&rev=202676
Log:
Convert verbatim based tables to actual tables.

Modified:
    team/group/newcdr/doc/tex/cel-doc.tex

Modified: team/group/newcdr/doc/tex/cel-doc.tex
URL: http://svn.asterisk.org/svn-view/asterisk/team/group/newcdr/doc/tex/cel-doc.tex?view=diff&rev=202676&r1=202675&r2=202676
==============================================================================
--- team/group/newcdr/doc/tex/cel-doc.tex (original)
+++ team/group/newcdr/doc/tex/cel-doc.tex Tue Jun 23 11:59:11 2009
@@ -769,58 +769,72 @@
 \end{verbatim}
 
 
-\section{Events and Fields}
-
-While CDR's and the Manager are basically both event tracking mechanisms, CEL
+\section{Events \& Fields}
+
+While CDRs and the Manager are basically both event tracking mechanisms, CEL
 tries to track only those events that might pertain to billing issues.
 
-Here is a list of events tracked by CEL:
-\begin{verbatim}
-       CHAN_START   -- The time a channel was created
-       CHAN_END     -- The time a channel was terminated
-       ANSWER       -- The time a channel was answered (ie, phone taken off-hook, etc)
-       HANGUP       -- The time at which a hangup occurred.
-       CONF_ENTER   -- The time a channel was connected into a conference room
-       CONF_EXIT    -- The time a channel was removed from a conference room
-       CONF_START   -- The time the first person enters a conf
-       CONF_END     -- The time the last person left a conf (and turned out the lights?)
-       APP_START    -- The time a tracked app was started
-       APP_END      -- the time a tracked app ended.
-       PARK_START   -- The time a call was parked
-       PARK_END     -- unpark event
-       BRIDGE_START -- The time a bridge is started
-       BRIDGE_END   -- The time a bridge is ended
-       3WAY_START   -- When a 3-way conf starts (usually via attended xfer)
-       3WAY_END     -- When one or all exit a 3-way conf
-       BLINDTRANSFER -- When a blind transfer is initiated
-       ATTENDEDTRANSFER -- When an attended transfer is initiated
-       TRANSFER     -- Generic transfer initiated; not used yet...?
-       HOOKFLASH    -- So far, when a hookflash event occurs on a Zap interface
-       USER_EVENT   -- these are triggered from the dialplan, and have a name given by the user.
-\end{verbatim}
-
-Each Event record contains the following fields:
-\begin{verbatim}
-       eventtype     The name of the event; see the above list; each is prefixed with "EV_".
-       eventtime     The time the event happened
-       cidname       CID name field
-       cidnum        CID num  field
-       cidani        CID ANI  field
-       cidrdnis      CID RDNIS field
-       ciddnid       CID DNID field
-       exten         The extension in the dialplan
-       context       The context in the dialplan
-       channame      The name assigned to the channel in which the event took place
-       appname       The name of the current application
-       appdata       The arguments that will be handed to that application
-       amaflags      The AMA flags associated with the event; user assignable.
-       accountcode   A user assigned datum (string)
-       uniqueid      Each Channel instance gets a unique ID associated with it.
-       userfield     A user assigned datum (string)
-       linkedid      the per-call id, spans several events, possibly.
-       peer          For bridge or other 2-channel events, this would be the other channel name
-\end{verbatim}
-
+See table~\ref{event_table} for a list of events raised by CEL and
+table~\ref{field_table} for the list of fields passed for each CEL event.
+
+\begin{table}[h]
+  \begin{tabular}{ | l | p{10cm} | }
+    \hline
+    Event            & Description                                                               \\ \hline \hline
+    CHAN\_START      & The time a channel was created                                            \\ \hline
+    CHAN\_END        & The time a channel was terminated                                         \\ \hline
+    ANSWER           & The time a channel was answered (ie, phone taken off-hook, etc)           \\ \hline
+    HANGUP           & The time at which a hangup occurred.                                      \\ \hline
+    CONF\_ENTER      & The time a channel was connected into a conference room                   \\ \hline
+    CONF\_EXIT       & The time a channel was removed from a conference room                     \\ \hline
+    CONF\_START      & The time the first person enters a conference                             \\ \hline
+    CONF\_END        & The time the last person left a conf (and turned out the lights?)         \\ \hline
+    APP\_START       & The time a tracked application was started                                \\ \hline
+    APP\_END         & the time a tracked application ended                                      \\ \hline
+    PARK\_START      & The time a call was parked                                                \\ \hline
+    PARK\_END        & unpark event                                                              \\ \hline
+    BRIDGE\_START    & The time a bridge is started                                              \\ \hline
+    BRIDGE\_END      & The time a bridge is ended                                                \\ \hline
+    3WAY\_START      & When a 3-way conf starts (usually via attended xfer)                      \\ \hline
+    3WAY\_END        & When one or all exit a 3-way conf                                         \\ \hline
+    BLINDTRANSFER    & When a blind transfer is initiated                                        \\ \hline
+    ATTENDEDTRANSFER & When an attended transfer is initiated                                    \\ \hline
+    TRANSFER         & Generic transfer initiated; not used yet...?                              \\ \hline
+    HOOKFLASH        & So far, when a hookflash event occurs on a Zap interface                  \\ \hline
+    USER\_EVENT      & these are triggered from the dialplan, and have a name given by the user. \\
+    \hline
+  \end{tabular}
+  \caption{List of CEL Events}
+  \label{event_table}
+\end{table}
+
+\begin{table}[h]
+  \begin{tabular}{ | l | p{10cm} | }
+    \hline
+    Field         & Description                                                                \\ \hline \hline
+    eventtype     & The name of the event; see the above list; each is prefixed with "EV\_".   \\ \hline
+    eventtime     & The time the event happened                                                \\ \hline
+    cidname       & CID name field                                                             \\ \hline
+    cidnum        & CID number field                                                           \\ \hline
+    cidani        & CID ANI field                                                              \\ \hline
+    cidrdnis      & CID RDNIS field                                                            \\ \hline
+    ciddnid       & CID DNID field                                                             \\ \hline
+    exten         & The extension in the dialplan                                              \\ \hline
+    context       & The context in the dialplan                                                \\ \hline
+    channame      & The name assigned to the channel in which the event took place             \\ \hline
+    appname       & The name of the current application                                        \\ \hline
+    appdata       & The arguments that will be handed to that application                      \\ \hline
+    amaflags      & The AMA flags associated with the event; user assignable.                  \\ \hline
+    accountcode   & A user assigned datum (string)                                             \\ \hline
+    uniqueid      & Each Channel instance gets a unique ID associated with it.                 \\ \hline
+    userfield     & A user assigned datum (string)                                             \\ \hline
+    linkedid      & the per-call id, spans several events, possibly.                           \\ \hline
+    peer          & For bridge or other 2-channel events, this would be the other channel name \\
+    \hline
+  \end{tabular}
+  \caption{List of CEL Event Fields}
+  \label{field_table}
+\end{table}
 
 \section{Applications \& Functions}
 
@@ -833,9 +847,9 @@
 which are stored on the channel.
 
 Channel variables are not available for reading from the CEL function, nor can
-any variable name other than what's in the list, be set. CDR's have a structure
+any variable name other than what's in the list, be set. CDRs have a structure
 attached to the channel, where the CDR function could access the values stored
-there, or set the values there. CDR's could store their own variable lists, but
+there, or set the values there. CDRs could store their own variable lists, but
 CEL has no such storage. There is no reason to store any event information, as
 they are immediately output to the various backends at the time they are
 generated.
@@ -844,15 +858,15 @@
 
 Here is a list of all the available channel field names:
 \begin{verbatim}
-    cidname       userfield
-    cidnum        amaflags
-    cidani        cidrdnis
-    ciddnid       appdata
-    exten         accountcode
-    context       uniqueid
-    channame      appname
-    peer          eventtime
-    eventtype
+  cidname       userfield
+  cidnum        amaflags
+  cidani        cidrdnis
+  ciddnid       appdata
+  exten         accountcode
+  context       uniqueid
+  channame      appname
+  peer          eventtime
+  eventtype
 \end{verbatim}
 
 \subsection{CELGenUserEvent Application}
@@ -862,10 +876,10 @@
 
 For more information, in the CLI, type: core show application CELGenUserEvent
 
-It's arguments take this format:
+Its arguments take this format:
 
 \begin{verbatim}
-     CELGenUserEvent(eventname)
+  CELGenUserEvent(eventname)
 \end{verbatim}
 
 Please note that there is no restrictions on the name supplied. If it happens to




More information about the asterisk-commits mailing list