Каталог расширений

Популярные теги

3gp       avi       fb2       jpg       mp3       pdf      

Как создать скомпилированный файл справки в формате html chm


создание CHM-справки в бесплатных и профессиональных программах

Формат 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. Его можно свободно скачать с сайта компании по данной ссылке. В составе программы имеется максимально подробный файл справки на английском языке. На сайте есть подробное описание формата, также в оригинале.

Не буду приводить пошаговые инструкции по работе с данной программой. С 1997 года их прилично накопилось в сети Интернет. Ссылки на несколько описаний вы найдете в конце статьи. В печатном виде с пошаговыми инструкциями можно ознакомиться в книге А. Гультяева «Help. Разработка справочных систем» на страницах 187-208.

Очевидный, и, на мой взгляд, единственный плюс программы 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. Подробное описание программы на русском языке можно посмотреть здесь.

На момент написания статьи выпускается 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.

 

Предварительный просмотр книги:

 

 

Чтобы бесплатно скачать книгу, пожалуйста, заполните форму:

 

 

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

 

 

Источники и дополнительная информация

Формат HTML Help.

Создание справочной системы в Microsoft Help Workshop.

Как создать CHM файл.

Описание HelpNDoc на русском языке.

Учимся создавать Help в формате CHM.

Канал HelpNDoc на YOUTUBE (порядка 60 обучающих видео).

Подготовка учебно-методических комплексов в системе HelpNDoc.

 

Создание CHM с поиском и индексом / Хабр

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

Формат CHM известен практически всем. Легкий, удобный и функциональный. Работает, правда, официально он только в Windows. У этого формата есть очень большой плюс — после создания такого файла в будущем будет возможность его отредактировать.

Что нам нужно для создания полноценного (с поиском, указателем, содержанием) файла chm?
0. скачанная копия сайта (здесь рассматривать не будем — получить копию сайта можно множеством способов, например, воспользовавшись программами типа Teleport Pro, WebCopier).
1. htm2chm — позволяет удобно создавать файлы содержания и указателя (там есть компилятор, но без поиска)
2. Microsoft HTML Help WorkShop — сам компилятор, которым будем создавать chm-ки.

После установки htm2chm делаем интеграцию с оболочкой.

Далее пользуясь контекстным меня создаем файлы указателя (TOC.hhc) и содержание (Index.hhk).

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

Теперь нам осталось только создать файл проекта и откомпилировать проект в HTML Help WorkShop.

Опытным путем я создал несколько шаблонов для проектов.
1. Шаблон с содержанием и избранным, без указателя (кодировка — Win1251):

[OPTIONS]
Compatibility=1.1 or later
Compiled file=Project.chm
Contents file=TOC.hhc
Default Window=ProjectType
Default topic=Index.htm
Display compile progress=No
Full-text search=Yes
Language=0x419 Русский

[WINDOWS]
ProjectType="???",«TOC.hhc»,,«Index.htm»,«Index.htm»,,,,,0x63520,,0x184e,,,,,,,,0

[FILES]
Sample.hhp

[INFOTYPES]

здесь:
Project.chm — имя файла на выходе.
Index.htm — начальная/домашняя страница для файла помощи

Все необходимые файлы для компиляции подхватятся из файла содержания (TOC.hhc).

2. Шаблон с содержанием и указателем, а также кнопкой изменения шрифта:
[OPTIONS]
Compatibility=1.1 or later
Compiled file=Project.chm
Default Window=WindowType
Default topic=Index.htm
Display compile progress=No
Full-text search=Yes
Language=0x419 Русский

[WINDOWS]
WindowType="???",«TOC.hhc»,«Index.hhk»,«Index.htm»,«Index.htm»,,,,,0x60520,250,0x10184e,[10,10,700,500],,0x200,1,,,,0

[FILES]
Sample_FIT.hhp

[INFOTYPES]

3. Шаблон с содержанием и указателем, а также кнопкой изменения шрифта и доп. кнопкой («About»):
[OPTIONS]
Compatibility=1.1 or later
Compiled file=Project.chm
Default Window=WindowType
Default topic=Index.htm
Display compile progress=No
Full-text search=Yes
Language=0x419 Русский

