Навигация:  Справочная информация > Переменные и условный вывод >

Условный вывод

Печать этого раздела Предыдущая страницаВернуться к краткому обзору главыСледующая страница

Help & Manual поддерживает многократные уровни условного вывода, которые дают Вам очень точное управление по тому, что включено в ваш компилируемый вывод, на основе выходного формата и определяемых пользователем условий вывода. Эти особенности позволяют генерировать разные версии вашего проекта в разных целях и выходных форматах. Вы можете управлять включением или исключением всего, от отдельных слов (или даже одной буквы) до целых разделов и переходов Содержания.

Например, если Вы выведете ваш проект и в Справку HTML, и в PDF, то Вы вообще будете должны сделать некоторые маленькие изменения в тексте для версии PDF, потому что некоторые вещи, которые являются уместными только в электронной справке, не имеют смысла в PDF или печатном руководстве. С условным выводом Вы можете включить обе версии в тот же проект, и только уместные компоненты будут включены, когда Вы компилируете.

Как работает условный вывод:

Вместо того, чтобы создавать и поддерживать многократные версии вашего проекта для разных версий Вы имеете только один проект, содержащий все дополнительные версии вашего вывода. Главы, разделы и содержимое раздела (текст, графика, таблицы и т.д.) для дополнительных версий "отмечены" условиями, названными, "включенные опции" (также известные, как условия сборки), которые управляют, включены они в вывод или нет.

Включенные опции на основе формата:

Например, предположите, что Вы имеете две разных версии предложения, одно для версии Справки HTML и одно для версии PDF. Вы включили бы первую версию в условный текстовый тэг IF_CHM, и вторую в тэг IF_PDF. И это - все, что Вы должны сделать, все остальное автоматически. Когда Вы компилируете а Справка HTML, только версия IF_CHM будет включена, и когда Вы компилируете в PDF, только версия IF_PDF будет включена.

Определяемый пользователем включенные опции:

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

Например, предположите, что Вы определили включенную опцию по имени BETABUILD и отметили определенные отрезки текств и разделы в вашем проекте условием IF_BETABUILD. Чтобы включить эти отрезки в ваш вывод, Вы просто выбираете включенную опцию BETABUILD в диалоге Создать и запустить файл справки, когда Вы компилируете, наряду с любыми другими уместными опциями.

Как указывает имя BETABUILD, Вы можете использовать эту особенность, чтобы генерировать разные версии вашего проекта в разных целях или контекстах. Например, Вы можете генерировать одну версию для версии lite вашего продукта, и другую версию для pro версии, все из того же проекта.

Условный вывод и ссылки

Так же, как, когда Вы работаете с модульными проектами, важно планировать ваши ссылки, когда Вы работаете с условным выводом. В модульных проектах Help & Manual нельзя проверить, будет ли ссылка к разделу в другом проекте работать или нет, потому что нет никакого способа узнать, будет ли внешний проект присутствовать во время выполнения.

Другая ситуация в условном выводе. Когда Вы исключаете раздел, Help & Manual проверяет все ссылки к разделу прежде, чем фактически исключить его. Если есть ссылки к разделу из других разделов в вашем проекте, ссылки терпели бы неудачу, если бы раздел был исключен, таким образом Help & Manual не будет исключать его.

Перед исключением раздела всегда щелкните правой кнопкой мыши на его входе Содержания и выберите Найти относящиеся, чтобы удостовериться, что его исключение не будет создавать никаких мертвых ссылок. Если это будет, раздел не будет исключен из компилируемого вывода.

Уровни условного вывода, поддержанные Help & Manual:

Условный текст:

На текстовом уровне Вы можете использовать условные текстовые тэги, чтобы отметить секции в ваших разделах -  параграфы, графику, предложения и даже отдельные слова и символы - которые должны быть включены, только когда выполнено определенное условие (выходного формата или определяемое пользователем).

Текстовые переменные:

Текстовые переменные (см. Использование переменных) позволяют Вам использовать переменные как текстовые элементы. Тода, если элемент изменяется, Вы должны переопределить только переменную, чтобы осуществить изменение всюду по всему вашему проекту.

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

Условия раздела:

Эти условия позволяют Вам включать или исключать все разделы и главы на основе выходного формата или определяемых пользователем условий.

Модульные проекты:

Особенности модульных проектов Help & Manual дают Вам возможность включить или исключать все проекты в вашей справке во времени компиляции. Это позволяет быстро добавить или удалить все блоки с многократными главами

Условия HTML:

Вы можете также использовать некоторые специальные условные переключатели в шаблонах HTML, чтобы управлять, когда код в шаблоне должен быть включен или исключен.

См. также:

Условия и настроенный вывод

Использование переменных

Работа с модульными системами справки

Условный вывод в шаблонах HTML