Add expression function help

qgis · Sep 4, 2012 · 72978cf · 72978cf
1 parent 2ef60da
commit 72978cf
Show file tree

Hide file tree

Showing 3 changed files with 48 additions and 0 deletions.
diff --git a/resources/function_help/$scale-en_US b/resources/function_help/$scale-en_US
@@ -0,0 +1,12 @@
+<h3>$scale function</h3>
+Returns the current scale of the map canvas.
+<br>
+Note: This function is only available in some contexts and will be 0 otherwise. 
+<h4>Syntax</h4>
+<code>$scale</code><br>
+
+<h4>Example</h4>
+<!-- Show example of function.-->
+<code>$scale &rarr; 10000</code><br>
+
+
diff --git a/resources/function_help/format_number-en_US b/resources/function_help/format_number-en_US
@@ -0,0 +1,16 @@
+<h3>format_number() function</h3>
+Returns a number formatted with the locale separator for thousands. 
+Also truncates the number to the number of supplied places. 
+<h4>Syntax</h4>
+<code>format_number(number,places)</code><br>
+
+<h4>Arguments</h4>
+<code>number</code> - is number. The number to be formatted.
+<br>
+<code>places</code> - is int. The number of decimal places to truncate the string
+to.
+
+<h4>Example</h4>
+<!-- Show example of function.-->
+<code>format_number(10000000.332,2) &rarr; 10,000,000.33</code>
+
diff --git a/resources/function_help/round-en_US b/resources/function_help/round-en_US
@@ -0,0 +1,20 @@
+<h3>round() function</h3>
+Rounds a number to number of decimal places.
+<br>
+This function can take one or two arguments depending on what is needed.
+<h4>Syntax</h4>
+<code>round(decimal,places)</code><br>
+<code>round(decimal)</code><br>
+
+<h4>Arguments</h4>
+<code>decimal</code> - is decimal. The decimal number to be rounded.
+<br>
+<code>places</code> - is int. The number of places to round decimal too. Can be negative.
+
+<h4>Example</h4>
+<!-- Show example of function.-->
+<code>round(1234.567, 2 ) &rarr; 1234.57</code><br>
+use <code>round(decimal)</code> to round to the nearest integer<br>
+<code>round(1234.567) &rarr; 1235</code><br>
+
+