Outdated version of the documentation. Find the latest one here.

Руководство по созданию документации

Введение

Это руководство описывает общие вопросы использования rst в документации QGIS. Документация автоматически генерируется на сервере в 0, 8am, 4pm PDT (Pacific Daylight Time). Последние версии доступны на http://docs.qgis.org.

Дополнительную информацию можно найти по адресу http://sphinx.pocoo.org/markup/inline.html or или в файле convention.rst.

При создании документации для QGIS следует в общем случае придерживаться Python documentation style guide lines.

Использование заголовков

При добавлении заголовков необходимо использовать следующие стили для глав, разделов, подразделов и параграфов.

заголовки

********
Chapter
********

Section
=======

Subsection
----------

Minisec
.......

Теги

  • Комбинация клавиш:

    :kbd:`ctrl B`

    отображается как Ctrl B

  • Пункты меню

    :menuselection:`menu --> submenu`
  • Имя файла

    :file:`README.rst`
  • Кнопка со всплывающей подсказкой

    |icon| :sup:`popup_text`

    (см. image ниже).

  • Заголовки диалоговых окон и вкладок

    :guilabel:`title`
  • Пользовательский текст

    ``label``
    

Сноска

Обратите внимание: сноски не распознаются ни одним из приложений для перевода, а также неправильно конвертируются при создании pdf. Поэтому не используйте сноски при создании документации.

Для создания сноски

blabla [1]_

Которая будет указывать на:

[1]

Обновления модулей ядра

Ссылки и метки

Для создания ссылки на какой-либо фрагмент используйте

.. _my_anchor:

Label/reference
===============

Так создаётся ссылка на ту же страницу

see my_anchor_ for more information. Notice how it will jump to
the following line/thing following the 'anchor'.
Normally to declare this label you do not need to use apastroph's but
you do need to use empty lines before and after the anchor. If you use
:ref:`my_anchor` it will display the caption instead
(In this case the title of this section!)

Т.к. ссылка 1 (my_anchor) и ссылка 2 Ссылки и метки

Так как ссылки зачастую показывают полное название, нет необходимости в использовать слово «раздел»

see :ref:`my_anchor`

Рисунки и изображения

Рисунок

.. _figure_readme_1:

.. only:: html

   **Figure Readme 1:**

.. figure:: /static/common/qgislogo.png
   :width: 20 em
   :align: center

   A caption: A logo I like

Результат будет иметь вид:

Figure Readme 1:

../../_images/qgislogo.png

A caption: A logo I like

Используйте .. only:: html чтобы номер рисунка (Figure Readme 1) выводился только в HTML-файлах. При создании PDF скрипт самостоятельно вставит автоматически сгенерированный номер перед рисунком.

Чтобы создать подпись (см. My caption) просто вставьте текст с отступом после пустой строки в блоке рисунка.

Сослаться на рисунок можно двумя способами. Первый — использовать метку, как ниже

(see Figure_Readme_1_).

В результату будет показан якорь Figure_Readme_1. При необходимости можно использовать верхний регистр. Такая ссылка может использоваться в том же документе RST, и не будет работать с другими.

Подобные ссылки больше не используются, так как в HTML ссылка на подпись теряется (теперь она ссылается на место перед Figure Readme 1:)

see :ref:`figure_readme_1`, does not work due to the lost reference to
the caption of the figure, this is not a 'bug' but a choice we made!

Таблицы

простая таблица

=======  =======  =======
x        y        z
=======  =======  =======
1        2        3
2        4
=======  =======  =======

Используйте \ дополненный пробелом « » чтобы вставить пустую строку.

Также можно создавать более сложные таблицы, рисуя их специальными символами и добавляя ссылки

.. _my_drawn_table_1:

+---------------+--------------------+
| Windows       | Mac OSX            |
+---------------+--------------------+
| |win|         | |osx|              |
+---------------+--------------------+
| and of course not to forget |nix|  |
+------------------------------------+

My drawn table, mind you this is unfortunately not regarded a caption

You can reference to it like this my_drawn_table_1_.

Результат:

Windows Mac OSX
win osx

и конечно же не забывайте nix

Моя таблицы, обратите внимание, что к сожалению этот текст не рассматривается как подпись

Сослаться на таблицу можно при помощи ссылки my_drawn_table_1.

Картинки

Изображение

.. image:: /static/common/qgislogo.png
   :width: 10 em

Замена

