2.2.1 Аннотация

Аннотация (если присутствует) должна предшествовать содержанию или первому заголовку статьи. Аннотация должна представлять краткий текст из нескольких предложений, который бы давал представление о теме нижеследующей статьи. Допускается в конце аннотации приводить список ключевых слов.

Аннотация должна быть оформлена как обычный текст, без отступов.

2.2.2 Содержание

Если статья большая и объёмная, то она как правило должна быть разбита на разделы. Если число разделов/подразделов больше 3х, то имеет смысл давать содержание. Содержание генерируется автоматически. Для вставки содержания необходимо использовать специальную директиву:

.. Содержание::

2.3.1 Заголовки

Текст статьи может разбиваться на ряд разделов/подразделов. Заголовок каждого раздела выделяется подчёркиванием в нижеследующей строке. Для заголовков разных уровней используются различные виды подчёркиваний. Рекомендуется ограничиваться использованием трёх уровней заголовков.

Заголовки могут иметь нумерацию. Нумерация должна начинаться с цифры 1. Каждый уровень заголовков имеет нумерацию из нескольких цифр, количество которых соответствует уровню заголовка. Цифры в номере заголовка разделяются точками, после последней цифры точка не ставится. Между номером заголовка и текстом заголовка должен быть пробел. Приложения (если таковые имеются) следует нумеровать, добавляя букву П в начале.

Пример оформления:

1 Заголовок А
=============

1.1 Заголовок Б
---------------
текст

1.1.1 Заголовок В
*****************
текст

1.2 Заголовок Д
---------------
текст

2.3.2 Логическое и смысловое выделение текста

Для того, чтобы акцентировать внимание на отдельные слова в тексте, используется два вида выделений: выделение текста и ударение.

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

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

Выделенный текст в формате ReStructuredText оформляется при помощи обрамления в виде "звёздочек":

*выделение*

**ударение**

2.3.3 Вставка рисунков

Для вставки рисунков используется директива image:

.. image::

Подробнее — см. в документации к Docutils.

2.3.4 Текст с отступом

Для вставки длинных цитат, примечаний и комментариев к основному тексту целесообразно использовать отступы:

основной текст

        длинный многострочный комментарий

снова основной текст

2.3.5 Списки (перечисления)

Для вставки в текст различного рода списков (нумерованных и ненумерованных) используются либо маркеры, либо обычный пронумерованный список. Каждый элемент должен начинаться с новой строки. Если текст одного элемента не умещается на одной строке и переносится на следующую, то он должен иметь небольшой отступ, чтобы совпадать с началом текста на предыдущей строке.

Пример ненумерованного списка:

* первый элемент;
* второй элемент, многострочный.
  Вторая строка второго элемента;
* третий элемент.

Пример нумерованного списка:

1) апельсин;
2) арбуз;
3) ананас.

При записи списков рекомендуется каждый пункт, кроме последнего, заканчивать символом точка с запятой (;), последний пункт следует заканчивать точкой.

2.3.6 Моноширинный текст

Для вставки в предложения текста, который соответствует именам переменным, инструкциям ассемблера или для других аналогичных случаев, можно использовать оформление вставляемого текста при помощи моноширинного шрифта. Такие кусочки текста должны обрамляться двойными обратными кавычками:

простой текст ``моноширинный текст``

2.3.7 Примеры программ, преформатированный текст

Для вставки в текст больших участков преформатированного текста (например, примеры кода программ) используйте текст с отступом, который предваряет двойное двоеточие (::).

Пример программы::

        int main(void)
        {
                return 0;
        }

2.3.8 Таблицы

Для вставки таблиц могут использоваться две формы записи.

В первом случае таблица "рисуется" при помощи символов:

• - для горизонтальных линий;
• | для вертикальных линий;
• + для пересечений линий;
• = для отделения заголовка таблицы от основного тела.

Во втором случае для простых таблиц, состоящих из нескольких колонок и строк, используется форма с отделением колонок и строк друг от друга при помощи пробелов и пустых строк:

=========  =========  ============
Колонка 1  Колонка 2  Колонка 3
=========  =========  ============
Строка 1   12         34

Строка 2   56         78
=========  =========  ============

Подробнее о таблицах и других возможностях — см. справку по синтаксису ReStructuredText.