Skip to content

Commit 496d0ae

Browse files
author
volayaf
committed
updated help
git-svn-id: http://sextante.googlecode.com/svn/trunk/soft/bindings/qgis-plugin@216 881b9c09-3ef8-f3c2-ec3d-21d735c97f4d
1 parent b47ca35 commit 496d0ae

File tree

12 files changed

+95
-30
lines changed

12 files changed

+95
-30
lines changed

src/sextante/help/3rdParty.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ <h3>A note on vector layer selections<a class="headerlink" href="#a-note-on-vect
101101
<p>By default, when an external algorithm takes a vector layer, it will use
102102
all its features, even if a selection exist in QGIS. You can make an
103103
external algorithm aware of that selection by checking the <em>Use selected
104-
features in eternal applications</em> item in the <em>General</em> settings group.
104+
features in external applications</em> item in the <em>General</em> settings group.
105105
When you do so, each time you execute an external algorithm that uses a
106106
vector layer, the selected features of that layer will be exported to a
107107
new layer, and the algorithm will work with that new layer instead.</p>
@@ -135,7 +135,7 @@ <h2>SAGA<a class="headerlink" href="#saga" title="Permalink to this headline">¶
135135
the algorithm descriptions (needed to create the parameters dialog and
136136
give SEXTANTE the information it needs about the algorithm) are not
137137
included with SAGA, but with SEXTANTE instead. That is, they are part of
138-
SEXTANTE, so you have them in yur installation even if you have not
138+
SEXTANTE, so you have them in your installation even if you have not
139139
installed SEXTANTE. Running the algorithm, however, needs SAGA binaries
140140
installed in your system.</p>
141141
<div class="section" id="about-saga-grid-system-limitations">
@@ -144,7 +144,7 @@ <h3>About SAGA grid system limitations<a class="headerlink" href="#about-saga-gr
144144
require them to have the same grid system. That is, to cover the same
145145
geographic area and have the same cellsize, so their corresponding grids
146146
match. When calling SAGA algorithms from SEXTANTE, you can use any
147-
layer, regarless of its cellsize and extent. When multiple raster layers
147+
layer, regardless of its cellsize and extent. When multiple raster layers
148148
are used as input for a SAGA algorithm, SEXTANTE resamples them to a
149149
common grid system and then passes them to SAGA (unless the SAGA
150150
algorithm can operate with layers from different grid systems).</p>
@@ -248,7 +248,7 @@ <h2>R. Creating R scripts<a class="headerlink" href="#r-creating-r-scripts" titl
248248
</pre></div>
249249
</div>
250250
<p>The variable <tt class="docutils literal"><span class="pre">polygon</span></tt> already contains a <tt class="docutils literal"><span class="pre">SpatialPolygonsDataFrame</span></tt>
251-
object, so it can be usedto call the <tt class="docutils literal"><span class="pre">spsample</span></tt> method, just like the
251+
object, so it can be used to call the <tt class="docutils literal"><span class="pre">spsample</span></tt> method, just like the
252252
<tt class="docutils literal"><span class="pre">numpoints</span></tt> one, which indicates the number of points to add to the
253253
created sample grid.</p>
254254
<p>Since we have declared an output of type vector named <tt class="docutils literal"><span class="pre">out</span></tt>, we have
@@ -277,7 +277,7 @@ <h2>R. Creating R scripts<a class="headerlink" href="#r-creating-r-scripts" titl
277277
&gt;lillie.test(layer[[field]])</pre>
278278
</div>
279279
<p>The output ot the last line is printed, but the output of the first is
280-
not (and neither are the otputs from other command lines added
280+
not (and neither are the outputs from other command lines added
281281
automatically by SEXTANTE).</p>
282282
<p>If your algorithm creates any kind of graphics (using the <tt class="docutils literal"><span class="pre">plot()</span></tt>
283283
method), add the following line:</p>
6.35 KB
Loading
1.93 KB
Loading
Loading

src/sextante/help/_sources/index.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.
55

6-
Welcome to SEXTANTE for QGIS's documentation!
6+
SEXTANTE for QGIS's documentation
77
=============================================
88

99
Contents:

src/sextante/help/_sources/modeler.txt

Lines changed: 42 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ the modeler window:
6262
- Boolean value
6363

6464
Double-clicking on any of them, a dialog is shown to define its
65-
characteristics. Depending on the parameter itself, the dialog will
65+
caracteristics. Depending on the parameter itself, the dialog will
6666
contain just one basic element (the description, which is what the user
6767
will see when executing the model) or more of them. For instance, when
6868
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
9797
appear, with a content similar to the one found in the execution panel
9898
that SEXTANTE shows when executing the algorithm from the toolbox. the
9999
one shown next correspond to the SAGA convergence index algorithm, the
100-
same one we saw in the section dedicated to the SEXTANTE toolbox.
100+
same one we saw in the section dedicated to the SEXTANTe toolbox.
101101

102102
.. figure:: models_parameters4.png
103103
:align: center
@@ -114,7 +114,7 @@ you supply will be the description for the output, which will be the one
114114
the user will see when executing the model.
115115

116116
Selecting the value of each parameter is also a bit different, since
117-
there are important differences between the context of the modeler and
117+
there are importante differences between the context of the modeler and
118118
the toolbox one. Let's see how to introduce the values for each type of
119119
parameter.
120120

@@ -154,8 +154,7 @@ Elements can be dragged to a different position within the canvas, to
154154
change the way the module structure is displayed and make it more clear
155155
and intuitive. Links between elements are update automatically.
156156

157-
You can run your algorithm anytime clicking on the *Run* button. However,
158-
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.
157+
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.
159158

160159
Saving and loading models
161160
-------------------------
@@ -193,6 +192,41 @@ renders all the algorithms in that provider unusable by the modeler,
193192
which might cause problems when loading models. Keep that in mind when
194193
you have trouble loading or executing models.
195194

195+
Editing a model
196+
---------------
197+
198+
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.
199+
200+
If you right-click on an algorithm in the canvas representing the model, you will see a context menu like the one shown next:
201+
202+
.. figure:: modeler_right_click.png
203+
:align: center
204+
205+
206+
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:
207+
208+
.. figure:: cannot_delete_alg.png
209+
:align: center
210+
211+
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.
212+
213+
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.
214+
215+
Activating and deactivating algorithms
216+
--------------------------------------
217+
218+
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.
219+
220+
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.
221+
222+
.. figure:: deactivated.png
223+
:align: center
224+
225+
All algorithms depending (directly or undirectly) on that algorithm will also appear as inactive, since they cannot be executed now.
226+
227+
To activate an algorithm, just right--click on its icon and select the *Activate* option.
228+
229+
196230
Editing model help files and meta-information
197231
---------------------------------------------
198232

@@ -218,7 +252,7 @@ if the number of output layers cannot be know in advance), then it is
218252
not possible to use it within a model, and thus does not appear in the
219253
list of them that you can find in the modeler dialog.
220254

