Обзор возможностей программы
← Назад к Обзору всех возможностей

Макропеременные

Разработчики документации часто сталкиваются с проблемой многократного использования одного и того же фрагмента текста. В таких случаях они часто прибегают к очевидным решениям - "Ctrl+C", Ctrl+V" или каждый раз вводят заново необходимую информацию.

Для того чтобы избежать "рутины" в процессе написания документации, в Dr.Explain есть функция, которая значительно повысит вашу производительность - это текстовые макропеременные. Они полезны, если вы часто используете одни и те же фрагменты текста  в своем руководстве, такие как название компании, название продукта, контактные данные и так далее. Переменные особенно полезны, когда нужно много раз писать один и тот же текст, который периодически изменяется - например, версия документируемой программы.

Как работают макропеременные

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

Если вам нужно изменить номер версии или контактный адрес электронной почты во всем проекте - обновите значение переменной в настройках проекта. Dr.Explain автоматически внесет изменения на все страницы, содержащие эту переменную в тексте.

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

Таким образом, когда вы будете работать над проектом, в редакторе у вас будут видны имена переменных, а в финальном экспорте будут подставлены их актуальные значения.

Смотрите также