Изображения можно вставлять в текст или создать псевдоним и использовать его везде. Чтобы исплользовать изображение внутри абзаца просто создайте где-нибудь псевдоним.

.. |nice_logo| image:: /static/common/qgislogo.png
               :width: 2 em

и используйте его в вашем тексте

my paragraph begins here with a nice logo |nice_logo|.

Вот так этот пример будет выглядеть:

здесь начинается мой текст с красивым логотипом nice_logo.

Индексы

В RST существует несколько видов индексов. Чтобы индексные указатели можно было переводить, они должны быть интегрированы в текст. Для этого используется следующий синтаксис:

QGIS allows to load several :index:`Vector formats` supported by GDAL/OGR ...

Если термин не нуждается в переводе, используйте синтаксис:

.. index:: WMS, WFS, WCS, CAT, SFS, GML, ...

Добавление новых скриншотов

Here are some hints to create new, nice looking screenshots. For the user guide they go into ./resources/en/user_manual/

  • единое окружение для всех скриншотов (одна и та же ОС, одинаковые декорации, единый размер шрифта)

  • уменьшайте окно до минимальных размеров, необходимых для отображения необходимой информации (делать снимок всего экрана ради маленького модального окна чересчур)

  • чем меньше «шума», тем лучше (не стоит активировать все панели инструментов)

  • don’t resize them in an image editor, the size will be set into the rst files if necessary (downscaling the dimensions without properly upping the resolution > ugly)
  • уберите фон

  • Set print size resolution to 135 dpi (this way, if no size is set in the rst files, images will be at original size in html and at a good print resolution in the PDF)
  • используйте формат png (отсутствие артефактов сжатия jpeg)

  • скриншот должен показывать то, что описывается в тексте

  • you can find some prepared QGIS -projects that were used before to create screenshots in ./qgis-projects. This makes it easier to reproduce screenshots for the next version of QGIS. These projects use the QGIS sample dataset which should be placed in the same folder as the QGIS-Documentation Repository.
  • Use the following command to remove the global menu function in Ubuntu to create smaller application screens with menu’s.
sudo apt-get autoremove appmenu-gtk appmenu-gtk3 appmenu-qt

Перевод скриншотов

Here are some hints to create screenshots for your translated user guide. They will go into ./resources/<your language>/user_manual/

  • единое окружение для всех скриншотов (одна и та же ОС, одинаковые декорации, единый размер шрифта)

  • use the QGIS -projects included in QGIS-Documentation repository (in ./qgis_projects ). These were used to produce the ‘original’ screenshots in the manual. The QGIS Sample dataset should be placed in the same folder as the QGIS-Documentation Repository.
  • размер должен совпадать с размером «оригинальных» скриншотов, в противном случае они будут растянуты. Если необходимо использовать другой размер из-за более длинных строк, не забудьте изменить размер в соответсвующем файле rst.

  • уменьшайте окно до минимальных размеров, необходимых для отображения необходимой информации (делать снимок всего экрана ради маленького модального окна чересчур)

  • чем меньше «шума», тем лучше (не стоит активировать все панели инструментов)

  • не меняйте размер изображений в графическом редакторе. Размер лучше задавать в файлах rst (уменьшение размеров без соответствующего увеличения разрешения дает плохой результат)

  • уберите фон

  • используйте формат png (отсутствие артефактов сжатия jpeg)

  • скриншот должен показывать то, что описывается в тексте

Documenting Processing algorithms

If you want to write documentation for Processing algorithms consider this guidelines:

  • don’t overwrite existing help files by files from other sources (e.g. QGIS source tree or Processing-Help repository), this files have different formats
  • Processing algorithm help files are part of QGIS User Guide, so use same formatting as User Guide and other documentation
  • avoid use “This algoritm does this and that...” as first sentence in algorithm description. Try to use more general words like in TauDEM or GRASS algoritms help
  • add images if needed. Use PNG format and follow general guidelines for documentation.
  • if necessary add links to additional information (e.g. publications or web-pages) to the “See also” section
  • give clear explanation for algorithm parameters and outputs (again GRASS and TauDEM are good examples).
  • don’t edit parameter or output names. If you found typo or wrong spelling — report this in bugracker, so developers can fix this in Processing code too
  • don’t list available options in algorithm description, options already listed in parameter description.
  • don’t add information vector geometry type in algorithm or parameter description without compelling reason as this information already available in parameter description