При описании справочной системы приняты некоторые соглашения, касающиеся приемов описания и представления текстов.
Типографские соглашения
Формат |
Описание |
|---|---|
Полужирный текст |
Используется для имен наборов проектов, проектов и их типов, узлов, окон, приложений, команд и граф, параметров и их групп. Иногда - для смыслового выделения определяющего слова. |
Курсив |
Используется для смыслового выделения слова, для имен и расширений файлов, путей доступа к файлам, для описания горячих клавиш, для значений параметров и состояний (цветной курсив). |
<Ctrl+F5> |
Наименование "горячей" клавиши. |
Выделение текста цветом |
Используется для указания ключевых слов ссылки переходов на другие темы и разделы, а также - ключевых слов с выпадающим слоем (внутри текущего текста, без перехода в другой документ). |
Соглашения по описанию команд
Название команды отображено на баннере. Перед описанием работы команды приводится 
таблица команды с описанием доступных способов ее активизации (кнопка панели инструментов, команда контекстного меню, горячие клавиши вызова команды). Если команда не имеет кнопки, горячих клавиш и вызывается только из меню, то таблица в описании не приводится.
В таблице команды могут быть приведены следующие способы вызова (при их наличии): –вид и название кнопки панели инструментов, соответствующей команде (для быстрого доступа к команде); –описание горячих клавиш быстрого вызова команды; –команда контекстного меню (по правой клавише мыши), соответствующая данной команде. Пример 1:
Пример 2:
|
В случае единого описания однотипных команд таблица будет содержать несколько строк с приведением кнопок и названий всех описываемых команд. Кнопки команд (в случае их наличия) стандартно доступны на панели инструментов.
ОТКОС ВЫЕМКИ/НАСЫПИ
|
Описание локальной панели инструментов команды (с кнопками методов)
В тексте описания команды возможно также приведение таблицы методов ее локальной панели инструментов (находится на панели параметров) - указываются рисунки кнопок методов и их названия. Существующая ссылка на имени метода (в таблице) открывает его описание.
Методы работы вызываются кнопками локальной панели инструментов, которая находится на панели параметров.
|
Примечание В случае доступности команды в меню, а также на локальной панели инструментов (как локального метода другой команды) таблица вызова команды будет содержать и дополнительную строку с описанием этого метода.
|
