From cad477755d09bc60c06000c9a840c96082294c3e Mon Sep 17 00:00:00 2001 From: Paolo Corti Date: Tue, 10 Apr 2012 18:24:50 +0200 Subject: [PATCH] Started using rst_prolog and rst_epilog for custom rules and substitutions. Added beginning of chapter 3. --- linfiniti-sphinx-theme | 2 +- source/conf.py | 21 +++++++++++++++++++++ source/features_at_a_glance.rst | 32 ++++++++++++++++++++++++++++++++ source/getting_started.rst | 17 +++-------------- source/index.rst | 2 +- 5 files changed, 58 insertions(+), 16 deletions(-) create mode 100644 source/features_at_a_glance.rst diff --git a/linfiniti-sphinx-theme b/linfiniti-sphinx-theme index 2d18c2b..b483523 160000 --- a/linfiniti-sphinx-theme +++ b/linfiniti-sphinx-theme @@ -1 +1 @@ -Subproject commit 2d18c2b401aa2b3c4a128f9fe85471ed0d0571ce +Subproject commit b483523d50646b35a954506931b10c07b2be23bd diff --git a/source/conf.py b/source/conf.py index cb3f1db..0457e32 100644 --- a/source/conf.py +++ b/source/conf.py @@ -247,3 +247,24 @@ locale_dirs = ['translated'] +# all the custom rules will be included at the prolog of each source file +rst_prolog = """ +.. role:: cmd-txt +.. role:: button-name +.. role:: tool-name +.. role:: dialog-name +.. role:: tab-name +.. role:: radio-name +.. role:: check-name +""" + +# all the substitutions will be included at the epilog of each source file +rst_epilog = """ +.. |qg| replace:: QGIS +.. |osx| image:: images/operating_system_icons/osx.png + :height: 12 +.. |win| image:: images/operating_system_icons/win.png + :height: 12 +.. |nix| image:: images/operating_system_icons/nix.png + :height: 12 +""" diff --git a/source/features_at_a_glance.rst b/source/features_at_a_glance.rst new file mode 100644 index 0000000..e401ab9 --- /dev/null +++ b/source/features_at_a_glance.rst @@ -0,0 +1,32 @@ +.. _features_at_a_glance: + +******************************************************************************** +Features at a Glance +******************************************************************************** + +After a first and simple sample session in :ref:`Section 2 ` +we now want to give you a more detailed overview of the features of QGIS. Most +features presented in the following chapters will be explained and described in +own sections later in the manual. + +Starting and Stopping QGIS +================================================================================ + +In :ref:`Section 2.3 ` you already learned how +to start QGIS. We will repeat this here and you will see that QGIS also provides +further command line options. + +* |nix| Assuming that QGIS is installed in the PATH, you can start QGIS by + typing: qgis at a command prompt or by double clicking on the QGIS application + link (or shortcut) on the desktop or in the application menu. +* |win| Start QGIS using the Start menu or desktop shortcut, or double click on + a QGIS project file. +* |osx| Double click the icon in your Applications folder. If you need to start + QGIS in a shell, run /path-to-installation-executable/Contents/MacOS/Qgis. + +To stop QGIS, click the menu options {|nix| |win| |osx|} Quit, or use the +shortcut Ctrl+Q + + + + diff --git a/source/getting_started.rst b/source/getting_started.rst index 61e2fd8..8fa2229 100644 --- a/source/getting_started.rst +++ b/source/getting_started.rst @@ -1,10 +1,4 @@ -.. role:: cmd-txt -.. role:: button-name -.. role:: tool-name -.. role:: dialog-name -.. role:: tab-name -.. role:: radio-name -.. role:: check-name +.. _getting-started: ******************************************************************************** Getting Started @@ -98,6 +92,8 @@ a selection of sample locations (e.g. Spearfish or South Dakota) at the official GRASS GIS website http://grass.osgeo.org/download/data.php. +.. _getting-started-sample-session: + Sample Session ================================================================================ @@ -158,13 +154,6 @@ in . Let's move on to the sections that follow to learn more about the available functionality, features and settings and how to use them. -.. |qg| replace:: QGIS -.. |osx| image:: images/operating_system_icons/osx.png - :height: 12 -.. |win| image:: images/operating_system_icons/win.png - :height: 12 -.. |nix| image:: images/operating_system_icons/nix.png - :height: 12 .. |mActionAddRasterLayer| image:: images/images/mActionAddRasterLayer.png .. |mActionAddOgrLayer| image:: images/images/mActionAddOgrLayer.png diff --git a/source/index.rst b/source/index.rst index ff07819..edadf01 100644 --- a/source/index.rst +++ b/source/index.rst @@ -13,7 +13,7 @@ Contents: introduction getting_started - + features_at_a_glance Indices and tables ==================