Merge pull request #15 from gpetit/update_db_connexion

Update db connexion and others
orbisgis · Mar 3, 2017 · 9ef4d23 · 9ef4d23
2 parents e12d358 + 059924e
commit 9ef4d23
Show file tree

Hide file tree

Showing 21 changed files with 1,071 additions and 59 deletions.
diff --git a/docs/_images/add_wksp.png b/docs/_images/add_wksp.png
diff --git a/docs/_images/db_tree_detail.png b/docs/_images/db_tree_detail.png
diff --git a/docs/_images/db_tree_detail.svg b/docs/_images/db_tree_detail.svg
diff --git a/docs/_images/db_tree_detail_source.png b/docs/_images/db_tree_detail_source.png
diff --git a/docs/_images/drag_and_drop.gif b/docs/_images/drag_and_drop.gif
diff --git a/docs/_images/execute_selection.png b/docs/_images/execute_selection.png
diff --git a/docs/_images/folder_add_wksp.png b/docs/_images/folder_add_wksp.png
diff --git a/docs/_images/og_ubuntu_menu.png b/docs/_images/og_ubuntu_menu.png
diff --git a/docs/_images/orbisgis_main_components (copie).png b/docs/_images/orbisgis_main_components (copie).png
diff --git a/docs/_images/sql_console.png b/docs/_images/sql_console.png
diff --git a/docs/_images/wksp_customize_db.png b/docs/_images/wksp_customize_db.png
diff --git a/docs/_images/wksp_db_parameters.png b/docs/_images/wksp_db_parameters.png
diff --git a/docs/_images/wksp_db_postgis.png b/docs/_images/wksp_db_postgis.png
diff --git a/docs/_images/wksp_manager.png b/docs/_images/wksp_manager.png
diff --git a/docs/_images/wksp_set_default.png b/docs/_images/wksp_set_default.png
diff --git a/docs/index.rst b/docs/index.rst
@@ -38,6 +38,7 @@ In this part, we present the basis of OrbisGIS (how to launch, to discover and t
    users/components
    users/quickstart
    users/attributes
+   users/sql_console
    users/groovy_with_sql
 
 

diff --git a/docs/users/attributes.rst b/docs/users/attributes.rst
@@ -13,7 +13,7 @@ A new tab appears in the UI with all the attributes.
 
 .. image:: ../_images/link_table_map.png
               :alt: Open attributes table
-
+              :align: center
 
 **Remarks**
 

diff --git a/docs/users/components.rst b/docs/users/components.rst
@@ -1,19 +1,24 @@
+.. _main_components:
+
 Main Components 
-===============
+===========
 
-Here is a list of the main components of OrbisGIS. Except for the map, these components can be: 
+Here is a list of the main components of OrbisGIS. Except for the map, all these components are consider by OrbisGIS as plugins. So they can be: 
 
 - made visible or not *(just close the component to hide it)*,
 - resized *(using the cursor of your mouse)*, 
 - moved *(drag & drop the component to a new place in the UI)*,
-- (un)docked *(pretty useful if you have a dual screen)*.
-
+- (un)docked *(pretty useful if you have a dual screen)*,
+- (un)installed *(thanks the plugin manager)*.
 
 .. image:: ../_images/orbisgis_main_components.png
               :alt: OrbisGIS main components
+              :align: center
+
+To load a component, check the list in the "Windows" menu *(in red in the illustration above)* or the "Tools" menu *(for the SQL Console)*.
 
-To load a component, check the list in the "Windows" menu *(in red in the illustration above)*.
 
+.. _geocatalog:
 
 Geocatalog
 ---------------
@@ -30,7 +35,6 @@ The Geocatalog ( |GeoCatalog| ) is the place where datasources are managed. Thro
 
 
 
-
 .. |GeoCatalog| image:: ../_images/geocatalog.png
               :alt: Geocatalog icon
 	      :width: 16 pt
@@ -61,16 +65,19 @@ The Geocatalog ( |GeoCatalog| ) is the place where datasources are managed. Thro
 
 
 Map
----------------
+-------
 
 The map ( |Map| ) is the place where geographic informations (vector or raster) are displayed. The user can navigate into the map (using zoom or pan tools), select and get informations on objects.
 
 .. |Map| image:: ../_images/map.png
               :alt: Map icon
 	      :width: 16 pt
 
+
+.. _toc:
+
 TOC
----------------
+------
 
 TOC ( |TOC| ) stands for "Table Of Content". This component allows the user to:
 
@@ -130,7 +137,12 @@ Moreover, several features are available via a right-click:
 DB Tree
 ---------------
 
-The DB Tree ( |DBTree| ) is a tree representation of all the layers loaded in OrbisGIS. Layers *(tables)* are listed into their respectives folder *(views)*.
+The DB Tree ( |DBTree| ) is a tree representation of all the layers loaded in OrbisGIS. Layers *(tables)* are listed into their respectives folder *(schema)*.
+
+.. image:: ../_images/db_tree_detail.png
+              :alt: DB tree detail
+              :align: center
+
 Specific options allows the user to:
 
 - Create spatial index (|GeoIndex| ),
@@ -151,49 +163,25 @@ Specific options allows the user to:
 
 
 Output console
----------------
+--------------------
 
 The output ( |Output| ) console is the place where all messages (informations, warnings or errors) are displayed.
 
+Logs can be copy and paste into a text editor.
+
 .. |Output| image:: ../_images/output.png
               :alt: Output icon
 	      :width: 16 pt
 
 
 SQL console
----------------
-
-The SQL console ( |SQLConsole| ) is the place where the user can execute SQL scripts. This component can be considered as a text editor. The user is able to:
-
-- Write & execute ( |SQLExecute| ) instructions,
-- Load & Save .sql files,
-- Search (spatial) SQL functions and operators into a predetermined list ( |SQLfunctions| ),
-- Search & Replace words *(with advanced options)* ( |Search| ),
-- Share SQL instructions via email *(need a specific plugin)*,
-- To auto-complete instructions *(see more below)*.
-
-**Auto-completion**
-
-To use the auto-completion, just press "Ctrl + Space". For example, if you write “sel” and then press “Ctrl + Space”, OrbisGIS will recognize that you want to write “SELECT”. In the same spirit, if you start writing the name of a function, a table or field, a dropdown list will appear on the right to offer you the corresponding elements.
+----------------
 
-See an illustration video_.
+The SQL console ( |SQLConsole| ) is the place where the user can process data thanks to SQL scripts. To know more about this component, read ":ref:`sql_console`".
 
-.. _video: https://www.youtube.com/watch?v=neFpyo2qaAI
-
-N.B: This component is available through the "Tools" menu.
 
 .. |SQLConsole| image:: ../_images/sql_code.png
               :alt: SQL Console icon
 	      :width: 16 pt
 
-.. |SQLExecute| image:: ../_images/execute.png
-              :alt: Execute SQL instruction icon
-	      :width: 16 pt
 
-.. |SQLfunctions| image:: ../_images/builtinfunctionmap.png
-              :alt: SQL functions icon
-	      :width: 16 pt
-
-.. |Search| image:: ../_images/find.png
-              :alt: Search icon
-	      :width: 16 pt
diff --git a/docs/users/install.rst b/docs/users/install.rst
@@ -1,9 +1,9 @@
 Installation
-============
+=======
 
 
 Requierement
----------------
+-------------------
 
 Before using OrbisGIS, you must ensure that you are running at least the **JAVA 7** virtual machine (openJDK_ or Oracle_).
 
@@ -12,22 +12,23 @@ Before using OrbisGIS, you must ensure that you are running at least the **JAVA
 
 
 Download
----------------
+--------------
 
 To download OrbisGIS, just consult the official website here_.
 
 .. _here: http://www.orbisgis.org/index.html#download
 
 Execute
----------------
+------------
 
-OrbisGIS is a standalone application. It means that no installation is needed. In addition, it also means that you can play with OrbisGIS without any "administrator" rule !
+OrbisGIS is a standalone application. It means that, if you want (see `Ubuntu PPA repository`_), no installation is needed. In addition, it also means that you can play with OrbisGIS without any "administrator" rule !
 
 
 Once the orbisgis-bin.zip file downloaded, just unzip the file.
 
 .. image:: ../_images/install_zip.png
               :alt: Zip folder
+              :align: center
 
 In this folder, you can just focus on:
 
@@ -56,7 +57,7 @@ To launch OrbisGIS, you have the choice between:
 
 
 Run the .sh file
-----------------
+--------------------
 
 To run the .sh file *(in Linux and iOS)* in command line, just follow these two steps:
 
@@ -69,6 +70,7 @@ To run the .sh file *(in Linux and iOS)* in command line, just follow these two
 
 .. image:: ../_images/execute_terminal.png
               :alt: Execution terminal
+              :align: center
 
 Note: You must have the rights to run this file. To do this, you can use the following command: 
 
@@ -77,3 +79,30 @@ Note: You must have the rights to run this file. To do this, you can use the fol
 	chmod ug+x ./orbisgis.sh
 
 ... and your file will be executable.
+
+
+
+Ubuntu PPA repository
+-----------------------------
+
+If you are using Ubuntu (or a Debian like distribution) you also have the possibily to connect to our PPA repository, available here : https://launchpad.net/~orbisgis/+archive/ubuntu/orbisgis-unstable
+
+To add this repository and to install OrbisGIS (snapshot version), just execute the following command lines:
+
+.. code-block:: bash
+
+	sudo add-apt-repository ppa:orbisgis/orbisgis-unstable
+	sudo apt-get update
+	sudo apt-get install orbisgis
+
+Once done, you can launch OrbisGIS thanks to the shortcut in the "Applications/Education" menu
+
+.. image:: ../_images/og_ubuntu_menu.png
+              :alt: OrbisGIS menu in Ubuntu
+              :align: center
+
+or enter the following command in the terminal:
+
+.. code-block:: bash
+
+	orbisgis