Правила

Для улучшения восприятия пользователем в данном документе используются определенные правила форматирования. Используемые правила форматирования представлены ниже.

Условные обозначения Руководства пользователя

Элемент

Форма записи

Описание

Выход

Общее выделение текста

В рабочей области Программа.

Чтобы выделить определенные текстовые элементы.

Текст выделен жирным шрифтом

Элементы графического пользовательского интерфейса (ГПИ)

Нажмите кнопку Функция.

Любые отсылки к элементам, которые находятся на экране ГПИ (например, командные кнопки, имена значков и имена полей).

Текст выделен жирным шрифтом

Путь графического интерфейса пользователя (ГПИ) >

Как правило, в верхней части ГПИ.

Средство навигации, которое отслеживает местоположение ГПИ.

Например: Контроллер > Программа > Редактировать

Пользовательский ввод

Введите Описание программы.

Любой текстовый ввод, выполненный пользователем.

Текст выделен жирным шрифтом

Имена файлов

Введите Имя файла для экспорта.

Файлы, экспортированные из системы или импортированные в нее.

Текст выделен жирным наклонным шрифтом

Имена переменных и параметров

Введите Имя для экспорта.

Имена переменных и параметров (не значения).

Текст выделен наклонным шрифтом

Значения переменных и параметров

Введите ЗНАЧЕНИЕ для экспорта.

Значения переменных и параметров.

Текст выделен ЖИРНЫМИ ПРОПИСНЫМ ШРИФТОМ

Системный вывод

Client.Domain.Models.ExportImportConfiguration

Любой текстовый вывод, выполненный системой.

Текст выделен моноширным шрифтом

Внешние ссылки

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

  • Технические характеристики изделия

  • Габаритные чертежи

  • Принадлежности.

  • Особую информацию по устройству

Выбираемый текст для внешних сайтов.

Ссылки на внутреннюю документацию.

  • Требуемая информация – ссылки на информацию, которая непосредственно относится к текущей теме и которую необходимо учитывать при выполнении некоторых конфигураций.

  • В данном разделе – ссылки на все темы раздела, которые могут быть полезными для понимания функции или конфигурации.

При наличии эти ссылки будут представлены под текстом.

Выбираемый текст для внутренних сайтов.