.. _label_conventions:

***********
Conventions
***********

.. only:: html

   .. contents::
      :local:

This section describes the uniform styles that will be used throughout
this manual.

GUI Conventions
---------------

The GUI convention styles are intended to mimic the appearance of the
GUI. In general, a style will reflect the non-hover appearance, so a
user can visually scan the GUI to find something that looks like the
instruction in the manual.

* Menu Options: :menuselection:`Layer --> Add a Raster Layer` or
  :menuselection:`Settings --> Toolbars --> Digitizing`
* Tool: |addRasterLayer| :sup:`Add a Raster Layer`
* Button : :guilabel:`Save as Default`
* Dialog Box Title: :guilabel:`Layer Properties`
* Tab: :guilabel:`General`
* Checkbox: |checkbox| :guilabel:`Render`
* Radio Button: |radioButtonOn| :guilabel:`Postgis SRID`
  |radioButtonOff| :guilabel:`EPSG ID`
* Select a number: |selectNumber|
* Select a string: |selectString|
* Browse for a file: :guilabel:`...`
* Select a color: |selectColor|
* Slider: |slider|
* Input Text: |inputText|

.. * Toolbox : \toolboxtwo{nviz}{nviz - Open 3D-View in NVIZ}

A shadow indicates a clickable GUI component.

Text or Keyboard Conventions
----------------------------

This manual also includes styles related to text, keyboard commands
and coding to indicate different entities, such as classes or
methods. These styles do not correspond to the actual appearance of
any text or coding within QGIS.

.. Use for all urls. Otherwise, it is not clickable in the document.

* Hyperlinks: https://qgis.org
* Keystroke Combinations: Press :kbd:`Ctrl+B`, meaning press and hold the Ctrl
  key and then press the B key.
* Name of a File: :file:`lakes.shp`
* Name of a Class: **NewLayer**
* Method: *classFactory*
* Server: *myhost.de*
* User Text: ``qgis --help``

.. * Single Keystroke: press \keystroke{p}
.. * Name of a Field: \fieldname{NAMES}
.. * SQL Table: \sqltable{example needed here}

Lines of code are indicated by a fixed-width font:

::

    PROJCS["NAD_1927_Albers",
      GEOGCS["GCS_North_American_1927",

Platform-specific instructions
------------------------------

GUI sequences and small amounts of text may be formatted inline: Click
|nix| |win| :menuselection:`File` |osx| :menuselection:`QGIS --> Quit
to close QGIS`. This indicates that on Linux, Unix and Windows
platforms, you should click the File menu first, then Quit, while on
macOS platforms, you should click the QGIS menu first, then Quit.

Larger amounts of text may be formatted as a list:

* |nix| Do this
* |win| Do that
* |osx| Or do that

or as paragraphs:

|nix| |osx| Do this and this and this. Then do this and this and this,
and this and this and this, and this and this and this.

|win| Do that. Then do that and that and that, and that and that and
that, and that and that and that, and that and that.

Screenshots that appear throughout the user guide have been created on
different platforms; the platform is indicated by the
platform-specific icon at the end of the figure caption.


.. Substitutions definitions - AVOID EDITING PAST THIS LINE
   This will be automatically updated by the find_set_subst.py script.
   If you need to create a new substitution manually,
   please add it also to the substitutions.txt file in the
   source folder.

.. |addRasterLayer| image:: /static/common/mActionAddRasterLayer.png
   :width: 1.5em
.. |checkbox| image:: /static/common/checkbox.png
   :width: 1.3em
.. |inputText| image:: /static/common/inputtext.png
.. |nix| image:: /static/common/nix.png
   :width: 1em
.. |osx| image:: /static/common/osx.png
   :width: 1em
.. |radioButtonOff| image:: /static/common/radiobuttonoff.png
   :width: 1.5em
.. |radioButtonOn| image:: /static/common/radiobuttonon.png
   :width: 1.5em
.. |selectColor| image:: /static/common/selectcolor.png
.. |selectNumber| image:: /static/common/selectnumber.png
   :width: 2.8em
.. |selectString| image:: /static/common/selectstring.png
   :width: 2.5em
.. |slider| image:: /static/common/slider.png
.. |win| image:: /static/common/win.png
   :width: 1em