[WINDOWS]
WindowType="???",«TOC.hhc»,«Index.hhk»,«Index.htm»,«Index.htm»,,,«About.htm»,«About»,0x60520,250,0x18184e,[10,10,700,500],,0x200,1,,,,0

[FILES]
Sample_FITJ2.hhp

[INFOTYPES]

здесь:
About — название кнопки
About.htm — файл, на который ссылается кнопка

Если внимательно посмотреть файл TOC.hhc, то можно заметить, что это обычный xml-файл, в котором идет перечисление параметров, а также настройки отображения файла помощи.
Вот про эти настройки и поговорим.
Можно увидеть примерно вот такие строки:
PARAM name=«Window Styles» value=«0x800627»
PARAM name=«ImageType» value=«Folder»
PARAM name=«ExWindow Styles» value=«0x2200»

Значение для Window Styles имеет 16-ричный формат. Вот расшифровка:
PARAM name=«Window Styles» value=«0xb0daec»
где:
c:
бит 1 — Plus/Minus squares | Квадраты плюса/минуса
бит 2 — Draw lines between items | Рисовать линии между элементами
бит 4 — Start line from the root | Начинать линию из корневого элемента
e:
бит 2 — Show selection when focus lost | Показывать выбор при потере фокуса
Лучше ставить — иначе при комбинации Скрыть/Показать текущий топик показываться не будет.
a:
бит 4 — Only expand a single heading | Разворачивать только одиночный заголовок
Т.е. автоматическое разворачивание заголовков, имеющих разделы, при выборе.
бит 2 — Automatically track selection | Автоматически подчеркивать элемент
бит 1 — Ставит чекбоксы (но зачем?)…
d:
бит 1 — Select entire row | Выделение полной строки (полезная штука)
только если не выбран стиль Draw lines between items
b:
бит 8 — Border | Рамка (имеет смысл только для Dialog Frame)
бит 4 — Dialog Frame | Диалоговая рамка

Итого для 0x800627 имеем:
8 — (Border)
6 — 4+2 (Only expand a single heading, Automatically track selection)
2 — (Show selection when focus lost )
7 — 4+2+1 (Plus/Minus squares, Draw lines between items, Start line from the root)

Дополнительно:
Right-to-left reading order | Порядок чтения справа налево
(чистый бит)
param name=«ExWindow Styles» value=«0x2200»
Raised edge | Рельефный край (разницы вместе с ним не видно)
(чистый бит)
param name=«ExWindow Styles» value=«0x100»
Scroll bar on left side | Полоса прокрутки на левой стороне
(чистый бит)
param name=«ExWindow Styles» value=«0x4200»

PARAM name=«ImageType» value=«Folder»
Если этот параметр указан, то значки представляются в виде файлов.

На этом описание окончано. Для компиляции используем:
"%PROGRAMFILES%\HTML Help Workshop\hhc.exe" <ИМЯ ПРОЕКТА.HHP>

В конце увидим примерно такой отчет:
Compiling ..\bacula_24\Bacula_24.chm

Compile time: 0 minutes, 3 seconds
70 Topics
5,168 Local links
74 Internet links
34 Graphics

PS. Для декомпиляции можно использоваться множество средств, лично я использую примочку для FAR manager — CHMView.

Создание файла CHM средствами HTML Help Workshop |

Поделиться с друзьями

Процесс создания chm значительно облегчает такой инструмент как HTML Help Workshop, разработанный Microsoft. Качаем HTML Help Workshop с сайта Microsoft. Устанавливаем HTML Help Workshop на свой компьютер. Создаем на локальном диске D: папку и называем ее chm. Запускаем HTML Help Workshop, выбираем в контекстном меню «File» -> «New» -> «Project». Откроется окно мастера проекта.

Рис. 1. Первая страница мастера создания справки

Необходимо указать, где будет храниться проект файла chm. Я указал созданную нами папку.

Рис. 2. Окно выбора расположения проекта

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

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

Нажимаем «Готово». У нас получился пустой проект. Теперь нужно подготовить файлы, без которых невозможно создание chm. Главное – это сами страницы, содержащие справку. Для их создания необходимо выбрать в контекстном меню «File» -> «HTML File», в появившемся окне набрать название страницы, которую будем создавать. Я назвал ее «Intro».

Рис. 4. Создание первого файла HTML

