Создание chm файлов из word документов
Перед тем, как приступить непосредственно к редактированию содержимого CHM-файла, подытожим выполненные заранее подготовительные работы. Определившись с бесплатными программами, которые будут использоваться для редактирования CHM, мы декомпилировали оригинальный CHM-файл. Далее мы создали новый исходник (полученные файлы + файл проекта HTML Help Workshop) и научились собирать обновленный CHM-файл с аналогичным функционалом. Во время редактирования мы будем регулярно выполнять сборку обновленного CHM, чтобы оперативно находить и исправлять ошибки.
Приступим непосредственно к редактированию CHM-справки. Начнем с самого простого: добавим текст на английском языке и заменим рисунок.
Замена рисунков в CHM
Чтобы поставить новый рисунок в справку, достаточно просто заменить файл рисунка в папке decompiled на одноименный файл с тем же расширением. В данном случае это файл viewer.jpg. Чтобы поставить рисунок с другим именем в другом формате, потребуется отредактировать код .htm-файла. Действуем по принципу: внесли изменения, собрали справку, проверили. Должен получиться следующий результат.
Добавление в CHM текста на английском языке
Чтобы добавить текст на английском языке в раздел About pop-up Windows, сначала необходимо найти файл .htm, соответствующий данному разделу. Для этого:
- В окне HTML Help Workshop перейдите на вкладку Contents.
- Выделите раздел About pop-up Windows и выберите команду Edit selection слева на панели инструментов. Будет открыто окно Table of Contents Entry. Имя файла будет указано в поле Files/URLs and their information types. В данном случае это файл wintypes_popup.htm.
- Найдите файл wintypes_popup.htm в Проводнике и откройте его в Notepad++.
Данный файл можно также открыть в редакторе, встроенном в HTML Help Workshop, воспользовавшись командой View HTML source. Работать с текстом здесь будет менее удобно (как в Блокноте).
- В окне Notepad++ отредактируйте существующий текст или добавьте новый. На данном этапе потребуются базовые знания HTML. В Notepad++ весь код (теги, атрибуты и их значения) выделен цветом, что значительно упрощает работу. Вот несколько примеров вставки текста:
- Сохраните внесенные изменения.
- Пересоберите справку и проверьте результат.
Добавление в CHM текста на русском языке
Перед вставкой в справку текста на русском языке необходимо проверить кодировку страниц. Если вы работаете с переведенным CHM-файлом, в разделах которого уже есть корректно отображающийся русский текст, кодировка страниц должна быть правильной — Windows-1251. В этом случае английский текст можно просто поменять на русский, либо добавить русский текст, как было описано выше.
Чтобы поменять кодировку:
- Откройте файл, в который необходимо вставить текст на русском языке, в Notepad++.
- Подправьте кодировку в разделе head (в данном случае в строке 4).
- В строке меню выберите Кодировки / Кодировки / Кириллица / Windows-1251. После этого в правом нижнем углу окна будет отображаться кодировка Windows-1251.
После этого в данный файл можно добавить текст на русском языке, сохранить изменения и собрать справку. Работать с другими HTM-файлами нужно в аналогичном порядке.
Редактирование раздела в CHM справке
Теперь несколько слов о редактировании раздела About the HTML Help Viewer (в Overview / Window Types). Весь текст, который выводится на экран, есть в коде .htm-страницы, файл wintypes_viewer.htm. Текст всплывающих подсказок задан в атрибуте alt тега img, в атрибутах title тегов area, а также в JavaScript в нижней части страницы. Другие .htm-страницы организованы аналогичным образом. Открывающие и закрывающие теги абзаца иногда опущены.
Редактируя тексты в html-коде, важно соблюдать принятые синтаксические правила. Если вы не сильны в HTML и JavaScript, просто не трогайте символы слева и справа от текстов. В данном примере — это двойные кавычки и теги. На рисунках ниже текст, который нужно заменить при переводе на русский, выделен цветом.
Порядок работы аналогичен описанному выше:
- с латиницей работаем в текущей кодировке;
- перед вставкой кириллицы проверяем кодировку, при необходимости меняем ее на Windows-1251, подправляем кодировку в head и вставляем кириллицу.
- Сохраняем изменения, собираем справку и проверяем полученный результат.
На данном этапе работы должно получиться примерно следующее.
Редактирование содержания CHM-справки
Из задач, обозначенных в первом материале Как отредактировать CHM-файл, осталось перевести название раздела About the HTML Help Viewer в содержании справки. Содержание CHM-документа находится в файле с расширением HHC, в данном случае, api.hhc. Это обычный текстовый файл, размеченный тегами HTML. В нем в иерархическом порядке приведены названия разделов в содержании и имена соответствующих им HTM-файлов. Если данный файл открыть в Notepad++, он будет выглядеть следующим образом.
В нашем случае кодировка файла распознается как ANSI. Строго говоря, это набор кодовых страниц, в который среди прочих входят Windows-1252 и Windows-1251. Если бы мы открыли содержание русифицированного, либо созданного на русском языке CHM-файла, кодировка бы распозналась как Windows-1251.
Если следовать логике редактирования раздела, описанной выше, для перевода названия раздела в содержании следовало бы сначала изменить кодировку файла HHC на Windows-1251, затем заменить название раздела на «О средстве просмотра HTML Help», сохранить изменения и собрать CHM для проверки. Если данная операция выполняется один раз, все будет работать.
Но до первого сохранения файла HHC программой HTML Help Workshop. Даже если вы редактировали название другого раздела в содержании, после сохранения файла все кириллические символы будут перекодированы в специальные символы HTML (мнемоники). Преобразовать их обратно в кириллицу без старого доброго Штирлица сможет только HTML Help Workshop. После такого преобразования работать с содержанием в Notepad++ будет, мягко говоря, сложно.
Поэтому я расскажу, как отредактировать содержание CHM-справки в HTML Help Workshop.
Редактирование содержания CHM в HTML Help Workshop
- Запустите HTML Help Workshop.
- Откройте файл проекта new_prj.hhp.
- Проверьте, чтобы в свойствах проекта был выбран русский язык.
- Перейдите на вкладку Contents.
- В структуре выделите название раздела, которое необходимо отредактировать.
- Слева на панели инструментов выберите команду Edit Selection.
- В поле Entry Title введите новое название раздела на английском или русском языке.
- Нажмите на кнопку ОК. Название в структуре содержания изменится на новое.
- Сохраните внесенные изменения.
- Соберите справку и проверьте ее. Должны получиться следующие результаты.
На этом все задачи, поставленные в материале Как отредактировать CHM-файл, можно считать выполненными. Проверьте получившийся CHM-файл: все ли разделы открываются, все ли ссылки работают, все ли рисунки соответствуют оригиналу.
Выводы
Ознакомившись на практике с бесплатными программами, которые были использованы для редактирования CHM-файла, каждый сделает выводы. И у каждого они будут индивидуальными. Поделюсь своими. Из достоинств представленного метода (редактирование CHM при помощи бесплатного ПО) неоспоримо только одно: бесплатность. Основные недостатки, на мой взгляд, следующие:
- Не дружественный интерфейс пользователя. Во время работы с HTML Help Workshop приходится продираться сквозь дебри пользовательского интерфейса, созданного за 20 лет до того, как UI и UX дизайну стало уделяться больше внимания. С другой стороны, со временем к интерфейсу можно привыкнуть.
- Высокая трудоемкость разработки справки. Все работы по разработке справки выполнить только в HTML Help Workshop невозможно (например, проработать исключительно структуру). Отсюда необходимость использования дополнительных программ. Следовательно, одну и ту же работу приходится делать по 2-3 раза (например: создать структуру в FreeMind, создать вручную HTM-файлы разделов, создать вручную содержание в HTML Help Workshop, привязать вручную HTM-файлы к названиям разделов и т.д.).
- Очень высокая трудоемкость редактирования справки. Обновить серьезный проект (от 1000 разделов, от 700 рисунков) в HTML Help Workshop просто не реально. Трудоемкость редактирования будет превышать трудоемкость разработки первой версии.
- Большое количество тонкостей. Нюансы работы, о которых я рассказал в данной серии статей, это только вершина айсберга. Например: в созданных из HTML Help Workshop HTM-файлах не прописывается кодировка, что важно при работе с русским языком. Значит нужно либо каждый раз прописывать кодировку руками, либо использовать еще одну программу или шаблон. Продолжать можно до бесконечности… С другой стороны, нюансов много в любой сфере.
- Неэффективная разработка контента. Писать текст с иллюстрациями, ключевыми словами и перекрестными ссылками в HTML-разметке не только неудобно, но и нерационально. Для этого эффективнее использовать визуальный редактор с системой проверки правописания. Это подтверждается рядом научных работ. Так, по результатам исследования, проведенного под эгидой Университета Гиссена (Германия), опубликованного в 2014 году, эксперты по использованию LaTeX показали меньшую производительность, чем неопытные пользователи MS Word. Пользователи LaTeX набирали текст медленнее, делали больше опечаток, орфографических и грамматических ошибок, а также ошибок форматирования. Данный пункт неплохо бы взять на заметку менеджерам, принимающим решение в пользу выбора того или иного платного или бесплатного инструмента для технического писателя.
Добавить комментарий
Комментарии
Перед тем, как приступить непосредственно к написанию комментария, подытожим выполненные заранее подготовительные работы. Определившись с бесплатными программами, которые будут использоваться для редактирования CHM, мы декомпилировали оригинальный CHM-файл. Далее мы создали новый исходник (полученные файлы + файл проекта HTML Help Workshop) и научились собирать обновленный CHM-файл с аналогичным функционалом. Во время редактирования мы будем регулярно выполнять сборку обновленного CHM, чтобы оперативно находить и исправлять ошибки.
Что-ж все так растянуто. Очень помогла статья, спасибо. Но очень многое приходится пропускать.
Рубрики
Илья Жуков
Последние статьи
Ключевые слова в Help+Manual
Предметный указатель — это список ключевых слов (терминов, основных понятий и т.п.), помогающий читателю быстро найти в документе нужную информацию. В печатной докумен.
HTML Help Workshop – бесплатная программ…
В 1997 году Microsoft выпустила новый формат справки, HTML Help (CHM), а также бесплатную программу для создания и редактирования справки в этом формате — HTML Help Wo.
HelpNDoc — бесплатная альтернатива Help+…
Еще одной альтернативой RoboHelp и Help&Manual является программа HelpNDoc от французского разработчика, компании IBE Software. Это практически полный аналог HelpS.
HelpSmith — достойная альтернатива Help+…
Продолжая тему средств разработки справки и пользовательской документации, нельзя не рассказать о программе HelpSmith. Она работает по принципу единого источника и под.
Dr.Explain — отечественная программа для…
За почти 30-летнюю историю существования RoboHelp и Help&Manual стали стандартом средств разработки справки и пользовательской документации в среде Windows. Сегодн.
Как вычитать свой текст: инструкция для …
В идеале любой технический текст кроме автора должен прочитать хотя бы один редактор и хотя бы один корректор. На практике дело ограничивается одним нормоконтролером и.
Как повысить качество текста инструкций
Каждый автор знает: во время написания и правки текста глаз замыливается. Смотришь в текст и читаешь не то, что написано, а то, что хочешь видеть. В этой статье я расс.
Закон построения нехудожественного текст…
Вы не задумывались, почему некоторые тексты читаются на одном дыхании, а через другие приходится продираться? Почему одна статья запоминается на лету, как бы сама собо.
Примечания и предупреждения в тексте инс…
Важную информацию в тексте можно выделять по-разному. Можно целые предложения оформлять жирным, подчеркнутым и курсивным шрифтом. Можно написать все слова в предложени.
Методика чтения научных книг
Я не люблю брать в руки разрисованные книги. Текст исчиркан, подчеркнут, зачеркнут. Ручкой, карандашом, маркером. Уголки страниц загнуты. На полях рукописные пометки, .
Книга «Пиши, сокращай: как создавать сил…
Наводя порядок в книжном шкафу, нашел книгу Максима Ильяхова и Людмилы Сарычевой «Пиши, сокращай: как создавать сильный текст». Я прочитал ее летом 2018 года, но отзыв.
Как починить поиск в русском PDF
Начинающий пользователь Help+Manual, пишущий документацию на русском языке, рано или поздно сталкивается с ситуацией, когда в созданном PDF-документе не работает поиск.
Что нового в Help+Manual 8
Работа со стилями в Help and Manual 7
Чтобы внешний вид нового CHM-файла соответствовал оригиналу, необходимо создать стили, применить их к проекту и очистить встроенное форматирование. Это позволит обеспе.
Форматы справки для ОС Linux
В рамках замещения импортного программного обеспечения все больше государственных структур переходят на отечественные сборки Linux. Прежде всего, это Alt Linux и Astra.
Сборка CHM-файла в Help and Manual
Регулярная сборка выходных файлов позволяет контролировать качество справки и исправлять ошибки по горячим следам. Она необходима для любого формата справки, а также д.
предлагаю как-то обобщить под одну тему хотя бы. тем более, что их много, связных. да и будет минимум несколько от меня.
Итак, номер раз - многие авторы предлагают MS Word в качестве "создателя" исходных html-ей.
По многим причинам, этот метод очень даже эффективный и оперативный.
Но вот в чем успел убедиться лично - так это минимум в том, что вставленные в исходный документ рисуночки формата jpg (из буфера обмена, что тоже весьма удобно!) в сохраненной html-ке браузерами отображаются, а вот в компилированном chm-е - уже нет (при том только jpg). Залез вовнутрь html и немного ужаснулся от творчества Word-а (Word 2003). Если убить адское обрамления тегов рисунков , а потом еще и практически всю заголовочную часть html, захватив до кучи практически все сгенерированные Word-ом стили - тогда jpg-шки эти прорисовываются таки в chm-е, да.
Есть ли адекватный способ (ну или пара хитростей - может, так сказать будет правильнее) приведения word-html-щины в божеский для chm-а вид - без создания html-ек ручками (чего бы очень не хотелось)?
Sewer
Есть ли адекватный способ (ну или пара хитростей - может, так сказать будет правильнее) приведения word-html-щины в божеский для chm-а вид - без создания html-ек ручками (чего бы очень не хотелось)?
Делать html ручками или посредством Word есть полный изврат. Вордовский html можно просто сразу убить и забыть об этом кошмарном способе. Я пользую для изготовления html утилиту Shalom Help Maker 0.6.1. Он делает прекрасные html, потом давишь его Compile, вызывается заранее инсталированный MS Help Compiler и делает из этой кучи единый hlp-файл. К сожалению, Shalom Help Maker не умеет работать с более свежей версией MS Help Compiler, который бы создавал chm. Но меня вполне устраивает и конечный hlp. Графика попадает в него без проблем. Возможно, кроме Shalom Help Maker существуют и другие фриварные хелп-мэйкеры, я не искал. Вот что пишется в его хелпе :
ну, hlp-файлы это уже несколько вчерашний день, все же
Чем хорош собственно Word - кроме, естественно, получения doc и rtf файлов (с исходниками, которые потом можно применять не только для компиляции!) - так это удобными стилями, оглавлением, проверкой орфографии, вставкой рисунков из буфера и еще много чем. Вобщем, всем тем, что позволяет перейти от "хард-кодинга" а-ля html source - к удобной работе непосредственно с данными
попробуй MICROSOFT FRONTPAGE или EXPRESSION STUDIO
Sewer
ну, hlp-файлы это уже несколько вчерашний день, все же
Чем хорош собственно Word - кроме, естественно, получения doc и rtf файлов (с исходниками, которые потом можно применять не только для компиляции!) - так это удобными стилями, оглавлением, проверкой орфографии, вставкой рисунков из буфера и еще много чем. Вобщем, всем тем, что позволяет перейти от "хард-кодинга" а-ля html source - к удобной работе непосредственно с данными
Русскоязычное издание FoxTalk
Февраль 2003
Создание CHM-файлов из Word-документов, часть 1
Дуг Хенниг
Некоторые инструментальные средства, например West Wind HTML Help Builder, могут сократить объем работы по созданию справочных Help-файлов, представленных в формате HTML (CHM). А что если вы начинаете эту работу не на пустом месте, а уже имея в своем распоряжении готовые Word-документы? В данной серии статей, состоящей из двух частей, Дуг Хенниг рассматривает основные моменты процесса создания CHM-файлов (в том числе те задачи, которые необходимо решить при формировании CHM-файлов из документов, представленных в формате текстового процессора Word) и знакомит вас с набором инструментов, предназначенным для автоматизации этого процесса
Апрель 2003
Создание CHM-файлов из Word-документов, часть 2
Дуг Хенниг
Во второй части этой серии публикаций, состоящей из двух статей, Дуг Хенниг рассматривает основы создания CHM-файлов, а затем, используя классы, представленные в прошлом месяце, автоматизирует процесс формирования CHM-документа из набора HTML-файлов, которые в свою очередь получены из Word-документов.
Идея в том, что из подготовленного в Word файла программно выбрасывается весь мусор. При помощи специальных классов.
Однако лично я пишу справку напрямую в HTML Help Workshop. Просто стараюсь делать справку максимально простую. Без различных выкрутасов. А для этого вполне хватает простейших тегов абзаца и выделений.
В 2007 ворде при сохранении есть опция "Веб страница с фильтром (*.htm, *.html)" Получаемый после этого HTML хоть и не "чисто-чистый", но вполне приемлемый, и тысяч строк всякой шелухи не содержит. Не знаю есть ли такая фишка в 2003 ворде.
P.S. Сам пользую Help&Manual - в общем и целом нравится. Не нравится конечно то что он не бесплатный Ну и есть некоторые проблемы с подключением его проекта к приличным системам контроля версий типа svn (он типа свою собственную систему для совместной работы имеет).
Igor Korolyov
В 2007 ворде при сохранении есть опция "Веб страница с фильтром (*.htm, *.html)" Получаемый после этого HTML хоть и не "чисто-чистый", но вполне приемлемый, и тысяч строк всякой шелухи не содержит. Не знаю есть ли такая фишка в 2003 ворде.
Я тут опробовал хваленый ABC Amber HLP Compiler. Вроде как он из готового HLP делает CHM, PDF и черт-те чего еще. Да, делает, но поскольку он только триальный и криво заточен под русский язык, то получается такая пакость, что я решил-таки оставить хелп в виде HLP, пусть даже это и несовременно. Зато Shalom Help Maker так прост и дружит с русскоязычным хелпом (HTML->HLP), что устали меня эти хелпшопы и амберы.
Владимир Максимов
Русскоязычное издание FoxTalk
Февраль 2003
Создание CHM-файлов из Word-документов, часть 1
Дуг Хенниг
Да, Дуг Хеннинг молодец. На несколько страниц с упоением рассказывает о красивой и идеологически правильной по парадигмам объектного проектирования структуре своей утилиты , но потом идет
Сформированный для встроенной графики HTML код ужасен и требует присутствия целого набора файлов в создаваемом Word подкаталоге. Если вы связываете два этих документа по ссылке, то Word
формирует простой тэг — почти так же, как поступили бы вы сами, если бы формировали HTML-код вручную.
Если не использовать встроенной графики - смысл использования Word-а для меня при создании документации примерно тот же, что и Dreamweaver-а для непосредственного html-я.
Sewer
Да, Дуг Хеннинг молодец. На несколько страниц с упоением рассказывает о красивой и идеологически правильной по парадигмам объектного проектирования структуре своей утилиты , но потом идет
Коллега, а может не морочить себе голову и сделать вполне рабочим инструментом HLP (опять-таки в виде одного файла), только кил на 500 тяжелее. Или "вам нужны шашечки, а не ехать" ?
Что такое "встроенная графика"? Если я сохраняю документ с картинкой (вставленной тем самым Ctrl+V из буфера обмена) из ворда 2007 в "фильтрованный html" то там как раз будет папка с картинкой и в html тот самый тег IMG - насколько я помню это как раз то что нужно нелп-компилятору - ну только возможно ему нужно указать в настройках путь к папке с картинками - это я не помню.
Igor Korolyov
Что такое "встроенная графика"? Если я сохраняю документ с картинкой (вставленной тем самым Ctrl+V из буфера обмена) из ворда 2007 в "фильтрованный html" то там как раз будет папка с картинкой и в html тот самый тег IMG - насколько я помню это как раз то что нужно нелп-компилятору - ну только возможно ему нужно указать в настройках путь к папке с картинками - это я не помню.
В аттаче то что выдаёт 2007 ворд - IMHO лишнего там минимум. Ссылка на рисунок более чем скромная - тег абзаца и внутри img - ничего лишнего Саму папку с картинкой нет смысла прикладывать - там обычный jpg и более ничего.
Igor Korolyov
В аттаче то что выдаёт 2007 ворд - IMHO лишнего там минимум. Ссылка на рисунок более чем скромная - тег абзаца и внутри img - ничего лишнего Саму папку с картинкой нет смысла прикладывать - там обычный jpg и более ничего.
ларчик просто открывался:
1. сохраняем из MS Word (пробовал версии 2003-2007) как html с фильтром
2. если имя файла с пробелами и русскими буквами - переименовываем папку с доп.файлами к html в латиницу и соотв. меняем ссылки внутри html-ки
3. .
4. PROFIT!
Sewer
ларчик просто открывался:
1. сохраняем из MS Word (пробовал версии 2003-2007) как html с фильтром
2. если имя файла с пробелами и русскими буквами - переименовываем папку с доп.файлами к html в латиницу и соотв. меняем ссылки внутри html-ки
3. .
4. PROFIT!
Смею вас заверить - на порядки удобнее, нежели хардкодинг хелпа в html или паталогоанатомирование получившегося после Worda html-мусорника при помощи спец. утилит!
Фактически - операция в несколько кликов-щелчков, а результат - переход от "человеческой" документации к удобному во всех смыслах одному-единственному chm-файлику
Равно как и создание хелпа в HTML Help Workshop (хорошо описано, имхо, в книгах Шапорева и Гурвица).
Просто стоит разок попробовать самому
. а вот еще вопрос по HTML Help Workshop.
При открытии справки из программы, заголовком окна со справочным документом является просто "Справка".
При этом параметр Title для самого hhp-проекта очень даже как указан!
Формат 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-файл из проекта в Help and Manual 7.
Что нужно для сборки CHM-файла?
Чтобы собрать CHM-файл, нужно:
- чтобы на вашем компьютере была установлена программа HTML Help Workshop, и
- чтобы входящий в ее состав компилятор был подключен к Help and Manual.
Без этого собрать CHM-файл не получится.
Чтобы это проверить:
- В окне программы выберите File \ Program Options.
- Перейдите на вкладку Compilers.
- C:\Program Files\Help Workshop\hhc.exe (32-битная Windows)
- C:\Program Files (x86)\Help Workshop\hhc.exe (64-битная Windows)
- Если программа HTML Help Workshop не установлена, скачайте HTML Help Workshop по ссылке, установите программу и подключите компилятор к Help and Manual как описано выше.
Чтобы собрать CHM-файл:
1. Откройте проект.
2. На вкладке Project выберите команду Publish. Данная команда также есть в меню File и на панели быстрого доступа. Дополнительно можно воспользоваться сочетанием клавиш Ctrl+F9.
3. В раскрывающемся списке Publish Format выберите HTML Help.
4. В поле Output File измените наименование выходного файла и его расположение (при необходимости).
По умолчанию выходной файл будет предложено сохранить в папку проекта. Название файла будет совпадать с названием файла проекта.
5. В поле Select Skin выберите шаблон, если для сборки документа будет использоваться шаблон (skin file).
6. Задайте дополнительные параметры (при необходимости).
2 флажка, выделенные на рисунке, снимать не нужно. Они отвечают за удаление временных файлов и за автоматическое открытие файла после сборки.
7. Нажмите на кнопку Publish Now.
Сборка CHM-файла обычно занимает несколько секунд. С настройками по умолчанию CHM-файл открывается после сборки автоматически.
Примечание. Большинство настроек публикации (имя выходного файла, его расположение, выбранный шаблон и т.д.) для каждого выходного формата сохраняется. Поэтому каждый раз перед сборкой задавать их не нужно.
Смотрите видеоинструкцию: Сборка CHM-файла в Help and Manual
Установка Dr.Explain
Рисунок 1. Мастер установки «Dr.Explain»
Создание и настройка нового проекта
При запуске программы в окне «Проекты Dr.Explain» (Рисунок 2) выберите пункт «Создать новый проект» и нажмите «ОК», либо используйте пункт «Файл -> Создать» главного меню.
Рисунок 2. Окно «Проекты Dr.Explain»
Для настройки параметров экспорта в формат CHM, выберите пункт «Настройки -> Настройки проекта» в главном меню. Выберите раздел «CHM экспорт» в окне настроек.
Создание тематических разделов в файле справки
Создайте новую тему с помощью пункта «Настройки -> Добавить тему» главного меню. Также можно использовать пункт «Добавить -> Добавить тему» контекстного меню, которое вызывается нажатием правой кнопки мыши на любой позиции дерева проекта (Рисунок 3).
Рисунок 3. Дерево проекта «Dr.Explain»
Настройте порядок следования разделов в структуре документа с помощью пунктов «Выше» и «Ниже» контекстного меню. Изменить названия тем можно с помощью пункта «Переименовать».
Далее создайте содержимое разделов, выберите интересующий пункт в дереве проекта и приступайте к заполнению в окне редактора. Заполняйте раздел в свободной форме. В редакторе предусмотрены основные стандартные функции редактирования и форматирования текста и ряд функция для работы с изображениями, видео, таблицами и переменными. Использование переменных позволяет заменить повторяющиеся данные именем переменной. В таком случае при изменении присвоенного переменной значения, соответствующий текст изменится во всем документе.
Для повышения удобства поиска по файлу справки создайте и настройте ключевые слова. Откройте окно ключевых слов — кнопка «Ключевые слова» (Рисунок 4). Для добавления и удаления слов служат одноименные кнопки. Настройте привязку тем к словам, для этого выбрав интересующий раздел в структуре проекта, проставьте метки в полях тех терминов, которые хотите ассоциировать с данной темой.
Рисунок 4. Ключевые слова
Рисунок 5. Окно «Захват объекта»
После открытия окна «Захват объекта» (Рисунок 5) установите метки в поле «Accessible -объект» или «Win 32-окно», затем выполните захват изображения интересующей формы одним из способов, предложенных в окне захвата. В структуре документа будет автоматически создан раздел, содержащий аннотированное изображение формы приложения (Рисунок 6). В окне редактора можно добавить и удалить аннотацию или изменить порядок следования описания отдельных элементов.
Рисунок 6. Результат выполнения захвата объекта
Настройка значений Help ID
Рисунок 7. Изменение значения Help ID в окне «Свойства страницы»
Предварительный просмотр и сохранение проекта
Перед экспортом проекта используйте функцию предварительного просмотра — кнопка «Просмотр CHM», чтобы убедиться в корректном отображении всех разделов справки. Если необходимо внести изменения, вернитесь в режим редактирования.
Для сохранения проекта выберите пункт «Файл -> Сохранить как» главного меню, введите имя файла и укажите путь его размещения в открывшемся окне сохранения.
Экспорт проекта в CHM-файл
Рисунок 8. Окно «Экспорт в CHM»
- откройте проект с помощью средств среды разработки, которую вы используете;
- в редакторе форм (Рисунок 9) выберите «Button» из панели элементов;
- поместите элемент в форму;
- в свойствах элемента задайте название и подпись кнопки, например, например, «HlpButton» и «Help». Параметры вводятся в поля «Name» и «Text» соответственно;
Рисунок 9. Редактор форм среды разработки Microsoft Visual Studio
Рисунок 10. Редактор кода среды разработки Microsoft Visual Studio
При таком способе вызова файла справки при любых его перемещениях необходимо заново указывать в коде полный путь.
Будьте внимательны, для обеспечения правильной работы элемента вызова файла справки строго соблюдайте синтаксис, приведенный в примерах.
- добавьте компонент «Help Provider» путем егоперемещения в форму приложения из панели элементов. Значок компонента появится в нижней части окна редактора форм;
ОБРАТИТЕ ВНИМАНИЕ: Допускается использование нескольких компонентов «Help Provider». Это удобно в том случае, когда информация о различных элементах содержится в различных файлах справки. Также вы можете использовать отдельные компоненты для различных форм;
- в окне свойств элемента «Help Provider» укажите расположение файла справки — поле «HelpNamespace»
ОБРАТИТЕ ВНИМАНИЕ: Если файл справки располагается в одной папке с исполнительным файлом приложения, то достаточно указать только имя файла. При раздельного размещении файлов необходимо указать полный путь. В таком случае при любом перемещении файла справки, значение параметра «HelpNamespace» должно быть заменено актуальным.
- в окне свойств объекта внесите значение Help ID соответствующего объекту раздела справки в поле «HelpKeyword on Help Provider1». Выберите значение «TopicId» для поля «Help Navigator on Help Provider1»
ОБРАТИТЕ ВНИМАНИЕ: Количество параметров «HelpKeyword …» и «Help Provider…» в свойствах объектов соответствует количеству используемых компонентов «Help Provider», а цифра в наименовании параметра соответствует номеру компонента. Будьте внимательны при заполнении данных полей;
- убедитесь в правильной работе компонента «Help Provider». Запустите отладку — пункт «Debug -> Start debugging» главного меню, после чего на экране появится стартовая форма приложения. При нажатии клавиши «F1» должен открыться тот раздел файла справки, который соответствует элементу, находящемуся в фокусе;
- повторите описанную процедуру для всех объектов, которые необходимо ассоциировать с определенными разделами файла справки.
Открытие определенных разделов файла справки с помощью компонента Help Provider
Помимо вызова определенных разделов файла справки по соответствующим им HelpID, компонент «HelpProvider» также может быть использован для адресации разделов с использованием других параметров. Для настройки вызова определенных разделов необходимо установить соответствующие значения полей «HelpKeyword on Help Provider1» и «Help Navigator on Help Provider1» в свойствах элементов. Для настройки вывода определенных разделов файла справки при нажатии клавиши «F1» проделайте следующие действия:
- добавьте компонент «Help Provider», перетащите его из панели элементоввформу. Компонент отобразится в нижней части окна редактора форм;
- укажите расположение файла справки — поле «HelpNamespace» в окне свойств объекта «Help Provider»;
- в окне свойств элемента, в поле «HelpNavigator on Help Provider1» выберите интересующий параметр:
·AssociateIndex— открывает вкладку «Указатель» иподсвечивает в списке первое по порядку ключевое слово, название которого начинается с сочетания символов в поле «HelpKeyword on Help Provider1»;
·Index — открывает вкладку «Указатель» и подсвечивает в спискеключевое слово, указанное в поле «HelpKeyword on Help Provider1»;
·Find — открывает вкладку «Поиск»;
·TableOfContents — открывает оглавление;
·Topic — открывает раздел, название которого указано в поле «HelpKeyword on Help Provider1».
ОБРАТИТЕ ВНИМАНИЕ: Название раздела указывается в формате «Topic.htm», это необходимо для правильной работы вызова справки.
·TopicId — открываетраздел,которому соответствует параметр Help ID, указанный в поле «HelpKeyword on Help Provider1»;
·KeywordIndex — открывает вкладку «Указатель» и выводит список разделов, содержащих ключевое слово, указанное в поле «HelpKeyword on Help Provider1».
Такой способ вызова справки позволяет гибко настроить адресацию и поиск в справочной системе, а также использовать для каждой отдельной формы или элемента соответствующий им файл справки или отдельные его разделы.
Если необходимо вызвать определенный раздел справочной системы с помощью кнопки, используйте следующие фрагменты кода:
Код вызова стартовой страницы справки:
Код вызова вкладки «Указатель»:
Код вызова оглавления:
Код вызова вкладки «Поиск»:
Код вызова поиска по первым буквам ключевого слова:
где me — сочетание букв для поиска
Код вызова поиска по ключевому слову:
где FAQ — ключевое слово
Код вызова раздела по его названию:
где Overview.htm — название раздела (ключевое слово всегда указывается в формате Topic.htm)
Читайте также: