Adobe RoboHelp - Краткое руководство

Adobe RoboHelp - популярный инструмент создания справки (HAT) от Adobe. Он используется профессионалами отрасли для создания привлекательныхhelp content, e-learning resources, organizational policies и knowledge base articlesширокой аудитории независимо от форм-фактора устройства. Последняя версия RoboHelp (выпуск 2017 г.) помогает легко создавать адаптивные макеты HTML5 следующего поколения, которые обеспечивают плавную навигацию и широкие возможности интерактивного взаимодействия.

RoboHelp был впервые создан Gen Kiyooka и выпущен Blue Sky Software in 1992. Blue Sky Software была приобретенаMacromedia, который впоследствии был приобретен Adobe в 2005 году. Adobe RoboHelp 2017 имеет версию 13.0, хотя технически это версия 21 с учетом предыдущих версий, выпущенных под Macromedia.

RoboHelp превратился из просто шляпы в универсальный инструмент, который может помочь вам создавать электронные книги и даже веб-сайты. RoboHelp может выводить данные в различные форматы справки, используя следующиеSingle Source Layouts (SSL) -

  • Адаптивный HTML5
  • eBook
  • Справка Microsoft HTML
  • JavaHelp
  • Справка Oracle
  • Справка по Eclipse
  • Справка Adobe AIR
  • Стандартная документация Word и PDF

Одна из самых больших проблем, с которыми сталкивается при доставке контента, - обеспечение того, чтобы целевая аудитория могла его просматривать. RoboHelp позволяет создателям контента создавать собственные приложения для Android и iOS без необходимости в дополнительном программном обеспечении.

Благодаря множеству новых функций в последней версии, Adobe RoboHelp остается отраслевым стандартом HAT для создания увлекательной справочной системы, электронного обучения и технического контента, который динамично удовлетворяет разнообразные потребности целевой аудитории. Он прост в использовании - как опытными авторами, так и новичками.

Версия RoboHelp 2017 года содержит множество новых функций. К ним относятся -

  • Макеты HTML5 нового поколения
  • Auto-complete
  • Поддержка эскизов
  • Избранное в адаптивных макетах HTML5
  • Импорт папки с багажным файлом
  • Варианты просмотра

Давайте разберемся с ними подробнее.

Макеты HTML5 нового поколения

Выпуск RoboHelp 2017 обещает помочь вам создавать привлекательные макеты HTML5 без полей. Эти макеты предлагают превосходные возможности поиска и навигации и предварительно загружены множеством функций, таких как слайдеры тем, отображение / скрытие виджетов и т. Д. Адаптивный дизайн позволяет хорошо масштабировать контент на экранах разных размеров.

Автозаполнение

Теперь вы можете получать результаты прогнозируемого поиска в поле поиска адаптивного вывода HTML5 после ввода нескольких первых символов. Результаты появляются мгновенно и зависят от контекста, и пользователю не нужно вводить полную строку поиска. Результаты ранжируются в зависимости от частоты использования ключевого слова в содержании.

Поддержка эскизов

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

Избранное в адаптивных макетах HTML5

Теперь можно отмечать темы как избранные и добавлять собственные ссылки с помощью нового адаптивного макета HTML5 на тему Indigo.

Импорт папки с багажным файлом

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

Варианты просмотра

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

Adobe RoboHelp Server - это серверная справочная система. Вы можете загрузить содержимое справки на сервер, который затем сможет предоставлять обратную связь с конечным пользователем в режиме реального времени. Он может регистрировать данные по запросам, которые задают пользователи. Сервер RoboHelp может графически показать, как пользователи перемещаются по справочной системе.

Вы можете использовать инструмент для создания контента, который может включать несколько проектов и загружать весь проект на сервер RoboHelp. Сервер RoboHelp включает автоматическое объединение проектов, которое позволяет авторам работать над разными проектами по разным графикам и публиковать их все на одном сервере. Авторы также могут публиковать проекты, написанные на разных языках, на одном сервере.

Сервер RoboHelp также может взаимодействовать с серверами баз данных, такими как Oracle или MS SQL Server, и создавать отчеты и журналы. Ответ на запрос пользователя ретранслируется через HTTP-сервер Apache.

Типичное рабочее пространство RoboHelp состоит из элементов, называемых Pods, Panes, Bars и Windows. Давайте посмотрим на некоторые компоненты рабочего пространства.

Панель быстрого доступа

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

Команды по умолчанию включают в себя: Сохранить все, Копировать, Вставить, Отменить и Вернуть.

Вкладки

Вкладки - это логические группы команд, составленные вместе. Вкладка содержит команды связанных функций. Вкладки контекстны и меняются в зависимости от типа содержимого и форматирования.

Панель документа

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

Эти вкладки описаны ниже.

  • Первая строка - это Tabbed Document Pane. Каждая вкладка состоит из одного проекта. Вы можете работать над несколькими проектами одновременно и копировать и вставлять активы между этими проектами.

  • Вторая строка - это Design and HTML View Panes. Для любого документа вы можете переключаться между дизайном, над которым вы работаете, и HTML-кодом вашего дизайна. Вы можете редактировать HTML для еще более точного контроля. Код HTML создается автоматически по мере того, как вы продолжаете работать над дизайном.

  • Третья строка показывает Document Area Selectors. Это поможет вам перейти к различным разделам документа, таким как абзацы, заголовки и гиперссылки.

Стручки

Модули - это панели, которые можно закрепить в любом месте рабочей области, чтобы получить доступ ко всем функциям, которые логически сгруппированы. Например, модуль Project Manager показывает все компоненты проекта. Модули могут быть сгруппированы вместе или могут свободно перемещаться по рабочей области.

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

RoboHelp позволяет легко находить и идентифицировать команды, связанные с определенной функцией, путем организации их на вкладках. Вкладки организованы в виде ленты, аналогичной пакету программ Microsoft Office.

Лента состоит из нескольких вкладок, которые включают:

  • File
  • Project
  • Edit
  • Insert
  • Review
  • Collaborate
  • Output
  • Tools

Давайте разберемся с каждым из них подробно.

файл

Создавайте новые проекты, открывайте, сохраняйте существующий проект, просматривайте недавние проекты и изменяйте настройки программы.

Проект

Создавайте, импортируйте, редактируйте и удаляйте компоненты проекта, такие как темы, фрагменты, теги и переменные. Вы можете сохранить несохраненные в настоящий момент изменения во всем проекте.

редактировать

Создание и редактирование таблиц стилей, форматирования текста и тегов содержимого.

Вставить

Вставляйте такие объекты, как таблицы, изображения, контент Adobe Captivate и фрагменты.

Обзор

Отслеживайте изменения, принимайте и отклоняйте изменения в обзоре документа.

Сотрудничать

Делитесь ресурсами проекта между пользователями и активируйте контроль версий.

Вывод

Создавайте, ищите, настраивайте, генерируйте, просматривайте и открывайте выходы RoboHelp.

инструменты

Вы можете создавать и просматривать отчеты. RoboHelp поставляется с рядом скриптов, которые вы можете использовать для выполнения определенных команд. Выберите и выполните сценарии из списка сценариев на этой вкладке.

Модуль - это плавающее или закрепленное окно рабочего процесса или связанных функций, организованных логическим образом. Чтобы открыть модуль, перейдите на вкладку «Проект», затем в разделе «Открыть» щелкните значок «Модули», чтобы открыть список модулей. Выберите модуль из списка. Вы можете установить модуль на док-станцию ​​или оставить его на рабочем столе. Вы также можете автоматически скрыть модуль или открыть его как документ с вкладками.

RoboHelp включает в себя множество типов модулей. Некоторые из них включают -

  • Стартовый модуль
  • Модуль Project Manager
  • Модуль настройки вывода

Давайте подробно обсудим каждый из них.

Стартовый модуль

Модуль Starter Pod обычно отображается в виде документа с вкладками, но, как и любой другой модуль, вы можете сделать его плавающим или даже закрепить. Обычно это отправная точка в рабочем процессе RoboHelp.

Стартовый блок состоит из четырех секций, а именно:

  • Recent Projects - Показывает список недавно открытых проектов.

  • Create - Позволяет выбрать тип файла справки, который вы хотите создать.

  • Import - Импортируйте контент из файлов Microsoft Word, Adobe FrameMaker, Adobe PDF, HTML или других поддерживаемых форматов.

  • Resources - Содержит ссылки на справочные ресурсы, семинары и статьи базы знаний, которые помогут вам максимально эффективно использовать RoboHelp.

Модуль Project Manager

Модуль Project Manager содержит все различные папки, в которых вы храните и редактируете файлы проекта. В модуле Project Manager есть папки по умолчанию для каждого типа контента.

Например, все изображения в проекте хранятся в папке «Изображения», видео и звуки - в папке «Мультимедиа» и т. Д.

Модуль Project Manager также содержит Baggage Filesпапка, содержащая косвенно связанные файлы, являющиеся частью проекта. Багажные файлы могут включать –PDF-файлы, презентации PowerPoint и т. Д. Двойной щелчок по файлам в папке «Багажные файлы» открывает файл в соответствующем приложении.

Модуль настройки вывода

Модуль настройки вывода помогает просматривать и изменять вывод содержимого в зависимости от целевого устройства. Он содержит иерархическую организацию различных компонентов вывода, таких как окно, главные страницы, обложки, профили устройств, макеты экрана и т. Д.

Щелкните правой кнопкой мыши любой контейнер, чтобы изменить его свойства.

Например - если вы хотите изменить размеры MS_HTML В окне вывода щелкните правой кнопкой мыши контейнер MS_HTML в папке Windows и выберите способ отображения окна на экране.

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

Затем среды можно вызвать, выбрав среду из Workspaceменю в правом верхнем углу окна. Окружения сохраняются в файле .rhs, которым можно обмениваться с другими авторами.

Создание и сохранение окружающей среды

Разместите все стручки в рабочем пространстве. Щелкните стрелку раскрывающегося списка рядом с рабочей областью в верхнем правом углу окна RoboHelp. Нажмите наSave... и выберите расположение и имя для рабочего пространства.

Загрузка сохраненного окружения

Щелкните стрелку раскрывающегося списка рядом с рабочей областью в верхнем правом углу окна RoboHelp и выберите Load….

Перейдите к расположению файла .rhs файл и нажмите Открыть, чтобы загрузить среду.

Удаление окружения

Чтобы удалить среду, перейдите в то место на диске, где хранился файл .rhs, и просто удалите файл .rhs, относящийся к этой среде.

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

Создать сочетания клавиш

Следующие пункты объяснят, как создавать сочетания клавиш в RoboHelp.

  • В раскрывающемся меню рядом с Quick Access Toolbar выберите More Commands вариант.

  • в General раздел под User Interface Options, нажмите на Customize Keyboard Shortcuts.

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

  • в Press new shortcut key box, введите сочетание клавиш или комбинацию и нажмите Assign. Если сочетания клавиш уже назначены, они появятся вKey assignments: box.

  • После того, как вы назначили все сочетания клавиш, нажмите Close чтобы закрыть диалоговое окно.

  • Вы также можете экспортировать список сочетаний клавиш как CSV file выбрав Export.

Удалить сочетания клавиш

Следующие пункты объяснят, как удалить сочетания клавиш в RoboHelp.

  • Чтобы удалить назначенный ярлык, перейдите к Customize Keyboard Shortcuts… диалоговое окно и щелкните команду, для которой вы хотите удалить сочетание клавиш.

  • Затем нажмите на Remove чтобы удалить сочетание клавиш, назначенное этой команде.

  • Чтобы восстановить для сочетаний клавиш значения по умолчанию, выберите Reset All.

Чтобы настроить общие параметры программы, перейдите в File вкладка, затем перейдите к Options и выберите раздел Общие, чтобы изменить настройки.

Обзор некоторых важных настроек приведен на следующем снимке экрана -

Предпочтения для общих настроек

Ниже приведены общие настройки RoboHelp.

  • Use underscores in filenames - Имена файлов тем сохраняются с подчеркиванием между словами, что требуется для проектов HTML.

  • Automatically check for updates- Проверяет наличие обновлений при выходе. Вы также можете включить эту опцию, выбрав Файл → Справка → Учетные записи и обновления → Обновления ...

  • Allow editing of multiple topics - Открывает темы на разных вкладках в редакторе дизайна и позволяет редактировать.

  • Clear project cache (.cpd file) before opening any project- Это помогает каждый раз удалять старый файл <ProjectName> .cpd. При открытии проекта из файлов проекта создается новый <ProjectName> .cpd.

  • Remember project state - Гарантирует, что RoboHelp запоминает расположение открытых файлов и модулей, чтобы проект открывался в том же состоянии при следующем открытии программы.

Генерация команд

Ниже приведен список команд в RoboHelp.

  • Auto-compile outdated files - Автоматически генерирует ваш основной макет, когда выходные файлы устарели.

  • Auto-display output view - Отображает окно вывода в нижней части окна программы при создании проекта.

  • Convert RoboHelp-edited topics to HTML- Преобразует темы XHTML в HTML на выходе. Темы, созданные или отредактированные сторонними редакторами, не конвертируются.

  • Show learning resources on Starter page - Показать или скрыть область, в которой есть поток учебных ресурсов, на стартовой странице.

Проект - это набор исходных файлов, который становится справочной системой, которую видит конечный пользователь. Файлы проекта хранятся в.xpj format и содержат информацию и свойства проекта.

Файл проекта состоит из следующих компонентов -

  • Content
  • Properties
  • Navigation

Давайте подробно обсудим каждый из них.

Содержание

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

Свойства

В новом проекте используются свойства по умолчанию. Эти свойства включают в себя такие параметры, как - Название, Язык, Окна и т. Д., Которые можно изменить в зависимости от требований.

Навигация

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

Файлы проекта

Проект RoboHelp состоит из следующих файлов -

  • Главный файл проекта (XPJ)
  • Файлы папок (FPJ)
  • Файлы макета с одним исходным кодом (SSL)
  • Вспомогательные файлы проекта (APJ) и
  • Другие типы файлов

Давайте подробно обсудим каждый из этих файлов ниже.

Главный файл проекта (XPJ)

Файл проекта (.xpj) основан на XML. Старые файлы .mpj конвертируются в файлы XPJ в последней версии RoboHelp.

Файлы папок (FPJ)

В файле FPJ перечислено содержимое папки. Отображаются только те подпапки и разделы, которые перечислены в файле FPJ папки.

Файлы макета с одним источником (SSL)

Сохраняет свойства макета с одним источником и изменяется при редактировании свойств.

Вспомогательные файлы проекта (APJ)

Такие компоненты, как окна, багажные файлы, файлы карт, наборы шрифтов и т. Д., Имеют соответствующие файлы APJ, которые можно изменять или редактировать.

Другие типы файлов

Другие типы файлов в проекте включают следующие:

  • Обзор последовательностей (BRS)
  • Темы (HTM)
  • ТОС (HHC)
  • Индекс (HHK)
  • Глоссарий (GLO)
  • Графические и мультимедийные файлы (расширение имени файла может быть разным)
  • Таблицы стилей (CSS)

Вы можете создать проект с нуля или импортировать данные из внешнего файла, такого как FrameMaker, Word или PDF.

Создание нового проекта

Следующие пункты описывают, как создать новый проект в RoboHelp.

  • Новый проект можно создать, выбрав File → New Project или используя опцию «Еще» в модуле «Стартовый» в разделе «Создать».

  • В диалоговом окне «Новый проект» дважды щелкните тип проекта. Вы можете изменить тип проекта после того, как ваш проект будет создан.

  • в New Project Wizard В диалоговом окне укажите такие параметры, как заголовок проекта, имя файла, расположение на диске и заголовок первой темы, и нажмите Finish создать проект.

