Блог технического писателя Ильи Жукова

Ассоциативные ключевые слова в Help+Manual 7

Ассоциативные ключевые слова поддерживаются только в формате HTML Help (CHM). Они позволяют автоматически создать список всех разделов справки с заданным ассоциативным ключевым словом (или несколькими ключевыми словами). В обычных проектах справки ассоциативные ключевые слова используются для создания списков ссылок на разделы по смежным темам «Смотрите также».

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

Как создать список ссылок на разделы со смежными темами

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

  • Прописать ассоциативные ключевые слова в необходимые разделы справки.
  • Создать ассоциативные ссылки, которые будут генерировать список ссылок на разделы по смежным темам.

Прописать ассоциативные ключевые слова

  1. Откройте проект Help+Manual.
  2. В Project Explorer выделите раздел, в который необходимо добавить ассоциативное ключевое слово.
  3. В редакторе текста перейдите на вкладку Topic Options.
  4. В поле A-Keywords for HTML Help введите одно или несколько ассоциативных ключевых слов. Обратите внимание на то, что дочерние ключевые слова не поддерживаются.

введите ассоциативные ключевые слова

  1. Добавьте данное ассоциативное ключевое слово в разделы, которые необходимо «ассоциировать» с данным разделом.
  2. Повторите процедуру для остальных ассоциативных ключевых слов.

 

Создать ассоциативные ссылки

  1. В тексте раздела выберите место, в которое необходимо вставить ассоциативную ссылку.
  2. На вкладке Write щелкните Link или нажмите сочетание клавиш Ctrl+L.
  3. В открывшемся диалоговом окне Insert Hyperlink перейдите на вкладку Script Link.

создание ассоциативной ссылки

  1. Установите переключатель Type of script / macro: в положение WinHelp Macro.
  2. В поле Script: введите Alink() и в скобках через точку с запятой введите ассоциативные ключевые слова, по которым будет генерироваться список ссылок на смежные темы. Обратите внимание на то, что другие параметры макроса WinHelp Alink не поддерживаются.
  3. При необходимости задайте остальные параметры ссылки: текстовую метку (Caption), всплывающую подсказку (Tooltip) и стиль отображения — ссылка (Link), текст (Text), кнопка (Button) или рисунок (Picture).
  4. В окне Insert Hyperlink нажмите кнопку ОК.
  5. Добавьте ассоциативные ссылки в остальные разделы аналогичным образом.
  6. Сохраните внесенные изменения.

После сборки CHM-файла ссылка из приведенного выше примера будет выводить на экран в отдельном окне список ссылок на все разделы справки, содержащие ассоциативные ключевые слова «сортировка» или «фильтрация».

 

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

 

Добавить комментарий

Последние статьи

Что нового в Help+Manual 8

10 февраля 2020 года вышла 8-я версия Help+Manual. Любой желающий может бесплатно скачать пробную версию с сайта компании-разработчика и оценить ее потенциал. В течени...

Читать полностью...

Работа со стилями в Help and Manual 7

Чтобы внешний вид нового CHM-файла соответствовал оригиналу, необходимо создать стили, применить их к проекту и очистить встроенное форматирование. Это позволит обеспе...

Читать полностью...

Форматы справки для ОС Linux

В рамках замещения импортного программного обеспечения все больше государственных структур переходят на отечественные сборки Linux. Прежде всего, это Alt Linux и Astra...

Читать полностью...

Сборка CHM-файла в Help and Manual

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

Читать полностью...

Основные настройки проекта в Help and Ma…

Если для сборки справки не используется шаблон (skin-file), внешний вид и основной функционал CHM-справки берется из настроек проекта. В этой статье я расскажу о том, ...

Читать полностью...

Импорт CHM в Help and Manual

Программный комплекс Help and Manual позволяет импортировать документацию из ряда форматов, в том числе, из HTML и CHM. Готовую документацию можно загрузить как в суще...

Читать полностью...

Как отредактировать CHM в Help and Manua…

Если вам нужно внести несколько небольших правок в CHM-файл, такую задачу можно успешно решить при помощи бесплатных программ HTML Help Workshop и Notepad++. Серьезная...

Читать полностью...

Как сделать качественные скриншоты

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

Читать полностью...

Внесение изменений и сборка нового CHM-ф…

Перед тем, как приступить непосредственно к редактированию содержимого CHM-файла, подытожим выполненные заранее подготовительные работы. Определившись с бесплатными пр...

Читать полностью...

Создание и настройка проекта в HTML Help…

Установив необходимые бесплатные программы, мы разобрали исходный файл api.chm и получили 64 файла (подробнее смотрите материал Декомпиляция CHM-файла). Это основная ч...

Читать полностью...

Декомпиляция CHM-файла

Файл в формате CHM представляет собой скомпилированный HTML. В него могут входить HTML-страницы, рисунки, таблицы стилей, скрипты и другие файлы. Подробное описание со...

Читать полностью...

Редактирование CHM бесплатными программа…

Если заказчику или работодателю не принципиально, какое программное обеспечение использовать, я предпочитаю редактировать CHM в Help+Manual 7. Но как показывает практи...

Читать полностью...

Как отредактировать CHM-файл

Пользовательская документация для приложений, работающих в ОС Windows, чаще всего поставляется в формате CHM как встроенная в программу справка. Технические писатели, ...

Читать полностью...

Как создать справку в формате CHM

Формат HTML Help или CHM был разработан компанией Microsoft в 1997 г. Сегодня CHM остается стандартом справки для приложений, работающих в ОС Windows. Средство для про...

Читать полностью...

Бесплатный локальный сервер HM2GO для We…

Одна из моих предыдущих статей была посвящена особенностям работы WebHelp на локальных компьютерах. Некоторые популярные браузеры, в том числе Google Chrome, Opera и Я...

Читать полностью...

Дата в полном формате с месяцем в родите…

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

Читать полностью...

Все о справке и документации для пользователей!

Следить за новыми статьями:

© Илья Жуков, 2019. Охраняется законом об авторском праве.