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

Создание и настройка проекта в 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-файла.

 

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

Комментарии  

Сергей
# 0 Сергей 06.09.2020 17:37
А теперь подробно и обстоятельно...Справка на русском к HTML Help Workshop: https://yadi.sk/d/5DMC7SEXEhZF5A.
Ссылка не работает - автор комментария удалил файл(ы).
Ответить Ответить с цитатой Цитировать

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

Как вставить тесты в CHM и WebHelp…

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

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

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

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

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

Подключение таблицы стилей к проекту Hel…

При работе с форматами, основанными на HTML, для оформления контента в документах можно использовать каскадные таблицы стилей, cascading style sheets или CSS. Данная т...

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

Формулы в HTML Help (CHM)

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

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

Импорт документов MS Word в Help+Manual…

Часто технический писатель получает исходные данные от аналитиков, разработчиков, тестировщиков, маркетологов и других специалистов в форматах DOC, DOCX и RTF (реже, и...

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

Поиск в WebHelp находит удаленные раздел…

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

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

Контекстная справка в приложениях Window…

Понятие контекстной или контекстно-зависимой справки (от англ. context-sensitive help) появилось в 1987 году с выходом формата WinHelp. Изначально контекстная справка ...

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

Как поддерживать скриншоты в актуальном …

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

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

Книга «Разработка технической документац…

Уважаемые коллеги! Если вам нужно быстро освоить разработку документации по ГОСТ, рекомендую обратить внимание на книгу В.А. Глаголева «Разработка технической документ...

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

Перевод выходных документов в Help and M…

Выбрав русский язык и русскую кодировку в настройках проекта Help and Manual, многие авторы после первой сборки удивляются, увидев в выходных документах английские сло...

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

Размер и расположение окна CHM при перво…

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

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

Рваные края скриншотов в Help and Manual…

Многие платные редакторы скриншотов, например, SnagIt, FastStone Capture и др., умеют создавать эффект рваных краев. В сети Интернет можно найти множество видеоуроков ...

Читать полностью...
новое в Help and Manual 9

Новое в Help and Manual 9

23 ноября 2022 года компания EC Software к 25-летнему юбилею выпустила 9-ю версию программного комплекса Help and Manual (выходит c 1997 года). Комплект шаблонов Premi...

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

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

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

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

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

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

Читать полностью...
ключевые слова

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

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

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

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

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

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