Создайте проект, импортировав документы

Следующие шаги объясняют, как создать проект путем импорта документов в RoboHelp.

  • Вы можете создавать новые проекты, импортируя контент из внешних источников, таких как FrameMaker или документы Word.

  • Перейдите в диалоговое окно «Новый проект» «Файл» → «Новый проект» или используйте параметр «Дополнительно» в модуле «Начальный» в разделе «Создать новый». Выберите вкладку Импорт.

  • Выберите тип документа, который нужно импортировать, и нажмите ОК.

  • В диалоговом окне «Мастер создания нового проекта» укажите такие параметры, как «Название проекта», «Имя файла», «Расположение на диске» и заголовок первой темы, и нажмите «Готово», чтобы создать проект.

Вы можете открыть проект при запуске RoboHelp с помощью Starter pod или традиционно с помощью File menu.

Открытие проекта из модуля Starter

В модуле Starter отображается список недавно открытых проектов. Щелкните название проекта, который необходимо открыть. Если вы не видите нужный проект, нажмите «Открыть проект» и перейдите к расположению проекта на диске.

Открытие проекта из меню файла

Щелкните вкладку «Файл» и выберите «Открыть проект». Щелкните локальный или сетевой путь и выберите проект с диска.

Если вы открываете проекты, созданные в более старой версии RoboHelp, вам будет предложено преобразовать проект в новый формат.

Чтобы изменить настройки проекта, на вкладке «Проект» щелкните «Параметры проекта» в разделе «Файл».

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

в Indexраздел, вы можете добавить новые ключевые слова в файл индекса проекта (HHK) или сохранить как файлы отдельных тем (HTM). Выберите параметр « Двоичный индекс», если вы хотите объединить индексы из нескольких файлов CHM.

Вы логически упорядочиваете темы и папки в модуле Project Manager для определения макета главы. Этот макет главы является основой дляTable of Contents создание RoboHelp.

Здесь следует отметить несколько важных моментов:

  • Если вы переименуете папку или тему, темы и папки сохранят свой порядок.

  • Если вы удалите тему или папку, оставшиеся темы сохранят свой порядок.

  • Если вы добавляете новую тему или папку, она добавляется вверху внутри родительской папки.

  • Если вы перетаскиваете тему или папку на элемент, не связанный с темой / папкой (например, CSS, изображение или багаж), он перемещается в последнюю позицию внутри родительской папки цели.

Чтобы упорядочить темы, просто перетащите тему или папку выше или ниже другой темы или папки. Зеленая стрелка показывает расположение темы или папки.

RoboHelp предоставляет множество способов организовать файлы проекта и работать с ними. Мы рассмотрим некоторые из распространенных операций ниже -

Список тем по названию или имени файла

Откройте project, а на вкладке «Проект» перейдите в раздел «Просмотр» → «Показать темы» и выберите отображение тем. By Topic Title или же By File Name.

Использование списка дел

Задачи проекта можно отслеживать с помощью списков дел, которые можно настроить. Списки дел сохраняются при преобразовании проектов из более старой версии RoboHelp. Чтобы отредактировать список дел, перейдите вProject Settings, нажми на General вкладку и затем щелкните Manage…

Чтобы добавить задачу в список, нажмите «Добавить». Введите имя элемента задачи. Чтобы отредактировать или удалить задачу, выберите задачу и нажмите «Изменить» или «Удалить».

Редактировать список недавно открытых проектов

В модуле RoboHelp Starter перечислены недавно открытые проекты. Чтобы отредактировать этот список, перейдите в меню «Файл» и нажмите «Параметры». Щелкните вкладку "Последние проекты". Если вы хотите изменить количество файлов в списке, укажите число в поле «Максимальное количество проектов». Чтобы удалить файл из списка, выберите его и нажмите «Удалить». Вы можете закрепить часто используемые файлы, выбрав их и нажавPin.

Добавить файлы и папки в папку с файлами багажа

Иногда вам может потребоваться добавить файлы в Baggage Filesпапка, чтобы внешние элементы правильно отображались на выходе. Вы можете добавлять отдельные файлы или даже папки. Чтобы добавить файлы или папку в папку «Файлы багажа», щелкните правой кнопкой мыши «Файлы проекта», перейдите в «Импортировать багаж» и выберите «Файл или папку».

Сопоставление типов файлов

Вы можете сопоставить типы файлов, чтобы связать их с приложениями для редактирования и просмотра. Чтобы связать расширение файла с приложением, перейдите в меню «Файл» и нажмите «Параметры». Нажми наFile Association tab. Вы можете связывать программы, а также редакторы HTML.

Чтобы связать программы, нажмите Добавить в Associated Programsраздел и введите расширение имени файла. Выберите редактор для редактирования документов с указанным расширением имени файла, а затем выберите программу для просмотра файла.

Чтобы добавить редактор HTML, нажмите «Добавить» в разделе «Редакторы HTML», выберите из рекомендованных или других зарегистрированных программ для редактирования или просмотра файлов .html или .htm и нажмите «ОК».

Удалить темы из проектов

Перед удалением файлов проекта рекомендуется создавать резервные копии всех файлов проекта, просматривать и распечатывать отчеты. Это особенно важно, если ваш проект не находится под контролем версий. Во избежание битых ссылок не удаляйте файлы в проводнике Windows или программном обеспечении для контроля версий.

Выберите один или несколько файлов и нажмите Удалить на клавиатуре. В качестве меры предосторожности рекомендуется не удалять ссылки на удаленные темы, чтобы их можно было отобразить вBroken Links folderдля последующего обзора. Чтобы удалить несколько тем, используйтеTopic List Pod.

Подобно управлению файлами проекта, RoboHelp также предоставляет способы управления файлами проекта. Мы рассмотрим некоторые из общих операций с папками ниже -

Создание папок

Существуют папки по умолчанию, которые можно использовать для создания папок и подпапок в Project Manager. Эти папки включают в себя -

  • HTML-файлы (темы)
  • Images
  • Multimedia
  • Таблицы стилей и
  • Багажные файлы

Чтобы создать папку, щелкните правой кнопкой мыши на Project Files папка в Project Manager pod, перейдите в «Создать» и выберите «Папка». Введите имя и нажмите Enter.

Переименовать папки

Чтобы переименовать папки, разверните папку Project Files в модуле Project Manager. Щелкните правой кнопкой мыши папку, которую хотите переименовать, и выберите «Переименовать». Введите новое имя и нажмите Enter.

Переместить папки

Чтобы переместить папку, выберите папку в Project Files в модуле Project Manager и перетащите подпапку в новое место.

Удалить пользовательские папки

Чтобы удалить папку, щелкните ее правой кнопкой мыши в модуле « Диспетчер проектов» и выберите « Удалить» .

RoboHelp позволяет создавать контент на нескольких языках. Язык применяется к тексту, словарю и индексу проекта. Однако имейте в виду, что ОС конечного пользователя должна быть на том же языке для справочных систем HTML, что и язык проекта, в противном случае он будет переопределен языком ОС.

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

Сравнение контента на разных языках

Чтобы сравнить контент на разных языках, откройте темы, созданные на разных языках. Перетащите вкладку одной из тем чуть ниже на кнопку «Дизайн» (вторая строка на панели документа) и выберите, хотите ли вы сравнить их по вертикали или по горизонтали.

Язык для перевода файла проекта

На вкладке «Вывод» выберите «Стоп-слова», как показано на следующем снимке экрана.

Вы можете изменить следующие параметры на соответствующих вкладках в диалоговом окне «Дополнительные параметры локализации».

  • Stop List - Добавьте слова, которые необходимо игнорировать при текстовом поиске.

  • Phrases - Добавьте фразу, которую мастер Smart Index Wizard будет использовать при поиске содержания темы по ключевым словам.

  • Labels - Измените текст для каждого перечисленного элемента пользовательского интерфейса.

  • "Always Ignore" Words - Добавьте слово или фразу, которые мастер Smart Index Wizard игнорирует при создании индекса.

  • Synonyms- Добавить синоним к слову. Результаты всегда возвращаются для искомых слов даже при поиске синонима.

В следующей главе мы поймем, как импортировать файлы PDF в RoboHelp.

RoboHelp позволяет импортировать контент из файлов PDF. ToC перенесены в файл справки. Однако имейте в виду, что зашифрованные файлы PDF или файлы, содержащие SWF, не будут импортированы. Вы можете создать проект, импортировав PDF-файл, или импортировать PDF-файл в проект.

Создание проекта из файла PDF

Чтобы создать проект из файла PDF, нам нужно будет выполнить шаги, указанные ниже.

Step 1- Перейдите в меню «Файл», нажмите «Новый проект» и перейдите на вкладку «Импорт». Выберите PDF-документ в списке типов файлов и нажмите OK.

Step 2- В мастере импорта PDF перейдите в папку с файлом PDF, который вы хотите импортировать, и нажмите «Далее». Введите сведения о проекте и нажмите Далее. Выберите желаемые параметры преобразования и нажмите «Готово», чтобы импортировать PDF-файл как файл справки HTML.

Step 3 - Когда вы решите создать новую тему (темы) на основе стиля (ов), RoboHelp проанализирует PDF-файл на предмет стилей и заголовков абзацев и разделит темы для вас.

Импорт файлов PDF в проект

Чтобы импортировать файлы PDF в проект, мы должны выполнить шаги, указанные ниже.

Step 1- Вы можете импортировать файлы PDF в существующий проект. Убедитесь, что модуль Project Manager открыт, затем щелкните правой кнопкой мыши папку Project Files. Нажмите наImport Topics… и перейдите к расположению файла PDF на диске.

Note - Вы также можете выбрать сразу несколько файлов PDF, удерживая клавишу Ctrl и щелкая каждый файл.

Step 2- В мастере импорта PDF перейдите в папку с файлом PDF, который вы хотите импортировать, и нажмите «Далее». Введите сведения о проекте и нажмите Далее.

Step 3- Выберите нужные параметры преобразования и нажмите «Готово», чтобы импортировать PDF-файл как файл справки HTML. Когда вы решите создать новую тему (темы) на основе стиля (ов), RoboHelp проанализирует PDF-файл на предмет стилей и заголовков абзацев и разделит темы для вас.

Как и файлы PDF, вы можете импортировать и связывать документы Microsoft Word в RoboHelp. Вы можете создавать новые файлы справки, импортируя документы Word или импортируя документы Word в существующие файлы справки. Перед импортом документов Word важно оптимизировать их для онлайн-вывода. У вас есть возможность импортировать или связывать документы Word. Важно выбрать тот, который соответствует вашим потребностям.

Импорт позволяет интегрировать документ Word в файл справки и настраивать имена файлов из Менеджера проектов. Связывание позволяет вам динамически обновлять исходный документ, включая ToC, индекс и глоссарий.

Вы также можете повторно создать удаленные темы и сохранить изменения в созданных темах. Однако вы не можете изменить имена файлов и заголовки тем из Менеджера проекта.

Оптимизация документов Word для онлайн-вывода

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

  • Heading hierarchies- Применяйте иерархические заголовки перед преобразованием для автоматической разбивки на страницы. Например, вы можете применить стиль «Заголовок 1» в своем документе Word, сопоставить этот стиль с аналогичным стилем RoboHelp и определить разбиение на страницы для создания темы HTML для каждого стиля «Заголовок 1».

  • Inline styles and style overrides - Вы можете конвертировать встроенные стили в стили CSS в RoboHelp.

  • Header and footer information- RoboHelp может конвертировать верхние и нижние колонтитулы. Чтобы обеспечить согласованность между вашими темами, вы можете определить главную страницу, содержащую необходимую информацию о верхнем и нижнем колонтитулах.

  • Chapter versus topic- В интерактивной справке организационная единица является темой, и пользователи просматривают темы по одной. Предоставляйте исчерпывающую информацию, не добавляя избыточности, путем группирования связанных тем.

  • ToCs - Вы также можете импортировать ToC Word в ToC RoboHelp, определив иерархию тем и представив ее в ToC RoboHelp.

  • Context sensitivity- Вы можете назначать контекстно-зависимые маркеры справки в документах Word, используя настраиваемые записи сносок. RoboHelp читает эти записи сносок и назначает идентификаторы карты созданным темам.

Импорт документа Word в RoboHelp

В отличие от PDF-файлов, для которых не требуется установка Acrobat или Acrobat Reader, вам необходимо установить Microsoft Word, чтобы иметь возможность импортировать документы Word в RoboHelp.

Чтобы импортировать документ Word, в модуле «Начальный» перейдите на вкладку «Импорт», выберите значок, представляющий документы Word (* .docx, * .doc), и выберите документ Word, который нужно импортировать. Введите данные проекта и нажмите Готово.

Связывание документа Word с проектом RoboHelp

Чтобы связать документ Word с проектом RoboHelp, мы должны выполнить шаги, указанные ниже.

Step 1 - В модуле Project Manager Pod щелкните правой кнопкой мыши папку Project Files и выберите Word Document из Linkподменю. Выберите один или несколько документов Word и нажмите «Открыть».

Step 2 - Щелкните правой кнопкой мыши связанный документ Word в папке «Файлы проекта» и выберите «Свойства».

Step 3 - В диалоговом окне «Параметры документа Word» укажите параметры для ToC, индекса и глоссария.

Step 4 - Чтобы создать ToC из документа Word, нажмите на Convert Table of Contents Установите флажок и выберите: добавить к существующим ToC или создать новый связанный ToC.

Step 5 - Чтобы создать индекс из документа Word, щелкните значок Convert Index Установите флажок и выберите: добавить к существующему индексу или создать новый связанный индекс.

Step 6 - Чтобы создать глоссарий из документа Word, щелкните значок Convert Glossary установите флажок и выберите: добавить к существующему глоссарию или создать новый связанный глоссарий.

Стили Word сопоставляются со стилями RoboHelp с помощью Cascading Style Sheets(CSS). CSS по умолчанию, используемый RoboHelp, называетсяRHStyleMapping.css. Вы можете изменить его на файл по вашему выбору или отредактировать этот файл CSS в предпочитаемом вами редакторе CSS.

Выбор CSS для сопоставления стилей

Чтобы выбрать CSS для сопоставления стилей, мы должны следовать пунктам, приведенным ниже.

  • Свяжите или импортируйте документ Word, стиль которого необходимо сопоставить с RoboHelp.

  • Откройте диалоговое окно «Параметры проекта» на вкладке «Проект» и щелкните вкладку «Импорт».

  • Выберите CSS из раскрывающегося меню CSS для сопоставления стилей. Вы также можете выбрать собственный CSS, выбрав <BrowseCSS> в раскрывающемся меню.

Преобразование стилей абзацев и символов Word в стили RoboHelp

Для преобразования абзацев Word и стилей символов в стили RoboHelp мы должны рассмотреть следующие шаги.

Step 1- Импортируйте или свяжите документ Word и перейдите в Настройки проекта. Выберите вкладку Импорт и нажмитеEdit… в разделе Word Document.

Step 2 - В диалоговом окне "Параметры преобразования" выберите стиль Word из Paragraph group. Вы можете выбрать картуRoboHelp styleк стилю Word из раскрывающегося меню Стиль RoboHelp. Выбрать[Source]чтобы сохранить внешний вид текста Word в формате онлайн-справки. Чтобы изменить выбранный стиль RoboHelp, нажмитеEdit Style.

