Skip to content

Commit

Permalink
Started using rst_prolog and rst_epilog for custom rules and substitu…
Browse files Browse the repository at this point in the history
…tions. Added beginning of chapter 3.
  • Loading branch information
capooti committed Apr 10, 2012
1 parent c68d14e commit cad4777
Show file tree
Hide file tree
Showing 5 changed files with 58 additions and 16 deletions.
2 changes: 1 addition & 1 deletion linfiniti-sphinx-theme
21 changes: 21 additions & 0 deletions source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
"""
32 changes: 32 additions & 0 deletions source/features_at_a_glance.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
.. _features_at_a_glance:

********************************************************************************
Features at a Glance
********************************************************************************

After a first and simple sample session in :ref:`Section 2 <getting-started>`
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 <getting-started-sample-session>` 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




17 changes: 3 additions & 14 deletions source/getting_started.rst
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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
================================================================================

Expand Down Expand Up @@ -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

2 changes: 1 addition & 1 deletion source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Contents:

introduction
getting_started

features_at_a_glance

Indices and tables
==================
Expand Down

0 comments on commit cad4777

Please sign in to comment.