Навигация:  Справочная информация > Модульные проекты

Модульная система справки - система справки, которая состоит из нескольких проектов справки, которые могут быть отредактированы отдельно, но компилируются и выводятся, как если бы они были единственным проектом. Есть также два уровня "модульности": Авторская модульность (ваш проект состоит из нескольких модулей Help & Manual), и модульность вывода (ваши файлы справки вывода также состоят из модулей).

Авторская модульность:

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

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

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

Модульность вывода:

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

Зачем использовать модульные системы справки?

Есть множество очень серьезных оснований для того, чтобы использовать модульные системы справки:

Гибкое управление версией:

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

Многократное использование содержимого:

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

Более эффективная работа группы:

Когда Вы работаете с проектом в группе, Вы можете назначить отдельные модули на каждого члена группы. Каждый автор может тогда работать со своим собственным модулем отдельно.

Управление очень большими проектами:

Сборка ваших проектов справки из блоков делает очень большие проекты проще для обработки. Между прочим, компилирование маленьких дочерних модулей быстрее, и Вы можете проверить ваш вывод более быстро.

Главный проект и дочерние проекты:

Модульный проект состоит из главного проектна и нескольких дочерних проектов (которые могут в свою очередь быть подглавными проектами, содержащими собственные дочерние проекты).

Главный проект и дочерние проекты - обычные проекты Help & Manual. Единственная вещь, которая делает их "модульными", - способ, которым они структурированы: Дочерние проекты вставлены в Содержании главного проекта как отдельные элементы, точно тем же способом, которым Вы вставляете разделы. Но все отдельные проекты могут (и должны) быть отредактированными отдельно, когда Вы хотите изменить их содержание.

Что случается, когда Вы компилируете:

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

См. также:

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