Step 3 - Чтобы отметить стиль для глоссария, выберите Glossary DefinitionУстановите флажок, чтобы учесть стиль определения глоссария. ВыбратьGlossary Term Установите флажок, чтобы учесть стиль термина глоссария.

Step 4 - Для создания Help topic при каждом появлении выбранного стиля абзаца Word выберите Pagination (Split into topics based on this style) флажок.

Step 5 - Вы также можете выбрать или ввести User Defined HTML Tag для выбранного стиля абзаца.

Step 6- Вы также можете сопоставить и редактировать форматы символов Word в стилях символов в RoboHelp. Выберите стиль символа Word изCharacter group и выберите стиль символа RoboHelp из раскрывающегося меню.

Step 7 - Чтобы импортировать стиль символа Word, выберите [Source]из всплывающего меню. Вы можете изменить стиль персонажа в RoboHelp, нажав наEdit Style.

А Darwin Information Typing Architecture (DITA)map похожа на список содержания и ссылки на темы для определенного вывода. Они объединяют темы в последовательность и иерархию с учетом конкретных требований к доставке. Файл карты DITA имеет расширение .ditamap. Вы можете импортировать как карту DITA, так и файлы XML для созданияXHTML output.

Импорт файлов карты DITA

Чтобы импортировать файлы карт DITA, мы должны выполнить шаги, указанные ниже.

Step 1 - Перейдите в меню «Файл», нажмите New Projectи щелкните вкладку Импорт. Выберите PDF-документ в списке типов файлов и нажмите OK, чтобы открыть диалоговое окно DITA Open Toolkit Processing Options.

Step 2 - Просмотрите следующие настройки, доступные в диалоговом окне, и нажмите Готово.

  • Replace default XSLT file for conversion - Выберите файл XSL, который будет использоваться для преобразования файлов DITA в XHTML вместо файла XSL по умолчанию, используемого DITA Open Toolkit.

  • Use DITA val for conditional processing- XHTML создается на основе файла Val. Файл DITA Val содержит информацию о фильтрах, пометках и редакциях. Укажите файл DITA Val, который будет использоваться для условной обработки файлов DITA.

  • Show Index entries in Topics - Выберите для отображения записей указателя в темах RoboHelp.

  • Show image filename in Annotation - Выберите, чтобы добавить аннотации к изображениям с указанием имени файла изображения или полного пути для включения в темы.

  • Include Draft and Cleanup content - Выберите, чтобы включить черновик и необходимое содержимое для очистки (элементы, отмеченные как оставшиеся перед публикацией).

  • Select XHTML file to be placed in the header area (hdf) - Выберите расположение файла, содержащего XHTML, для размещения в области заголовка выходного файла.

  • Select XHTML file to be placed in the body running-header area (hdr) - Выберите расположение файла, содержащего XHTML, для помещения в область основного заголовка выходного файла.

  • Select XHTML file to be placed in the body running-footer Area (ftr) - Выберите расположение файла, содержащего XHTML, для помещения в нижний колонтитул основного текста выходного файла.

  • DITA Open Tool Kit Home Directory- Выберите абсолютное расположение домашней папки DITA Open Toolkit. Вы указываете это место только один раз. Он хранится в реестре.

Импорт файлов XML

Чтобы импортировать файлы XML в проект в RoboHelp, мы должны выполнить шаги, указанные ниже.

Step 1- RoboHelp создает тему для файла XML при импорте в существующий проект. Чтобы импортировать XML-файл, в модуле «Диспетчер проектов» выберите файл для импорта.

Step 2- Перейдите в раздел «Импорт» на вкладке «Проект» и в раскрывающемся меню выберите XML-файл. Выберите один или несколько файлов XML и нажмите «Открыть».

Step 3- В диалоговом окне «Выбор обработчика импорта XML» нажмите «Параметры». Вы также можете выбрать Импорт XML (CSS / XSL), чтобы установить дополнительные параметры.

Доступны следующие варианты -

  • Treat as text flow - Импортируйте файл XML как текст HTML без форматирования.

  • Treat as XML tree view- Импортируйте XML-файл в виде дерева HTML. HTML импортируется как код.

  • Use customized CSS/XSL file - Выберите файл во всплывающем меню.

Step 4 - Нажмите OK, чтобы импортировать XML-файл в проект.

RoboHelp может импортировать скомпилированные WinHelp 4.0 (HLP) или же WinHelp Project File (HPJ)в свой проект. Хотя вы не можете вывести файл WinHelp из RoboHelp HTML, вы можете импортировать файл HPJ, который является основным организационным файлом, содержащим набор всех исходных файлов.

В модуле Starter выберите либо WinHelp (*.hlp) или же WinHelp Project (*.hlp)и перейдите к просмотру местоположения файла на диске. Нажмите «Готово», чтобы преобразовать и импортировать файл как файл RoboHelp.

Ограничения HTML с файлами HLP

При преобразовании файлов HLP в HTML существуют некоторые ограничения. Все эти ограничения кратко объясняются следующим образом:

  • Bullets- Темы WinHelp не должны использовать ссылки на растровые изображения в качестве маркеров. Однако вы можете сохранить маркированные списки.

  • HTML Jumps - Переход к HTML-страницам, которые не были преобразованы, но вы можете легко воссоздать ссылки в редакторе дизайна после создания тем HTML.

  • Jumps to external WinHelp topics - Переход к внешним темам WinHelp, удаленным из тем HTML.

  • Macros, buttons, and shortcuts- Макросы, которые конвертируют, включают Jump Context, JumpId и PopupId. Остальные макросы не конвертируются.

  • Microsoft Word HTML styles - Стили HTML Microsoft Word не используются для форматирования тем HTML.

  • Microsoft Word templates - Шаблоны Word, которые используются для форматирования файлов RTF в WinHelp, не преобразуются в таблицы стилей HTML.

  • Mid-Topic jumps - Переходы по средней теме преобразуются в закладки.

  • Multimedia files (AVI and WAV)- Эти файлы нельзя преобразовать в файлы HLP. Однако вы можете добавить звук и видео к темам HTML в редакторе дизайна.

  • Non-scrolling regions - Вывод на основе HTML не поддерживает области без прокрутки.

  • Numbered lists- В нумерованных списках по умолчанию используется шрифт с засечками из 12 пунктов. Чтобы изменить стиль, вам необходимо создать новый стиль нумерованного списка и переформатировать его в RoboHelp.

  • Related Topics buttons - Ключевые слова по связанным темам переводятся в термины по связанным темам.

  • Secondary windows- Вторичные окна WinHelp не переводятся. В отличие от тем WinHelp, темы HTML не поддерживают ссылки, отображающие информацию во вторичных окнах.

  • Table of contents - Файл HTML TOC (HHC) не поддерживает страницы WinHelp, которые ссылаются на внешние темы WinHelp или справочные макросы, или которые содержат операторы ссылок.

  • What's This? Help- Контекстно-зависимая справка не конвертируется. Что это? Разделы справки или диалоговые разделы преобразуются в обычные разделы справки в формате HTML.

  • Microsoft Word formatting - В темах HTML преобразуется следующее форматирование - подчеркивание, интервалы между абзацами, отступы, выравнивания, границы таблиц, электронные таблицы, цвета фона и водяные знаки.

В следующей главе мы поймем, что такое контроль версий и какую пользу он приносит RoboHelp.

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

RoboHelp поддерживает родные Microsoft SharePoint 2010и выше интеграции. Поддержка Microsoft SharePoint устанавливается при установке самой программы. Программа установки также устанавливает.NET Framework 4.0 и SQL Server Compact 3.5 SP2, который необходим для интеграции с SharePoint.

Настроить параметры SharePoint

Чтобы настроить параметры SharePoint, перейдите в меню «Файл», нажмите «Параметры» и выберите «Контроль версий». Чтобы можно было сравнивать файлы между вашим компьютером и сервером, у вас должна быть установлена ​​программа сравнения файлов.

Вы можете скачать бесплатную программу под названием Winmerge из http://winmerge.org/и введите путь к программе в параметре «Путь» в области «Параметры SharePoint». Вы также можете ввести любые аргументы, специфичные для программы.

Вы также можете настроить следующие параметры -

  • Notify before overwriting writable files - Уведомляет пользователя перед перезаписью любых файлов с возможностью записи, которые не были извлечены.

  • Replace local file even if server version is same - Получать последние файлы с сервера, даже если локальная версия файла и версия сервера совпадают.

  • Default Check-in Option- Выберите, чтобы вернуть файлы как основную или вспомогательную версию. По умолчанию регистрируется как основная версия.

В следующей главе мы узнаем, как работать с отчетами в RoboHelp.

RoboHelp позволяет легко получать отчеты о проекте. Вы можете экспортировать, печатать и отправлять отчеты изReports Dialog Box.

Экспорт отчетов по проектам

Щелкните вкладку «Инструменты» и выберите тип отчета. При необходимости настройте отчет. Нажмите «Сохранить как ...» и сохраните отчет как файл RTF или TXT.

Распечатать отчеты по проекту

В диалоговом окне «Отчеты» настройте отчет по мере необходимости. Нажмите наPrint…распечатать отчет. Вы можете распечатать ToC или индекс из модуля ToC или модуля Index, перейдя в меню «Файл» и нажав «Печать».

Отправить отчеты по проекту

В диалоговом окне «Отчеты» настройте отчет и щелкните «Отправить по почте…». Перед использованием этой функции в системе должна быть настроена программа электронной почты. Отчет появится в теле сообщения, которое вы можете отредактировать перед отправкой.

С помощью RoboHelp вы можете создавать и настраивать широкий спектр отчетов. Мы рассмотрим пример ненастраиваемого и настраиваемого отчета. Все отчеты доступны изTools таб.

Отчет о неработающих ссылках

К этому отчету можно получить доступ, щелкнув значок идентификатора карты на вкладке «Инструменты» и выбрав « Неработающие ссылки» . Он находит файлы, содержащие неработающие ссылки. Этот отчет не настраивается.

Индексный отчет

Нажми на ToC icon на вкладке Инструменты и выберите Indexиз раскрывающегося меню. В этом отчете можно настроить следующие параметры.

  • Keywords - Включает все ключевые слова из индекса.

  • Keywords and Topics- Содержит список ключевых слов. Каждое ключевое слово содержит список тем, в которых оно используется.

  • Topics and Keywords- Содержит список тем. В каждой теме перечислены ключевые слова, связанные с этой темой.

  • Select Index - Выберите индекс из списка, чтобы создать отчет для выбранного индекса.

Модуль Project Manager позволяет легко создавать, сохранять или открывать темы.

Создание темы

Чтобы создать тему в RoboHelp, мы должны выполнить шаги, указанные ниже.

Step 1 - Для начала создайте проект, щелкните правой кнопкой мыши папку XHTML Files (Topics), перейдите в меню «Создать» и выберите Topic… , чтобы открыть диалоговое окно «Новая тема».

Step 2- В диалоговом окне «Новая тема» укажите заголовок темы и выберите переменную из списка «Переменные», затем нажмите «Вставить». Переменные помогают управлять изменениями и обеспечивать согласованность.

Step 3- В соответствии с протоколом именования файлов HTML используйте подчеркивания, а не пробелы. При необходимости выберите главную страницу и укажите язык для новой темы. Если вы не укажете язык, RoboHelp будет использовать языковые настройки проекта по умолчанию.

Step 4- Вы можете добавить ключевые слова, чтобы пометить содержание темы. Ключевые слова можно разделять запятой, пробелом или точкой с запятой. Если вы предпочитаете не включать эту тему в результаты поиска, установите флажокExclude this topic from Search флажок.

Сохранение темы

Чтобы сохранить тему, просто нажмите Ctrl + S на клавиатуре или щелкните значок «Сохранить все» на вкладке «Проект».

Открытие темы

Чтобы открыть тему, дважды щелкните имя темы в модуле Project Manager или модуле Topic List, чтобы открыть тему в Design Editor. Чтобы открыть тему в любом редакторе, щелкните тему правой кнопкой мыши, перейдите вEdit With меню и выберите редактор.

RoboHelp может создавать файлы тем в XHTML. XHTML допускает структурированную разработку, которая гарантирует хорошо написанный код. Все старые темы RoboHelp для HTML обновлены до XHTML. Темы XHTML соответствуют спецификации XHTML 1.0 Transitional от Консорциума World Wide Web (W3C).

Темы имеют тип документа XHTML Transitional 1.0 - <DOCTYPE html PUBLIC «- // W3C3DTD XHTML 1.0 Transitional // EN» «http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd»>

Файлы XHTML, созданные RoboHelp, могут редактироваться сторонними редакторами, такими как Notepad или же Adobe Dreamweaver. Чтобы просмотреть исходный код XHTML, откройте тему и щелкните значокHTML View beside в Design Editor.

Преобразование XHTML в HTML

Вы можете преобразовать темы XHTML в HTML в выводе SSL. Для этого перейдите в меню «Файл», затем перейдите в «Параметры» и нажмите «Общие». В разделе «Генерация» установите флажок «Преобразовать отредактированные темы RoboHelp в HTML» и нажмите «ОК».

Проверка XHTML

Сгенерированный RoboHelp код XHTML можно проверить на соответствие спецификациям XHTML Transition 1.0 W3C. Чтобы проверить тему, щелкните ее правой кнопкой мыши и выберите «Проверить соответствие W3C», чтобы подтвердить тему. Это приведет к созданию окна вывода на панели документа, в котором будут показаны результаты.

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

Главные страницы - это форма шаблонов, которые помогают отделить макет и стиль от содержимого. Информация о макете главной страницы связана с файлом CSS. Шаблон главной страницы определяет размещениеHeaders, Footers и Placeholders для Body, Breadcrumbs и Topic ToC.

Создание мастер-страницы

Чтобы создать эталонную страницу, перейдите на вкладку «Вывод» и в меню эталонной страницы выберите New Master Page.

В диалоговом окне «Новая мастер-страница» введите имя для мастер-страницы. Перейдите на вкладку «Внешний вид», выберите таблицу стилей для применения к новой эталонной странице и нажмите «ОК». Это также можно изменить позже в свойствах главной страницы.

Редактирование мастер-страницы

Чтобы отредактировать эталонную страницу, просто дважды щелкните эталонную страницу в Output Setup Pod или щелкните правой кнопкой мыши главную страницу и выберите Edit. Внесите желаемые изменения.

Вставка заполнителя

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

Чтобы вставить новый заполнитель, поместите курсор ниже или после заполнителя основного текста. Перейдите на вкладку «Вставка» и в разделе «Дизайн страницы» нажмите кнопку «ToC темы», чтобы выбрать нужный заполнитель из раскрывающегося меню.

Применение мастер-страниц

В списке тем в Диспетчере проектов выберите одну или несколько тем, которым вы хотите назначить главную страницу. Щелкните правой кнопкой мыши тему (темы) и выберите Свойства.

На вкладке «Общие» выберите список мастер-страниц, доступных в раскрывающемся меню «Мастер-страница», и нажмите «ОК». Вы также можете выбрать предварительный просмотр, нажав кнопкуSpectacles Icon рядом с меню мастер-страницы или перейдите к мастер-странице на диске.

RoboHelp упрощает управление темами. Вы можете переименовывать темы, обновлять ссылки на темы и даже отслеживать статус темы.

Переименование темы

Чтобы переименовать тему, щелкните правой кнопкой мыши тему в Диспетчере проектов и выберите «Свойства».

На вкладке «Общие» введите новый заголовок в поле «Заголовок темы» и нажмите «ОК», чтобы обновить заголовок. Вы также можете нажать кнопку «Переименовать» в разделе «Файл» на вкладке «Проект».

