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

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

Ассоциативные ключевые слова (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.

 

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

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

Подключение таблицы стилей к проекту Hel…

При работе с форматами, основанными на HTML, для оформления контента в документах можно использовать каскадные таблицы стилей, cascading style sheets или CSS. Данная т...

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

Формулы в HTML Help (CHM)

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

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

Импорт документов MS Word в Help+Manual…

Часто технический писатель получает исходные данные от аналитиков, разработчиков, тестировщиков, маркетологов и других специалистов в форматах DOC, DOCX и RTF (реже, и...

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

Поиск в WebHelp находит удаленные раздел…

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

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

Контекстная справка в приложениях Window…

Понятие контекстной или контекстно-зависимой справки (от англ. context-sensitive help) появилось в 1987 году с выходом формата WinHelp. Изначально контекстная справка ...

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

Как поддерживать скриншоты в актуальном …

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

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

Книга «Разработка технической документац…

Уважаемые коллеги! Если вам нужно быстро освоить разработку документации по ГОСТ, рекомендую обратить внимание на книгу В.А. Глаголева «Разработка технической документ...

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

Перевод выходных документов в Help and M…

Выбрав русский язык и русскую кодировку в настройках проекта Help and Manual, многие авторы после первой сборки удивляются, увидев в выходных документах английские сло...

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

Размер и расположение окна CHM при перво…

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

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

Рваные края скриншотов в Help and Manual…

Многие платные редакторы скриншотов, например, SnagIt, FastStone Capture и др., умеют создавать эффект рваных краев. В сети Интернет можно найти множество видеоуроков ...

Читать полностью...
новое в Help and Manual 9

Новое в Help and Manual 9

23 ноября 2022 года компания EC Software к 25-летнему юбилею выпустила 9-ю версию программного комплекса Help and Manual (выходит c 1997 года). Комплект шаблонов Premi...

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

Создание CHM-справки в бесплатной програ…

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

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

KEL CHM Creator — бесплатная программа д…

Если вам нужно создать CHM-файл, и вы больше не хотите пользоваться глючной программой HTML Help Workshop, тогда KEL CHM Creator — это ваш вариант. Программа позволяет...

Читать полностью...
ключевые слова

Ключевые слова в Help+Manual…

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

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

HTML Help Workshop – бесплатная программ…

В 1997 году Microsoft выпустила новый формат справки, HTML Help (CHM), а также бесплатную программу для создания и редактирования справки в этом формате — HTML Help Wo...

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

HelpNDoc — бесплатная альтернатива Help+…

Еще одной альтернативой RoboHelp и Help&Manual является программа HelpNDoc от французского разработчика, компании IBE Software. Это практически полный аналог HelpS...

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

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

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

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