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

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

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

Сразу оговорюсь. В данной статье речь пойдет об обычных ключевых словах. Подробную информацию об ассоциативных ключевых словах (A-keywords) смотрите в статьях «Что такое ассоциативные ключевые слова» и «Ассоциативные ключевые слова в Help+Manual 7».

 

 

Содержание

 

 

В каких форматах поддерживаются ключевые слова

Ключевые слова поддерживаются в следующих форматах:

  • CHM
  • WebHelp
  • Word
  • PDF
  • EWriter

В форматах EPUB и MOBI ключевые слова не поддерживаются. В WebHelp и EWriter указатель можно включить или выключить.

Наверх к Содержанию

 

 

Откуда берутся ключевые слова в проекте Help+Manual

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

Наверх к Содержанию

 

 

Как работают ключевые слова

Ключевые слова можно добавить в разделы (topics). В этом случае ключевое слово будет указывать на раздел. Для выходных форматов CHM, WebHelp и Ewriter ссылку по ключевому слову можно сделать более точной — добавить одно или несколько ключевых слов для якоря (anchor). При открытии раздела по такому ключевому слову содержимое раздела будет прокручиваться до места установки якоря.

Упорядоченный по алфавиту список ключевых слов (указатель) генерируется автоматически во время сборки документации. В форматах CHM, WebHelp и Ewriter ссылка по ключевому слову будет открывать раздел. Если ключевое слово указывает на несколько разделов, будет открыто меню для выбора раздела. В Word и PDF в предметном указателе напротив ключевого слова будет указан актуальный номер страницы раздела с ключевым словом. Если в настройках для публикации PDF выбран интерактивный документ (переключатель Similar to a Printed User Manual), то в PDF-документе номер страницы будет представлять собой ссылку на страницу.

Наверх к Содержанию

 

 

Сколько уровней ключевых слов поддерживается

В Help and Manual поддерживаются ключевые слова первого (master keywords) и второго (child keywords) уровней. Первая группа также называется простыми ключевыми словами, а вторая – дочерними.

 

ключевые слова первого и второго уровня

 

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

 

ключевое слово первого уровня - заголовок

 

При этом само ключевое слово первого уровня может и не быть ссылкой на раздел.

 

ключевое слово - не ссылка

 

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

Наверх к Содержанию

 

 

Как добавить ключевое слово

Чтобы добавить ключевое слово в раздел, в редакторе выделите одно или несколько слов и нажмите на клавиатуре Ctrl + K (пользовательское сочетание клавиш можно задать в настройках File / Program Options / Shortcuts).

 

как добавить ключевое слово

 

Выделенное слово или словосочетание будет добавлено как простое ключевое слово в поле Keywords на вкладке Topic Options.

 

ключевое слово добавлено

 

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

Наверх к Содержанию

 

 

Как добавить ключевое слово второго уровня

Установите курсор в начало строки с ключевым словом первого уровня и нажмите на клавиатуре Tab. В результате ключевое слово первого уровня станет ключевым словом второго уровня (например, documentation по отношению к projects).

 

добавление ключевого слова второго уровня

Наверх к Содержанию

 

 

Как добавить ключевые слова к якорю

Одно или несколько ключевых слов первого и второго уровня можно добавить в поле Keywords: во время создания или редактирования якоря.

 

ключевые слова для якоря

 

В этом же окне можно отредактировать ключевые слова и удалить их.

Наверх к Содержанию

 

 

Как найти и заменить ключевые слова

Функция поиска и замены в Help+Manual поддерживает работу с ключевыми словами. Для этого нужно в раскрывающемся списке поля Find Where: выбрать Topic Keywords.

 

поиск и замена ключевых слов

Наверх к Содержанию

 

 

Как найти разделы без ключевых слов

Для поиска разделов без ключевых слов можно воспользоваться отчетом Missing Keywords.

 

поиск разделов без ключевых слов

Наверх к Содержанию

 

 

Средство для работы с ключевыми словами

В версиях Professional и Server в Help+Manual есть специальное средство для работы с ключевыми словами Index Tool. Оно представляет собой панель для работы с ключевыми словами проекта в виде списка.

 

средство для работы с ключевыми словами Index Tool

Наверх к Содержанию

 

 

Как добавить алфавитные заголовки для указателя в WebHelp

Во время генерации указателя в список ключевых слов автоматически добавляются заголовки, соответствующие буквам алфавита. По умолчанию в Help+Manual заданы только буквы латинского алфавита. Чтобы в ключевые слова на русском языке были добавлены русские буквы-заголовки:

  1. В Project Explorer выберите Configuration \ Publishing Options \ WebHelp \ Keyword Index.
  2. В поле Index Separators (typically letters A-Z): после латинских букв введите заглавные буквы русского алфавита через запятую.
  3. Сохраните изменения.

 