Обновить ссылки на темы

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

  • Text links- Путь ссылки обновлен, но текст ссылки, видимый пользователю, нет. Если текст ссылки в любой теме включает заголовок темы, мы должны обновить каждую тему.

  • Topic heading - Чтобы изменить заголовок темы в соответствии с заголовком темы, измените его в редакторе дизайна.

  • Table of Contents- В модуле «Содержание» щелкните правой кнопкой мыши книгу или страницу и выберите «Переименовать». Введите новый заголовок.

  • Index- Если заголовок темы является ключевым словом индекса, обновите ключевое слово в модуле указателя. Щелкните правой кнопкой мыши ключевое слово в верхней панели и выберите «Переименовать». Введите новый заголовок.

Отслеживание статуса темы

Статус новых тем по умолчанию: In Progress. Информация о статусе отображается в отчете по проекту. Чтобы изменить статус темы или установить приоритеты, откройте Свойства темы в разделе «Файл» на вкладке «Проект» и щелкните на вкладке «Статус». Вы можете изменить стадию разработки темы в раскрывающемся меню «Статус».

Введите число для присвоения приоритета в поле Priority. Вы также можете установить приблизительные или фактические часы разработки в поле Часы. Вы можете отмечать пункты в списке дел по мере их заполнения. Любое другое описание можно ввести в поле «Комментарий».

RoboHelp может проверять орфографию в Content, ToC, Index и Glossaryпроекта. Вы можете проверить правописание в теме или во всем проекте.

Проверка орфографии в теме

Чтобы проверить орфографию в теме, откройте тему в редакторе дизайна и на вкладке «Обзор» щелкните либо Spell Check или же Spell Check All Topics в разделе «Корректировка».

RoboHelp сканирует документ и рекомендует исправления для слов. Вы также можете добавлять слова в текущий словарь.

Проверка орфографии в проекте

Вы также можете проверить правописание всего проекта, включая глоссарий, указатель и ToC. Для этого на вкладке «Обзор» щелкните «Проект проверки орфографии». Это откроет такое же диалоговое окно правописания, как и раньше. Вы можете переходить к различным частям проекта, нажимая «Пропустить».

Настроить словарь

Вы можете добавить дополнительные слова в словарь, используя Dictionary Editor. Слова в редакторе словаря чувствительны к регистру. На вкладке "Обзор" нажмитеSpelling Options. На вкладке Параметры в диалоговом окне Параметры правописания щелкнитеModify… , чтобы открыть редактор словаря.

Введите слово, которое хотите добавить в словарь. Затем нажмите кнопку «Добавить» и нажмите «ОК».

Использование поиска и замены

С помощью функции «Найти и заменить» вы можете искать и заменять текст, HTML, атрибуты и т. Д. В текущей теме или проекте или даже в файлах и папках по указанному пути. Чтобы открыть модуль поиска и замены, нажмитеCtrl+Shift+F на клавиатуре или нажмите «Найти и заменить» на вкладке «Проект».

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

Могут применяться следующие расширенные фильтры -

  • Begins With - Укажите фразы, слова или символы, которые должны встречаться в начале найденных экземпляров.

  • Ends With - Укажите фразы, слова или символы, которые должны стоять в конце найденных экземпляров.

  • Contains - Укажите фразы, слова или символы, которые должны содержать найденные экземпляры.

  • Does Not Contain - Укажите фразы, слова или символы, которые в найденных экземплярах не должны содержаться.

Введите текст, тег или атрибут, который вы хотите заменить, в поле «Заменить на». Если вы хотите выполнить поиск без замены, оставьте поле «Заменить на» пустым.

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

  • Current Project - Поиск в текущем проекте.

  • Current Window - Искать в текущей теме.

  • Opened Files - Искать все файлы, открытые в настоящее время в RoboHelp.

  • Path - Искать все файлы в выбранном пути к папке.

В следующей главе мы узнаем, как обеспечить соответствие W3C в RoboHelp.

Вы можете проверить как темы, так и проекты на соответствие W3C. RoboHelp проверяет весь контент и показывает предупреждения или сообщения об ошибках в случае несоответствия. Чтобы проверить тему, щелкните правой кнопкой мыши тему в модуле «Диспетчер проектов» и выберите «Проверить соответствие W3C».

Чтобы проверить проект, щелкните правой кнопкой мыши папку Project Files в модуле Project Manager и выберите Validate W3C Compliance. В зависимости от ситуации в модулях просмотра вывода и списках ошибок отображаются следующие сообщения.

  • Errors - неверные или незакрытые теги

  • Warnings - неверный тег XHTML

  • Information - все темы проверены

Модуль «Список ошибок» показывает строку и столбец в HTML, где произошла ошибка. Вы можете напрямую перейти к этой строке, дважды щелкнув ошибку.

RoboHelp включает Design Editor и HTML Editorпо умолчанию. Вы также можете использовать сторонние редакторы, такие какMicrosoft Word или же Adobe Dreamweaver для редактирования.

Редактор дизайна RoboHelp

Выберите файл темы в модуле Project Manager, чтобы открыть его в редакторе дизайна. Вы можете использовать редактор дизайна RoboHelp для выполнения задач обработки текста и для вставки онлайн-элементов, таких как ссылки, мультимедиа и динамический HTML.

Вы также можете добавить ключевые слова индекса к темам, применить условный текст, создать последовательности просмотра, сопоставить идентификаторы и редактировать главные страницы. Вы можете редактировать любой стандартный файл XHTML или HTML в редакторе дизайна.

HTML-редактор RoboHelp

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

Вы можете использовать расширения ключевых слов, чтобы автоматически предлагать ключевые слова или теги при вводе. Когда вы начинаете вводить ключевое слово, вы можете выбрать его из списка расширения ключевых слов, чтобы вставить ключевое слово или тег. В дополнение к существующим ключевым словам и тегам вы также можете указать свои собственные ключевые слова, щелкнув правой кнопкой мыши в редакторе HTML и выбравEdit Expansions….

Использование RoboHelp со сторонними редакторами HTML

Вы можете использовать сторонние редакторы HTML, пока RoboHelp открыт, но специальные функции RoboHelp, такие как всплывающие окна только с текстом или элементы управления ссылками, недоступны. Вставьте изображения и специальные эффекты на основе JavaScript в папку «Файлы багажа». Если вы их вставляете с помощью стороннего редактора.

Чтобы добавить редактор HTML, нажмите «Параметры» на вкладке «Файл» и нажмите «Ассоциации файлов». В разделе «Редакторы HTML» нажмите «Добавить» и выберите из списка рекомендуемых программ или перейдите к расположению программы на диске.

Вкладка «Правка» предоставляет параметры для работы с символами и шрифтами. Вы можете создавать встроенные стили, используя вкладку «Правка», которая переопределяет существующую таблицу стилей.

Добавить или удалить форматирование символов

Чтобы добавить или удалить форматирование шрифта, выберите требуемый текст и на вкладке «Правка» перейдите в раздел «Символ», нажмите «Форматирование символов» и затем выберите «Шрифт».

Создать набор шрифтов

Набор шрифтов - это набор шрифтов, которые можно применить в таблице стилей. Например, вы можете создать набор шрифтов, используя Calibri в качестве первого шрифта, а затем Cambria и Segoe UI (по порядку) в качестве заменяющих шрифтов. Если программа просмотра не имеет установленного Calibri, она будет использовать Cambria, а затем Segoe UI.

Чтобы создать набор шрифтов, нажмите «Наборы шрифтов» в меню «Форматирование символов» на вкладке «Правка». Вы можете изменить существующий набор шрифтов, выбрав шрифт и нажавModify… или создайте новый набор, щелкнув «Новый» и введя имя для набора шрифтов.

В диалоговом окне «Изменить набор шрифтов» выберите первый шрифт и нажмите «Добавить». Выберите оставшиеся шрифты в порядке предпочтения, затем добавьте их и нажмите кнопку ОК. Наборы шрифтов сохраняются и затем связываются с проектами.

Вкладка Правка предоставляет параметры для работы с абзацами. Вы можете создавать встроенные стили, используя вкладку «Правка», которая переопределяет существующую таблицу стилей.

Выравнивание и отступ абзацев

Выберите абзац для выравнивания и нажмите одну из четырех кнопок выравнивания в разделе «Абзац» на вкладке «Правка». Чтобы установить отступ, нажмите кнопку «Увеличить отступ» или «Уменьшить отступ» в том же разделе.

Отрегулировать межстрочный интервал

Чтобы настроить межстрочный интервал, нажмите «Абзац» в меню «Форматирование абзаца» на вкладке «Правка».

Установите параметры интервала в диалоговом окне абзаца; укажите количество пробелов над и после каждого абзаца, а также интервал между строками и нажмите OK.

RoboHelp позволяет легко редактировать границы и фон в вашем контенте. Применяемое форматирование создает встроенные стили, которые переопределяют таблицы стилей.

Добавить или изменить границы и фон

Выберите абзац в теме и в Paragraph Formatting в меню на вкладке Правка нажмите Borders and Shading. Щелкните вкладку «Границы» или вкладку «Затенение», укажите необходимые параметры и нажмите «ОК».

Добавить границы к изображениям

Дважды щелкните изображение в Design Editor. В диалоговом окне "Изображение" нажмите "Границы", чтобы открыть диалоговое окно "Границы" и установить необходимые параметры. Щелкните ОК.

Добавляйте звуки в темы

Щелкните правой кнопкой мыши тему в Диспетчере проектов и выберите «Свойства». На вкладке «Внешний вид» введите звуковой файл в поле «Фоновый звук». Поддерживаемые звуковые форматы включают в себя -.au, .mid, .rmi и .wav. Введите количество воспроизведений в поле Sound Loop Count.

RoboHelp позволяет организовать данные в таблицы. Таблицы в RoboHelp полностью настраиваются с возможностью применения стилей, которые можно использовать в нескольких темах. Стили таблиц из документов Word или FrameMaker можно импортировать и сопоставить со стилями таблиц RoboHelp.

Вставка таблиц

Перейдите на вкладку «Вставка» и щелкните значок «Таблица», чтобы выбрать количество строк и столбцов для добавления. Щелкните, чтобы вставить таблицу.

Вы также можете вставить пользовательские таблицы, нажав «Вставить таблицу…». Это откроет диалоговое окно, в котором вы можете указать количество строк и столбцов и выбрать предопределенные стили таблиц.

Редактирование таблиц

Чтобы отредактировать таблицу, щелкните ее, чтобы активировать вкладку Таблица на ленте. На этой вкладке вы можете добавлять или удалять строки и столбцы, а также объединять или разделять ячейки. Вы также можете изменить свойства таблицы, такие как выравнивание и ширину столбца.

RoboHelp предлагает несколько вариантов работы со списками. Вы можете делать отступы в списках и применять стили маркеров и форматы нумерации.

Списки отступов

Выберите список в теме, в которой вы хотите сделать отступ, и на панели инструментов «Правка» выберите либо «Уменьшить отступ», либо «Увеличить отступ» по мере необходимости.

Список соответствия и цвета маркера

Вы можете сопоставить цвет маркеров с цветом списка, просто изменив цвет шрифта. Выберите список, цвет которого вы хотите изменить, и на вкладке «Правка» щелкните меню «Форматирование символов» и выберите «Шрифт» или просто нажмите Ctrl + D. В появившемся диалоговом окне выберите желаемый цвет шрифта. Цвет маркера и цвет списка станут одним в виде встроенного стиля.

Применить нумерацию к списку

Выберите список, который вы хотите пронумеровать, щелкните список правой кнопкой мыши и нажмите Bullets and Numbering…Выберите желаемый стиль нумерации. вNumbered На вкладке выберите нужный образец нумерации.

Добавить абзац в список

Чтобы добавить абзац в список, вставьте курсор в конец абзаца и нажмите Shift+Enterчтобы создать разрыв строки. Чтобы завершить разрыв строки и перезапустить маркеры или нумерацию, нажмите Enter.

Вы можете хранить статическую глобальную информацию, которую можно многократно использовать в вашем проекте, в виде User-Defined Variables(UDV). Когда вы изменяете переменную или значение, каждое вхождение этой переменной или значения обновляется во всем проекте.

В модуле «Пользовательские переменные» перечислены все пользовательские переменные в проекте.

Создание переменной, определяемой пользователем

Чтобы создать UDV, щелкните правой кнопкой мыши слово в теме, перейдите в Add toи выберите Пользовательская переменная. В появившемся диалоговом окне укажите Имя переменной и нажмите OK.

Создание набора переменных

Наборы переменных позволяют изменять значения различных определяемых пользователем переменных и использовать их в различных выходных данных. ВDefault Variable Set- это главный набор переменных. Когда вы вставляете переменную, она берется из набора переменных по умолчанию.

Чтобы использовать набор переменных, отличный от набора переменных по умолчанию, нажмите значок «Добавить / изменить набор переменных» в модуле UDV и нажмите «Добавить», чтобы указать имя для нового набора переменных, а затем нажмите «ОК».

Редактирование пользовательских переменных

Чтобы отредактировать пользовательскую переменную, щелкните правой кнопкой мыши имя переменной и нажмите Edit…. В определяемом пользователем диалоговом окне «Свойства переменной» вы можете редактировать различные свойства переменной, такие как имя переменной, набор, к которому она принадлежит, значение и дополнительное описание.

Правила мультимедиа помогают определить внешний вид документа на экранах разных размеров.

Определение стилей для конкретных носителей в таблице стилей

Чтобы определить стиль, зависящий от носителя, щелкните правой кнопкой мыши таблицу стилей в модуле «Диспетчер проектов» и выберите «Изменить». вStyles Dialog Box, выберите стиль, который нужно изменить для определенного носителя. Выберите тип носителя из списка Медиа.

  • Стиль (нет) используется для определения общих стилей, а стиль печати - для принтеров.

  • При необходимости измените стиль и нажмите ОК.

Добавление правила мультимедиа в стили темы

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

  • Выберите медиа или имя профиля экрана из списка медиа.

  • При необходимости измените стиль и нажмите ОК.

Таблица стилей может быть связана с любым количеством тем HTML или новой темой. Если вы создаете таблицу стилей в проекте и применяете ее к новой теме, все темы, которые вы создадите позже, будут использовать новую таблицу стилей. При необходимости вы можете связать тему с другой таблицей стилей.

Связывание таблицы стилей с темами или мастер-страницами

Чтобы связать таблицу стилей, выберите одну или несколько тем из списка тем, щелкните правой кнопкой мыши, выберите «Свойства» и щелкните вкладку «Внешний вид».

Выберите таблицу стилей в списке или перейдите к новой таблице стилей на своем компьютере. Вы можете нажать «Создать», чтобы создать таблицу стилей, или отредактировать таблицу стилей в диалоговом окне «Стили».

Создать таблицу стилей

В default.cssявляется таблицей стилей по умолчанию, пока вы не создадите таблицу стилей или не свяжете другую таблицу стилей с новой темой. Чтобы создать таблицу стилей, перейдите на вкладку «Правка» и в разделе «CSS» щелкните «Новая таблица стилей».

В поле Имя введите имя файла, включая .css extensionи выберите расположение папки. Если вы хотите создать новую таблицу стилей на основе существующей, выберите существующий стиль в раскрывающемся меню «Копировать стили из». Нажмите «Создать», чтобы открыть диалоговое окно «Стили» для создания нового стиля, а затем нажмите «ОК».

