iframe-proxy | Sunbelt Computer Software

245 lines (232 loc) · 8.16 KB
Help strings used in the plugin:
    htmlhelp: HTML for the Help tab - deprecated; help now displayed in browser
    htmlabout: HTML for the About tab
def htmlhelp():
    Return the html used to populate the Help tab.
    return """<html>
    <h2>Script Runner Help</h2>
    <i>Run it like you own it</i>
    <a href="#design">Design Options</a><br>
    <a href="#requirements">Requirements for Your Script</a><br>
    <a href="#working_with_scripts">Working with Scripts</a><br>
    <a href="#editing_a_script">Editing a Script</a><br>
    <a href="#passing_arguments">Passing Arguments</a></br>
    <a name="design"/>
    The Script Runner allows you to execute a script in QGIS to automate
    a task. The script can use two approaches to access the QGIS API:
    <li>Use the qgis.utils.iface object</li>
    <li>Import qgis.core and qgis.gui</li>
    In the first method, you are limited to to only those methods supported
    by the QgisInterface class. In the second you have full access to the
    PyQGIS API.
    <a name="requirements"/>
    <h4>Requirements</h4>
    In order for Script Runner to execute your script you must define a
    <em>run_script</em> function that accepts a single argument.
    This is the standard entry point used by Script Runner. A reference to
    the qgis.utils.iface object will be passed to your
    <em>run_script</em> function.
    You don't have to use the iface object in your script but your
    <em>run_script</em> function must accept it as an argument.
   Here is an example of a simple <em>run_script</em> function:
    def run_script(iface):
        ldr = Loader(iface)
        ldr.load_shapefiles('/vmap0_shapefiles')
   In this example, the <em>run_script</em> creates an instance (ldr) of a
   class named Loader that is defined in the same source file. It then calls a
   method in the Loader class named load_shapefiles to do something useful---in
   this case, load all the shapefiles in a specified directory.
   Alternatively, you could choose not to use classes and just do everything
   within the <em>run_script</em> function, including having it call functions
   in the same script or others you might import. The important thing is to be
   sure you have defined a <em>run_script</em> function. If not, Script Runner
   won't load your script.
   <a name="working_with_scripts"/>
   <h4>Working with Scripts</h4>
   To run a script, you must add it to Script Runner using the <em>Add
   Script</em> tool on the toolbar. This will add it to a list in the left
   panel. This list of scripts is persisted between uses of QGIS. You can
   remove a script using the <em>Remove Script</em> tool. This just removes it
   from the list; it does nothing to the script file on disk.
   Once you have a script loaded, you can click the <em>Script Info</em> tool
   to populate the Info and Source tabs in the panel on the right. The Info tab
   contains the docstring from your module and then a list of the classes,
   methods, and functions found in the script. Having a proper docstring at the
   head of your script will help you determine the puprose of script.  </p>
   You can view the source of the script on the Source tab. This allows you
   to quickly confirm that you are using the right script and it does what you
   think it will.
   <a name="editing_a_script"/>
   <h4>Editing a Script</h4>
   The context menu (right-click on a script) has an <em>Edit script in external
   editor</em> option---this will open the script in the default system
   editor used for Python source files. If you wish to use a different editor,
   you can enter the full path to the editor on the Preferences dialog.
   This feature allows you to quickly make edits to your script during
   development. Once edited, be sure to click the *Reload* button to pull in
   the new version. You can leave the script open in your editor during the
   edit->reload->run cycle.
   <a name="passing_arguments"/>
   <h4>Passing Arguments</h4>
   You can pass one or more arguments to your script. Your <em>run_script</em>
   function must include an argument preceded by <tt>**</tt>:
    def run_script(iface, **args):
   To run the script, click the <em>Run script with arguments</em> button  and
   enter the arguments in the form: key=value.
   For example, if your script needs the path to a raster, you would enter the
   argument as:
   path='/data/myraster.tif'
   In your <em>run_script</em> function you then access the path using:
   args['path']
   Arguments can be either numeric or string. Arguments are separated by commas
   and all strings must be quoted. For example:
   buffer_size=100, path='/data/myvectors.shp'
    </body>
    </html>"""
def htmlabout():
    Return the html used to populate the About tab.
    return """<html>
    <h3>Script Runner - Version 2.0.1</h3>
    Script Runner lets you run Python scripts in QGIS to automate and perform
    repetitive tasks.
    Author: Gary Sherman, Copyright &copy; 2012-2013 GeoApt LLC</p>
    <a href="mailto:gsherman@geoapt.com?Subject=Script Runner">
    gsherman@geoapt.com</>
    Repository: <a href="https://github.com/g-sherman/Script-Runner">
    https://github.com/g-sherman/Script-Runner</a>
    Bug Tracker: <a href="http://hub.qgis.org/projects/scriptrunner">
    http://hub.qgis.org/projects/scriptrunner</a>
    Please report issues and feature requests using the Bug Tracker.
    <h4>Credits</h4>
    <li>Syntax highlighting taken from:
    <a href="http://diotavelli.net/PyQtWiki/Python%20syntax%20highlighting">
    http://diotavelli.net/PyQtWiki/Python%20syntax%20highlighting</a>
    "Based on existing work by Carson Farmer and Christophe Kibleur, and an
    example on the SciPres wiki."</li>
       <h4>Changelog</h4>
       <ul>
       <li>2.0.1</li>
       <ul>
       <li>New icons and bug fixes</li>
       </ul>
       </ul>
       <ul>
       <li>1.991</li>
       <ul>
       <li>Fix minor error when fetching the list of loaded scripts</li>
       </ul>
       </ul>
       <ul>
       <li>1.99</li>
       <ul>
       <li>Fix issues with scripts that are moved, renamed or deleted</li>
       <li>Allow creation of a starter script by typing in a file name when adding a script</li>
       <li>List of scripts is now sorted</li>
       <li>Warning messages displayed in red in the console</li>
       </ul>
       </ul>
       <ul>
       <li>0.8</li>
       <ul>
       <li>Changes to work with the 2.0 API. No new features are implemented
       in this version.</li>
       </ul>
       </ul>
       <ul>
       <li>0.71</li>
       <ul>
       <li>For mandatory arguments, prompt by name</li>
       <li>A single run button is now used to run scripts with or without arguments</li>
       <li>Fixed bug that prevented syntax highlighting from working when
       reloading a script</li>
       <li>Updated documentation</li>
       <li>Moved help from tab to button that opens Sphinx doc in browser</li>
       </ul>
       </ul>
       <ul>
       <li>0.6</li>
       <ul>
       <li>Script output is logged to the Script Runner window<li>
       <li>Script output can be logged to disk</li>
       <li>Preferences dialog allows control of output and logging options</li>
       <li>Exceptions in scripts are displayed without interfering with
       console/logging output</li>
       <li>Context menu (right-click) to access script functions</li>
       <li>Edit script function uses system default editor or one you specify
       in preferences</li>
       <li>
       <li>Arguments can be passed to a script using keyword arguments</li>
       </ul>
       <li>0.5</li>
       <ul>
       <li>Double-click on script to show info/source</li>
       <li>Fix problem with info under master (issue #5034)</li>
       </ul>
    </body>
    </html>"""
Sunbelt Computer Software

PL/B Language Development and Support

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Sunbelt Computer Software

PL/B Language Development and Support

FilesExpand file tree

scriptrunner_help.py

Latest commit

History

scriptrunner_help.py

File metadata and controls