После того как вы вбили свое название и нажали «OK», перед вами будет окно, в котором уже есть пустая html страница, если мы сохраним ее в таком виде, то это будет просто пустая html страница c заголовком «Intro». Наберите что-нибудь между тегами <body></body> и сохраните страницу, нажав на изображение дискеты, в папке D:\CHM.

Рис. 5. Редактор HTML страниц

Также создайте еще пару страниц, чтоб можно было немного поэкспериментировать. Я создал страницы «FolderIntro.htm» и «Help In Folder.htm»

Рис. 6. Файлы в папке проекта

Теперь у нас есть 3 файла, которые необходимо скомпилировать в один файл chm. Но для того, чтобы созданный chm был полноценным важно наличие дерева каталогов и страниц справки, хранящихся внутри файла. Это дерево всегда располагается слева от текста справки. Для создания этого дерева нам нужно перейти на вкладку «Contents» в окне HTML Help Workshop. При нажатии на эту вкладку появится вопрос:

Рис. 7. Создание файла контента (в котором хранится древовидная структура справки)

Мы, конечно же, соглашаемся и создаем новый файл контента. Примем то имя файла, которое предложит нам HTML Help Workshop – «Table of Contents.hhc». С левой стороны обращаем внимание на вертикальный ряд кнопок, ими мы будем пользоваться при создании файла контента. Нажмем верхнюю из них – «Contents Properties».

Рис. 8. Окно в котором создается дерево контента

Появится такое вот окошко «Table of Contents Properties», можете в будущем поиграться с настройками стилей и видов, но сейчас мы не будем тут ничего менять, закроем окно. Рассмотрим кнопки немного ниже, чем кнока «Contents Properties», первая (с изображением папки) – создает каталог внутри файла chm, в который можно помещать страницы, вторая (с изображением исписанного листа бумаги) – создает страницу внутри файла chm, третья (карандаш) – редактирует страницу или каталог внутри файла chm, четвертая – удаляет страницу или каталог из списка страниц внутри файла chm. Еще ниже, расположены кнопки, которые позволяют перемещать страницы и каталоги вверх и вниз по списку, также передвигать правее и левее. Предпоследняя кнопка для просмотра HTML кода страницы и последняя, чтоб сохранить всю эту беду.

Итак, давайте приступим к созданию дерева каталогов. Нажмем на кнопку с изображением листика, перед нами появится окно, в котором заполняем поле «Entry title» (у меня набрано Intro). Нажимаем кнопку «Add…», появляется окно «Path or URL», набираем в поле «File or URL» название нашей первой созданной html страницы. Так как страница хранится в той же папке, что и сам проект – D:\CHM, то нет необходимости указывать полный путь к файлу.

Рис. 9. Добавление страницы в таблицу контента

Рис. 10. Добавление страницы в проект

Затем нажимаем «OK» в обоих окошках. Теперь нажимаем на кнопку с изображением папки. Появится окно, которое интересуется вставить ли каталог в начало таблицы контента. Мы согласимся, а потом, если надо, изменим.

Рис. 11. Указание расположения записи в дереве контента

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

Рис. 12. Что-то похожее на дерево контента

Сохраним таблицу контента.

Теперь создадим «Индекс» для файла chm. Для этого перейдем на вкладку «Index» и согласимся создать новый индексный файл «index.hhk». В появившемся окне нажимаем на кнопку с изображением ключа, набираем в поле «Keyword» ключевое слово, при поиске которого по индексу (когда файл справки будет уже создан) будет открываться определенная страница. После того, как указали ключевое слово, также как и при создании таблицы контента, нужно указать файл, который будет соответствовать этому ключевому слову.

Рис. 13. Окно создания индекса

После того как созданы таблица контента, индекс и сами html файлы можно приступить к непосредственно настройке файла chm. Для этого переходим на вкладку «Project», и тут нажимаем на самую верхнюю в вертикальном ряду кнопку. Настраиваем все как на скриншотах.

Рис. 14. Настройка проекта вкладка General

Рис. 15. Настройка проекта вкладка Files

На вкладке «Files» видно, что необходимо указать какие файлы мы используем как Contents file и Index file, а также Full text search stop list file. Первые два файла мы создали ранее, а последний создадим, нажав кнопку «Browse…» и указав имя «search». После этого нажимаем «OK».