В этой главе мы поймем, как стилизовать таблицы стилей.

Создайте стиль в диалоговом окне "Стили"

Чтобы создать стиль, щелкните правой кнопкой мыши таблицу стилей, в которой вы хотите создать стиль, в модуле Project Manager и нажмите «Изменить». Нажмите «Создать» и выберите тип стиля. По умолчанию новый стиль создается с именем по умолчанию, например Style1.

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

Для дополнительных параметров нажмите Формат и выберите один из следующих вариантов -

  • Font - Выберите семейства шрифтов, размер и атрибуты, например полужирный или курсив.

  • Paragraph - Установите отступы, межстрочный интервал и выравнивание.

  • Borders and Shading- Используйте вкладку «Границы», чтобы задать типы, цвет, толщину линий и интервалы границ. Используйте вкладку «Затенение», чтобы установить цвет фона и параметры изображения.

  • DHTML Effects - Выберите, какой динамический HTML-эффект включать и когда его включать.

Создайте стиль с помощью редактора дизайна

Вы можете создавать стили на лету с помощью редактора дизайна. Для этого выделите текст в теме и примените форматирование. Не снимая выделения с текста, введите имя стиля в списке «Стиль» на вкладке «Правка» и нажмите клавишу «Ввод». В появившемся диалоговом окне нажмите «Создать».

В Style Editorпозволяет создавать и настраивать стили таблиц в соответствии с вашими требованиями. Изменения стиля таблицы влияют на все таблицы, использующие этот стиль.

Применить стили таблицы

Чтобы применить стиль таблицы к существующей таблице, щелкните правой кнопкой мыши существующую таблицу в теме и выберите Table Style…. ВыбратьClean Table Inline Formattingв диалоговом окне «Выбор стиля таблицы», чтобы удалить все встроенные стили, используемые в таблице. Выберите стиль из списка «Доступные стили таблиц» или выберите стиль глобальной таблицы (шаблоны таблиц) и нажмите «ОК».

Создание стилей таблиц

Откройте модуль «Стиль и форматирование» на вкладке «Проект». На вкладке "Стиль и форматирование" нажмитеCreate New Styleи выберите Стиль таблицы. Назовите новый стиль таблицы и нажмите OK.

Вы можете применить форматирование ко всей таблице, первому или последнему столбцу или строке или группе строк или столбцов. В списке «Применить форматирование к» выберите столбцы или строки для форматирования.

Выберите шрифт, размер и цвет. Выберите границу и цвет границы и нажмите Применить. Новый стиль появится в списке «Стили CSS» диалогового окна «Стили таблиц». Выберите этот стиль, чтобы позже создавать таблицы с таким же стилем.

<Начать здесь> С помощью RoboHelp вы можете создавать как списки HTML, так и расширенные списки. Расширенные списки могут быть одноуровневыми или многоуровневыми.

  • HTML lists - Все заказано <ol> и неупорядоченный <ul> списки подпадают под списки HTML.

  • Advanced lists - Создает иерархический или структурный список, например нумерованные стили заголовков, с такой нумерацией, как 1, 1.1, 1.1.1 и т. Д.

Создавайте списки HTML

В модуле «Стили и форматирование» выберите «Стили списка». Щелкните модуль правой кнопкой мыши, перейдите в «Новое меню» и выберите «Стиль списка». Назовите новый список, выберите шрифт, размер и цвет шрифта для нового стиля списка.

Вы можете нажать кнопку «Создать нумерованный список» или кнопку «Создать маркированный список», чтобы создать нумерованный или маркированный список.

Создавать многоуровневые списки

В модуле «Стиль и форматирование» нажмите «Создать новый стиль» и выберите «Стиль многоуровневого списка». Введите имя нового многоуровневого списка и нажмите ОК. Выберите уровень списка в меню «Применить форматирование к» и выберите стиль абзаца, который будет применяться к текущему уровню списка. Вы можете выбрать предопределенный стиль списка в раскрывающемся меню «Стиль списка» или нажать «Создать», чтобы создать стиль списка.

В диалоговом окне «Изменить стиль» введите текст или числа для префикса последовательности или многоуровневого списка. Чтобы указать уровень для префикса, выберите уровень в меню «Вставить уровень». Вы можете добавить префикс к уровню в поле «Изменить стиль», разделив уровень и префикс разделителем, например точкой (.) Или угловой скобкой (>).

Примените форматирование к стилю списка и нажмите OK.

Вы можете редактировать Div, Hyperlink и Image стили с помощью редактора стилей или из модуля "Стили и форматирование".

  • Div используется для текстовых полей и позиционированных текстовых полей.

  • Hyperlink используется для гиперссылок, раскрывающихся горячих точек, расширяющихся горячих точек и терминов глоссария.

  • Image используется для размещения изображения.

Создавайте стили на основе стилей Div, Hyperlink и Image

Чтобы создать стиль на основе стилей Div, Hyperlink или Image, дважды щелкните файл CSS в модуле Project Manager, чтобы открыть редактор стилей. Щелкните правой кнопкой мыши категорию стиля в списке стилей и выберите «Создать». Назовите стиль и установите необходимые свойства.

Редактирование стилей Div и Image

Мы можем редактировать свойства стилей Div и Image из редактора стилей или из модуля «Стили и форматирование». Вы можете редактировать атрибуты Size, Margin, Float и Border для разделения или раздела текста или изображения.

Используйте атрибут Float для размещения текста слева или справа от разделения. Если вы установите для атрибута Float значение Left, текст будет размещен справа. Свойство Overflow (для стилей Div) можно использовать, чтобы указать, что произойдет, если текст переполнится в разделе. Если вы укажете «Переполнение» как «Прокрутка», будет добавлена ​​полоса прокрутки для отображения переполняющегося содержимого.

Когда вы редактируете стили в файле CSS, все темы, связанные с файлом, обновляются.

Редактировать стиль с помощью диалогового окна "Стили"

Чтобы отредактировать стиль, щелкните правой кнопкой мыши файл CSS в модуле Project Manager и выберите Edit. Снимите флажок «Скрыть унаследованные стили» и выберите таблицу стилей в раскрывающемся меню «Доступно в».

Выберите стиль в поле «Стили», нажмите «Формат», выберите атрибуты и нажмите «ОК».

Редактирование стилей в редакторе HTML

Щелкните правой кнопкой мыши файл CSS в модуле диспетчера проектов и выберите «Изменить с помощью редактора кода», чтобы открыть таблицу стилей в новом окне темы. Теперь вы можете редактировать стили в соответствии с вашими требованиями.

Оглавление (ToC) - это иерархия папок и тем в Менеджере проекта. В этой главе мы увидим, как создавать и распечатывать ToC в RoboHelp.

Создать ToC

Чтобы создать ToC, щелкните правой кнопкой мыши папку «Оглавление» в Диспетчере проектов и выберите «Новое оглавление». Укажите имя для ToC. Вы также можете найти существующий файл ToC (.hhc), установив флажок Copy Existing Table of Contents, чтобы создать ToC из доступного ToC.

Щелкните OK, чтобы открыть модуль "Оглавление". В модуле «Оглавление» нажмите кнопку «Автоматическое создание оглавления». У вас есть возможность удалить текущий ToC перед созданием нового или создать новый, используя закладки в темах.

Распечатать ToCs

Чтобы распечатать ToC, щелкните модуль Table of Contents, перейдите на вкладку File и нажмите Print TOC. В появившемся диалоговом окне выберите один из следующих вариантов печати -

  • Overview - Распечатать все названия книг и страниц.

  • Detailed - Распечатать названия всех книг и страниц, названия тем, связанных с каждым из них, и папки, в которых они расположены.

Вы можете изменить параметры печати, щелкнув «Свойства» или «Параметры страницы».

Вы можете переименовывать книги и страницы ToC, не затрагивая заголовок связанной с ним темы. Вы также можете изменить заголовок темы, не влияя на ToC. В RoboHelp вы можете переименовывать, переупорядочивать или изменять свойства книг или страниц ToC.

Переименовать книги и страницы ToC

Чтобы переименовать книгу или страницу ToC, щелкните правой кнопкой мыши книгу или страницу в модуле «Оглавление» и выберите «Переименовать». Введите новое имя и нажмите Enter.

Изменить порядок книг и страниц ToC

Выберите книгу или страницу в модуле «Оглавление» и перетащите элемент в другое место.

Изменение свойств книг или страниц ToC

Чтобы переименовать книгу или страницу или отредактировать рамку окна, щелкните правой кнопкой мыши книгу или страницу в модуле «Оглавление». Щелкните «Свойства», чтобы открыть диалоговое окно «Свойства книги оглавления». Внесите желаемые изменения на вкладках «Общие» и «Дополнительно» и нажмите «ОК».

RoboHelp предоставляет несколько возможностей для управления ToC и устранения ошибок и неработающих ссылок.

Управление ToC с помощью отчетов

Мы можем получить различные формы отчетов ToC, которые мы можем распечатать, скопировать и отправить по электронной почте. Чтобы получить доступ к этим отчетам, перейдите наTools вкладка и в Reports выберите нужный тип отчета.

Отчет TOC отображает иерархию книг и страниц в оглавлении. Если вы измените названия тем или имена файлов, вы можете сравнить их с названиями, используемыми в книгах и страницах.

Вы можете выбрать один из следующих форматов отчетов -

  • Detailed - Включает заголовки книг и страниц, названия связанных с ними тем и названия папок, в которых находятся файлы.

  • Overview - Включает названия книг и страниц, а также названия связанных с ними тем.

Выявление и исправление неработающих ссылок ToC

Вы можете идентифицировать неработающие ссылки, когда они отображаются в модуле «Оглавление» с красным крестиком. На вкладке «Проект» щелкните «Неработающие ссылки» в разделе «Навигация».

Ссылки на выбранную тему

Показывает все ссылки на отсутствующую тему. Значок «Открытая книга»

указывает на неработающие ссылки на оглавление.

Все отсутствующие темы

Отображает темы, отсутствующие в проекте. Чтобы удалить элемент оглавления, выберите его в разделе «Ссылки на выбранную тему» ​​и нажмите «Удалить».

Мы можем создать несколько ToC для одного проекта, которые можно использовать для публикации из одного источника, например, отдельные оглавления для проекта, который содержит несколько языков или результаты для разных аудиторий.

Перемещение книг и страниц в ToC

Дважды щелкните оглавление в папке «Оглавление» в модуле «Диспетчер проектов». Перетаскивайте книги и страницы из одного модуля содержания в другой.

Создание нескольких ToC для проекта

У проекта может быть несколько ToC. Щелкните правой кнопкой мыши папку «Оглавление» в модуле «Диспетчер проектов» и выберите «Новое оглавление». В диалоговом окне «Новое оглавление» введите имя ToC и нажмите «ОК». В папке «Оглавление» создается пустое оглавление.

Объединить ToC

Также возможно объединить несколько ToC в проекте в одну ToC. Для этого выберите книгу или страницу, на которых вы хотите объединить оглавление, в модуле «Оглавление» и нажмите кнопку «Вставить заполнитель оглавления». В диалоговом окне «Вставить заполнитель оглавления» выберите оглавление для объединения в меню «Выбрать оглавление» и нажмите «ОК».

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

Добавьте ключевые слова индекса с помощью панели инструментов

Откройте модуль Index, перейдя в меню Pods на вкладке Project. Чтобы добавить ключевое слово, нажмите кнопку «Новое ключевое слово индекса» на панели инструментов модуля индекса. Введите ключевое слово в текстовое поле и нажмите Enter. Новое ключевое слово выделено жирным шрифтом, что означает, что оно еще не связано с темами.

Откройте модуль «Список тем» из меню «Модули» на вкладке «Проект». Чтобы связать ключевое слово с темами, перетащите темы из модуля «Список тем» на нижнюю панель модуля «Указатель». Связанное ключевое слово изменится с полужирного на обычный текст.

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

Ключевые слова индекса можно копировать между темами. После копирования вы можете настроить их для работы с отдельными темами. Щелкните правой кнопкой мыши тему в модуле «Список тем» и выберите «Свойства». На вкладке «Индекс» нажмите «Добавить существующий». Слева отображается список всех ключевых слов в проекте. Справа появится список всех ключевых слов для текущей темы. Если тема еще не проиндексирована, ключевые слова не появляются.

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

Ключевые слова указателя перекрестных ссылок

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

Добавьте ключевое слово для перекрестной ссылки в модуле указателя. Щелкните ключевое слово правой кнопкой мыши и выберите «Свойства». В диалоговом окне «Свойства ключевого слова индекса» установите флажок «Перекрестные ссылки» и в раскрывающемся меню выберите альтернативное ключевое слово. Перекрестная ссылка появится на нижней панели конструктора указателей.

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

Перемещение и сортировка ключевых слов индекса

Вы можете отсортировать ключевые слова индекса тремя способами:

  • Выберите ключевое слово и нажмите кнопку со стрелкой на панели инструментов.

  • Перетащите ключевое слово.

  • Щелкните ключевое слово правой кнопкой мыши. В меню Сортировка выберите либоCurrent Level или же Current Level and Below.

Сортировка доступна, только если действие разрешено для индекса.

Переименовать ключевые слова для темы

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

В модуле «Список тем» щелкните тему правой кнопкой мыши и выберите «Свойства». Выберите ключевое слово на вкладке "Указатель". Введите новое ключевое слово в текстовое поле и нажмите «Заменить».

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

Удаление ключевого слова из темы влияет только на текущую тему. Другие темы, которые ссылаются на ключевое слово, все еще связаны с ним. В диалоговом окне «Свойства темы» выберите ключевое слово на вкладке «Указатель» и нажмите «Удалить».

Вы можете использовать отчеты для управления индексами. Есть два типа отчетов для индексов -Index report и Unused Index Keywords reports.

Отчет Index позволяет отображать все ключевые слова, список ключевых слов с соответствующими темами или список тем и связанных с ними ключевых слов. В отчете «Неиспользуемые ключевые слова индекса» перечислены ключевые слова, на которые не ссылаются темы. Эти ключевые слова находятся в индексном файле.

Управление индексами с помощью отчетов

На вкладке «Инструменты» выберите «Индекс» в разделе «Отчеты». Просмотрите отчет и нажмите «Закрыть», чтобы закрыть отчет. Вы также можете распечатать, скопировать или отправить отчет по электронной почте.

Выявление и исправление неработающих ссылок для тем по ключевым словам

Откройте папку Broken Links в модуле Project Manager. Отсутствующие темы, если таковые имеются, будут отмечены красным крестиком. Щелкните отсутствующую тему правой кнопкой мыши и выберите Свойства. Ключевые слова, которые ссылаются на отсутствующую тему, отображаются со значком ключа, который можно удалить или повторно связать в модуле указателя.

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

Создать индекс автоматически

Мастер Smart Index может выполнять поиск по содержанию тем и предлагать ключевые слова. На вкладке «Инструменты» нажмите «Мастер интеллектуального индексации». В диалоговом окне Smart Index Wizard выберите один из следующих критериев поиска -

  • Find new and existing index keywords - Добавить ключевые слова на основе содержания темы и существующих записей указателя.

  • Add existing index keywords to topic(s) - Найдите темы по уже использованным ключевым словам и привяжите ключевые слова к темам.

  • Use custom search settings- Выберите «Настройки» и установите индивидуальные параметры поиска. В диалоговом окне Smart Index Settings вы можете определить эффективный язык для поиска ключевых слов индекса.

На следующем экране укажите следующие параметры -

  • Folder - Поиск тем в указанной папке.

  • Status - Поиск тем по статусу.

  • Check only new topics (that have not been Smart Indexed) - Искать только неиндексированные темы.