заголовки для указателя

 

При указанных выше настройках в указателе будут работать латинские и русские алфавитные заголовки.

 

русские заголовки в указателе

Наверх к Содержанию

 

 

Как добавить алфавитные заголовки для указателя в PDF

Чтобы добавить русские буквы-заголовки в шаблон для сборки PDF документов:

  1. На вкладке Project выберите Templates&Skins \ Launch PDF Manual Designer.

 

запуск Print Manual Designer

 

  1. В окне Print Manual Designer откройте шаблон, который вы используете для генерации PDF-документов, например, Standard_manual_A4.mnl.
  2. В рабочей области перейдите на вкладку Keyword Index. Если данная вкладка скрыта, воспользуйтесь меню справа от вкладок.

 

настройки указателя в PDF

 

  1. Выберите Pages \ Page Options.

 

свойства указателя

 

  1. В окне Page Options for [Keyword Index] перейдите на вкладку Keyword Index Section.

 

буквы-заголовки

 

  1. В поле Keyword Index Separators после латинских букв введите заглавные буквы русского алфавита через запятую.
  2. Нажмите на кнопку ОК.
  3. Сохраните отредактированный шаблон в папку с проектом.
  4. Во время сборки PDF выберите данный шаблон в поле Select Print Manual Template.

При указанных выше настройках в указателе будут работать латинские и русские алфавитные заголовки.

 

заголовки указателя в PDF

Наверх к Содержанию

 

 

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

Комментарии  

Алексей
# 0 Алексей 11.04.2022 00:46
Добрый вечер.
Описание вопроса такое.
Ключевое слово находится в нескольких разделах. Когда в разделе "указатель" скомпилированного файла при двойном нажатии на это слово появляется окно "Найденные разделы". Так вот в таблице "Название" разделы записаны как какая то абракадабра из букв и символов незнакомого алфавита. В чём ошибка или загвоздка?
Ответить Ответить с цитатой Цитировать
Илья Жуков
# 0 Илья Жуков 11.04.2022 11:24
Здравствуйте. Видел подобную проблему с кодировкой в HM Basic Edition -> с кириллицей корректно работает только версия HM Pro. Маловероятно, но проверьте языковые настройки в проекте: язык и кодировка должны быть русскими. В Windows в языковых настройках также везде должны быть Россия / Русский. Это нужно для корректной сборки CHM на русском языке.
Ответить Ответить с цитатой Цитировать
Алексей
# 0 Алексей 12.04.2022 00:15
Хочу спросить далее.
Я выбираю популярное слово (на русском алфавите) из текста всего проекта, затем делаю его ключевым, сохраняю всё. Опубликовываю проект, перехожу в раздел "указатель". Ключевое слово появилось.Далее, при внесении этого же слова в раздел "Поиск" и нажатии на кнопку "раздел" появляется окно с сообщением "разделы не найдены". Хотя это ключевое слово должно находиться в более чем 50-ти разделах документа.
Если проделывая аналогичные операции со словом на английском языке, то ключевое слово после внесения его в раздел "Поиск" ищется по всем разделам документа, но названия разделов в которых оно встречается прописываются абракадаброй.
Ответить Ответить с цитатой Цитировать
Алексей
# 0 Алексей 12.04.2022 00:16
Так же если одно и тоже ключевое слово было сохранено в нескольких разделах, то при нажатии на него дважды мышкой появляется окно "Найденные разделы" где указываются разделы в которых было сохранено ключевое слово, НО так же как было указанно ранее разделы записаны абракадаброй вне зависимости от того на каком языку написано ключевое слово.
Версия программы H&M 7 Professional. Язык справки Русский (Россия) Кодировка символа RUSSIAN_CHARSET
Ответить Ответить с цитатой Цитировать
Илья Жуков
# 0 Илья Жуков 13.04.2022 11:16
В редакторе на вкладке Topic Options исправьте все Topic ID до формата «latinletters_001».
Ответить Ответить с цитатой Цитировать

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

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

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

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

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

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

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

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-файла соответствовал оригиналу, необходимо создать стили, применить их к проекту и очистить встроенное форматирование. Это позволит обеспе...

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

Форматы справки для ОС Linux

В рамках замещения импортного программного обеспечения все больше государственных структур переходят на отечественные сборки Linux. Прежде всего, это Alt Linux и Astra...

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

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

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

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