瀏覽代碼

app_jsdt Minor update to documentation

Olle E. Johansson 7 年之前
父節點
當前提交
7b0ad6b1a1
共有 1 個文件被更改,包括 12 次插入11 次删除
  1. 12 11
      src/modules/app_jsdt/doc/app_jsdt_admin.xml

+ 12 - 11
src/modules/app_jsdt/doc/app_jsdt_admin.xml

@@ -17,15 +17,16 @@
     <section>
     <section>
 	<title>Overview</title>
 	<title>Overview</title>
 	<para>
 	<para>
-		This module allows executing JavaScript scripts from config file.
+		This module allows executing JavaScript scripts from the Kamailio 
+		configuration file.
 		It exports all KEMI functions to JavaScript in order to access the
 		It exports all KEMI functions to JavaScript in order to access the
-		current processed SIP message. These functions are within JavaScript
-		object 'KSR'.
+		currently processed SIP message. These functions are named within
+		the JavaScript object 'KSR'.
 	</para>
 	</para>
 	<para>
 	<para>
-		It includes the Duktape JavaScript engine (http://www.duktape.org),
-		which is a fast and easy to embed JavaScript interpreter. Exported API
-		from SIP router to JavaScript is documented in the dokuwiki.
+		The module is based on the Duktape JavaScript engine (http://www.duktape.org),
+		which is a fast and easy to embed JavaScript interpreter. The exported API
+		from Kamailio to JavaScript is documented in the wiki.
 	</para>
 	</para>
 	<para>
 	<para>
 		The module has two JavaScript contexts:
 		The module has two JavaScript contexts:
@@ -42,7 +43,7 @@
 			and parameter 'load'. Therefore jsdt_run() cannot execute functions
 			and parameter 'load'. Therefore jsdt_run() cannot execute functions
 			from scripts loaded via jsdt_dofile() in config. This is kind of
 			from scripts loaded via jsdt_dofile() in config. This is kind of
 			caching mode, avoiding reading file every time, but you must be sure
 			caching mode, avoiding reading file every time, but you must be sure
-			you do not have something that is executed by default and requires
+			you do not have someting that is executed by default and requires
 			access to SIP message. This environment is also used by KEMI
 			access to SIP message. This environment is also used by KEMI
 			framework for the config SIP routing functions.
 			framework for the config SIP routing functions.
 		</para>
 		</para>
@@ -74,7 +75,7 @@
 		    <listitem>
 		    <listitem>
 			<para>
 			<para>
 				<emphasis>libm</emphasis> - the math library (part of standard
 				<emphasis>libm</emphasis> - the math library (part of standard
-				system libraries - it is needed to compile embedded Duktape JS
+				system libraries - it is needed to complile embedded Duktape JS
 				interpreter).
 				interpreter).
 			</para>
 			</para>
 		    </listitem>
 		    </listitem>
@@ -116,7 +117,7 @@ modparam("app_jsdt", "load", "/usr/local/etc/kamailio/js/myscript.js")
 		<function moreinfo="none">jsdt_dofile(path)</function>
 		<function moreinfo="none">jsdt_dofile(path)</function>
 	    </title>
 	    </title>
 	    <para>
 	    <para>
-		Execute the JS script stored in 'path'. The parameter can be
+		Execute the JavaScript script stored in 'path'. The parameter can be
 		a string with pseudo-variables evaluated at runtime.
 		a string with pseudo-variables evaluated at runtime.
 	    </para>
 	    </para>
 		<example>
 		<example>
@@ -134,7 +135,7 @@ jsdt_dofile("/usr/local/etc/kamailio/js/myscript.js");
 		<function moreinfo="none">jsdt_dostring(script)</function>
 		<function moreinfo="none">jsdt_dostring(script)</function>
 	    </title>
 	    </title>
 	    <para>
 	    <para>
-		Execute the Lua script stored in parameter. The parameter can be
+		Execute the JavaScript script stored in parameter. The parameter can be
 		a string with pseudo-variables.
 		a string with pseudo-variables.
 	    </para>
 	    </para>
 		<example>
 		<example>
@@ -248,7 +249,7 @@ if(!jsdt_runstring('KSR.dbg("Hello World from $fU\n")'))
     <section>
     <section>
 	<title>Example of usage</title>
 	<title>Example of usage</title>
     <para>
     <para>
-		Create your JS script and stored on file system,
+		Create your JS script and store it on the file system,
 		say: '/usr/local/etc/kamailio/js/myscript.js'.
 		say: '/usr/local/etc/kamailio/js/myscript.js'.
     </para>
     </para>
 <programlisting format="linespecific">
 <programlisting format="linespecific">