Нажмите Далее, чтобы увидеть предлагаемые ключевые слова для первой темы. Выберите, отмените выбор, переименуйте или удалите ключевые слова. Затем нажмите «Далее» и нажмите «Закрыть» в диалоговом окне «Результаты». Новые ключевые слова появятся в модуле указателя.

Синонимы поиска для индексирования

Откройте мастер Smart Index Wizard и дважды нажмите Next. Выберите ключевое слово в списке, нажмите Параметры и выберите Синонимы…

Ключевое слово появится в поле Word. Вы также можете нажать «Антонимы», чтобы просмотреть антонимы для ключевого слова. Чтобы найти синонимы и антонимы для дополнительных слов, введите слово в поле «Слово» и нажмите «Найти».

Выберите наиболее подходящее слово в разделе «Категории» и в разделе «Синонимы» выберите слово, которое нужно добавить в качестве ключевого слова. Нажмите «Добавить в тему» ​​и нажмите «Закрыть», чтобы закрыть диалоговое окно.

В одном проекте можно создать несколько индексов, которые будут добавлены в папку индексов. Вы можете щелкнуть правой кнопкой мыши любой индекс и выбратьSet as Default чтобы установить этот индекс в качестве индекса по умолчанию.

Слияние индексов

Чтобы объединить индексы в рамках проекта, откройте папку «Индекс» в модуле «Диспетчер проектов» и дважды щелкните индекс. В модуле указателя выберите ключевое слово, в которое вы хотите вставить объединенный указатель, и нажмите кнопку «Вставить заполнитель указателя». Выберите индекс для вставки и нажмите ОК.

Объединенный индекс отображается со значком «Новый индекс». Дважды щелкните значок, а затем нажмите «Просмотр».

Вы можете выбрать собственный шрифт для отображения заголовков книг и страниц, а также создать трехмерный вид ToC. Вы также можете добавить элементы управления ToC и индекс для лучшей навигации.

Настроить ToC

Щелкните правой кнопкой мыши макет для вывода справки HTML в модуле «Макеты единого источника» и выберите «Свойства». Нажмите «Изменить» рядом с «Дополнительные параметры» и перейдите на вкладку «Стили оглавления». Установите необходимые параметры стиля и нажмите ОК.

Добавить элементы управления ToC (HTML-справка)

Откройте тему в режиме просмотра «Дизайн». Щелкните в том месте, куда вы хотите добавить оглавление. В разделе HTML на вкладке «Вставка» выберите «Оглавление» в меню «Javascript». Элемент управления «Содержание» появится в редакторе дизайна.

Чтобы протестировать элемент управления, сгенерируйте проект. Элемент управления «Оглавление» отображает то же оглавление, что и в окончательном выводе.

Добавить элементы управления индексом (справка HTML)

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

В разделе HTML на вкладке Вставка выберите Индекс в меню JavaScript. Элемент управления Index появится в редакторе дизайна. Чтобы протестировать элемент управления индексом, скомпилируйте проект. Элемент управления индексом отображает тот же индекс, что и в окончательном выводе.

Чтобы создать глоссарий, дважды щелкните глоссарий в папке Glossary в модуле Project Manager. В модуле «Глоссарий» введите термин в поле «Термин». Нажми наAdd Term button(знак плюса) или нажмите Enter. Термин выделен жирным шрифтом, что означает, что у него нет определения. На панели «Определение для» введите определение.

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

Импорт и изменение глоссариев

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

Импортировать термины и определения из глоссария

Выберите глоссарий в папке Glossary в модуле Project Manager. На вкладке «Проект» выберите «Глоссарий» в раскрывающемся меню в разделе «Импорт». Нажмите кнопку «Обзор», чтобы перейти к файлу GLO. Чтобы определения во внешнем глоссарии заменяли совпадающие термины, выберитеReplace Existing Glossary Definitions.

Выберите один или несколько терминов в Terms in Imported glossary в списке нажмите кнопку «Добавить» или «Добавить все», а затем нажмите кнопку «ОК».

Изменить определения глоссария

Чтобы изменить определения глоссария, выберите термин, который нужно изменить, в модуле «Глоссарий» и отредактируйте текст определения.

Создать несколько глоссариев

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

Note - Вы не можете удалить глоссарий по умолчанию.

Чтобы создать несколько глоссариев, мы должны выполнить шаги, указанные ниже.

  • В модуле Project Manager Pod щелкните правой кнопкой мыши папку Glossary и выберите New Glossary.

  • Вы также можете нажать кнопку «Создать / просмотреть файл глоссария» и нажать «Создать».

  • Введите имя в текстовое поле.

  • Чтобы скопировать существующий глоссарий, выберите «Копировать существующий глоссарий» и нажмите кнопку обзора, чтобы перейти к глоссарию.

Глоссарий Горячие точки

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

Note - Панель глоссария не поддерживается в справке Oracle.

Добавить горячие точки расширяющегося глоссария

Чтобы добавить расширяющиеся горячие точки глоссария, перетащите термин из модуля «Глоссарий» в тему. Вы также можете щелкнутьGlossary Hotspot Wizard в модуле Глоссарий.

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

Снять отметку с горячих точек расширяющегося глоссария

Откройте мастер горячих точек глоссария, как описано выше. ВыберитеConfirm marking Terms for each topicфлажок. Выберите папку и статус для поиска. В меню «Выбрать термин» выберите термин, который нужно удалить, и нажмите «Далее».

Мы можем создавать ссылки на большинство элементов, которые вы видите в Project Manager и TOC Composer включая темы, закладки, URL-адреса, багажные файлы, группы новостей, FTP-сайты, файлы (например, PDF), связанные с другими программами и удаленными темами.

Использование редактора дизайна для создания текстовых ссылок

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

Выберите один из следующих вариантов -

  • Display in Frame- Этот параметр определяет набор фреймов для отображения целевого содержимого. Вы можете выбрать тип кадра или ввести пользовательскую информацию о кадре.

  • Display in auto-sizing popup - Отображает целевую тему во всплывающем окне, а не в средстве просмотра или браузере.

  • Display in custom-sized popup- Отображает целевую тему во всплывающем окне. Чтобы изменить размер окна вручную, введите число в поля Ширина и Высота.

Добавьте текст всплывающей подсказки, который будет отображаться при наведении курсора на ссылку. Выберите локальную тему, закладку, фрейм или URL-адрес в раскрывающемся меню «Выбрать место назначения (файл или URL-адрес)», а затем нажмите «ОК».

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

Диспетчер, щелкните значок плюса

рядом с темой.

Создать закладки

Щелкните слева от нужного места для закладки в редакторе дизайна. Затем нажмите кнопкуInsert Bookmarkиз раздела Ссылки на вкладке Вставка. Введите имя без пробелов, используя любую комбинацию букв и цифр.

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

Переименовать закладки

Откройте тему с закладкой. Дважды щелкните закладку рядом с темой, отредактируйте имя и нажмите OK.

Мы можем связывать изображения, звуки, видео и другие мультимедийные файлы в RoboHelp.

Добавить ссылки на мультимедийные клипы

Поместите курсор в то место, где вы хотите разместить ссылку в редакторе дизайна, или выделите текст или изображение, чтобы создать точку доступа для ссылки. Нажми наInsert Hyperlink кнопка из Links раздел Insert таб.

В Link To нажмите кнопку с треугольником и выберите «Мультимедиа ...». Выберите файл для ссылки и нажмите «Открыть».

Добавление ссылок из изображений и мультимедиа

Вы также можете добавлять ссылки из изображений и мультимедиа. В редакторе дизайна щелкните мультимедийный объект или изображение, которое нужно связать, и выполните действия, указанные ниже.

  • Нажмите кнопку «Вставить гиперссылку» в разделе «Ссылки» на вкладке «Вставка».

  • Чтобы создать ссылку из мультимедиа, в разделе «Ссылка на» нажмите кнопку с треугольником и выберите Multimedia…

  • Для ссылки с изображений выберите место назначения. Изображения могут содержать только одну ссылку.

В этой главе мы узнаем, как связать внешние источники в RoboHelp.

Ссылка на внешние темы (проекты справки Microsoft HTML)

Внешними темами могут быть проекты справки Microsoft HTML или другие подобные проекты. Нажмите кнопку «Вставить гиперссылку» в разделе «Ссылки» на вкладке «Вставка». В разделе «Ссылка на» щелкните раскрывающееся меню треугольника, чтобы выбрать «Удаленная тема».

Ссылка на внешние файлы

Выберите место ссылки в редакторе дизайна и введите текст. Выделите текст, нажмите кнопку «Вставить гиперссылку» в разделе «Ссылки» на вкладке «Вставка». Нажмите кнопку с треугольником рядом с Link To и выберите File ....

Найдите файл, откройте его и скопируйте в папку проекта. Создайте файл для проверки ссылок на внешние темы. Для проектов WebHelp внешний файл должен быть размещен в папке WebHelp. Для проектов справки Microsoft HTML внешний файл должен распространяться вместе с файлом CHM.

Ссылки на адреса электронной почты, FTP-сайты, группы новостей и веб-адреса

Выберите место для ссылки в редакторе дизайна или выделите текст или изображение, чтобы определить точку доступа. Нажмите кнопку «Вставить гиперссылку» в разделе «Ссылки» на вкладке «Вставка».

В разделе «Ссылка на» нажмите кнопку с треугольником и выберите один из следующих вариантов:

  • Для ссылки на электронную почту или выберите Электронная почта.

  • Чтобы ссылаться на FTP-сайты или группы новостей, выберите FTP или Новости Usenet.

  • Для ссылки на интрасети или веб-сайты выберите Веб-адрес.

В следующей главе мы обсудим, как поддерживать и восстанавливать ссылки в RoboHelp.

Поддержание и восстановление ссылок - очень важный компонент RoboHelp. Давайте узнаем, как это делается и в чем его преимущества.

Обновить и удалить ссылки

Чтобы обновить и удалить ссылки, мы должны выполнить шаги, указанные ниже.

  • Откройте тему, содержащую нужную ссылку.

  • Чтобы обновить ссылку, щелкните ссылку правой кнопкой мыши, выберите Свойства гиперссылки и внесите изменения.

  • Чтобы удалить ссылку, щелкните ее правой кнопкой мыши и выберите «Удалить гиперссылку».

  • Чтобы удалить ссылку и текст, выделите текст и нажмите «Удалить».

Исправить неработающие ссылки

Чтобы исправить неработающие ссылки, мы должны выполнить шаги, указанные ниже.

  • Нажми на Topic References buttonв разделе «Навигация» на вкладке «Проект», чтобы открыть диалоговое окно «Ссылки на темы». Чтобы исправить ссылку, сначала выберите ссылку в списке «Ссылки на выбранную тему», а затем нажмите «Изменить» или «Удалить», чтобы изменить или удалить гиперссылку.

  • Чтобы исправить элемент оглавления, ключевое слово индекса или карту изображений, сначала выберите элемент, затем нажмите «Изменить» и выберите допустимое место назначения для восстановления неработающей ссылки.

  • Чтобы удалить записи оглавления, выберите элемент оглавления и нажмите «Удалить».

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

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

Добавить элементы управления связанными темами

Щелкните место для элемента управления в редакторе дизайна. В разделе «Ссылки» на вкладке «Вставка» щелкните «Связанные темы». В диалоговом окне «Мастер связанных тем» - «Параметры ссылки» выберите параметр для отображения связанных тем в виде кнопки, которая может быть меткой или изображением, или для отображения связанных тем в виде текста, а затем нажмите «Далее».

В разделе «Темы в проекте» выберите тему и нажмите «Добавить». Продолжайте добавлять все темы, которые должны отображаться как связанные темы. Нажмите «Изменить», чтобы обновить название темы в «Связанных темах», если необходимо, а затем нажмите «Далее».

Выберите, должны ли параметры отображаться в Topics Foundдиалоговом окне или во всплывающем меню. Выберите вариант отображения выбранной темы во фрейме или новом окне и нажмите «Далее».

Выберите параметры отображения и шрифта.

Нажмите «Готово», а затем нажмите кнопку «Просмотр» для проверки.

Создать и назначить См. Также Ключевые слова

Double Для создания и назначения ключевых слов "См. Также" нажмите на See Also Folderв модуле «Диспетчер проектов», чтобы открыть модуль «См. также». Вы также можете ввести ключевое слово «См. Также» в текстовое поле и щелкнуть знак «плюс». Ключевое слово выделено жирным шрифтом, что означает, что с ним не связаны никакие темы.

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

  • Чтобы назначить темы для See Also keyword, щелкните модуль списка тем.

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

  • Чтобы добавить ключевое слово в отдельные темы, щелкните значок Topic List pod, выберите тему, нажмите кнопку «Свойства» и выберите See Also. Введите ключевое слово, которое нужно назначить теме, и нажмите «Добавить».

  • Добавьте к новому ключевому слову элемент управления См. Также.

Изменение, повторное использование или удаление элементов управления ссылками

Чтобы изменить, повторно использовать или удалить элементы управления ссылками, мы должны выполнить шаги, указанные ниже.

  • Откройте тему, содержащую элемент управления ссылкой, в редакторе дизайна.

  • Чтобы изменить элемент управления, дважды щелкните его и измените его свойства.

  • Чтобы повторно использовать элемент управления, щелкните его правой кнопкой мыши и выберите «Копировать». Щелкните правой кнопкой мыши целевую тему и выберите «Вставить».

  • Чтобы удалить элемент управления, выберите его и нажмите «Удалить».

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

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

Создание всплывающих окон только с текстом

Выделите текст в редакторе дизайна и на вкладке «Вставка» щелкните значок «Всплывающее окно». Введите всплывающий текст прямо в окно.

Редактировать только текстовые всплывающие окна

Чтобы редактировать только текстовые всплывающие окна, щелкните правой кнопкой мыши текст, которому назначено только текстовое всплывающее окно. Затем мы должны выбрать Text Popup Properties ...

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

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

Автоматически создавать последовательности просмотра

Чтобы автоматически создавать последовательности просмотра, создайте оглавление. В разделе «Навигация» на вкладке «Проект» нажмите «Обзор последовательностей». вBrowse Sequence Editor В диалоговом окне нажмите «Автоматически создавать с использованием оглавления…», чтобы открыть диалоговое окно «Автоматическое создание последовательностей с использованием оглавления».

Введите количество уровней из иерархии оглавления, которые вы хотите включить в последовательность просмотра, а затем нажмите OK. Еще раз нажмите ОК. Нажмите наYes, если вы видите Enable Browse Sequence диалоговое окно.

Создание последовательностей просмотра вручную

Чтобы создать последовательности просмотра вручную, в разделе «Навигация» на вкладке «Проект» нажмите «Обзор последовательностей», чтобы открыть диалоговое окно «Обзор редактора последовательностей». Нажмите «Создать» и назовите последовательность просмотра. В списке «Доступные темы» выберите папку, содержащую добавляемые темы, и добавьте темы вBrowse Sequences Paneи нажмите ОК. Нажмите Да, если вы видите диалоговое окно «Включить последовательность просмотра».

RoboHelp поддерживает множество функций для поиска. Например, у нас может быть многоязычный поиск, который пользователи могут использовать для поиска терминов на других языках (если они встроены в тему). Мы также можем искать поисковые запросы на китайском / японском / корейском (CJK) языке с помощьюWebHelp, FlashHelp и AIRHelpвыходы. Вы также можете использовать логические операторы, такие какAND, OR и NOT для выполнения поисков.