Для создания поиска по файлу chm необходимо на вкладке «Compiler» поставить галку «Compile full-text search information».

Теперь жмем на кнопку с изображением папки (вторая сверху), в появившемся окне нажимаем кнопку «Add…», выделяем все html файлы, которые хотим добавить в справку и нажимаем «Открыть». Все файлы будут добавлены в файл справки. Теперь у нас должна быть такая картина.

Рис. 16. Добавления файлов HTML

Остается только скомпилировать файл chm. Нажимаем на самую нижнюю кнопку в вертикальном ряду кнопок.

Рис. 17. Компиляция

Появляется лог, того что проделано. Открываем папку D:\CHM, и видим там готовый файл «MyProject.chm». На этом создание chm завершено.

Файл справки в формате CHM

Любой программист, написавший в жизни хотя бы пару программ, по окончании написания программы задумывался, как организовать справочную систему для своей программы. Написать справку в блокноте - это смешно. Составить справочное руководство при помощи мощного текстового процессора типа MS Word - тоже как-то не очень серьезно.

Самый лучший вариант - это сделать справку в современном формате chm, но нужно обладать определенными знаниями для создания справки в этом формате. Как оказывается, эти знания иметь вовсе и не обязательно. На помошь придет программа HelpNDoc, которую Вы можете скачать прямо с сайта по ссылке Скачать HelpNDoc.

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

Файл справки в формате CHM. Этап №1. Создание проекта

Итак, при первоначальном запуске программа предложит нам три варианта:

New Project - Новый проект
Open Project - Открыть существующий проект
Import... - данная опция позволит импортировать уже скомпилированный файл справки 

Выберем опцию New Project. Откроется окно создания шаблона проекта справки, в котором можно задать имя проекта (Project Title) и язык проекта (Project Language), а также будет отображена таблица первоначального наполнения, которую можно импортировать из уже существующего проекта.

Отредактировав необходимые параметры, жмем кнопку Создать проект (Create Project), после чего будет создан проект по выбранному шаблону. 

 

Файл справки в формате CHM. Этап №2. Задание опций проекта

Далее все делается интуитивно. Щелкнув по первой кнопке Project Options и выбрав вкладку General settings, мы попадем в окно задания опций проекта, в котором можно задать Имя проекта, автора, версию проекта, написать комментарий, добавить строку Copyright, задать топик, который открывается по умолчанию ("топик" - это раздел вашей справки) и т. д.

На вкладке Generation Settings можно задать пути для формирования файлов справок. Кстати, HelpNDoc позволяет создавать справку не только в формате CHM, но и PDF, HTML и Word. 

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

Файл справки в формате CHM. Этап №3. Добавление топиков

Для добавления топиков (разделов справки) служит команда Add topic. Подтопики добавляются командой Add child topic

Менять параметры топиков (иконку топика, Help Context и т.д.) можно через контекстное меню самого топика. 

Файл справки в формате CHM. Этап №4. Форматирование текста

На вкладке Write можно задавать различные параметры форматирования текста как в MS Word. 

Вкладка Insert позволяет добавлять различные объекты в файл справки, например картинки, видео, документы, HTML-код и т.д. При добавлении картинки и щелчке по ней сразу же появляется контекстная вкладка Format, которая позволяет изменить параметры отображения картинки. 

Файл справки в формате CHM. Этап №5. Сохранение проекта

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

Файл справки в формате CHM. Этап №6. Генерация файла справки

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

Совсем забыл. Сгенерировать проект не получится, если у Вас не установлена программа Microsoft HTML Help WorkShop, которую можно скачать в интернете либо прямо с этого сайта по ссылке Скачать MS HTML Help WorkShop.
Ну и напоследок привожу пример файла справки, созданный некогда мной для программы на Delphi Скачать testchop.chm. Удачи.

Понравилась статья? Не очень? Тогда возможно, что вы напишите свою гораздо лучше. Просто перейдите по ссылке Размещение статей и ознакомьтесь с правилами публикации статей на сайте MultiBlog67.RU.

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

Регулярная сборка выходных файлов позволяет контролировать качество справки и исправлять ошибки по горячим следам. Она необходима для любого формата справки, а также для любого вида работ, будь то создание новой документации или редактирование существующей. В этой статье я расскажу, как собрать CHM-файл из проекта в Help and Manual 7.

