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

Ассоциативные ключевые слова в 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 ссылка, по которой будет автоматически открыт раздел. Если ни одного раздела с искомым ассоциативным ключевым словом найдено не будет, на экран будет выведено соответствующее сообщение.

 

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

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

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