Добавить метаданные поиска

Вы можете добавить или отредактировать метаданные поиска, перейдя в Настройки проекта в разделе Файл на вкладке Проект. Нажмите кнопку «Дополнительно» рядом с раскрывающимся меню «Язык», чтобы открыть дополнительные настройки дляLocalization dialog box.

При необходимости установите следующие компоненты метаданных.

Синонимы

Используется для определения синонимов в поисковых запросах. Например, если синонимичными терминами являются «Процессор» и «ЦП», RoboHelp возвращает темы, содержащие слово «Intel» с выделенным термином. Помните, что на вкладке «Синонимы» мы можем указывать только слова, но не фразы.

Ключевые слова темы

Используется для связывания определенных слов или фраз с текущей темой. Вы можете выбрать слова или фразы, которые имеют отношение к делу, но обычно не встречаются в содержании. Например, если с темой связано «Adobe Systems», когда пользователь ищет «Adobe Systems», тема отображается, даже если она на самом деле не содержит этого ключевого слова.

Использовать Phrases вкладка, чтобы добавить ключевые слова.

Стоп-слова

Используется для игнорирования слов для отображения релевантных результатов поиска. Общие слова, такие как «a», «an», «the» и т. Д., Можно игнорировать, чтобы гарантировать, что RoboHelp отображает только результаты для необходимых ключевых слов.

В этой главе мы поймем, как оптимизировать и настроить поиск в RoboHelp.

Оптимизировать контент для поиска

RoboHelp поддерживает множество способов оптимизации контента для поиска -

  • Make Office and PDF files searchable (WebHelp/Pro, FlashHelp/Pro) - Когда багажные файлы упоминаются в теме через гиперссылку, пользователи могут искать их в опубликованных результатах.

  • Exclude specified baggage file types from search (Multiscreen HTML5, WebHelp, FlashHelp, and AIR Help)- Параметр «Исключить типы файлов багажа из поиска» позволяет исключить файлы багажа указанных типов из поиска. Например, вы можете исключить из поиска все файлы PDF в своих проектах.

Настроить возможности поиска

Вы можете настроить поиск конечных пользователей следующими способами:

  • Show Total Number Of Search Results (WebHelp and AIRHelp) - Эта опция включает отображение общего количества результатов для строки поиска, введенной пользователями в выводе.

  • Hide Rank column in search results (WebHelp and WebHelp Pro) - Столбец «Рейтинг» в результатах поиска можно скрыть, чтобы предоставить больше места для отображения результатов поиска.

Вы можете отображать контент с указанных URL-адресов на основе поисковых запросов пользователя, используя поиск внешнего контента. Когда пользователь выполняет поиск с использованием любого из этих условий поиска, RoboHelp возвращает заголовок и описание соответствующего URL-адреса в результатах поиска.

Настройка поиска внешнего контента и управление им

В разделе «Открыть» на вкладке «Проект» щелкните значок Pods icon и выберите External Content Search, чтобы открыть модуль поиска внешнего содержимого. Подставка позволяет использовать следующие параметры -

  • Add - Нажмите «Добавить» и укажите условия поиска (разделенные запятой, пробелом или точкой с запятой) и URL-адрес внешнего содержимого.

  • Edit- Выберите запись, которую хотите отредактировать, и нажмите «Изменить». Измените детали и нажмите ОК.

  • Import - Позволяет выбрать SearchOptions.xml file из проекта, чтобы импортировать настройки поиска внешнего контента этого проекта в текущий проект.

  • Export - Выберите папку для экспорта файла SearchOptions.xml.

  • Search - Позволяет указать строку для поиска определенной записи.

RoboHelp поддерживает стандартные форматы изображений, такие как GIF, JPEG, BMP, MRB, WMF, PNG и т. Д.

Найдите изображения

Вы можете использовать Graphics Locatorдля сканирования жестких дисков и папок на предмет файлов изображений, просмотра эскизов и копирования файлов. Дважды щелкните указатель графики вToolbox podи выбираем формат графического файла, который мы должны искать. Введите путь для поиска или перейдите в новое место и нажмите «Поиск».

Добавить изображение в тему

Чтобы добавить изображение в тему в RoboHelp, мы должны выполнить шаги, указанные ниже.

  • Выберите место для изображения в редакторе дизайна. В разделе «Медиа» на вкладке «Вставка» нажмите «Изображение».

  • Вы можете либо перейти к файлу, либо вставить изображение из проекта. Вы также можете перетащить изображения из папки Images Менеджера проектов в тему.

  • Щелкните ОК, чтобы закрыть диалоговое окно Изображение.

Редактировать изображение в RoboHelp

Выберите изображение для редактирования. В редакторе дизайна щелкните изображение правой кнопкой мыши и выберите «Свойства изображения», чтобы установить следующие параметры:

  • Text Wrapping - Совместите изображение с окружающим текстом.

  • Screen Tip - Текст, отображаемый, когда пользователь наводит курсор на изображение.

  • ALT Text - Текст, отображаемый, когда изображение не отображается.

  • Size- Установите размеры изображения в пикселях. ВыбратьMaintain aspect ratio чтобы сохранить пропорцию высоты к ширине.

  • Margins - Укажите расстояние между изображением и текстом.

  • Borders - Добавьте рамку к изображению и укажите стиль.

Можно запустить Adobe Captivate из RoboHelp и создать демонстрационные темы. Вы также можете вставитьSWF и HTML5вывод демонстраций Adobe Captivate в существующие темы. Исходный код демонстрации можно открыть в RoboHelp и отредактировать.

Нажми на Document icon в разделе Импорт на вкладке Проект и выберите Adobe Captivate Demo, чтобы открыть Select Adobe Captivate Demo dialog box. Укажите заголовок, путь для вывода HTML и путь для вывода SWF для новой темы, которую вы хотите создать для демонстрации.

Если вы пропустили указание соответствующего пути вывода SWF, RoboHelp добавляет нередактируемый SWF-заполнитель для использования в Design Editor.

RoboHelp позволяет добавлять в свои справочные проекты широкий спектр мультимедийного контента. Вы можете добавлять как онлайн, так и офлайн контент. В зависимости от вывода и целевого браузера RoboHelp позволяет вам включатьMPEG4, QuickTime и Ogg files наряду с множеством других совместимых форматов, таких как Real Media и Windows Media files.

Добавить мультимедиа

Чтобы добавить мультимедийный объект, выберите место в теме, куда вы хотите вставить мультимедиа, и выберите Мультимедиа из Media section of the Insert tab.

Выберите «Локальный файл», чтобы вставить мультимедийный файл с диска, или выберите «Интернет-URL», чтобы создать ссылку на мультимедийный файл в Интернете. Нажми наBrowse iconрядом с полем «Источник», чтобы перейти к месту на диске. Если вы уже добавляли файлы ранее, они будут отображаться в разделе Мультимедиа вProject Folders Section.

Для онлайн-источников введите URL-адрес источника, а не URL-адрес HTTP. Исходный URL-адрес можно найти во встроенном коде онлайн-мультимедийного контента, который начинается с 'src =' в коде. Однако вы можете использовать URL-адреса HTTP, если вставляетеYouTube, Vimeo или же DailyMotion ссылки

Удалить мультимедиа из тем

Чтобы удалить мультимедийный объект, просто щелкните объект и нажмите клавишу Delete на клавиатуре.

Dynamic HTML или DHTML используется для создания интерактивных веб-страниц с использованием комбинации HTML, JavaScript, CSS и DOM. С помощью DHTML можно добавлять к HTML-страницам эффекты, которые зачастую трудно реализовать. RoboHelp позволяет добавлять DHTML в свои проекты помощи.

Добавление эффектов DHTML в тему

Выберите элемент в редакторе дизайна и в разделе DHTML на вкладке «Вставка» щелкните значок Effects dropdown menu и выберите Эффекты.

Выберите событие для запуска эффекта из списка Когда и из списка «Что» выберите эффект, который хотите применить. Настройте соответствующие свойства в разделе «Настройки». Эффекты DHTML обозначаются светло-серыми решетками.

Удалить эффекты DHTML

Открыв тему в редакторе дизайна, перейдите в раздел DHTML на вкладке «Вставка», щелкните раскрывающееся меню «Эффекты» и выберите Remove Effects.

Светло-серые решетки больше не связаны с текстом или абзацем.

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

Назначьте триггер тексту или изображениям

Выберите текст или изображение в Design Editor и из DHTML section вкладки "Вставка" щелкните значок Trigger dropdown menu и выберите Триггер.

Значок кабельного барабана отображается на контенте, к которому применяется триггер. Знаки решетки указывают на применение эффекта DHTML. Следующим шагом будет привязка триггера к изображению или тексту.

Подключите триггеры к тексту или изображениям

Чтобы связать триггер с текстом или изображением, выберите текст или изображение для использования в качестве цели и в разделе DHTML на вкладке «Вставка» щелкните раскрывающееся меню «Эффекты» и выберите «Эффекты». В разделе "Когда" выберите1st Trigger Activationа в разделе «Что» выберите эффект, который возникает, когда пользователь нажимает на триггер. Задайте необходимые свойства в разделе "Настройки". Повторите для2nd Trigger Activation.

Значок вилки указывает на то, что это цель. Для изображений вы можете перетащить значок кабеля на любое изображение и выбрать требуемый эффект DHTML в качестве цели.

Удаление триггеров

Чтобы удалить триггер DHTML, выберите элемент, связанный с триггером, и в разделе DHTML на вкладке «Вставка» щелкните раскрывающееся меню «Триггер» и выберите «Удалить триггер».

Марки перемещают текстовые сообщения.

Добавление шатров

Чтобы вставить рамку, выберите текст в теме и из HTML section вкладки "Вставка" щелкните значок Text Box dropdown menu и выберите Marquee. Чтобы изменить свойства области, щелкните область правой кнопкой мыши и выберитеMarquee Properties , чтобы изменить настройки выделения.

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

Удалить шатры

Чтобы удалить область выделения, щелкните ее границу и нажмите клавишу Delete на клавиатуре.

RoboHelp позволяет легко вставлять HTML-комментарии в темы.

Вставка комментария HTML

Чтобы вставить комментарий HTML, откройте тему в Design Editorи поместите курсор в то место, куда вы хотите вставить комментарий. ИзHTML section вкладки "Вставка" щелкните значок Text Box dropdown menu и выберите Comment.

Введите свой комментарий в Comment Editor в следующем формате - <!--a comment -> и нажмите ОК.

Вы можете вставить встроенные фреймы (iframe), чтобы показать PDFs или же URLsвнутри HTML-страницы. Чтобы вставить iframe, откройте тему вDesign Editorи поместите курсор в то место, куда вы хотите вставить iframe. ИзHTML section вкладки "Вставка" щелкните значок Text Box dropdown menu и выберите Iframe.

Введите имя в Name поле и нажмите на Browse button чтобы выбрать URL-адрес, HTML-файл или PDF-файл для ссылки, а затем нажмите OK.

При желании вы можете установить параметры границы в Border таб.

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

Создание тега условной сборки

в New section на вкладке "Проект" нажмите Tag. Введите имя тега в NewConditional Build Tag dialog box. Вы также можете выбрать цвет для тега, нажав кнопку Build Tag Color.

По умолчанию RoboHelp предоставляет два тега - Online и Print во всех новых проектах.

Применение тегов условной сборки к контенту

Открыть Topic Listpod и выберите тему или несколько тем. На вкладке «Редактировать» в разделе «Теги» щелкните значокApply dropdown menu и нажмите на New/Multiple…

Выберите условный тег, который вы хотите применить. Когда применяется условный тег, на содержимое накладывается цвет определенного тега.

Чтобы применить теги к папкам, индексам и ToC, щелкните соответствующую папку в модуле Project Manager и на вкладке «Редактировать» в разделе «Теги» щелкните раскрывающееся меню «Применить» и щелкните «Создать / несколько…». Выберите условный тег (ы) ), который вы хотите применить.

Иногда вы можете почувствовать необходимость в создании файлов справки, связанных с действием, выполняемым пользователем. Такая помощь называетсяContext-Sensitive Help (CSH). Например, вы можете предоставить справочную информацию, когда пользователь наводит курсор на диалоговое окно или другие объекты. Процесс создания CSH включает в себя указаниеmap IDs и map files. Механизм справки получает номер карты и имя файла справки всякий раз, когда пользователь обращается к CSH. Затем механизм справки сопоставляет номер карты с идентификатором темы и файлом HTM и отображает правильный раздел справки.