Что нужно для сборки CHM-файла?

Чтобы собрать CHM-файл, нужно:

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

Без этого собрать CHM-файл не получится.

 

Чтобы это проверить:

  1. В окне программы выберите File \ Program Options.
  2. Перейдите на вкладку Compilers.

 

  1. Если в поле HTML Help Compiler (.CHM): путь к файлу компилятора не указан, справа в данном поле нажмите на кнопку Выбрать и укажите путь к файлу компилятора стандартным для ОС Windows способом. Если программа HTML Help Workshop установлена на вашем компьютере, файл компилятора можно найти по следующему пути:

- C:\Program Files\Help Workshop\hhc.exe (32-битная Windows)
- C:\Program Files (x86)\Help Workshop\hhc.exe (64-битная Windows)

  1. Если программа 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).

При первой сборке в этом поле будет отображаться сообщение No skin selected (Шаблон не выбран). Если вы уже собирали справку с использованием шаблона, здесь будет отображаться использованный шаблон. Чтобы собрать справку с настройками, заданными в проекте (не в шаблоне), откройте список данного поля и внизу выберите команду Remove skin (Удалить шаблон).

6. Задайте дополнительные параметры (при необходимости).

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

7. Нажмите на кнопку Publish Now.

 

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

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

 

Смотрите видеоинструкцию: Сборка CHM-файла в Help and Manual

 

 

 

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

Пользовательская документация для приложений, работающих в ОС Windows, чаще всего поставляется в формате CHM как встроенная в программу справка. Технические писатели, технические переводчики, а также другие специалисты, занимающиеся разработкой и локализацией программного обеспечения, нередко сталкиваются с необходимостью внести изменения в CHM-файл. Если есть исходник, это не представляет особых проблем. Если исходника нет, внесение изменений в CHM — непростая, но решаемая задача. Продолжая тему работы с форматом HTML Help (CHM), я расскажу о том, как отредактировать CHM-файл, если нет исходника.

Кому и когда это может понадобиться

Представьте себе такую ситуацию: выходя на новое место работы, вы получаете задачу обновить пользовательскую документацию. На первый взгляд, все просто и понятно. Но, как известно, дьявол кроется в деталях. На входе есть CHM-файл, рабочие сборки программы, список закрытых программистами задач в Jira или Redmine и дата, например, дата очередного релиза. Исходника (проект, из которого справка была собрана) нет. Связи с автором нет. Времени на создание проекта справки с нуля тоже нет. Как технический писатель я оказывался в подобном положении, и не один раз.

У технических переводчиков также порой возникает необходимость отредактировать CHM-файл. Иногда в переведенном на русский язык файле справки остается несколько абзацев или несколько рисунков с текстом на английском языке. Иногда на языке оригинала выводится текст всплывающих подсказок или название раздела в содержании. И вроде бы перевести пару строк текста – минутное дело. А вот как вставить текст и рисунки в CHM-файл, если все нужно сдать сегодня к концу дня?

Похоже, что тема редактирования CHM стала тем «хорошо забытым старым», что сегодня, зимой 2019 года, является тем «новым». Действительно, обзоры инструментов для работы с форматом CHM, датированные 1990ми-2000ми годами, частично утратили свою актуальность. Часть программ, о которых в них идет речь, уже не существует. Поэтому давайте рассмотрим два основных способа редактирования справки в формате HTML Help (CHM). Первый способ предполагает использование бесплатного программного обеспечения, второй — профессионального платного.

Пример

Разберем оба способа на конкретном примере: возьмем файл api.chm. Это часть справки, встроенной в HTML Help Workshop. После установки данной программы этот файл вы найдете в папке: C:\Windows\Help. Дополним текст в разделе About pop-up WindowsOverview / Window Types) текстом на английском языке. Заменим в разделе About the HTML Help ViewerOverview / Window Types) рисунок на рисунок с переводом, вставим текст на русском языке и переведем название раздела в содержании.

 

Таким образом, на входе есть:

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

 

Задачи:

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

 

На выходе необходимо получить полнофункциональный файл api.chm с описанными выше изменениями.

 

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

 

