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¶
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:
1some numbered python code
2if re.match(r'^\d{3}-\d{4}$', test_string):
3some numbered python code highlighted
4some 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>
General commands are written as some command, guilabel as
Guilabel, direction through a menu is displayed as
, 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¶
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.
Figures¶
Tables¶
Contributors to GIS.lab documentation |
Country |
---|---|
Ludmila Furtkevicova |
Slovakia |
Ivan Mincik |
Slovakia |
Martin Landa |
Czech republic |
… |
… |
Columns¶
Example of three columns is shown below.
|
|
|
Footnotes¶
See also