RoboHelp поддерживает три типа CSH:

  • Window-level- Этот уровень CSH предоставляет темы для окон, диалоговых окон и других полей. Пользователи могут получить доступ к CSH на уровне окна, вызвав функцию справки в приложении или нажавF1.

  • Field-level (What's This?)- Эта CSH описывает информацию, когда пользователь щелкает значок вопросительного знака, а затем щелкает поле или функцию. "Что это?" темы поддерживаются толькоWinHelp и MS HTML Help проекты.

  • Airplane Help- Обычно это относится к автономной справке, которая вызывается при отсутствии доступа к Интернету. Для использования справки самолета необходимо связать автономную справочную систему сRH_AssociateOfflineHelp программная функция.

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

  • Map Number- Номер карты - это номер, связанный с идентификатором темы. Номера карт и идентификаторы тем хранятся в файлах карт, которые вызываются при вызове CSH.

  • Map File- Файл карты содержит номер карты и идентификаторы тем. Проект может содержать несколько файлов карт. Файлы карт имеют расширение .h, .hh или .hm.

  • Map ID - Идентификатор карты связывает номер карты с идентификатором темы.

Создание файла карты

Файл карты может быть создан либо authors или же developers. ОткрытьOutput Setup Pod и расширить Context-Sensitive Help папка.

Щелкните правой кнопкой мыши Map Files папку и щелкните New Map File… Введите имя для нового файла карты и нажмите OK.

Создание идентификатора карты

Чтобы создать идентификатор карты, мы должны выполнить шаги, указанные ниже.

  • Разверните Map Files folder в папке контекстно-зависимой справки в модуле настройки вывода и дважды щелкните All Map IDs.

  • в Map File dropdown menu, выберите файл карты для хранения идентификатора карты.

  • Затем нажмите на Create Map ID или же Edit Map ID кнопка.

  • Введите слово или фразу, чтобы обозначить тему в Topic ID и введите число в Map Number.

Мы можем динамически редактировать context-sensitive help topic(CST), связанный с диалоговым окном приложения. Технические авторы могут открывать приложение и динамически связывать раздел справки.

Сопоставление диалогового окна приложения с темой

RoboHelp позволяет легко сопоставить проект справки с приложением. Откройте проект справки, относящийся к приложению, для которого необходимо создать CSH. В разделе CSH на вкладке Инструменты нажмитеOpen CSH Helpперейдите к пути исполняемого файла, для которого необходимо сопоставить CSH. Затем нажмите кнопку «Открыть».

Когда приложение запустится, выберите в приложении диалоговое окно, которое необходимо CSH mappingи нажмите F1 или щелкните «Справка». Выберите файл карты изProject Map File всплывающее меню в диалоговом окне Параметры CSH.

Отсюда мы можем либо сопоставить приложение с существующей темой (Сопоставить с выбранной темой), либо сопоставить его с новой темой (Сопоставить с новой темой), а затем нажать OK. Мы также можем отредактировать содержание темы (Изменить сопоставленную тему) или полностью удалить сопоставление (Удалить сопоставление).

Разработчики могут использовать RoboHelp APIs для создания настраиваемых диалоговых окон на основе их требований. RH_ShowHelp- это программная функция, которая вызывает файлы справки в проекте. Поддерживаемые языки включаютVisual Basic, C/C++, JavaScript и Java.

Файлы для соответствующих языков находятся в Install Directory\Adobe\Adobe RoboHelp (version)\CSH API. В документации RoboHelp перечислены параметры, содержащиеся в RH_ShowHelp. В следующей таблице описаны все эти параметры -

Sr. No. Параметр и описание
1

hParent

Этот параметр закрывает диалоговое окно справки, когда закрывается вызывающее окно.

2

a_pszHelpFile

Этот параметр указывает источник справки в зависимости от типа вывода.

Для Webhelp / FlashHelp: «Путь к начальной странице проекта»

Для Webhelp Pro: "http: // <ServerName> /roboapi.asp"

Для справки HTML: «Путь к файлу .CHM».

3

uCommand

Этот параметр содержит следующие константы -

HH_DISPLAY_INDEX - отображает панель указателя и тему по умолчанию.

HH_DISPLAY_SEARCH - отображает панель поиска и тему по умолчанию.

HH_DISPLAY_TOC - отображает панель содержимого и тему по умолчанию.

HH_HELP_CONTEXT - открывает тему, связанную с идентификатором карты в параметре dwData.

4

dwData

Этот параметр используется для получения идентификатора карты и экспорта файла карты для языка программирования. Используйте HH_HELP_CONTEXT в параметре uCommand.

Для получения дополнительной информации или дальнейшего подключения тем CSH к перечисленным выше языкам см. Документацию Adobe RoboHelp, доступную по следующей ссылке - https://helpx.adobe.com/support/robohelp.html.

"Что это?" Справку можно использовать для добавления CSH к элементам управления и полям в диалоговых окнах. Для файлов справки MS HTML композитор поддерживает.exe, .dll и .ocxфайлы. Файлы справки создаются вContext.txt файл, который затем прикрепляется к проекту.

Создание Что это? Помогите

Чтобы создать "Что это?" Файл справки разверните папку контекстно-зависимой справки в модуле настройки вывода. Щелкните правой кнопкой мыши "Что это?" Папка Help Files и нажмитеCreate/Import What’s This? Help File…

В Create / Import What's This? В диалоговом окне "Файл справки" выберите текстовый файл, содержащий сообщение "Что это?" Содержание справки. Кроме того, вы можете ввести имя для поля Что это? Файл справки, и RoboHelp создаст для вас файл .txt.

Когда вы создаете новый файл What's This? В файле справки вам будет предоставлена ​​возможность связать идентификаторы тем с соответствующими номерами карт. Теперь мы должны выполнить шаги, указанные ниже, чтобы завершить процесс -

  • Введите идентификатор темы и соответствующие номера карт.
  • В поле "Текст темы" введите содержание темы.
  • Щелкните Добавить / Обновить, чтобы связать тему и номер карты.
  • По завершении нажмите "Закрыть".

Макеты с одним исходным кодом (SSL) - это шаблоны для различных типов вывода проекта. Например, вы можете создать SSL с разными настройками для разных типов выходов, таких какeBooks, WebHelp, Responsive HTML5и т. д. SSL позволяет нам определять настройки вывода и разрешать пакетную публикацию.

Указание основного макета

Первичные макеты позволяют нам установить макет по умолчанию для нашей работы. Затем можно указать дополнительные параметры для основного макета. Чтобы указать основной макет, щелкните правой кнопкой мыши макет в модуле «Выводы (SSL)» и выберите «Установить как основной вывод». Дополнительные окна создаются на основе этого основного макета.

Создание SSL

Чтобы создать SSL, нажмите на Create Output in the Outputs (SSL)стручок Вы также можете скопировать существующий макет, щелкнув значок «Дублировать вывод».

Затем введите имя в поле «Имя вывода» и выберите тип вывода в раскрывающемся меню «Тип вывода», а затем нажмите «ОК».

В Dynamic User Centric Content(DUCC) помогает пользователям переключаться между различными типами макетов, которые подходят для разных продуктов. Каждый макет будет содержать свойToC, Index и Glossary.

DUCC лучше всего работает с Adobe AIR и WebHelpвыходы. Например, вы можете создать категории контента в макете Adobe AIR, которые затем можно будет выбрать на выходе.

Создание категорий контента в макете Adobe AIR

Из Outputs (SSL) pod, нажмите на Create Output на панели инструментов и выберите тип вывода как Adobe AIR.

Затем щелкните правой кнопкой мыши выходные данные Adobe AIR в модуле «Выводы (SSL)» и выберите «Свойства». На вкладке «Категории содержимого» выберите категории, которые пользователь должен динамически изменять. Вы также можетеcreate, edit, change the order или же remove existing categories.

Каждая категория контента имеет свои ToC, Index, Browse Sequences, и т.д.

Можно публиковать собственные выходные данные ASPX или HTML прямо на сервере Microsoft SharePoint из RoboHelp. SharePoint действует как единый ресурс для множества веб-приложений и управления контентом. Следовательно, это упрощает пользователям малых и средних предприятий доступ к централизованной информации.

Публикация многоэкранного вывода ASPX в MS SharePoint

В Multiscreen HTML5 SSLпозволяет напрямую публиковать собственные (ASPX) выходные данные в библиотеке SharePoint 2010 или папке SharePoint 2007. При просмотре в браузере темы отображаются как одна HTML-страница.

В модуле «Выводы (SSL)» щелкните правой кнопкой мыши вывод Multiscreen HTML5 и выберите «Свойства». В диалоговом окне «Параметры многоэкранного HTML5» щелкните «SharePoint (Собственный)» и укажите версию SharePoint на сервере.

Вы также можете создать настраиваемые главные страницы для каждого из профилей устройств, щелкнув имя профиля устройства и выбрав тип главной страницы.

Публикация вывода HTML в MS SharePoint

Подобно многоэкранному выводу ASPX, вы можете публиковать WebHelp, FlashHelp так же как Adobe AIRвывод непосредственно в SharePoint. Чтобы опубликовать вывод WebHelp, дважды щелкните вывод WebHelp в модуле Outputs (SSL), чтобы открыть диалоговое окно настроек WebHelp.

Затем нажмите «Опубликовать» и выберите сервер SharePoint, на котором мы хотим опубликовать выходные данные. Мы также можем добавить новые серверы SharePoint, нажав наNew… кнопка.

Большинство современных браузеров доступны на нескольких платформах и оптимизированы для динамического масштабирования содержимого в зависимости от размера экрана. Однако этого может быть не всегда достаточно, и иногда вам может потребоваться нацелить контент на определенный размер экрана или форм-фактор. С помощьюMultiscreen HTML5 SSL позволяет нам оптимизировать наш контент для определенного размера экрана, так что пользователям автоматически предоставляется наиболее оптимизированный контент.

  • Вы также можете публиковать контент на HTTPS места.

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

В документации Adobe RoboHelp перечислены следующие поддерживаемые браузеры для вывода HTML5:

Платформа Поддерживаемый браузер
Android Браузер на основе Webkit (Chrome)
iOS Apple Safari
Рабочий стол Windows Firefox 4+, Chrome 9+, IE9
Mac OS Apple Safari

RoboHelp также может публиковать результаты в MS HTML, JavaHelp и Oracle Helpмакеты. Каждый макет предназначен для работы с приложениями, написанными на соответствующих языках программирования.

Microsoft HTML Help layout

The MS HTML projects include HTM files for the topics along with Index, ToC, Related topics, etc. The MS HTML files can be generated at any point during the project.

We can also extract topics from the CHM files using RoboHelp. To do so, open the Toolbox pod and double click on the HTML Help Studio icon. Go to the File menu and click on Open to select a CHM file. Select All Files or individual files and click on Extract to extract to a specified destination.

JavaHelp Layout

JavaHelp projects include compressed output files that work with Java applications that run on various platforms. JavaHelp can also be created from existing WinHelp or HTML projects. RoboHelp can output directly to the JavaHelp format along with HTML features such as hyperlinks.

We will need Sun Java 2 SDK (or later) and JavaHelp 1.1.3 (or later) to author JavaHelp content. The user needs to have Java Runtime Environment (JRE) 1.2.1 (or later) and JavaHelp 1.1.3 (or later) to view JavaHelp JAR files. JavaHelp does not support text animations or special effects.

Oracle Help layout

Similar to JavaHelp, Oracle Help projects also work with applications written in Java or other programming languages. The Oracle Help file is stored as a compressed JAR file. To author or view Oracle Help files, Oracle Help components 3.2.2 or 4.1.2 (or later), Sun Java 2 SDK (or later) and the Java Runtime Environment (JRE) 1.2.1 (or later) are required.

Oracle Help uses a default window for displaying topics. If we want the topic to be displayed in its own window, open the topic in the HTML Editor and edit the following Meta tag −

meta name = “window-type” content = [“window name”]

Help content can be distributed in the EPUB or Kindle Book formats, so that it can be read on eBook readers, tablets and other mobile devices.

To generate eBook outputs, double click on the eBook in the Outputs (SSL) pod to open the eBook Settings page. In the General Page under the eBook Formats, select EPUB 3 or Kindle Book or both.

For EPUB 3, RoboHelp generates .epub files. For Kindle Book, RoboHelp generates a Kindle Format 8 and Mobi file using the KindleGen converter. The link to download the KindleGen converter is available in the Kindle Book Generation dialog box.

The EPUB output can be validated by clicking on the Validate EPUB 3 Output under Options. This requires downloading a Java EpubCheck file, which is available in the link shown in the dialog box.

To add a cover image to the eBook, click Meta Information on the left hand side pane and under Cover Image, select the path to the image that you wish to be the cover image.

We can also embed fonts used in the project along with the EPUB, so that users need not have the fonts installed natively on their reader. To do so, click on Content in the left hand side pane and tick the Embed Fonts checkbox. Click on Manage… to select the fonts you wish to embed in the eBook.

RoboHelp makes it easy for effective collaboration among all stakeholders involved in the project. We will look at some of the review and collaboration features below −

Review in Design Editor

We can directly insert our comments in the Design Editor. The Review tab contains all the tools we need to add/edit reviews and track changes. To track changes in the Design Editor, click on Track Changes in the Tracking section of the Review toolbar.

Note − RoboHelp cannot track formatting and structure changes.

Create a PDF for Review

You can also create a PDF that can be sent to the reviewers. The PDF uses the same-tagged structure as the RoboHelp project, so that we can directly import those reviews into RoboHelp.

To create a PDF for review, in the PDF section of the Review tab, click on Create PDF to open the Create PDF for Review dialog box. Here, you can select the topics to be included for review and define Conditional Build Tag Expressions as well.

We can import a reviewed PDF by clicking on the Import Comments in the PDF section of the Review tab. However, for the import to be successful, the PDF should have been created from within RoboHelp.

Manage Comments and Changes

Comments made by you or stakeholders can be accepted or rejected from the Design Editor. All the comments in the project can be viewed as a list in the Review Pane pod. The Review Pane pod allows you to filter comments and accept/reject them. Each comment can also have a status.

Often, teams work on big projects are distributed and work simultaneously. Whereas, the content is hosted on different servers such as −

  • Dropbox
  • OneDrive
  • Google Drive
  • SharePoint, etc.

RoboHelp can help you add resources from across cloud and file-system based locations into the project. To add a shared location, in the Open section of the Review tab, click on Pods and click on Resource Manager. In the Resource Manager pod, click on Add Shared Location and specify the type of shared location you want to add.

The Resource Manager pod also allows you to order your resources as categories. To add a category, click on the Add/Edit Categories icon and add the corresponding file types to a category such as .avi and .flv files for Video.

ActiveX controls are small programs that run in Windows applications such as Internet Explorer and HTML Help Viewer to enable additional functionality to the HTML page. RoboHelp comes with several ActiveX controls that you can use for HTML Help. By default, ActiveX controls such as HHCTRL.OCX are included to provide ToC, index and full text search.

The most common types of HTML ActiveX controls include −

  • Calendar Control
  • Custom Buttons
  • Banner
  • Chart
  • Calculations, etc.

Add ActiveX controls

You might need to distribute the ActiveX controls located in the Redist directory of your Adobe RoboHelp installation to users who require them.

To insert an ActiveX control, place the cursor in the topic where the control is desired and from the HTML section of the Insert tab, click on the JavaScript dropdown menu and click on ActiveX Control.

Select the desired ActiveX control from the list and click on OK to add the control to your topic. You can double click on the added ActiveX control to view its properties.

Note − Not all ActiveX controls have properties dialog boxes.

RoboHelp allows you to add forms to topics where the user can fill in information and create frames and framesets to help in navigation.

Adding a Form to a Topic

To insert a form, place the cursor in the topic where the form is desired and from the HTML section of the Insert tab, click on the HTML Form dropdown menu and click on Form.

A placeholder will be inserted in the text. Double click on the placeholder to edit the form’s properties.

Creating Frames and Framesets

Frames divide the help viewer into different regions for each topic. Framesets allow the topics to change, while keeping some topics stationary. Though you can create multiple frames in a frameset, creating too many frames can clutter the interface and even cause increased load times.

In the Project Manger tab (click on Toggle Project Manager View if required), right click on the Project Files folder and in the ‘New’ menu click on Frameset.

Select a frameset template from the options given. Enter a title and click on Next.

Наборы фреймов можно увидеть в HTML Files папка в Project Manager и его можно редактировать.

Элементы управления HTML-справкой помогают в навигации по содержимому. Они переносимы и могут быть скопированы в несколько тем.

Повторное использование элементов управления справкой HTML

Чтобы повторно использовать элемент HTML-справки, откройте раздел, содержащий этот элемент управления, в редакторе дизайна, щелкните его правой кнопкой мыши и выберите «Копировать». Вставьте его в тему, которая требует контроля.

Добавить элементы управления WinHelp Topic

Чтобы добавить элементы управления темами WinHelp, выберите желаемое расположение для элемента управления темами WinHelp и в разделе HTML на вкладке «Вставка» щелкните раскрывающееся меню JavaScript и выберите тему WinHelp.

Следуйте инструкциям мастера, чтобы вставить элемент управления темой WinHelp.

Добавить элементы управления индексом и ToC (для справки MS HTML)

Элементы управления индексом могут быть полезны, когда проект не поддерживает трехпанельный дизайн, содержащий вкладку индекса. Чтобы вставить элемент управления индексом, поместите курсор в тему, в которой требуется элемент управления индексом, и в разделе HTML на вкладке «Вставка» щелкните раскрывающееся меню JavaScript и нажмите «Индекс».

Чтобы добавить элемент управления ToC, поместите курсор в тему, в которой требуется элемент управления ToC. Затем в разделе HTML на вкладке «Вставка» щелкните раскрывающееся меню «JavaScript» и выберите «Оглавление».

Скомпилируйте проект, чтобы протестировать индекс и элементы управления ToC.

Добавить заставку (для справки MS HTML)

Заставки могут отображаться, когда тема открывается в средстве просмотра. Bitmap и GIFизображения могут использоваться для заставок. Чтобы добавить экран-заставку, откройте тему, для которой требуется экран-заставка, и в разделе HTML на вкладке «Вставка» щелкните значокJavaScript dropdown menu и нажмите на Splash Screen.

Выберите файл изображения для экрана-заставки. Вы также можете установить продолжительность, в течение которой будет отображаться заставка, установив количество времени вDuration of splash display (Seconds) поле.

Щелкните Готово. Просмотрите тему, чтобы проверить заставку.