[Asterisk-doc] docs appendix03.xml,1.13,1.14
blitzrage
asterisk-doc@lists.digium.com
Sun, 21 Dec 2003 02:55:23 +0000
Comments:
Update of /cvsroot/asterisk/docs
In directory sc8-pr-cvs1:/tmp/cvs-serv6848/docs
Modified Files:
appendix03.xml
Log Message:
blitzrage
- ummm.. to be honest, I did a bunch of stuff over the day, and I kinda
forget all the stuff I changed, but it was all in appendix 3.
All small things. Tried to fix up anything that jsmith noted
while he was doing his run through.
*jsmith: yes, I compiled it first to make sure there were no
errors :)
There is still a few things in appendix 3 that need to be edited,
will try to document them as I find them, either that, or just fix
them :)
Index: appendix03.xml
===================================================================
RCS file: /cvsroot/asterisk/docs/appendix03.xml,v
retrieving revision 1.13
retrieving revision 1.14
diff -C2 -d -r1.13 -r1.14
*** appendix03.xml 20 Dec 2003 18:35:08 -0000 1.13
--- appendix03.xml 21 Dec 2003 02:55:17 -0000 1.14
***************
*** 607,610 ****
--- 607,613 ----
<para>
<!-- Do we really need the angle brackets around the variables below? -->
+ <!-- blitzrage Dec 20: No we do not. They are simply to show that they
+ should not be literal. For example, <month> can be jan-dec -->
+ <!-- This will obviously still need to be edited to show the options -->
<function>GotoIfTime(<replaceable><times></replaceable>|<replaceable><weekdays></replaceable>|<replaceable><mdays></replaceable>|<replaceable><months></replaceable>?[[<replaceable>context</replaceable>|]<replaceable>extension</replaceable>|]<replaceable>priority</replaceable>)</function>
</para>
***************
*** 770,778 ****
<para>
Monitor takes the following arguments:
! <!-- TODO: This really ought to be a variablelist, not a simplelist -->
! <simplelist>
! <member>file_format -- optional, if not set, defaults to "wav"</member>
! <member>fname_base -- if set, changes the filename used to the one specified</member>
! </simplelist>
</para>
<formalpara><title>MP3Player: Play an MP3 file or stream</title>
--- 773,789 ----
<para>
Monitor takes the following arguments:
! <variablelist>
! <varlistentry><term><emphasis>file_format</emphasis></term>
! <listitem>
! <para>optional, if not set, defaults to "wav"</para>
! </listitem>
! </varlistentry>
!
! <varlistentry><term><emphasis>fname_base</emphasis></term>
! <listitem>
! <para>if set, changes the filename used to the one specified</para>
! </listitem>
! </varlistentry>
! </variablelist>
</para>
<formalpara><title>MP3Player: Play an MP3 file or stream</title>
***************
*** 1067,1072 ****
</formalpara>
<para>
! Says the passed digits
<!-- TODO: Show the difference between this and SayNumber() -->
</para>
--- 1078,1088 ----
</formalpara>
<para>
! Says the passed digits. With this, if you insert a string of digits,
! Asterisk will say the individual numbers.
<!-- TODO: Show the difference between this and SayNumber() -->
+ <!-- blitzrage Dec. 20: Added more to description -->
+ </para>
+ <para>
+ Example: SayDigits(12345) will be said as "One Two Three Four Five".
</para>
***************
*** 1077,1081 ****
</formalpara>
<para>
! Says the passed number
</para>
--- 1093,1101 ----
</formalpara>
<para>
! Says the passed number. With this, if you insert a string of digits,
! Asterisk will say the number, and not the individual digits.
! </para>
! <para>
! Example: SayNumber(12345) will be said as "Twelve-Thousand Three-Hundred Forty-Five".
</para>
***************
*** 1330,1334 ****
<formalpara><title>StripMSD: Strip leading digits</title>
<para>
! StripMSD(count)
</para>
</formalpara>
--- 1350,1354 ----
<formalpara><title>StripMSD: Strip leading digits</title>
<para>
! <function>StripMSD(<replaceable>count</replaceable>)</function>
</para>
</formalpara>
***************
*** 1348,1352 ****
<formalpara><title>SubString: Save substring digits in a given variable</title>
<para>
! SubString(variable=string_of_digits|count1|count2)
</para>
</formalpara>
--- 1368,1372 ----
<formalpara><title>SubString: Save substring digits in a given variable</title>
<para>
! <function>SubString(variable=<replaceable>string_of_digits</replaceable>|<replaceable>count1</replaceable>|<replaceable>count2</replaceable>)</function>
</para>
</formalpara>
***************
*** 1363,1372 ****
For example:
<!-- TODO: Change this to a program listing with callouts! -->
exten => _NXXXXXX,1,SubString,test=2564286161|0|3
! assigns the area code (3 first digits) to variable test.
exten => _NXXXXXX,1,SubString,test=2564286161|-7|7
! assigns the last 7 digits to variable test.
exten => _NXXXXXX,1,SubString,test=2564286161|0|-4
! assigns all but the last 4 digits to variable test.
</para>
<para>
--- 1383,1395 ----
For example:
<!-- TODO: Change this to a program listing with callouts! -->
+ <!-- blitzrage, Dec 20: Changed this around a bit, feel free to format if you don't like this -->
+ <programlisting>
exten => _NXXXXXX,1,SubString,test=2564286161|0|3
! <lineannotation>assigns the area code (3 first digits) to variable test.</lineannotation>
exten => _NXXXXXX,1,SubString,test=2564286161|-7|7
! <lineannotation>assigns the last 7 digits to variable test.</lineannotation>
exten => _NXXXXXX,1,SubString,test=2564286161|0|-4
! <lineannotation>assigns all but the last 4 digits to variable test.</lineannotation>
! </programlisting>
</para>
<para>
***************
*** 1434,1437 ****
--- 1457,1461 ----
<para>
<!-- TODO: Is context really optional now with VoiceMail2? -->
+ <!-- blitzrage: I would assume so, I use Voicemail2 without an @context -->
<function>VoiceMail2([s|u|b]<replaceable>extension</replaceable>[@<replaceable>context</replaceable>])</function>
</para>
***************
*** 1562,1565 ****
--- 1586,1590 ----
<para>
<!-- TODO: What does "caller user" mean in this paragraph? -->
+ <!-- blitzrage: typo? "called user" make more sense? -->
Returns -1 when caller user hangs up and is independent of the
state of the channel being monitored.