Переменная

Содержание и/или функция переменной

<%DOCTYPE%>

Вставляет правильный тэг DOCTYPE в начале страниц вывода HTML. Эта переменная является основной во всех шаблонах и не должна быть удалена. Если Вы удалите ее, то Вы получите сообщение об ошибках от компилятора.

<%DOCCHARSET%>

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

<%STYLESHEET%>

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

<%TOPIC_HEADER%>

Вставляет заголовок текущего раздела, если он существует. Если текущий раздел не имеет никакого заголовка, значение этой переменной - нуль. Это может отличаться от заголовка раздела, вставленного с <%TOPIC_TITLE%>.

<%TOPIC_HEADER_TEXT%>

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

Это используется прежде всего для оптимизации механизма поиска, для которой Вы вставили бы это в мета тэг description, как это:

<meta name="description" content="<%TOPIC_HEADER_TEXT%>">

<%TOPIC_TEXT%>

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

<%TOPIC_BREADCRUMBS%>

Генерирует ряд "ссылок навигации" следа крошки к разделам выше текущего раздела в дереве Содержания. Эта переменная пуста в разделах верхнего уровня. В разделах второго уровня и ниже переменная генерирует ряд ссылок в формате Ссылка1> Ссылка2> Ссылка3...

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

Переменная следа крошки пуста в разделах в секции Невидимые разделы.

Эта переменная имеет соответствующую пару условия: <IF_TOPIC_BREADCRUMBS> и <IFNOT_TOPIC_BREADCRUMBS>. Эти условия могут использоваться, чтобы вставить след, только где это уместно, и вставить альтернативное содержимое, когда не уместно.

См. здесь для деталей относительно того, как использовать эту переменную.

<%TOPIC_TITLE_PATH%>

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

Первичное использование этой переменной - для оптимизации механизма поиска, для которой Вы вставили бы ее в тэг <title> вашего шаблона страницы раздела вместо обычной переменной <%TOPIC_TITLE%>, как это:

<title><%TOPIC_TITLE_PATH%></title>

Модификация для Справка HTML:

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

<title><IF_HTML><%TOPIC_TITLE_PATH%></IF_HTML><IF_CHM><%TOPIC_TITLE%></IF_CHM></title>

<%TOPIC_HEADER_BGCOLOR%>

HTML-кодированная строка цвета, которая представляет цвет фона заголовка раздела, если Вы установили.

<%TOPIC_TEXT_BGCOLOR%>

HTML-кодированная строка цвета, которая представляет фон тела раздела.

<%TOPIC_TITLE%>

Заголовок раздела (это - заголовок раздела в Содержании).

<%TOPIC_KEYWORDS%>

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

<%TOPIC_AKEYWORDS%>

Вставляет все A-ключевые слова текущего раздела, отделенные запятыми.

<%HREF_PREVIOUS_PAGE%>

Адрес ссылки предыдущего раздела (используется для кнопок Предыдущая/Следующая).

<%HREF_NEXT_PAGE%>

Адрес ссылки следующего раздела.

<%HREF_DEFAULT_PAGE%>

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

<%HREF_PARENT_CHAPTER%>

Адрес ссылки родительского раздела (глава). Это может использоваться как альтернатива <%HREF_DEFAULT_PAGE%>.

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

<%HREF_CURRENT_PAGE%>

Адрес ссылки текущей страницы.

Переменная

Содержание и/или функция переменной

<%HREF_TOP_PAGE%>

Адрес ссылки главного фрейма (например "index.html")

<%HREF_CONTENT_PAGE%>

Адрес ссылки страницы Содержания

<%HREF_INDEX_PAGE%>

Адрес ссылки страницы указателя ключевых слов

<%HREF_SEARCH_PAGE%>

Адрес ссылки страницы поиска по всей справке

Переменная

Содержание и/или функция переменной

<%HREF_CONTENT_PAGE_DYN%>

Адрес ссылки динамической страницы Содержания.

<%HREF_CONTENT_PAGE_STATIC%>

Адрес ссылки статической страницы Содержания.

<%NAVIGATION_SCRIPT%>

Вставляет навигационный сценарий, требуемый главным фреймом.

Переменная

Содержание и/или функция переменной

<%TABLE_OF_CONTENTS%>

Вставляет все Содержание в страницу.

Переменная

Содержание и/или функция переменной

<%KEYWORD_INDEX%>

Вставляет весь указатель ключевых слов в страницу.

Переменная

Содержание и/или функция переменной

<%SEARCH_SCRIPT%>

Вставляет сценарий поиска по всей справке в страницу.