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

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

Форматы электронной документации CHM, WebHelp и EWriter давно используются для создания и распространения электронных книг и учебников. Разработать такое учебное пособ...

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

Оформление рисунков в Help+Manual при по…

Рисунки в проекте Help and Manual можно единообразно оформить тремя способами. Во-первых, это можно сделать в графическом редакторе, например в Impict. Во-вторых, для ...

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

Подключение таблицы стилей к проекту 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…

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

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

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

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

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