Часть 2. Редактирование CHM бесплатными программами.

Часть 3. Декомпиляция CHM-файла.

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

Часть 5. Внесение изменений и сборка нового CHM-файла.

Часть 6. Редактирование CHM-файла в Help+Manual 7.

 

Обзор возможностей

HelpNDoc - Создание скомпилированных файлов справки Microsoft HTML (формат CHM)

Поддержите свое приложение Windows с помощью выдающегося файла справки CHM

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

Сочетание клавиш F1 - , широко используемое пользователями Microsoft Windows для запуска файла справки текущего приложения. Это дает конечным пользователям прекрасную возможность самостоятельно изучить и устранить неполадки в своем программном обеспечении. Они не только удовлетворены тем, что нашли подходящий ответ на свою проблему, но и избежали длительной работы с вашей службой поддержки . Вот почему обеспечение стандартного файла справки Windows CHM с вашим программным обеспечением чрезвычайно важно .
К сожалению, большинству разработчиков и технических писателей очень трудно использовать устаревшие инструменты Microsoft для создания файлов справки CHM. Теперь это уже не так: с помощью мощного средства создания справки HelpNDoc вы сможете создавать файлы справки Microsoft Windows CHM очень быстро и легко . До такой степени, что вы, вероятно, скоро «получите удовольствие от документирования» !

Попрощайтесь с Microsoft HTML Help Workshop

Microsoft HTML Help Workshop - официальный редактор и компилятор для создания файлов справки CHM.Но это программное обеспечение не обновлялось Microsoft за год: оно не поддерживает Unicode и содержит множество ошибок и ограничений. К счастью, HelpNDoc инкапсулирует этот устаревший компилятор в простой пользовательский интерфейс, так что вы можете сконцентрироваться на написании наилучшего возможного руководства пользователя .

HelpNDoc предоставляет чистый и эффективный пользовательский интерфейс с помощью редактора WYSIWYG , аналогичного Microsoft Word. Добавьте к этому интуитивно понятное оглавление и редакторы ключевых слов, мощную библиотеку многократно используемых ресурсов, различные вспомогательные инструменты для документации ... все было интегрировано, чтобы помочь вам максимально легко создавать впечатляющие файлы справки .
HelpNDoc по-прежнему использует компилятор Microsoft HTML Help Workshop для создания окончательного файла справки CHM, но вы его даже не увидите. Вам не нужно будет изучать сложный формат кодирования «alias.h», «project.hhp», «toc.hhc» и многих других исходных файлов, необходимых компилятору для создания действительных файлов справки CHM: HelpNDoc будет автоматически создаст их для вас . Он даже поможет обойти различные ошибки компилятора Microsoft HTML Help Workshop, чтобы сделать весь процесс максимально гладким: просто напишите содержимое своей документации, нажмите кнопку «Создать документацию CHM», готово! Ваш файл справки CHM готов для вашего удовольствия.

Легче не значит менее мощный

HelpNDoc предоставляет простые способы значительной настройки сгенерированных файлов справки CHM: путем изменения расширенных настроек CHM или настройки внешнего вида всей документации.

Расширенные настройки справки CHM, такие как видимые кнопки панели инструментов, размер и положение окна справки ... легко доступны из простого пользовательского интерфейса HelpNDoc. И если этого недостаточно, HelpNDoc включает полный исходный код шаблона генерации CHM , так что можно настроить все до того, как оно будет скомпилировано в окончательный файл справки CHM.
Благодаря системе условной генерации HelpNDoc можно даже создать несколько сборок CHM из одного проекта с разным содержанием и настройками. Это отличный способ создания альтернативных файлов справки CHM для различных целей, таких как клиенты, руководство, разработчики…

.

Как создать файл CHM с помощью инструмента создания справки

4.) Запись содержимого и вставка гиперссылок

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

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

Чтобы вставить гиперссылку на другую тему справки в том же файле справки HTML (CHM):

  1. Выберите тему, в которую вы хотите вставить новую гиперссылку.
  2. На вкладке Вставка в группе Ссылки щелкните Гиперссылка.
  3. Введите текст новой гиперссылки и в поле «Контекст темы» выберите тему, на которую вы хотите создать ссылку.
  4. Нажмите ОК.
.

