Оформление и обозначения

Страница показывает, как на сайте выглядят элементы текста: заголовки, списки, таблицы, код, врезки. Открывайте её, чтобы сверить оформление новой записи, и как шпаргалку по обозначениям в примерах.

Заголовки

На странице один заголовок первого уровня. Второй уровень делит текст на разделы, третий выделяет подразделы внутри них.

Заголовок третьего уровня

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

Списки

• маркированный список — для вариантов и свойств;
• обычный пункт без вложенности.

1. нумерованный список — для шагов;
2. второй шаг.

Код

Короткие имена методов и параметров пишутся прямо в строке: OpenFile, WaitPageLoaded, GetText. Если имя длинное, оно переносится, а не растягивает страницу.

program HumanEmulator;
begin
  OpenFile(path);
  WaitPageLoaded(30);
  Run;
end.

Блок кода прокручивается по горизонтали, если строка шире окна, и не ломает вёрстку на телефоне.

Таблица

Обозначение	Что значит
[имя]	параметр, который нужно заменить своим значением
…	повторяющиеся строки пропущены для краткости
→	результат действия, например клика или запуска скрипта
важно	условие, без которого пример не заработает: версия, права, формат данных

Врезки и выделения

Цитату используют для чужой формулировки: например, дословного условия с сайта или текста ошибки.

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

Ссылки

Внутренние ссылки ведут на разделы сайта: Human Emulator, Услуги, Примеры работ. Внешние ссылки открываются в новой вкладке и не передают туда адрес страницы.

Зачем это нужно

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