Add function helps for $page, $numpages, $feature and $numfeatures

qgis · Oct 4, 2012 · a588e1b · a588e1b
1 parent ea44e0f
commit a588e1b
Show file tree

Hide file tree

Showing 4 changed files with 48 additions and 0 deletions.
diff --git a/resources/function_help/$feature-en_US b/resources/function_help/$feature-en_US
@@ -0,0 +1,12 @@
+<h3>$feature function</h3>
+In atlas generation, returns the current feature number that is iterated over on the coverage layer.
+
+<h4>Syntax</h4>
+<pre>$feature</pre>
+
+<h4>Arguments</h4>
+None
+
+<h4>Example</h4>
+<pre>$feature &rarr; 2</pre>
+
diff --git a/resources/function_help/$numfeatures-en_US b/resources/function_help/$numfeatures-en_US
@@ -0,0 +1,12 @@
+<h3>$numfeatures function</h3>
+In atlas generation, returns the total number of features within the coverage layer.
+
+<h4>Syntax</h4>
+<pre>$numfeatures</pre>
+
+<h4>Arguments</h4>
+None
+
+<h4>Example</h4>
+<pre>$numfeatures &rarr; 42</pre>
+
diff --git a/resources/function_help/$numpages-en_US b/resources/function_help/$numpages-en_US
@@ -0,0 +1,12 @@
+<h3>$numpages function</h3>
+Returns the total number of pages in the composition.
+
+<h4>Syntax</h4>
+<pre>$numpages</pre>
+
+<h4>Arguments</h4>
+None
+
+<h4>Example</h4>
+<pre>$numpages &rarr; 42</pre>
+
diff --git a/resources/function_help/$page-en_US b/resources/function_help/$page-en_US
@@ -0,0 +1,12 @@
+<h3>$page function</h3>
+Returns the current page number within a composition.
+
+<h4>Syntax</h4>
+<pre>$page</pre>
+
+<h4>Arguments</h4>
+None
+
+<h4>Example</h4>
+<pre>$page &rarr; 2</pre>
+