delphi - Как скомпилировать файлы HTML в файл CHM?

Переполнение стека
  1. Около
  2. Продукты
  3. Для команд
  1. Переполнение стека Общественные вопросы и ответы
  2. Переполнение стека для команд Где разработчики и технологи делятся частными знаниями с коллегами
  3. Вакансии Программирование и связанные с ним технические возможности карьерного роста
  4. Талант Нанимайте технических специалистов и создавайте свой бренд работодателя
  5. Реклама Обратитесь к разработчикам и технологам со всего мира
  6. О компании

Загрузка…

.

Как декомпилировать файлы скомпилированной справки HTML (.CHM) и извлечь информацию с помощью Powershell - Статьи TechNet - США (английский)


Скомпилированная HTML-справка Microsoft - это собственный формат интерактивной справки Microsoft, состоящий из набора HTML-страниц, индекса и других средств навигации. Файлы сжимаются и развертываются в двоичном формате с расширением .CHM, что означает скомпилированный HTML. Формат часто используется для документации по программному обеспечению, например, для инструментов Sysinternals.

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

Итак, я заключил команды в функцию Powershell, как показано ниже

001

002

003

004

005

006

007

008

009

010

011

012

013

014

015

016

017

018

019

020

021

022

023

024

025

026

027

028

029

030

031

032

033

034

<#

НАЗНАЧЕНИЕ: Скрипт использует HH.exe для декомпиляции скомпилированного файла справки HTML (.CHM)

АВТОР: Пратик Сингх

БЛОГ: http: \\ Geekeefy.wordpress.com

#>

Функция Get-DecompiledHTMLHelp

{

[cmdletbinding ()]

парам (

[Строка] $ Назначение, [Строка] $ Имя файла

)

$ EXE = 'C: \ Windows \ hh.exe'

Если (-not (Test-Path $ destination))

{

«Целевая папка не существует»

}

elseIf (-not (Test-Path $ Filename))

{

"Мишень.chm файл не найден, убедитесь, что вы вводите полный путь и имя файла "

}

еще

{

Start-Process -FilePath $ EXE -ArgumentList "-decompile $ Назначение $ Имя файла "

$ FilesAndFolder = Get-ChildItem $ Назначение -Recurse | группа psiscontainer

$ FolderCount = ($ Filesandfolder |? {$ _. Name -eq $ true}). Count

$ FileCount = ($ Filesandfolder |? {$ _.name -eq $ False}). count

Write-host "Декомпилирован в папки $ (if ($ Foldercount -gt 0) {$ Foldercount} else {0}) и $ (if ($ FileCount) {$ FileCount} else {0}) Файлы в место назначения $ Место назначения "-ForegroundColor Yellow

}

}

Укажите путь к скомпилированному файлу справки HTML (.CHM) и папке назначения для размещения декомпилированного содержимого, к функции, которая декомпилирует и сохраняет содержимое в целевом месте назначения, как показано на следующем рисунке.

Для извлечения информации из файлов HTML используйте функцию Create-HTMLDomFromFile, чтобы создать структуру DOM для содержимого HTML и вытащить текст, находящийся под определенным HTML, как показано ниже.


.

Как создать файл справки CHM, онлайн-справочную систему или руководство в формате PDF

3. Добавьте темы в содержание

Оглавление (TOC) отражает структуру вашего файла справки или руководства в формате PDF, поэтому в HelpSmith вы можете добавлять элементы различных типов в оглавление, включая темы, элементы заголовков, ссылки на внешние URL-адреса и ссылки на существующие темы в тот же ТОС.

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

Чтобы добавить новый элемент, например заголовок или тему, в оглавление:

  1. На вкладке "Проект" в группе "Темы и шаблоны" нажмите "Добавить".
  2. В диалоговом окне «Новый элемент» на левой боковой панели выберите тип элемента, например тему, заголовок или URL-ссылку, которую вы хотите добавить.
  3. Укажите название элемента и другие параметры в зависимости от выбранного типа элемента.
  4. Нажмите ОК.
.

Хотите создать chm-файл из html-страниц веб-сайта

Переполнение стека
  1. Около
  2. Продукты
  3. Для команд
  1. Переполнение стека Общественные вопросы и ответы
  2. Переполнение стека для команд Где
.

Смотрите также