diff --git a/src/sextante/help/3rdParty.html b/src/sextante/help/3rdParty.html index 942bd3ace67d..89ce64488cab 100644 --- a/src/sextante/help/3rdParty.html +++ b/src/sextante/help/3rdParty.html @@ -101,7 +101,7 @@
The variable polygon already contains a SpatialPolygonsDataFrame -object, so it can be usedto call the spsample method, just like the +object, so it can be used to call the spsample method, just like the numpoints one, which indicates the number of points to add to the created sample grid.
Since we have declared an output of type vector named out, we have @@ -277,7 +277,7 @@
The output ot the last line is printed, but the output of the first is -not (and neither are the otputs from other command lines added +not (and neither are the outputs from other command lines added automatically by SEXTANTE).
If your algorithm creates any kind of graphics (using the plot() method), add the following line:
diff --git a/src/sextante/help/_images/cannot_delete_alg.png b/src/sextante/help/_images/cannot_delete_alg.png new file mode 100644 index 000000000000..d445c0a80e1b Binary files /dev/null and b/src/sextante/help/_images/cannot_delete_alg.png differ diff --git a/src/sextante/help/_images/deactivated.png b/src/sextante/help/_images/deactivated.png new file mode 100644 index 000000000000..5b552fa26be1 Binary files /dev/null and b/src/sextante/help/_images/deactivated.png differ diff --git a/src/sextante/help/_images/modeler_right_click.png b/src/sextante/help/_images/modeler_right_click.png new file mode 100644 index 000000000000..1e3baa944363 Binary files /dev/null and b/src/sextante/help/_images/modeler_right_click.png differ diff --git a/src/sextante/help/_sources/index.txt b/src/sextante/help/_sources/index.txt index 61cd36b5a133..3821d202e5ca 100644 --- a/src/sextante/help/_sources/index.txt +++ b/src/sextante/help/_sources/index.txt @@ -3,7 +3,7 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to SEXTANTE for QGIS's documentation! +SEXTANTE for QGIS's documentation ============================================= Contents: diff --git a/src/sextante/help/_sources/modeler.txt b/src/sextante/help/_sources/modeler.txt index ca55cbf297b2..1c1d1801049b 100644 --- a/src/sextante/help/_sources/modeler.txt +++ b/src/sextante/help/_sources/modeler.txt @@ -62,7 +62,7 @@ the modeler window: - Boolean value Double-clicking on any of them, a dialog is shown to define its -characteristics. Depending on the parameter itself, the dialog will +caracteristics. Depending on the parameter itself, the dialog will contain just one basic element (the description, which is what the user will see when executing the model) or more of them. For instance, when adding a numerical value, as it can be seen in the next figure, apart @@ -97,7 +97,7 @@ To add an algorithm, double-click on its name. An execution dialog will appear, with a content similar to the one found in the execution panel that SEXTANTE shows when executing the algorithm from the toolbox. the one shown next correspond to the SAGA convergence index algorithm, the -same one we saw in the section dedicated to the SEXTANTE toolbox. +same one we saw in the section dedicated to the SEXTANTe toolbox. .. figure:: models_parameters4.png :align: center @@ -114,7 +114,7 @@ you supply will be the description for the output, which will be the one the user will see when executing the model. Selecting the value of each parameter is also a bit different, since -there are important differences between the context of the modeler and +there are importante differences between the context of the modeler and the toolbox one. Let's see how to introduce the values for each type of parameter. @@ -154,8 +154,7 @@ Elements can be dragged to a different position within the canvas, to change the way the module structure is displayed and make it more clear and intuitive. Links between elements are update automatically. -You can run your algorithm anytime clicking on the *Run* button. However, -in order to use it from the toolbox, it has to be saved and the modeler dialog closed, to allow the toolbox to refresh its contents. +You can run your algorithm anytime clicking on the *Run* button. However, in order to use it from the toolbox, it has to be saved and the modeler dialog closed, to allow the toolbox to refresh its contents. Saving and loading models ------------------------- @@ -193,6 +192,41 @@ renders all the algorithms in that provider unusable by the modeler, which might cause problems when loading models. Keep that in mind when you have trouble loading or executing models. +Editing a model +--------------- + +You can edit the model you are currently creating, redefining the workflow and the relationships between the algorithms and inputs that define the model itself. + +If you right-click on an algorithm in the canvas representing the model, you will see a context menu like the one shown next: + +.. figure:: modeler_right_click.png + :align: center + + +Selecting the *Remove* option will cause the selected algorithm to be removed. An algorithm can be removed only if there are no other algorithms dependind on it. That is, if no output from the algorithm is used in a different one as input. If you try to remove an algorithm that has others depending on it, SEXTANTE will show you a warning message like the one you can see below: + +.. figure:: cannot_delete_alg.png + :align: center + +Selecting the *Edit* option or simply double-clicking on the algorithm icon will show the parameters dialog of the algorithm, so you can change the inputs and parameter values. Not all input elements available in the model will appear in this case as available inputs. Layers or values generated at a more advanced step in the workflow defined by the model will not be available if they cause circular dependencies. + +Select the new values and then click on the *OK* button as usual. The connections between the model elements will change accordingly in the modeler canvas. + +Activating and deactivating algorithms +-------------------------------------- + +Algorithms can be deactivated in the modeler, so they will not be executed once the model is run. This can be used to test just a given part of the model, or when you do not need all the outputs it generates. + +To deactivate an algorithm, right--click on its icon in the model canvas and select the *Deactivate* option. You will see that the algorithm is represented now with a red label under its name indicating that is not active. + +.. figure:: deactivated.png + :align: center + +All algorithms depending (directly or undirectly) on that algorithm will also appear as inactive, since they cannot be executed now. + +To activate an algorithm, just right--click on its icon and select the *Activate* option. + + Editing model help files and meta-information --------------------------------------------- @@ -218,7 +252,7 @@ if the number of output layers cannot be know in advance), then it is not possible to use it within a model, and thus does not appear in the list of them that you can find in the modeler dialog. -Additionally, you will see some algorithms in the modeler that are not +Additionaly, you will see some algorithms in the modeler that are not found in the toolbox. This algorithms are meant to be used exclusively as part of a model, and they are of no interest in a different context. The *Calculator* algorithm is an example of that. It is just a simple @@ -230,6 +264,8 @@ make too much sense. SEXTANTE models as Python code ------------------------------ +*[This feature is temporarily unavailable]* + Along with the tab that contains the graphical design of the model, you will find another one containing a Python script which performs the same task as the model itself. Using that code, you can create a console diff --git a/src/sextante/help/console.html b/src/sextante/help/console.html index d3360850e466..bc9c4e85752e 100644 --- a/src/sextante/help/console.html +++ b/src/sextante/help/console.html @@ -157,7 +157,7 @@> runalg{name_of_the_algorithm, param1, param2, ..., paramN, Output1, Output2, ..., OutputN)-
The list of parameters and ouputs to add depends on the algorithm you +
The list of parameters and outputs to add depends on the algorithm you want to run, and is exactly the list that the describealg method gives you, in the same order as shown.
Depending on the type of parameter, values are introduced differently. @@ -214,7 +214,7 @@
Unlike when an algorithm is executed from the toolbox, outputs are not @@ -292,7 +292,7 @@
The parameter name is the name that will be shown to the user when executing the algorithm, and also the variable name to use in the script -code. The value entered by the user for that parameter will be asigned +code. The value entered by the user for that parameter will be assigned to a variable with that name.
Layers and tables values are strings containing the filepath of the corresponding object. To turn them into a QGIS object, you can use the @@ -307,7 +307,7 @@
The value asigned to the output variables is always a string with a +
The value assigned to the output variables is always a string with a filepath. It will correspond to a temporary filepath in case the user has not entered any output filename.
When you declare an output, SEXTANTE will try to add it to QGIS once the @@ -315,7 +315,7 @@
Do not use the load() method in your scripta algorithms, but just +
Do not use the load() method in your script algorithms, but just when working with the console line. If a layer is created as output of an algorithm, it should be declared as such. Otherwise, you will not be able to properly use the algorithm in the modeler, since its syntax (as diff --git a/src/sextante/help/index.html b/src/sextante/help/index.html index de0142a9f8d8..fb44a9495bb1 100644 --- a/src/sextante/help/index.html +++ b/src/sextante/help/index.html @@ -8,7 +8,7 @@
-Contents:
Algorithms can be deactivated in the modeler, so they will not be executed once the model is run. This can be used to test just a given part of the model, or when you do not need all the outputs it generates.
+To deactivate an algorithm, right–click on its icon in the model canvas and select the Deactivate option. You will see that the algorithm is represented now with a red label under its name indicating that is not active.
+All algorithms depending (directly or undirectly) on that algorithm will also appear as inactive, since they cannot be executed now.
+To activate an algorithm, just right–click on its icon and select the Activate option.
+You can document your models from SEXTANTE. Just click on the Edit model help button and a dialog like the one shown next will appear.
@@ -235,6 +259,7 @@[This feature is temporarily unavailable]
Along with the tab that contains the graphical design of the model, you will find another one containing a Python script which performs the same task as the model itself. Using that code, you can create a console @@ -264,6 +289,8 @@
Along with the aforementioned Output folder entry, the General block contains parameters for setting the default rendering style for SEXTANTE -layers (that is, layers generated by using algorihtms from any of the +layers (that is, layers generated by using algorithms from any of the SEXTANTE components). Just create the style you want using QGIS, save it to a file, and then enter the path to that file in the settings so SEXTANTE can use it. Whenever a layer is loaded by SEXTANTE and added to