Навигация:  Справочная информация > О шаблонах HTML

Шаблоны HTML используются, чтобы определить размещение HTML-основанных выходных форматов всего Help & Manual (Справка HTML, Броузерная справка, eBook и Справка Visual Studio). То, что Вы вводите в редакторе, определяет содержание, шаблоны определяют структуру, в которой представлено ваше содержание. Шаблоны HTML сохранены вместе с вашим проектом, во внутренней базе данных в основном .HMX проектном файле.

Те же шаблоны HTML используются для страниц раздела во всех трех форматах. В дополнение к этому есть также отдельные шаблоны для фреймов Содержания и Указателя ключевых слов, используемые в Броузерной справке, чтобы подражать пользовательскому интерфейсу средства просмотра Справки HTML.

Шаблоны HTML и типы справочного окна:

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

Что Вы можете сделать с шаблонами HTML:

Обычно Вы не должны волноваться о содержании шаблонов HTML. Вы можете установить немного основных установок в Проект > Свойства проекта > Броузерная справка, но все остальное обрабатывается программой на заднем плане. (Больше деталей относительно установок смотрите в Установки Броузерной справки в секции Справочной информации.)

Однако, если Вы знакомы с написанием кода HTML "вручную", Вы можете редактировать все шаблоны HTML непосредственно. Это дает Вам полное управление по появлению ваших разделов и позволяет изменять размещение страницы любым путем, которым Вы хотите, добавляя такие особенности, как заголовки и нижние колонтитулы, используя DHTML, объекты ActiveX и JavaScript и так далее.

Переменные:

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

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

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

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

Шаблоны HTML Help & Manual:

Есть четыре категории шаблонов HTML. Первая категория, шаблоны страницы раздела, используется для всех HTML-основанных выходных форматов (Справка HTML, Броузерная справка, eBook, Справка Visual Studio / MS Help 2.0). Другие три категории используются только для Броузерной справки.

Шаблоны страницы раздела (общие):

Шаблоны страницы раздела используются во всех HTML-основанных выходных форматах. Есть только один набор шаблонов страницы раздела, общий для всех этих форматов. К шаблонам можно обратиться во всех секциях Свойств проекта для этих форматов.

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

Эти шаблоны определяют все установки размещения для ваших страниц раздела в Справке HTML, Броузерной справке, eBook и Справке Visual Studio / MS Help 2.0. Установки в ваших определениях типов справочного окна также добавлены к шаблонам (использя динамические локальные переменные). В этих форматах шаблон страницы раздела также хранит установки, связанные с появлением окна раздела, сделанные в Проект > Свойства проекта > Окна справки.

Каждый тип справочного окна имеет собственный шаблон страницы раздела HTML, который может быть отредактирован отдельно. Это означает, что изменение типа справочного окна применяет другой шаблон страницы раздела к разделу. Заданный по умолчанию тип справочного окна, примененный автоматически ко всем разделам в Содержании - Main. Чтобы применить другой тип справочного окна к разделу, Вы должны изменить назначение в области Окно справки: в его вкладке Опции раздела. См. Использование вторичных окон для большего количества деталей относительно этого.

Шаблон Содержания (только Броузерная справка):

Расположен в секции Содержание установок Броузерной справки. Этот шаблон используется только в Броузерной справке. Он определяет появление и функциональные возможности панели Содержания, подражая средству просмотра Справки HTML настолько близко, насколько возможно.

Шаблон Указателя ключевых слов (только Броузерная справка):

Расположен в секции Указатель ключевых слов. Этот шаблон также используется только в Броузерной справке. Он определяет появление и функциональные возможности панели Указателя ключевых слов в эмуляции броузером интерфейса Справки HTML.

Шаблон Поиска по всей справке (только Броузерная справка):

Расположен в секции Полнотекстовой поиск. Этот шаблон также используется только в Броузерной справке. Он определяет появление и функциональные возможности панели Поиска в эмуляции броузером интерфейса Справки HTML. (Вывод Броузерной справки включает мощную функцию поиска по всей справке, которая использует полное индексирование для высокоскоростного поиска.)

См. также:

Окна справки

Шаблоны и вторичные окна

Выбор справочного окна