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

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

Ассоциативные ключевые слова (associative keywords, A-keywords, A-link keywords или See Also keywords) — технология компании Майкрософт, позволяющая автоматически создавать список ссылок на все разделы справки, для которых задано одно или несколько общих ключевых слов. Данная технология поддерживалась в WinHelp. После того, как формат был признан устаревшим и перестал использоваться, технология была унаследована форматом-преемником. Сегодня данная технология поддерживается только в формате HTML Help (CHM).

Ассоциативные ключевые слова не попадают в Указатель, как обычные ключевые слова. Пользователи справки не видят их. Ассоциативные ключевые слова используются для создания так называемых ассоциативных ссылок (могут быть в форме гиперссылки, текста, кнопки или рисунка), возвращающих список ссылок на все разделы справки, в которых содержится данное ассоциативное ключевое слово.

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

Такой список ссылок не создается автором справки вручную, а генерируется автоматически во время работы пользователя со справкой. Когда пользователь активирует ассоциативную ссылку (в приведенном выше примере нажимает на кнопку Related Topics), браузер справки просматривает все разделы справки на наличие указанных в ссылке ассоциативных ключевых слов, включая все разделы во внешних файлах справки в модульных системах справки, и возвращает список ссылок на найденные разделы.

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

Как это работает?

Ассоциативные ссылки реализуются при помощи макроса WinHelp Alink, который ищет все ключевые слова, указанные в А-сносках (A-footnotes) в текущем файле справки, либо во всех файлах справки, на которые ссылается оглавление.

ALink(keyword[; keyword] [, type[, topic-ID [, window-name]]])

В определении макроса в круглых скобках указывается одно или несколько ассоциативных ключевых слов через точку с запятой. Если ключевое слово содержит запятую, то всё ключевое слово целиком необходимо взять в кавычки. Обратите внимание на то, что в HTML Help поддерживаются только ключевые слова. Другие параметры макроса Alink в HTML Help не поддерживаются.

Alink(keyword;key word)

Полное описание макроса, его параметров и примеры использования можно найти в справке к программе Microsoft Help Workshop в разделе WinHelp Reference \ Macro Reference \ Alink.

Когда это используется?

В обычных проектах справки ассоциативные ключевые слова используются для создания списков ссылок на разделы со смежными темами (See Also, Related Topics, Смотрите также и т.п.).

В модульных системах справки они используются для создания ссылок на разделы из других файлов справки.

Какие программы это поддерживают?

Работа с ассоциативными ключевыми словами поддерживается в современных средствах разработки справки, таких как Adobe RoboHelp 2017, Help+Manual 7 и других программах. Использованию технологии ассоциативных ключевых слов в Help+Manual 7 посвящен материал Ассоциативные ключевые слова в Help+Manual 7.

 

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

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

Что нового в 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. Охраняется законом об авторском праве.