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

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

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

 

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

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

Создание 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...

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

HelpSmith — достойная альтернатива Help+…

Продолжая тему средств разработки справки и пользовательской документации, нельзя не рассказать о программе HelpSmith. Она работает по принципу единого источника и под...

Читать полностью...
отечественная программа для разработки справки

Dr.Explain — отечественная программа для…

За почти 30-летнюю историю существования RoboHelp и Help&Manual стали стандартом средств разработки справки и пользовательской документации в среде Windows. Сегодн...

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

Как вычитать свой текст: инструкция для …

В идеале любой технический текст кроме автора должен прочитать хотя бы один редактор и хотя бы один корректор. На практике дело ограничивается одним нормоконтролером и...

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

Как повысить качество текста инструкций

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

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

Закон построения нехудожественного текст…

Вы не задумывались, почему некоторые тексты читаются на одном дыхании, а через другие приходится продираться? Почему одна статья запоминается на лету, как бы сама собо...

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

Примечания и предупреждения в тексте инс…

Важную информацию в тексте можно выделять по-разному. Можно целые предложения оформлять жирным, подчеркнутым и курсивным шрифтом. Можно написать все слова в предложени...

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

Методика чтения научных книг

Я не люблю брать в руки разрисованные книги. Текст исчиркан, подчеркнут, зачеркнут. Ручкой, карандашом, маркером. Уголки страниц загнуты. На полях рукописные пометки, ...

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

Книга «Пиши, сокращай: как создавать сил…

Наводя порядок в книжном шкафу, нашел книгу Максима Ильяхова и Людмилы Сарычевой «Пиши, сокращай: как создавать сильный текст». Я прочитал ее летом 2018 года, но отзыв...

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

Как починить поиск в русском PDF

Начинающий пользователь Help+Manual, пишущий документацию на русском языке, рано или поздно сталкивается с ситуацией, когда в созданном PDF-документе не работает поиск...

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

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

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

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

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

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

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

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

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

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