Conventions used in this documentation

There are many different organizational and typographical features throughout this documentation designed to help you get the most out of the material. You will find number of styles of text that distinguish between different kinds of information. Here are some types of headings, examples of typographical conventions, styles and an explanation of their meaning.

Styles of text

Example

*Italic*
**Bold**
:superscript:`superscript`
:subscript:`subscript`
``Code text``

Italic indicates mainly important or key terms, URLs or email addresses.

Bold shows new terms and other text indicating that we wish to draw your attention.

Other roles like ^superscript and _subscript text are displayed in this way.

Code text represents code, commands, options, switches, variables, attributes, keys, functions, types, classes, namespaces, methods, modules, properties, parameters, values, directories, objects, events, event handlers, tags, macros, the contents of files, or the output from commands.

More comprehensive parts are written in blocks as follows:

some numbered python code
if re.match(r'^\d{3}-\d{4}$', test_string):
some numbered python code highlighted
some numbered python code

Shell commands beginning with $ (dollar) should be run in command window.

$ some shell script code
$ if ! [ $MAX_NO -ge 5 -a $MAX_NO -le 9 ] ; then
$ some shell script code

<various code block>

Example

:command:`some command`
:guilabel:`Guilabel`
:menuselection:`First step --> Second step`
:file:`file.svg`
`GIS.lab project page <http://gislab-npo.github.io/gislab/>`_
:numref:`some-figure-t`
:ref:`Conventions <conventions>`

General commands are written as some command, guilabel as Guilabel, direction through a menu is displayed as First step ‣ Second step, name of file is represented by file.svg. For usage of footnotes, see [1], external hyperlinks are represented as GIS.lab web page, for reference to some picture, see Fig. 37, Fig. 38, Fig. 39 and Fig. 40, for reference to some part of page, see Conventions.

Example of useful term

description …

Example of useful command

description …

Short paragraphs

Tip

This signifies a tip, suggestion, or general useful note.

Attention

This style indicates a warning or caution.

Note

This is note.

Important

This represents something important.

Danger

This style indicates a warning or caution.

See also

This note leads the user to another material that is on the similar level of scope.

Todo

This signifies some issue to be done next time.

Types of Headings

For style of chapter names, please see chapter name above, for example of section, see subsection above, others are shown below.

Subsection

Subsubsection

Paragraph

Part

Paragraph heading

etc.

Example

.. _some-figure-t:

.. figure:: ../img/login_text_logo.svg
   :align: center
   :width: 150

   GIS.lab unit tiny.

Figures

Fig. 37 GIS.lab unit tiny.

Fig. 38 GIS.lab unit small.

Fig. 39 GIS.lab unit middle.

Fig. 40 GIS.lab unit large.

Tables

Table 1 Table with GIS.lab contributors.

Contributors to GIS.lab documentation	Country
Ludmila Furtkevicova	Slovakia
Ivan Mincik	Slovakia
Martin Landa	Czech republic
…	…

Sidebars, lists and quote-like blocks

Some Sidebar

vagrant up

.. sidebar:: Some Sidebar

   ``vagrant up``

Example of lists:

#. numbered list

  #. nested numbered list

* bulleted list

  * nested bulleted list

1. numbered list

1. nested numbered list

• bulleted list

  • nested bulleted list

Columns

Example of three columns is shown below.

A B C D

E F G H

I J K L

Footnotes

[1]

Some footnote.

See also

Coding conventions.