Навигация:  Справочная информация > ID раздела, контекстные числа и ключевые слова >

Об ID разделов и якорях

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

ID раздела:

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

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

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

Свойства ID раздела:

Максимальная длина ID раздела:

В Help & Manual 4 и выше ID раздела могут быть до 256 символов длиной.

Разрешенные символы:

Пробелы и множество специальных символов (\  / : * ? # = + % ! @ [ ] > " | , < > & и ') не разрешаются в ID раздела, и Help & Manual отобразит предупреждающее сообщение, если Вы будете пробовать ввести их. В дополнение к этому, фактически желательно использовать только а.. z, A.. Z, 0.. 9, символ подчеркивания _ и символ $ в ID раздела.

Изменение ID раздела:

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

· Для получения дополнительной информации см. Изменение ID раздела и контекстных чисел.

ID раздела и выходные файлы HTML:

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

Это применяется и к видимым файлам, сгенерированным в Броузерной справке, и к "внутренним" файлам, используемым в Справке HTML (здесь, файлы раздела HTML скрыты в .CHM файле справки, как если бы они были в каталоге).

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

Якоря:

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

Якоря вводятся со Вставить > Якорь раздела. Якоря, сохраненные в каждом разделе, перечислены во вкладке Опции раздела в области Якорь в разделе:. Эта область всегда содержит по крайней мере один якорь по имени (Top), который является стандартной целью перехода для ссылок без якорей.

· Больше деталей смотрите в Якоря - цели перехода.

Максимальная длина ID якоря:

В Help & Manual 4 и выше ID якоря могут быть до 256 символов длиной.

Разрешенные символы:

Пробелы и множество специальных символов (\  / : * ? # = + % ! @ [ ] > " | , < > & и ') не разрешаются в ID якоря, и Help & Manual отобразит предупреждающее сообщение, если Вы будете пробовать ввести их. В дополнение к этому фактически желательно использовать только а.. z, A.. Z, 0.. 9, символ подчеркивания _ и символ $ в ID раздела.

Где не поддерживается:

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

Якоря с контекстными числами и ключевыми словами

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

· Больше деталей смотрите в Назначение чисел справочного контекста и Использование ключевых слов с якорями.

Синтаксис для броузерной ссылки с якорями в разделах

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

index.html?topicname.htm#anchorname

Отметьте, что Help & Manual 4 теперь использования стандартный символ # как разделитель между именем файла раздела HTML и именем якоря вместо запятой, которая требовалась в Help & Manual 3!

· См. Якоря - цели перехода для деталей.

См. также:

Назначение ID раздела

Изменение ID раздела и контекстных чисел

Якоря - цели перехода