adding some function help files for field calculator, thanks to Zolta…

…n Siki
qgis · Feb 21, 2013 · a788b0d · a788b0d
1 parent a71946c
commit a788b0d
Show file tree

Hide file tree

Showing 12 changed files with 150 additions and 0 deletions.
diff --git a/resources/function_help/acos-en_US b/resources/function_help/acos-en_US
@@ -0,0 +1,12 @@
+<h3>acos() function</h3>
+Returns arcuscosinus of a value in radians.
+
+
+<p><h4>Syntax</h4>
+     acos(<i>real</i>)</p>
+
+<p><h4>Arguments</h4>
+<i>real</i> -> cos of an angle.</p>
+
+<p><h4>Example</h4>
+     acos(0.5) -> 1.0471975511966</p>
diff --git a/resources/function_help/asin-en_US b/resources/function_help/asin-en_US
@@ -0,0 +1,12 @@
+<h3>asin() function</h3>
+Returns arcussinus of a value in radians.
+
+
+<p><h4>Syntax</h4>
+     asin(<i>real</i>)</p>
+
+<p><h4>Arguments</h4>
+<i>real</i> -> sin of an angle.</p>
+
+<p><h4>Example</h4>
+     asin(1.0) -> 1.5707963267949</p>
diff --git a/resources/function_help/atan-en_US b/resources/function_help/atan-en_US
@@ -0,0 +1,12 @@
+<h3>atan() function</h3>
+Returns arcustanget of a value in radians.
+
+
+<p><h4>Syntax</h4>
+     atan(<i>real</i>)</p>
+
+<p><h4>Arguments</h4>
+<i>real</i> -> tan of an angle.</p>
+
+<p><h4>Example</h4>
+     atan(0.5) -> 0.463647609000806</p>
diff --git a/resources/function_help/atan2-en_US b/resources/function_help/atan2-en_US
@@ -0,0 +1,15 @@
+<h3>atan2() function</h3>
+Returns arcustangens of y/x using the signs of the two 
+arguments to determine the quadrant of the result
+
+
+
+<p><h4>Syntax</h4>
+     atan2(<i>real</i>, <i>real</i>)</p>
+
+<p><h4>Arguments</h4>
+<i>real</i> -> y coordinate difference<br>
+<i>real</i> -> x coordinate difference</p>
+
+<p><h4>Example</h4>
+     atan2(1.0, 1.732) -> 0.523611477769969</p>
diff --git a/resources/function_help/cos-en_US b/resources/function_help/cos-en_US
@@ -0,0 +1,12 @@
+<h3>cos() function</h3>
+Returns cosinus of an angle.
+
+
+<p><h4>Syntax</h4>
+     cos(<i>real</i>)</p>
+
+<p><h4>Arguments</h4>
+<i>real</i> -> angle in radians.</p>
+
+<p><h4>Example</h4>
+     cos(1.571) -> 0.000796326710733263</p>
diff --git a/resources/function_help/exp-en_US b/resources/function_help/exp-en_US
@@ -0,0 +1,12 @@
+<h3>exp() function</h3>
+Returns exponential of an value.
+
+
+<p><h4>Syntax</h4>
+     exp(<i>real</i>)</p>
+
+<p><h4>Arguments</h4>
+<i>real</i> -> number.</p>
+
+<p><h4>Example</h4>
+     exp(1.0) -> 2.71828182845905</p>
diff --git a/resources/function_help/sin-en_US b/resources/function_help/sin-en_US
@@ -0,0 +1,12 @@
+<h3>sin() function</h3>
+Returns sinus of an angle.
+
+
+<p><h4>Syntax</h4>
+     sin(<i>real</i>)</p>
+
+<p><h4>Arguments</h4>
+<i>real</i> -> angle in radians.</p>
+
+<p><h4>Example</h4>
+     sin(1.571) -> 0.999999682931835</p>
diff --git a/resources/function_help/sqrt-en_US b/resources/function_help/sqrt-en_US
@@ -0,0 +1,12 @@
+<h3>sqrt() function</h3>
+Returns square root of a value
+
+
+<p><h4>Syntax</h4>
+     sqrt(<i>real</i>)</p>
+
+<p><h4>Arguments</h4>
+<i>real</i> -> number.</p>
+
+<p><h4>Example</h4>
+     sqrt(9) -> 3</p>
diff --git a/resources/function_help/tan-en_US b/resources/function_help/tan-en_US
@@ -0,0 +1,12 @@
+<h3>tan() function</h3>
+Returns tangent of an angle.
+
+
+<p><h4>Syntax</h4>
+     tan(<i>real</i>)</p>
+
+<p><h4>Arguments</h4>
+<i>real</i> -> angle in radians.</p>
+
+<p><h4>Example</h4>
+     tan(1.0) -> 1.5574077246549</p>
diff --git a/resources/function_help/toint-en_US b/resources/function_help/toint-en_US
@@ -0,0 +1,13 @@
+<h3>toint function</h3>
+Converts a string to integer number. Nothing changed if a value cannot be converted to integer (e.g '123asd' is invalid).
+
+<p><h4>Syntax</h4>
+     toint(<i>string</i>)</p>
+
+<p><h4>Arguments</h4>
+<!-- List args for functions here-->
+<i>  string</i> -> is string.  The String to convert to integer number.</p>
+
+<p><h4>Example</h4>
+<!-- Show example of function.-->
+     toint('123') -> 123</p>
diff --git a/resources/function_help/toreal-en_US b/resources/function_help/toreal-en_US
@@ -0,0 +1,13 @@
+<h3>toreal function</h3>
+Converts a string to real number. Nothing changed if a value cannot be converted to real (e.g '123.56asd' is invalid). Numbers are rounded after saving changes if the precision is smaller than the result of the conversion.
+
+<p><h4>Syntax</h4>
+     toreal(<i>string</i>)</p>
+
+<p><h4>Arguments</h4>
+<!-- List args for functions here-->
+<i>  string</i> -> is string.  The String to convert to real number.</p>
+
+<p><h4>Example</h4>
+<!-- Show example of function.-->
+     toreal('123.45') -> 123.45</p>
diff --git a/resources/function_help/tostring-en_US b/resources/function_help/tostring-en_US
@@ -0,0 +1,13 @@
+<h3>tostring function</h3>
+Converts a number to string.
+
+<p><h4>Syntax</h4>
+     tostring(<i>number</i>)</p>
+
+<p><h4>Arguments</h4>
+<!-- List args for functions here-->
+<i>number</i> -> is integer or real.  The number to convert to string.</p>
+
+<p><h4>Example</h4>
+<!-- Show example of function.-->
+     tostring(123) -> '123'</p>