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

Создание и настройка проекта в HTML Help Workshop

Установив необходимые бесплатные программы, мы разобрали исходный файл api.chm и получили 64 файла (подробнее смотрите материал Декомпиляция CHM-файла). Это основная часть исходника. Именно эти файлы мы будем редактировать, чтобы обновить CHM. Но для сборки обновленного CHM-файла отредактированных файлов будет недостаточно. Чтобы собрать новый CHM-файл при помощи бесплатной программы HTML Help Workshop, вам также потребуется файл проекта. Поэтому прежде, чем перейти к редактированию, рассмотрим, как создать проект в HTML Help Workshop, и научимся собирать обновленный CHM-файл.

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

Чтобы создать проект с базовыми настройками:

  1. Запустите HTML Help Workshop из меню Пуск.
  2. Выберите File / New.
  3. В окне New будет выделен Project. Нажмите на кнопку ОК. Будет открыто первое окно Мастера создания нового проекта.
  4. Для продолжения нажмите на кнопку Далее. В следующих пунктах описания данный шаг будет опущен.
  5. В окне New Project - - Destination укажите название проекта и путь к папке, в которой он будет создан: C:\test\decompiled\new_prj.hhp. Можно также нажать на кнопку Browse и указать эти данные стандартным для ОС Windows способом.

файл проекта HTML Help Workshop

  1. В окне New Project - - Existing Files пометьте все флажки, чтобы добавить в проект извлеченные из CHM файлы.

добавление файлов в проект

  1. В окне New Project - - Table of Contents нажмите Browse и выберите файл C:\test\decompiled\api.hhc.

добавление оглавления

  1. В окне New Project - - Index нажмите Browse и выберите файл C:\test\decompiled\api.hhk.

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

  1. В окне New Project - - HTML Files нажмите Add, выберите и добавьте все .htm-файлы из папки decompiled.

добавление разделов

  1. В окне New Project - - Finish нажмите на кнопку Готово.

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

новый проект в HTML Help Workshop

 

Настройка проекта и тестовая сборка нового CHM-файла

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

Указать название справки, раздел по умолчанию и включить простой поиск:

  1. На вкладке Project щелкните Change Project Options.
  2. В окне Options на вкладке General введите название справки в поле Title. В оригинале это HTML Help API Reference.
  3. В раскрывающемся списке Default file: выберите файл ov_main.htm.

раздел по умолчанию

  1. Чтобы включить простой поиск, перейдите на вкладку Compiler, пометьте флажок Compile full-text search information и нажмите на кнопку ОК. Если сначала не включить простой поиск, это все равно придется сделать после активации расширенного поиска.

включить поиск

 

Включить расширенный поиск и избранное:

  1. На вкладке Project щелкните Add/Modify Window Definitions.
  2. В окне Add a New Window Type введите название для нового типа окна, например, new, и нажмите на кнопку ОК.

  1. В окне Window Types перейдите на вкладку Navigation Pane.
  2. В группе Tabs пометьте флажки Search tab, Advanced search, Favorites tab и нажмите на кнопку ОК. Окно Window Types будет закрыто.

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

  1. На вкладке Project снова щелкните Change Project Options, перейдите на вкладку Files и в поле Compiled file: проверьте путь к папке и название нового файла справки. Назовем его new_api.chm. В поле Compiled file: должно отображаться c:\test\decompiled\new_api.chm.

новый файл CHM

  1. Нажмите на кнопку ОК.
  2. Выберите File / Save Project. Все должно быть готово к тестовой сборке справки.

 

Собрать новый CHM-файл

  1. Выберите File / Compile или на панели инструментов щелкните Compile HTML file.
  2. В окне Create a compiled file проверьте, чтобы для сборки был выбран файл текущего проекта, и нажмите на кнопку Compile.
  3. Перейдите в папку decompiled и запустите файл new_api.chm. Должен получиться следующий результат. Панель инструментов будет немного отличаться от оригинала.

собрать новый CHM

 

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

  1. В окне HTML Help Workshop на вкладке Project щелкните Add/Modify Window Definitions.
  2. В окне Window Types перейдите на вкладку Buttons.
  3. В группе Button Types пометьте флажки напротив тех кнопок, которые должны быть на панели инструментов, и снимите флажки напротив тех кнопок, которые необходимо скрыть.

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

  1. Нажмите на кнопку ОК.
  2. Выберите File / Save Project.
  3. Пересоберите справку. Должен получиться следующий результат.

точная копия CHM-файла

Файлы, извлеченные из оригинального CHM, и файл проекта, созданный в HTML Help Workshop, вместе составляют новый исходник. Далее с ним можно работать: вносить изменения, дополнять, сокращать и т.д. этому посвящена следующая статья Внесение изменений и сборка нового CHM-файла.

 

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

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

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

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

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

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

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

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

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

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

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

Сборка CHM-файла в Help and Manual

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

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

Основные настройки проекта в Help and Ma…

Если для сборки справки не используется шаблон (skin-file), внешний вид и основной функционал CHM-справки берется из настроек проекта. В этой статье я расскажу о том, ...

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

Импорт CHM в Help and Manual

Программный комплекс Help and Manual позволяет импортировать документацию из ряда форматов, в том числе, из HTML и CHM. Готовую документацию можно загрузить как в суще...

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

Как отредактировать CHM в Help and Manua…

Если вам нужно внести несколько небольших правок в CHM-файл, такую задачу можно успешно решить при помощи бесплатных программ HTML Help Workshop и Notepad++. Серьезная...

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

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

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

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

Внесение изменений и сборка нового CHM-ф…

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

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

Декомпиляция CHM-файла

Файл в формате CHM представляет собой скомпилированный HTML. В него могут входить HTML-страницы, рисунки, таблицы стилей, скрипты и другие файлы. Подробное описание со...

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

Редактирование CHM бесплатными программа…

Если заказчику или работодателю не принципиально, какое программное обеспечение использовать, я предпочитаю редактировать CHM в Help+Manual 7. Но как показывает практи...

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

Как отредактировать CHM-файл

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

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

Как создать справку в формате CHM

Формат HTML Help или CHM был разработан компанией Microsoft в 1997 г. Сегодня CHM остается стандартом справки для приложений, работающих в ОС Windows. Средство для про...

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

Бесплатный локальный сервер HM2GO для We…

Одна из моих предыдущих статей была посвящена особенностям работы WebHelp на локальных компьютерах. Некоторые популярные браузеры, в том числе Google Chrome, Opera и Я...

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

Дата в полном формате с месяцем в родите…

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

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

Корректная работа WebHelp на локальном к…

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

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

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

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

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