221-
Additionally, you will see some algorithms in the modeler that are not
255+
Additionaly, you will see some algorithms in the modeler that are not
222256
found in the toolbox. This algorithms are meant to be used exclusively
223257
as part of a model, and they are of no interest in a different context.
224258
The *Calculator* algorithm is an example of that. It is just a simple
@@ -230,6 +264,8 @@ make too much sense.
230264
SEXTANTE models as Python code
231265
------------------------------
232266

267+
*[This feature is temporarily unavailable]*
268+
233269
Along with the tab that contains the graphical design of the model, you
234270
will find another one containing a Python script which performs the same
235271
task as the model itself. Using that code, you can create a console

src/sextante/help/console.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ <h2>Calling SEXTANTE from the Python console<a class="headerlink" href="#calling
157157
<div class="highlight-python"><pre>&gt; runalg{name_of_the_algorithm, param1, param2, ..., paramN,
158158
Output1, Output2, ..., OutputN)</pre>
159159
</div>
160-
<p>The list of parameters and ouputs to add depends on the algorithm you
160+
<p>The list of parameters and outputs to add depends on the algorithm you
161161
want to run, and is exactly the list that the <tt class="docutils literal"><span class="pre">describealg</span></tt> method
162162
gives you, in the same order as shown.</p>
163163
<p>Depending on the type of parameter, values are introduced differently.
@@ -214,7 +214,7 @@ <h2>Calling SEXTANTE from the Python console<a class="headerlink" href="#calling
214214
as it is done from the toolbox. If you want to save the result to a
215215
temporary file, use <tt class="docutils literal"><span class="pre">None</span></tt>. The extension of the file determines the
216216
file format. If you enter a file extension not included in the ones
217-
supportede by the algorithm, the default file format for that output
217+
supported by the algorithm, the default file format for that output
218218
type will be used, and its corresponding extension appended to the given
219219
filepath.</p>
220220
<p>Unlike when an algorithm is executed from the toolbox, outputs are not
@@ -292,7 +292,7 @@ <h2>Creating scripts and running them from the toolbox<a class="headerlink" href
292292
</ul>
293293
<p>The parameter name is the name that will be shown to the user when
294294
executing the algorithm, and also the variable name to use in the script
295-
code. The value entered by the user for that parameter will be asigned
295+
code. The value entered by the user for that parameter will be assigned
296296
to a variable with that name.</p>
297297
<p>Layers and tables values are strings containing the filepath of the
298298
corresponding object. To turn them into a QGIS object, you can use the
@@ -307,15 +307,15 @@ <h2>Creating scripts and running them from the toolbox<a class="headerlink" href
307307
<li><tt class="docutils literal"><span class="pre">output</span> <span class="pre">html</span></tt></li>
308308
<li><tt class="docutils literal"><span class="pre">output</span> <span class="pre">file</span></tt></li>
309309
</ul>
310-
<p>The value asigned to the output variables is always a string with a
310+
<p>The value assigned to the output variables is always a string with a
311311
filepath. It will correspond to a temporary filepath in case the user
312312
has not entered any output filename.</p>
313313
<p>When you declare an output, SEXTANTE will try to add it to QGIS once the
314314
algorithm is finished. That is the reason why, although the <tt class="docutils literal"><span class="pre">runalg()</span></tt>
315315
method does not load the layers it produces, the final TWI layer will be
316316
loaded, since it is saved to the file entered by the user, which is the
317317
value of the corresponding output.</p>
318-
<p>Do not use the <tt class="docutils literal"><span class="pre">load()</span></tt> method in your scripta algorithms, but just
318+
<p>Do not use the <tt class="docutils literal"><span class="pre">load()</span></tt> method in your script algorithms, but just
319319
when working with the console line. If a layer is created as output of
320320
an algorithm, it should be declared as such. Otherwise, you will not be
321321
able to properly use the algorithm in the modeler, since its syntax (as

src/sextante/help/index.html

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<head>
99
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1010

11-
<title>Welcome to SEXTANTE for QGIS’s documentation! &mdash; SEXTANTE for QGIS 1.0 documentation</title>
11+
<title>SEXTANTE for QGIS’s documentation &mdash; SEXTANTE for QGIS 1.0 documentation</title>
1212

1313
<link rel="stylesheet" href="_static/default.css" type="text/css" />
1414
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@@ -47,8 +47,8 @@ <h3>Navigation</h3>
4747
<div class="bodywrapper">
4848
<div class="body">
4949

50-
<div class="section" id="welcome-to-sextante-for-qgis-s-documentation">
51-
<h1>Welcome to SEXTANTE for QGIS&#8217;s documentation!<a class="headerlink" href="#welcome-to-sextante-for-qgis-s-documentation" title="Permalink to this headline"></a></h1>
50+
<div class="section" id="sextante-for-qgis-s-documentation">
51+
<h1>SEXTANTE for QGIS&#8217;s documentation<a class="headerlink" href="#sextante-for-qgis-s-documentation" title="Permalink to this headline"></a></h1>
5252
<p>Contents:</p>
5353
<div class="toctree-wrapper compound">
5454
<ul>
@@ -71,6 +71,8 @@ <h1>Welcome to SEXTANTE for QGIS&#8217;s documentation!<a class="headerlink" hre
7171
<li class="toctree-l2"><a class="reference internal" href="modeler.html#definition-of-inputs">Definition of inputs</a></li>
7272
<li class="toctree-l2"><a class="reference internal" href="modeler.html#definition-of-the-workflow">Definition of the workflow</a></li>
7373
<li class="toctree-l2"><a class="reference internal" href="modeler.html#saving-and-loading-models">Saving and loading models</a></li>
74+
<li class="toctree-l2"><a class="reference internal" href="modeler.html#editing-a-model">Editing a model</a></li>
75+
<li class="toctree-l2"><a class="reference internal" href="modeler.html#activating-and-deactivating-algorithms">Activating and deactivating algorithms</a></li>
7476
<li class="toctree-l2"><a class="reference internal" href="modeler.html#editing-model-help-files-and-meta-information">Editing model help files and meta-information</a></li>
7577
<li class="toctree-l2"><a class="reference internal" href="modeler.html#about-available-algorithms">About available algorithms</a></li>
7678
<li class="toctree-l2"><a class="reference internal" href="modeler.html#sextante-models-as-python-code">SEXTANTE models as Python code</a></li>
@@ -126,7 +128,7 @@ <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Pe
126128
<div class="sphinxsidebarwrapper">
127129
<h3><a href="#">Table Of Contents</a></h3>
128130
<ul>
129-
<li><a class="reference internal" href="#">Welcome to SEXTANTE for QGIS&#8217;s documentation!</a><ul>
131+
<li><a class="reference internal" href="#">SEXTANTE for QGIS&#8217;s documentation</a><ul>
130132
</ul>
131133
</li>
132134
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>

src/sextante/help/intro.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
<script type="text/javascript" src="_static/doctools.js"></script>
2828
<link rel="top" title="SEXTANTE for QGIS 1.0 documentation" href="index.html" />
2929
<link rel="next" title="The SEXTANTE toolbox" href="toolbox.html" />
30-
<link rel="prev" title="Welcome to SEXTANTE for QGIS’s documentation!" href="index.html" />
30+
<link rel="prev" title="SEXTANTE for QGIS’s documentation" href="index.html" />
3131
</head>
3232
<body>
3333
<div class="related">
@@ -40,7 +40,7 @@ <h3>Navigation</h3>
4040
<a href="toolbox.html" title="The SEXTANTE toolbox"
4141
accesskey="N">next</a> |</li>
4242
<li class="right" >
43-
<a href="index.html" title="Welcome to SEXTANTE for QGIS’s documentation!"
43+
<a href="index.html" title="SEXTANTE for QGIS’s documentation"
4444
accesskey="P">previous</a> |</li>
4545
<li><a href="index.html">SEXTANTE for QGIS 1.0 documentation</a> &raquo;</li>
4646
</ul>
@@ -62,11 +62,11 @@ <h1>Introduction<a class="headerlink" href="#introduction" title="Permalink to t
6262
<div class="section" id="basic-elements-of-the-sextante-gui">
6363
<h2>Basic elements of the SEXTANTE GUI<a class="headerlink" href="#basic-elements-of-the-sextante-gui" title="Permalink to this headline"></a></h2>
6464
<p>There are four basic elements in the SEXTANTE GUI, which are used to run
65-
SEXTANTE algorithms for different purposes. Chosing one tool or another
65+
SEXTANTE algorithms for different purposes. Choosing one tool or another
6666
will depend on the kind of analysis that is to be performed and the
6767
particular characteristics of each user and project. All of them (except
6868
for the batch processing interface, which is called from the toolbox, as
69-
we will see) can be accesed from the <em>SEXTANTE</em> menu item (you will see
69+
we will see) can be accessed from the <em>SEXTANTE</em> menu item (you will see
7070
more than four entries. The remaining ones are not used to execute
7171
algorithms and will be explained later in this chapter).</p>
7272
<ul>
@@ -120,7 +120,7 @@ <h3><a href="index.html">Table Of Contents</a></h3>
120120

121121
<h4>Previous topic</h4>
122122
<p class="topless"><a href="index.html"
123-
title="previous chapter">Welcome to SEXTANTE for QGIS&#8217;s documentation!</a></p>
123+
title="previous chapter">SEXTANTE for QGIS&#8217;s documentation</a></p>
124124
<h4>Next topic</h4>
125125
<p class="topless"><a href="toolbox.html"
126126
title="next chapter">The SEXTANTE toolbox</a></p>
@@ -156,7 +156,7 @@ <h3>Navigation</h3>
156156
<a href="toolbox.html" title="The SEXTANTE toolbox"
157157
>next</a> |</li>
158158
<li class="right" >
159-
<a href="index.html" title="Welcome to SEXTANTE for QGIS’s documentation!"
159+
<a href="index.html" title="SEXTANTE for QGIS’s documentation"
160160
>previous</a> |</li>
161161
<li><a href="index.html">SEXTANTE for QGIS 1.0 documentation</a> &raquo;</li>
162162
</ul>

0 commit comments

Comments
 (0)