Скомпилированный файл справки в формате html chm
CHM - это расширение файла в формате Compressed HTML Help. Формат был разработан Microsoft для гипертекстовых справочных систем. Для просмотра CHM файлов достаточно наличия в системе Internet Explorer. У CHM файлов, как правило, есть Содержание - отдельная панель со списком статей для упрощения навигации. В наличии содержания, пожалуй и заключается главное отличие CHM файлов от использовавшихся ранее HLP файлов справки Windows.
Несколько человек интересовались процессом создания моего учебника по автоматической установке Windows в формате CHM, а в двух словах это не описать. Изложенное ниже руководство применимо к созданию любого CHM файла, обладающего древовидной структурой отображения страниц в содержании, индексом, полнотекстовым поиском с поддержкой логических операторов и возможностью добавления страниц в избранное. Рассказ отражает мой личный опыт, и не исключено, что есть более простой путь (особенно при использовании специализированных и недешевых программных продуктов). Предполагается, что все HTML страницы, которые вы хотите включить в CHM уже подготовлены: в них работают все внутренние ссылки и отображаются картинки и прочие объекты. Речь в рассказе пойдет в основном о создании и компиляции CHM файла.
Давид и Голиаф (HTM2CHM и HTML Help Workshop)
Для создания оффлайн версии сайта использовались две бесплатные программы: Microsoft HTML Help Workshop и HTM2CHM (если заголовок параграфа вызвал у вас недоумение, то смотрите примечание :) . По ходу рассказа я объясню, почему не удалось обойтись лишь одной из них.
HTM2CHM - маленькая программа, написанная Ярославом Кирилловым. Программа обладает русским интерфейсом и интуитивно понятна. Если вы не планируете снабжать свой CHM файл полнотекстовым поиском и индексом, a расширенные настройки внешнего вида CHM файла вам не нужны, то наверное не стоит городить огород с HTML Help Workshop. Создать файл Содержания и выстроить страницы в желаемом порядке, назначив им различные иконки можно и в HTM2CHM.
Мне же возможностей этой программы не хватило - я посчитал, что для почти сотни страниц учебника нужен полнотекстовый поиск, а также не помешает индекс.
Поэтому пришлось задействовать HTML Help Workshop - творение программистов Microsoft. В отличии от HTM2CHM, программа не очень интуитивно понятна и русского интерфейса у нее тоже нет. Зато функционально она меня устроила всем, кроме того что не сумела корректно сформировать файл содержания из кириллических заголовков страниц. В заключение этого мини-сравнения хочу сказать, что у HTML Help Workshop получился намного более компактный учебник (у HTM2CHM размер выходного файла оказался в 1.5 раза больше).
Итак, перейдем к делу. Я изложу тонкости создания CHM в файла том порядке, в котором я создавал свой учебник. Рассказ о HTML Help Workshop будет длинным, но лишь потому, что первый раз требуется указать много настроек проекта (в дальнейшем изменить уже имеющийся проект намного проще).
Давид (HTM2CHM)
Работа с программой не должна вызвать затруднений даже у чайников - настолько все понятно и просто. Я рассмотрю создание содержания и компиляцию CHM файла.
Создание содержания
Содержание - это фактически обязательная часть любого CHM файла. На этой закладке отображается список статей (страниц), входящих в файл. Будет ли этот список линейным или древовидным, зависит от структуры информации и в каком виде вы ее хотите преподнести читателю. За содержание отвечает файл с расширением .HHC, который иногда для краткости именуют TOC файлом (Table of Contents). С создания TOC файла мы и начнем.
Как правило, названия статей для содержания генерируются из заголовков HTML страниц (тег TITLE). Для создания исходного файла содержания я как раз и использовал HTM2CHM, поскольку мне не удалось преодолеть проблему некорректного отображения кириллицы в TOC файле, сгенерированном HTML Help Workshop.
Создание файла содержания в HTM2CHM - дело нехитрое. Запускаем HTM2CHM и видим список режимов работы программы.
Выбрав Содержание, мы попадаем в окно генератора содержания, в котором нужно указать папку с HTML файлами, а также имя и расположение результирующего TOC файла.
После генерации файла содержания откроется редактор, в котором все статьи, вошедшие в содержание будут отображаться вертикальным линейным списком.
HTM2CHM позволяет отсортировать статьи в алфавитном порядке автоматически или сделать это вручную. Названия статей можно редактировать, а также назначать статьям индивидуальные иконки. Отмечу, что создание древовидной структуры и назначение иконок можно сделать и в HTML Help Workshop, однако в HTM2CHM это реализовано поудобнее.
Например, в HTM2CHM для перемещения статей можно просто перетаскивать их мышью или делать это с нажатой клавишей CTRL, что намного удобнее, чем тыкать курсором в кнопку, перемещая за раз всего на одну позицию. Иконки тоже назначаются легко - трудно придумать что-то проще, чем выпадающее меню (у HTML Help Workshop смена иконки находится в свойствах страницы, да еще и на второй закладке).
Короче говоря, я рекомендую привести файл содержания к желаемому виду в HTM2CHM, а уж если вам понадобятся дополнительные настройки CHM файла, то использовать для этого HTML Help Workshop.
Компиляция
После того как файл содержания готов, можно переходить к компиляции CHM файла. В главном окне программы жмем большую кнопку Создать.
И заполняем все поля, не забывая про только что созданный файл содержания. Через несколько секунд у вас будет готовый CHM файл.
К сожалению, HTM2CHM не обладает возможностью создания полнотекстового поиска (или я не нашел такой опции), так что покончив с Содержанием, я продолжил работу над CHM файлом в HTML Help Workshop, в котором мне также открылись и другие возможности.
Голиаф (HTML Help Workshop)
За неказистым (и иногда не очень удобным) интерфейсом HTML Help Workshop скрывается очень мощный инструмент создания CHM файлов. Насколько мне известно, у программы нет русского лица (однако, русификаторы существуют), да и английский интерфейс не слишком информативен - иконки не имеют подписей и пока их не "выучишь", приходится наводить курсор мыши для получения всплывающей подсказки. Однако, функционально HTML Help Workshop превосходит HTM2CHM. Я опишу лишь те функции программы, которые использовал сам. Вообще, HTML Help Workshop снабжен достаточно подробной справкой (EN).
Создание нового проекта
Первое что нужно сделать - это создать новый проект (File | New).
Выбираем Project и нам открывается мастер создания проекта.
На первом этапе предлагается конвертировать существующий WinHelp проект. Поскольку мы ничего не конвертируем, то флажок ставить не надо.
Указываем имя файла проекта (*.HHP) и папку, в которой он будет сохранен.
На этом этапе можно указать HTML файлы, которые мы включаем в проект, а также файл содержания и индекса (HHK). Я указываю только HTML файлы, а TOC файл, созданный в HTM2CHM, добавляю потом.
Добавляем HTML файлы. И на этом работа мастера завершается.
По завершении работы мастера левая часть рабочего окна HTML Help Workshop выглядит примерно так.
Настройка внешнего вида
Займемся настройкой будущего CHM файла. На своем опыте я уяснил, что сначала лучше настроить внешний вид, а потом уже остальные свойства проекта. Итак, сначала определимся, какие закладки мы хотим видеть в навигационной панели (например, Содержание, Индекс, Поиск, Избранное), какие кнопки мы хотим видеть в верхней панели, настроим размер окна и т.д.
В вертикальной панели инструментов HTML Help Workshop есть ряд иконок - нас интересует третья сверху (Add/Modify Windows Definitions).
Если это ваш первый щелчок на иконку, то появится такое диалоговое окно, в котором нужно напечатать Navigation Pane.
Нам откроется окно Window Types, в котором можно выставить немало настроек. На закладке Navigation Pane нужно отметить следующее:
- Window with navigation pane, topic pane, and button - обязательно ставим флажок, чтобы навигационная панель отображалсь в скомпилированном CHM файле. Поставив флажок, мы видим остальные опции.
- Тabs - закладки навигационной панели
- Default Tab - активная закладка по умолчанию (при открытии файла)
- Search Tab и Advanced - закладка поиска и возможность расширенного поиска с использованием логических операторов
- Favorites tab - закладка Избранное
Закладка Buttons контролирует какие кнопки будут доступны на верхней панели скомпилированного файла. Выбор оставляю на ваше усмотрение.
Закладка Position позволяет задать размер окна и его расположение на экране. Рекомендую дать пользователю возможность автоматически запомнить размер и позицию после первого запуска CHM файла (Save user defined window position after first use). Можете также поиграть с кнопкой Autosizer.
На закладке Files указываем ряд важных файлов:
- Window - фокус по умолчанию при запуске (я выбираю Навигационную панель)
- TOC - файл содержания. Здесь я указываю файл, который ранее создал в HTM2CHM (путь нужно указывать, если только TOC не в одной папке с файлом проекта)
- Index - индексный файл (если вам нужен индекс - впишите туда index.hhk; о создании индекса я расскажу ниже)
- Default - страница, отображаемая при открытии CHM файла
- Home - домашняя страница (кнопка Home на панели)
Остальные закладки диалогового окна Window Types изучите самостоятельно.
Свойства проекта
Чтобы попасть в свойства проекта, делаем двойной щелчок на слове [Options] (в левой верхней части главного окна программы под закладкой Project) и идем по закладкам по порядку. Может я не уловил логики программы, но мне показалось, что часть настроек дублируются. Т.е. ниже вы увидите некоторые настройки, которые мы уже установили, ковыряясь во внешнем виде.
На закладке General нас интересуют:
- Title - название CHM файла (отображается в заголовке окна скомпилированного файла)
- Default File - страница (статья), которая отображается при открытии CHM файла
- Default Window - я выбираю Navigation Pane (навигационная панель с закладками в левой части CHM файла)
- Language - Russian (обязательно, если в Содержании кириллица)
На закладке Files мы указываем следующие параметры:
- Compiled File - имя и расположение скомпилированного файла
- Contents File - вот тут я и указываю TOC файл, созданный в HTM2CHM
- Index file - (если вам нужен индекс - впишите туда index.hhk; о создании индекса я расскажу ниже)
- Include keywords from HTML file - эта опция предполагает наличие заранее сформированных ключевых слов в HTML файлах для создания индекса. См. ниже.
- Full text search stop file - текстовый файл с расширением STP, содержащий слова, которые вы хотите исключить из полнотекстового поиска. См. ниже.
Едем дальше - закладка Compiler. Здесь мы отмечаем лишь Compile full-text search information (если, конечно, нужен полнотекстовый поиск).
На этом начальную настройку проекта можно считать завершенной. Теперь можно уже переходить к компиляции. Если вас интересует создание индекса и исключение слов из поиска, то читайте дальше.
Создание индекса
Где-то в тексте справки к HTML Help Workshop мне встретилась фраза, что пользователи чаще обращаются к индексу, чем к поиску. Не знаю насколько это верно, но мне вообще хотелось иметь индекс, чтобы было все профессионально :) Добавить ключевые слова для индекса в каждую страницу можно через интерфейс HTML Help Workshop или вручную в каждую страницу. Я изложу оба способа.
Добавление ключевых слов через интерфейс Workshop
Через интерфейс программы ключевые слова добавляются на закладке Index. Я обойдусь без скриншотов, так как там трудно промахнуться (окна будут фактически аналогичны тем, что приведены в рассказе о редактировании проекта). Нажимаем на вторую сверху иконку с изображением ключа и получаем окно в котором нужно ввести ключевое слово и кнопкой Add выбрать страницу, к которой слово будет относиться. Одно ключевое слово может относиться к нескольким страницам - просто добавляйте их все в том же окне. В итоге индекс будет сохранен в файл index.hhk, который несмотря на расширение является текстовым файлом, содержащим гипертекстовую разметку (HTML).
Я, однако, избрал другой способ, и теперь уже точно не помню почему. Если память мне не изменяет, кириллические ключевые слова, добавленные через GUI, впоследствии некорректно отображались в CHM файле. Так что прежде чем наполнять индекс тысячами слов проверьте как у него дела с кириллицей :)
Внесение ключевых слов в HTML код
В код HTML страницы после тега BODY вносится следующий текст (приводится скриншот, т.к. данный HTML код вырезается скриптом сайта):
Непроизносимый набором символов лучше скопировать :) Вообще, это одна строка, просто на скриншоте сделан перевод строки.
Очевидно, что можно указать несколько ключевых слов - они все будут указывать на статью, в текст которой они были внесены. В итоге я методом Search&Replace внес эту абракадабру во все страницы, а потом потихоньку добавлял ключевые слова.
Ни один из способов особо быстрым не назовешь. Так или иначе приходится назначать ключевые слова страницам вручную, и как это автоматизировать непонятно. Если вам известен более простой способ, то я буду рад о нем узнать.
Исключение слов из полнотекстового поиска
Исключить слова из полнотекстового поиска можно, поместив их в обычный текстовый файл (одно слово на строку) и сохранив файл с расширением STP. В виде исключений я использовал слова, которые часто упоминаются на страницах, но вряд ли нужны при поиске. Фрагмент файла:
Не скажу, что мне удалось реально сэкономить на размере файла таким образом. Используя список на 70 слов я сэкономил 30 кб. Однако, для больших CHM файлов с длинным списком слов-исключений это вполне может иметь смысл.
Компиляция
Если у вас есть по крайней мере файл содержания и список страниц, можно попробовать запустить компиляцию и посмотреть, что получается. Делается это через меню File | Compile или по нажатию третьей кнопки слева на верхней панели инструментов.
Получаем предложение сохранить все файлы и показать скомпилированный файл по окончании компиляции. Через несколько секунд или минут (в зависимости от кол-ва материала и/или скорости компьютера) получаемый желаемый и любимый CHM файл. Смотрим что получилось. Если чего-то не хватает, проверяем настройки и компилируем снова.
Редактирование существующего проекта
Ну вот примерно такая картина наблюдается у меня на закладке Contents. Сразу видно, что файл содержания из HTM2CHM был принят как родной.
Слева панель инструментов, кнопки которой означают:
- Свойства содержания
- Добавить заголовок (секцию). Предварительно нужно выбрать страницу, после которой будет вставлен заголовок.
- Добавить страницу. Предварительно нужно выбрать страницу, после которой вставляется новая.
- Редактировать выбранную страницу или заголовок
- Удалить выбранную страницу или заголовок
- Перемещение страниц (перетаскивания нет)
- Посмотреть исходный код HTML (и внести изменения)
- Сохранить файл
Допустим, нам нужно добавить статью. Нажимаем на иконку с изображением вопросительного знака (3) и видим диалог добавления статьи.
Здесь все делается в таком порядке:
- Название статьи
- Добавить статью
- Выбрать статью
- Статья добавлена
На этом же скриншоте видна закладка Advanced, перейдя на которую можно назначить странице иконку. Однако, она недоступна в режиме создания новой статьи. А вот после создания - в режиме редактирования (кнопка с изображением карандаша (4)) иконку статье уже можно назначить.
Так победил ли Давид Голиафа?
Все зависит от поля боя :) Я вот наоборот пытался их подружить. И в связке эти две программы неплохо сработали. Другое дело, что сгенерировав содержание в HTM2CHM, я больше к ней не возвращался, а продолжаю редактировать проект в HTML Help Workshop, но на то у меня были свои причины.
А вообще, создание CHM файла не такая уж и сложная задача. Простой CHM файл можно создать при помощи HTM2CHM за три-четыре минуты. Потом можно потратить еще час на доводку, если редактировать меню и баловаться иконками страниц. HTML Help Workshop займет побольше времени, особенно на начальном этапе. Однако разобравшись с настройками и меню, вы будете тратить совсем немного времени на создание более функциональных и компактных файлов.
Если у вас есть на примете другие бесплатные (и удобные) инструменты для создания CHM файлов, то я буду признателен за ссылки на сайты программ.
Устаревший к 1996 г. формат WinHelp был заменен на новый формат HTML Help (CHM). Его полное название — Microsoft Compiled HTML Help. Первая версия CHM вышла в 1997 г. Так как более новые форматы справки, разработанные Microsoft для замены HTML Help, так и не стали публичными, CHM сегодня остается стандартом справки для платформы Windows. Средство для просмотра CHM-файлов поддерживается во всех версиях Windows 10.
Сводная информация
Наименование:
Microsoft Compiled HTML Help (CHM) — система справки для платформы Windows.
Расширение файлов:
Платформы:
Windows 98 – Windows 10
Программа:
HTML Help Workshop
Стандартное средство для просмотра CHM файлов — hh.exe (Microsoft® HTML Help Executable). Начиная с Windows 98, оно входит в любую ОС данного семейства и располагается в папке Windows. Для вывода на экран содержимого справки hh.exe использует основные компоненты Internet Explorer. Поэтому для просмотра CHM-справки в ОС Windows достаточно, чтобы был установлен Internet Explorer.
Разработчик, 1-й релиз:
Майкрософт, 1997 г.
HTML Help 1.0 Beta (1996) и HTML Help 1.0. (1997) вышли под руководством системного архитектора Ральфа Уолдена (Ralph Walden).
С 1998 г. разработку возглавлял Шейн МакРобертс (Shane McRoberts).
История:
1996 — Анонс и выход HTML Help 1.0 Beta.
1997 — выход HTML Help 1.0 с IE4.
1998 — выход HTML Help 1.1 с Windows 98.
1999 — выход HTML Help 1.21 с IE5.
2000 — выход HTML Help 1.3 с Windows 2000. HTML Help стал обновляться с ОС Windows.
2000 – выход HTML Help 1.32 с Windows Me и IE5,5.
2001 — выход HTML Help 1.33 с Windows XP и IE6.
2002 — выход HTML Help 1.4 SDK (версия HTML Help 1.3) с Windows XP SP1 и IE6 SP1. После этого разработка была заморожена.
2004-2005 — обновления системы безопасности, запрет на работу из ЛС.
Формат - предшественник:
Формат-преемник:
Microsoft Help 2 (не публичный формат — в 2003 г. Майкрософт решила не выпускать новую платформу для справки MS Help 2).
Поддержка контекстной
справки:
Возможность изменения
внешнего вида под
пользователя:
область отображения раздела – полностью;
область отображения содержания — ограниченно, но возможно.
Применение формата
Формат HTML Help задумывался, как система доставки информации с широким спектром применения: от разработки справки для приложений, работающих под управлением ОС Windows, до создания электронных книг и интерактивных систем обучения.
Плюсы
- Вся информация сохранена в одном файле.
- Небольшой размер файла (алгоритм сжатия LZX).
- Встроенная система полнотекстового поиска.
- Возможности форматирования HTML и
- Единственный на сегодня формат, поддерживающий модульные системы справки (общие оглавление и указатель формируются во время запуска).
- Единственная на сегодня система справки с
- Безопасность — при загрузке файлов CHM из сети содержимое файла блокируется (для разблокировки требуется участие пользователя).
Минусы
Как выглядит HTML Help
Ниже в левой части окна отображается (2) навигационная панель с вкладками Содержание, Указатель, Поиск, Избранное. Навигационную панель можно временно скрыть во время работы со справкой при помощи кнопки Скрыть (Показать – снова вывести на экран). Часть вкладок может быть полностью скрыта. Например, вкладка Избранное используется очень редко и, как правило, скрывается. Аналогично можно скрыть вкладку Поиск. Вкладка Указатель скрывается только автоматически, если в файле справки нет ни одного ключевого слова.
На вкладке Содержание отображается динамическое оглавление справки: разделы и подразделы. В модульных системах справки оглавление формируется автоматически во время запуска файла. В (3) расположенной справа и занимающей большую часть окна области отображается содержимое раздела, выбранного в оглавлении. Внешний вид данной области можно полностью изменить в соответствии с предпочтениями автора или заказчика справки (фирменный стиль, дизайн-макет и т.п.).
На вкладке Поиск расположены элементы управления полнотекстовым поиском по всему содержимому файла справки. Результаты поиска также отображаются на данной вкладке. При открытии найденных разделов в области просмотра автоматически подсвечивается поисковый контекст (искомый термин или термины).
На вкладке Избранное можно добавить ссылки на разделы справки для быстрого доступа к ним. Список избранных разделов справки сохраняется и отображается каждый раз при запуске файла справки. Ссылки на избранные разделы можно удалять.
Разработчик может задать размеры и положение окна справки для первого запуска, ширину навигационной панели по умолчанию, а также включить сохранение размера окна и его положения в реестре. В этом случае при каждом открытии файла будут использоваться последние пользовательские настройки.
Считается, что внешний вид навигационной панели (Содержание, Указатель, Поиск) изменить практически не возможно. Стандартными средствами можно изменить тип и размер шрифта оглавления и ключевых слов, отключить значки «+» и «-», которые отображаются слева от разделов, включить пунктирную линию, показывающую древовидную структуру разделов, включить выделение разделов при наведении на них курсора, а также включить автоматическое скрытие неактивных родительских разделов. При очень большом желании можно добиться следующего результата.
Как устроен HTML Help
- набор HTML-страниц;
- стили CSS;
- скрипты JavaScript и Visual Basic;
- рисунки в форматах JPEG, GIF и PNG;
- файл .hhc, содержащий оглавление справки (текст, размеченный тегами HTML);
- файл .hhk — список ключевых слов и ссылок на разделы справки (текст, размеченный тегами HTML);
- файл .hm — карта контекстных номеров справки;
- другие файлы, необходимые для работы справки.
HTML Help также поддерживает ActiveX и Java.
Как создать HTML Help
Чтобы не перекапывать поле лопатой, можно воспользоваться трактором! Сегодня существует ряд коммерческих программ, позволяющих эффективно создавать и поддерживать справку в формате CHM. Самыми популярными являются Adobe RoboHelp и Help & Manual. Есть и другие, менее функциональные и менее популярные коммерческие программы, такие как HelpNDoc, различные конвертеры и т.п. Для сборки справки в формате CHM в любом случае используется компилятор hhc.exe (Microsoft HTML Help Compiler), входящий в состав HTML Help Workshop.
Формат HTML Help или CHM был разработан компанией Microsoft в 1997 г. Сегодня CHM остается стандартом справки для приложений, работающих в ОС Windows. Средство для просмотра CHM-файлов есть во всех версиях Windows 10. Более того, наличие справки в приложении часто рассматривается как один из показателей качества приложения. В этой статье я расскажу о том, как создать справку в формате CHM.
Справка в формате HTML Help (CHM) представляет собой скомпилированный HTML — автономный веб-сайт, сжатый и упакованный в файл формата CHM. Наряду со стандартным функционалом, таким как динамическое оглавление, указатель и полнотекстовый поиск, HTML Help может содержать и дополнительный функционал, например, избранное и т.д. Подробное описание формата можно посмотреть в статье Формат HTML Help. Создать CHM справку можно при помощи специальных программ, как платных, так и бесплатных.
Бесплатные программы для создания CHM-справки
MS HTML Help Workshop
Компания Microsoft, разработчик формата CHM, предоставила для создания справки бесплатный инструмент, HTML Help Workshop. Его можно свободно скачать с сайта компании по данной ссылке. В составе программы имеется максимально подробный файл справки на английском языке. На сайте есть подробное описание формата, также в оригинале.
Пошаговых инструкций по работе с HTML Help Workshop в сети Интернет довольно много. Ссылки на некоторые из них вы найдете в конце статьи. В печатном виде с такими инструкциями можно ознакомиться в книге А. Гультяева «Help. Разработка справочных систем» на страницах 187-208. В этой статье я также не буду приводить подробных инструкций по работе с программой HTML Help Workshop, так как они есть в других материалах:
- Пошаговую инструкцию по декомпиляции CHM-файлов можно найти в статье «Декомпиляция CHM-файла».
- Подробная инструкция создания проекта в HTML Help Workshop приведена в статье «Создание и настройка проекта в HTML Help Workshop». Новый проект потребуется, чтобы отредактировать файлы, извлеченные из CHM во время декомпиляции, и чтобы собрать CHM-файл снова. Новый проект также потребуется для создания CHM-файла с нуля.
- Сам процесс редактирования файлов, извлеченных из CHM, а также последующая сборка CHM-файла в HTML Help Workshop подробно рассмотрены в статье «Внесение изменений и сборка нового CHM-файла».
Очевидный, и, на мой взгляд, единственный плюс программы HTML Help Workshop — бесплатность. Создание более-менее серьезной справки в HTML Help Workshop — очень трудоемкая задача, выполнение которой растягивается на многие месяцы. При этом вы получите справку с базовыми возможностями формата CHM: текст, рисунки, ссылки. Регулярное обновление справки на базе проекта, созданного в HTML Help Workshop, практически нереально. Я пользуюсь данной программой исключительно для компиляции / декомпиляции CHM-файлов. В более продвинутых бесплатных и профессиональных программах, предназначенных для разработки справочных систем, HTML Help Workshop используется в качестве компилятора. Это говорит о солидном потенциале формата, скрывающемся под непростым пользовательским интерфейсом инструмента.
Рассмотрим еще несколько более продвинутых программ, при помощи которых можно создать справку в формате CHM: HelpNDoc и Help+Manual.
HelpNDoc
HelpNDoc — это условно-бесплатная программа от французского разработчика, компании IBE Software. Пользовательский интерфейс программы выполнен в стиле MS Office, поэтому работу с программой можно быстро и легко освоить. Для работы с текстом, рисунками, таблицами, ссылками и другим контентом в HelpNDoc используется простой и интуитивно понятный визуальный редактор. HelpNDoc работает по принципу единого источника и поддерживает экспорт проекта в ряд форматов справки, в том числе, CHM. Краткое описание программы HelpNDoc на русском языке можно посмотреть в статье "HelpNDoc — бесплатная альтернатива Help+Manual".
На момент написания статьи выпускается 3 редакции программы:
- Standard — платная редакция, позволяющая генерировать CHM и Web-Help в коммерческих целях. Выходные файлы в остальных форматах (DOCX, PDF, EPUB и др.) будет содержать отметку о том, что они созданы некоммерческой версии программы.
- Professional — платная редакция без отметок во всех выходных форматах.
- Personal — полнофункциональная программа, бесплатная для личного, некоммерческого использования. Во всех выходных форматах в нижней части всех страниц добавляется отметка о том, что файл создан с использованием некоммерческой версии HelpNDoc.
Существует множество пошаговых инструкций, как при помощи HelpNDoc создать справку в формате CHM. Они есть и в текстовом формате, и в формате видеоуроков на английском и на русском языках. Так, канал разработчика HelpNDoc на YOUTUBE содержит порядка 60 обучающих видео с пошаговыми инструкциями на английском языке. На русском языке можно рекомендовать работы Стремнева А.Ю., например, статью «Разработка электронных учебных пособий в системе HelpNDoc» (Высшее образование в России, №11, 2015 г.) и другие.
По опыту использования HelpNDoc в течение 2 лет могу поделиться только положительными впечатлениями. HelpNDoc позволяет быстро написать с нуля и оперативно обновлять справку в различных форматах. Во время работы с программой не хватает возможности вставки в документацию элементов, характерных для электронных форматов: раскрывающихся блоков с контентом (аккордеон), адаптивных изображений, размер которых автоматически подстраивается под размер окна и т.п. Разумеется, все это можно реализовать, используя готовые или написанные самостоятельно стили и скрипты, но это отрывает технического писателя от главной задачи: разработка и обновление справки.
Как создать профессиональную справку в формате CHM
Несмотря на то, что первой профессиональной программой для разработки справки, с которой я познакомился в 2003 году, был RoboHelp Х4 (в связке с RoboDemo 4 они использовались в проекте локализации библиотеки пользовательской документации, включая справку и электронный обучающий видеокурс), с 2005 года я предпочитаю работать с Help&Manual. Сегодня это программный комплекс Help+Manual 7, в котором, на мой взгляд, есть всё необходимое для автора пользовательской документации.
Help+Manual 7 Pro — это самый популярный программный комплекс для создания справки, пользовательской и различной технической документации. Он предназначен для разработки и локализации профессиональных справочных систем, руководств пользователя, баз знаний, электронных книг и другой документации в форматах CHM, WebHelp, PDF, DOCX, EPUB, MOBI и др. для настольных и мобильных приложений, iOS и Android, Windows и Linux.
Бесплатная книга по Help+Manual 7 Pro на русском языке
Большинство обучающих материалов и инструкций по Help&Manual написано на английском и немецком языках. Предлагаемая вашему вниманию книга на русском. В ней изложены основы работы с Help&Manual. Какая версия программного комплекса подходит для работы с кириллицей? Где взять Help&Manual? Как установить? Что и как настроить для начала работы? Ответы на эти и многие другие вопросы вы найдете в данной книге.
Даже если вы ни разу не делали справку в формате CHM, данная книга идеально подойдет вам. В ней подробно разбирается пользовательский интерфейс Help&Manual, настройки и порядок работы. Для всех этапов создания справки в формате CHM приводятся подробные пошаговые инструкции с рисунками. Изучив мою книгу, вы сможете самостоятельно:
- установить и подготовить Help+Manual к работе;
- создать проект с нуля и импортировать все необходимые материалы;
- наполнить проект контентом: текстом, рисунками, таблицами и т.д.;
- создать справку в формате CHM.
Предварительный просмотр книги:
Чтобы бесплатно скачать книгу, пожалуйста, заполните форму:
Если есть вопросы по изложенному материалу или пожелания, что можно дополнительно включить в книгу, пишите в комментариях, либо воспользуйтесь формой обратной связи.
Файл справки в формате CHM (Compiled Help Modules) по умолчанию открывается утилитой, встроенной в операционную систему. Для открытия файла в этом формате достаточно два раза кликнуть по файлу CHM мышью, или открыть файл в соответствующей программе, которая имеет справочную информацию в виде файла данного типа, из меню управления приложения.
Далее операционная система Windows запустит утилиту и откроет скомпилированный файл помощи.
Чем еще можно открыть файл справки с расширением CHM? С помощью сторонних программ, файл справки CHM можно открыть в программах: 7-Zip, Sumatra PDF, Calibre, и некоторых других.
Не открывается файл CHM
В некоторых случаях, файл справки с расширением CHM не открывается:
- если файл CHM находится на сетевом диске, то для открытия файла нужно скопировать файл справки на компьютер;
- если в имени файла есть кириллица или специальные символы, то нужно переименовать файл, дав файлу имя буквами латинского алфавита.
Не отображается содержимое файла CHM
Намного чаще встречаются другой вариант: сам CHM файл запускается из программы, или непосредственно после клика по файлу, но содержимое справки не отображается. Открыто только содержание документа.
На написание этой статьи меня надоумил случай, происшедший со мной. Я писал на сайте обзор программы IrfanView. Программа поддерживает русский язык, но файлы для русификации программы, устанавливаются после установки программы на компьютер.
После установки языкового пакета, я запустил файл справки в программе, и увидел, что содержимое CHM файла не отображается. Операционная система Windows блокирует отображение файла справки с целью защиты компьютера.
Что делать? На самом деле, я знаю, что следует сделать, так как ранее уже сталкивался с подобной проблемой. Я продумал, что некоторые пользователи также могут столкнуться с таким вариантом запуска документа. Человек надеется получить ответы на свои вопросы, а вместо этого, получает пустое содержание файла справки, отображается только оглавление.
Сначала необходимо найти скомпилированный файл справки в формате CHM на компьютере. В большинстве случаев, он расположен в папке установленной программы.
Далее кликните правой кнопкой мыши по файлу формата CHM. В открывшемся контекстном меню выберите пункт «Свойства».
После этого откроется окно «Свойства: имя_файла». В нижней части окна вы увидите предупреждение: «Осторожно: этот файл получен с другого компьютера и, возможно, был заблокирован с целью защиты компьютера».
Далее поставьте галку напротив пункта «Разблокировать», а затем нажмите на кнопку «ОК».
Вы можете снова открыть файл справки CHM и увидеть, что теперь содержимое справки отображается.
Выводы статьи
Скомпилированный HTML-файл справки в формате CHM можно открыть с помощью средства операционной системы, или с помощью сторонних программ. В некоторых случаях, Windows блокирует содержимое файла справки для защиты компьютера, поэтому файл CHM можно разблокировать для отображения содержимого помощи.
Внесение изменений и сборка нового CHM-файла
Перед тем, как приступить непосредственно к редактированию содержимого CHM-файла, подытожим выполненные заранее подготовительные работы. Определившись с бесплатными программами, которые будут использоваться для редактирования CHM, мы декомпилировали оригинальный CHM-файл. Далее мы создали новый исходник (полученные файлы + файл проекта HTML Help Workshop) и научились собирать обновленный CHM-файл с аналогичным функционалом. Во время редактирования мы будем регулярно выполнять сборку обновленного CHM, чтобы оперативно находить и исправлять ошибки.
Создание и настройка проекта в HTML Help Workshop
Декомпиляция CHM-файла
Файл в формате CHM представляет собой скомпилированный HTML. В него могут входить HTML-страницы, рисунки, таблицы стилей, скрипты и другие файлы. Подробное описание состава CHM смотрите в материале Формат HTML Help. Результирующий файл в формате CHM не редактируется. Отредактировать можно только файлы, входящие в его состав. Извлечь файлы или декомпилировать CHM можно при помощи бесплатной программы HTML Help Workshop.
Редактирование CHM бесплатными программами
Если заказчику или работодателю не принципиально, какое программное обеспечение использовать, я предпочитаю редактировать CHM в Help+Manual 7. Но как показывает практика, примерно в 50% случаев заказчик или работодатель принимает решение в пользу любых бесплатных программ. С бесплатными программами дела обстоят примерно так же, как с ремонтно-строительными работами: все просто, если знать как. Рассмотрим, как отредактировать справку в формате CHM при помощи бесплатных программ HTML Help Workshop и Notepad++.
Как отредактировать CHM-файл
Пользовательская документация для приложений, работающих в ОС Windows, чаще всего поставляется в формате CHM как встроенная в программу справка. Технические писатели, технические переводчики, а также другие специалисты, занимающиеся разработкой и локализацией программного обеспечения, нередко сталкиваются с необходимостью внести изменения в CHM-файл. Если есть исходник, это не представляет особых проблем. Если исходника нет, внесение изменений в CHM — непростая, но решаемая задача. Продолжая тему работы с форматом HTML Help (CHM), я расскажу о том, как отредактировать CHM-файл, если нет исходника.
Читайте также: