[sr-dev] git:5.1:3d203d97: dialplan: note and example for prefixing string param with s: for rpc dialplan.translate

[Daniel-Constantin Mierla]

Module: kamailio
Branch: 5.1
Commit: 3d203d97f28e8d5eefb5ea63c0f3ff12b3cb9d2f
URL: https://github.com/kamailio/kamailio/commit/3d203d97f28e8d5eefb5ea63c0f3ff12b3cb9d2f

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2018-10-19T08:26:58+02:00

dialplan: note and example for prefixing string param with s: for rpc dialplan.translate

(cherry picked from commit a169b298018f08a57da8e7a8c116560ee4fff006)

---

Modified: src/modules/dialplan/doc/dialplan_admin.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/3d203d97f28e8d5eefb5ea63c0f3ff12b3cb9d2f.diff
Patch: https://github.com/kamailio/kamailio/commit/3d203d97f28e8d5eefb5ea63c0f3ff12b3cb9d2f.patch

---

diff --git a/src/modules/dialplan/doc/dialplan_admin.xml b/src/modules/dialplan/doc/dialplan_admin.xml
index e9f8f95350..ed8bad4fae 100644
--- a/src/modules/dialplan/doc/dialplan_admin.xml
+++ b/src/modules/dialplan/doc/dialplan_admin.xml
@@ -682,10 +682,12 @@ xlog("translated to var $var(y) \n");
         		<para>Parameters: <emphasis>2</emphasis></para>
         		<itemizedlist>
                 	<listitem>
-                	<para><emphasis>Dial plan ID</emphasis></para>
+					<para><emphasis>Dial plan ID</emphasis> (number)</para>
                 	</listitem>
                 	<listitem>
-                	<para><emphasis>Input String</emphasis></para>
+					<para><emphasis>Input string</emphasis> (string) - it
+					can be prefixed with 's:' to avoid auto-conversion when
+					the command is executed with CLI apps such as &kamcmd;.</para>
                 	</listitem>
 			</itemizedlist>
 			<para>
@@ -693,6 +695,7 @@ xlog("translated to var $var(y) \n");
 			</para>
 		<programlisting  format="linespecific">
 		&kamcmd; dialplan.translate 1 "abcdxyz"
+		&kamcmd; dialplan.translate 1 s:123456789
 		</programlisting>
 		</section>
 	</section>