| Соглашения по оформлению |
|
|
|
Для облегчения работы с документацией элементы, обозначающие аналогичные понятия, имеют одинаковое начертание. Ниже приведен перечень принятых условных обозначений:
|
Элемент |
Пример |
|
Клавиша |
F3 |
|
Одновременно нажать на две клавиши |
Alt+F3 |
|
Кнопка в экранной форме |
|
|
Пункт меню |
=> |
|
Конструкция языка |
<строка-формата-даты> |
Кроме того, в документе используются символы, назначение которых - привлечь особое внимание пользователя:
внимание, важная информация;
ссылка на другие документы;
полезный совет.
Примеры, содержащие исходный текст, выделяются моноширинным шрифтом на сером фоне:
Пример 1. Фрагмент исходного текста программы.
//---------------------------------------------------------
handleEvent //Обработчик событий
cmDoSomething:
Message('Hello', YesButton);
end; // handleEvent
Пример 2. Фрагмент файла конфигурации.
[Compilers] ClearResource=on