Шаблоны страницы раздела

В этом разделе:

Шаблоны страницы раздела используются, чтобы определить размещение и поведение страниц раздела во всех HTML-основанных выходных форматах (Справка HTML , Броузерная справка, eBooks и справка Visual Studio / MS Help 2.0). Каждый тип справочного окна, который Вы определяете, имеет собственную копию заданного по умолчанию шаблона страницы раздела, который может быть отредактирован отдельно. Чтобы применить другой шаблон к разделу, Вы должны только определить новый тип окна, редактировать его шаблон и назначить тип окна на раздел. См. Использование вторичных окон для деталей.

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

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

Размещение шаблона:

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

·	Проект > Свойства проекта > Справка HTML > Страницы раздела

·	Проект > Свойства проекта > Броузерная справка > Страницы раздела

·	Проект > Свойства проекта > Справка Visual Studio > Страницы раздела

Редактирование шаблона страницы раздела:

Выберите Позволить мне редактировать HTML код для отображения кода шаблона в интегрированном редакторе HTML. Все шаблоны HTML редактируются одним и тем же образом. См. Редактирование шаблонов HTML для деталей.

Простой режим редактирования (по умолчанию):

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

В простом режиме Вы можете сделать следующие изменения в страницах HTML:

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

Вы можете ввести здесь html-тэги, чтобы форматировать текст, включая ссылки на изображения.

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

·	Файлы рисунка должны быть расположены в одной из папок, перечисленных в ваших установках Папок рисунков в Свойства проекта > Общие свойства > Папки рисунков.

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

Здесь также, Вы можете ввести html-тэги, чтобы форматировать текст, включая ссылки на изображения.

"Позволить мне редактировать код HTML"

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

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

·	Более полные детали относительно всех установок в этой секции смотрите в Страницы раздела в секции Броузерная справка в главе Свойства проекта.

·	Для инструкций при редактировании шаблонов HTML см. Редактирование шаблонов HTML.

Структура шаблонов страницы раздела:

Содержимое раздела:

Самая важная вещь, которую нужно знать о шаблонах страницы раздела - то, что ваши конечные страницы HTML сделаны комбинацией кода шаблона с содержимым разделов, отредактированных в Help & Manual. В терминах HTML, содержимое из редактора - все между тэгами <body> и </body>, шаблон HTML предоставляет все остальное.

Содержимое вашего раздела вставляется в шаблон во время компиляции переменной <%TOPIC_TEXT%> в шаблоне. Когда Вы компилируете, создается страница HTML, заменяя эту переменную в шаблоне содержимым текущего раздела.

Создание "заголовков" и "нижних колонтитулов":

Это означает, что Вы можете создать "заголовки" и "нижние колонтитулы", редактируя шаблон HTML и добавляя материал выше и ниже переменной <%TOPIC_TEXT%>. Все выше этой переменной будет заголовком, все ниже этого будет нижним колонтитулом. Это может также быть сделано в "Простом режиме" (см. выше).

Добавление материала к заголовку раздела:

Код для заголовка раздела расположен между условными тэгами <IF_TOPIC_HEADER> и </IF_TOPIC_HEADER>. Вы можете добавить материал к заголовку на каждой странице раздела, добавляя текст, изображения-ссылки и т.д. в этом разделе.

Заданный по умолчанию шаблон страницы раздела:

См. заданный по умолчанию шаблон страницы раздела в разделе Справочная информация > Шаблоны > Шаблоны HTML о заданном по умолчанию коде шаблона и полной информации озаданном по умолчанию шаблоне.

Ссылки навигации хлебных крошек:

Переменная <%TOPIC_BREADCRUMBS%> может используются для создания навигационных ссылок к разделам выше текущего раздела в дереве Содержания. Это может быть полезным, чтобы показать пользователю, где он или она находится, даже в Указателе и Поиске на панелях справки, где Содержание не видно. (Это вообще действительно необходимо только в системах справки со многими уровнями.)

Если Вы должны создать след крошки без активных ссылок, Вы можете сделать это с переменной <%TOPIC_TITLE_PATH%>. Это - почти то же, как переменная хлебных крошек, но это не создает никаких ссылок и также включает заголовок текущего раздела. См. Переменные шаблона HTML для подробностей.

Например, если текущий раздел - Редактор в последовательности Введение > О Программе > Пользовательский интерфейс > Редактор, вставка переменной <%TOPIC_BREADCRUMBS%> создала бы такой ряд ссылок в вашем выводе (отметьте, что текущий раздел не включен):

Введение > О Программе > Пользовательский интерфейс

Ссылки активны, то есть нажатие на них приведет пользователя к разделам, на которые они ссылаются.

·	Эта особенность используется, чтобы создать ссылки хлебных крошек выше заголовков в Справке HTML и версиях броузерной справки этой справки.

Как вставлять хлебные крошки:

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

1.	Откройте шаблон раздела для Основного типа справочного окна (см. Редактирование шаблонов HTML), и определите местонахождение следующего кода:

<table width="100%" border="0" cellspacing="0" cellpadding="5">
<tr valign="top"><td align="left">
<%TOPIC_TEXT%>
</td></tr></table>

2.	Добавьте следующий код (подсвеченный синим):

<<table width="100%" border="0" cellspacing="0" cellpadding="5">
<tr valign="top"><td align="left">
<IF_TOPIC_BREADCRUMBS><p style="font-size: 8pt; margin-bottom: 15px">
<%TOPIC_BREADCRUMBS%> > <%TOPIC_TITLE%></p></IF_TOPIC_BREADCRUMBS>
<%TOPIC_TEXT%>
</td></tr></table>

·	Условие <IF_TOPIC_BREADCRUMBS> гарантирует, что след будет вставлен только там, где это уместно. (Переменная хлебных крошек пуста в разделах верхнего уровня и во всех разделах секции Невидимые разделы.)

·	Если Вы хотите, то можете также использовать <IFNOT_TOPIC_BREADCRUMBS>, чтобы вставить альтернативное содержимое, которое будет отображено в разделах верхнего уровня.

Заметьте, что заголовок текущего раздела не включен в переменную <%TOPIC_BREADCRUMBS%>, потому что это может не быть необходимо, если заголовок раздела видим непосредственно выше хлебных крошек. В нашем примере мы включили текущий заголовок раздела с переменной <%TOPIC_TITLE%>, чтобы показать, как это сделано. (Код > вставляет символ >, который может иначе быть извращен некоторыми броузерами.)

·	Больше подробностей о переменных и условиях вывода в шаблонах HTML смотрите в Переменные шаблона HTML и Условия вывода шаблона HTML.

Навигационные ссылки к родительской главе:

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

·	Это сделано с использованием новой переменной <%HREF_PARENT_CHAPTER%>.

Просто используйте эту переменную вместо переменной <%HREF_DEFAULT_PAGE%> в вашем шаблоне страницы раздела. Все появится автоматически – когда Вы компилируете, правильные ссылки будут сгенерированы автоматически к родительской главе или заданному по умолчанию разделу в зависимости от того, доступна родительская глава или нет.

См. также:

Заданный по умолчанию шаблон страницы раздела

Редактирование шаблонов HTML

Переменные шаблона HTML

Условия вывода шаблона HTML

Переменные

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

Окна справки