Создание chm справки. Русификаторы

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

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

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

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

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

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

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

После того как вы вбили свое название и нажали «OK», перед вами будет окно, в котором уже есть пустая html страница, если мы сохраним ее в таком виде, то это будет просто пустая html страница c заголовком «Intro». Наберите что-нибудь между тегами и сохраните страницу, нажав на изображение дискеты, в папке 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.

Файл справки CHM - это скомпилировнные в единое целое файлы HTML. Начну с того, что если редактировать файл, то сначала нужно его разобрать, а потом его собрать. Для этого нужно скачать бесплатную программу-компилятор MS HTMLHelp WorkShop (3500 KB). Лучше всего не отделываться общими фразами, а сразу описать все в примере.

Начнем. Нужно отредактировать к примеру файл help.chm , создайте папку, например chmhelp , и скопируйте его туда. Запусите MS HTMLHelp WorkShop и выберите меню File - Decompile... . В появившемся окне нажмите первую кнопку Browse... , найдите и укажите вашу папку chmhelp . Нажмите вторую кнопку Browse... , появится еще одно окно, найдите и укажите декомпилируемый файл help.chm . Нажмите ОК и через некоторое время у вас появятся много файлов в формате HTML.

Понятное дело, что без знания HTML-кода такие файлы редактировать тяжело. Для этих целей я написал небольшой патч Mode Edit IE , который из обозревателя Internet Explorer превращает его в редактор HTML. Но не просто превращает его в обычный редактор, а позволяет полностью проследить процесс редактирования, т.е. процесс правки будет полностью визуальный, примерно такой, как если бы вы правили такие файлы в MS Word. Можно тут возразить, а зачем нужно патчить IE, если есть текстовый процессор Word? Могу сказать, что после сохранения HTML-файла в Word, такой файл распухнет до безобразия. Можете поэкспериментировать. А редактирование в Internet Explorer позволяет сохранить код, в котором файл был создан изначально. Патч лишен многих возможностей, но основные операции с текстом и объектами HTML-файла может делать. Можно вставить или изменить гиперссылку, удалить или вставить рисунок. Нет возможности изменить шрифт или назначить фон... Обо всем об этом можно будет узнать из справки, которую можно будет вызвать из меню Сервис - Справка по режиму редактирования. Этот пункт появится в Internet Explorer после пропатчивания. Не буду описывать здесь Mode Edit IE , т.к. статья вообще-то по созданию справок CHM. А для более детального изучения кода HTML рекомендую учебник по HTML Алленовой Натальи , расположенном на ее сайте по адресу http://www.postroika.ru/news2.html

После редактирования файлов HTML, нужно их снова запихать в формат СНМ. После декомпиляции у вас будут файлы с расширением HTM или HTML, или другое расширение, но будет один файл с содержанием, т.е. тот файл, который отвечает за окошко слева главного окна справки, на рисунке ниже отмечен красным.

Его расширение будет СНН , в нашем случае help.chh . Но без файла проекта собрать все же не удастся, поэтому запустите MS HTMLHelp WorkShop, выберите File - New, в появившемся окне выберите Project и нажмите ОК.

Появится окно мастера, нажмите кнопку Next (Далее). На следующей странице (рис. ниже) введите вручную путь к вашей папки и имя без расширения - Next (Далее). На следующей странице мастера никаких галок не ставьте - Next (Далее), и появится последняя страница, на которой нужно нажать кнопку Finish (Готово). В вашей папке chmhelp появится файл с расширением HPP, т.е. help.hhp, а главном окне MS HTMLHelp WorkShop слева, как и в файле справки, этот файл отобразится (на рис. ниже отмечен красным).

Нажмите на панели инструментов MS HTMLHelp WorkShop слева кнопку (Add/Remove topic fies) и в новом окне Topic Files нажмите кнопку Add и найдите начальный файл HTML (обычно такие файлы имеют имя index или default , хотя не исключено и другое имя, в этом вы должны были разобраться при редактировании страниц). В MS HTMLHelp WorkShop перейдите на вкладку Contenst , при этом появится окошко (рис. ниже), в котором нужно установить переключтель в пункт и нажать ОК. Выберите файл help.chh , который тоже откроется в MS HTMLHelp WorkShop на вкладке Contenst .

Здесь нужно будет отредактировать, используя кнопку (Edit Selection), темы справки. Эти темы правятся в окне в поле Entry title (рис. ниже) - ОК. Так нужно поступить с каждой из тем.

После всех этих манипуляций нажмите кнопку (Compile HTML file) и дождитесь компиляции вашего справочного файл help.chm . На разного рода сообщения отвечайте положительно.

Введение

Интернет хорош тем, что он заполнен общедоступными справочными материалами по самым разным областям.
Задача - подать эти справочные материалы в самой удобной для использования форме.

Методы создания справок

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

Каждый, кто имеет некоторое представление о создании html-страниц, сможет быстро создать справку. Для этого достаточно создать страницы справки и оглавление. Оглавление содержит список тем (страниц), к которым можно быстро перейти, используя ссылки. Пример такой справки - данная страница (оглавление расположено на левой стороне страницы).

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

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

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

Для создания раскрывающегося списка применяется код JavaScript. Вы можете освоить JavaScript и создавать код раскрывающихся списков самостоятельно.
Или Вы можете применить специальные программы, способные создавать раскрывающиеся списки в визуальном режиме, например Sothink DHTML Menu , Xara Menu Maker , Easy CSS Menu , HTML TreeView Generator и другие (см. Навигация - Обзор программ ).
В этом случае достаточно вставить созданный спецпрограммой раскрывающийся список на страницу - и оглавление справки практически готово - см. Пример (раскрывающий список создан в бесплатной программе HTML TreeView Generator).

Еще более простой способ создания справок - применить программы, специально для этого предназначенные.
В этом случае даже не нужно знать html, css, javascript - работа во всех спецпрограммах по созданию справок ведется в визуальном режиме, и программа сама создает исходный код.

Некоторые программы позволяют добавлять к справке эффекты, используя jQuery (например - создается справка с временно исчезающим оглавлением, чтобы освободить место на экране компьютера).

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

Форматы справок

Справки могут создаваться в нескольких форматах, из которых наиболее распространены форматы CHM, Web Help и HTML.

CHM (Compiled HTML Help) или HTML Help, или Windows CHM - формат Microsoft.Чаще всего формат используется, чтобы создать справки для программ (так называемые контекстные справки), работающих в системах Windows.
Формат CHM позволяет объединить несколько отдельных файлов в один файл. Справка используется без подключения к Интернету.

Web Help или Browser-based Help - формат справки, которая размещается в Интернете (на сайте). Как уже понятно из названия, для того чтобы можно было пользоваться справкой, нужно подключение к Интернету.

HTML - Справка формата HTML может располагаться на Вашем сайте, и пользователи могут ее рассмотреть через свой браузер. При создании справки использованы фреймовая структура, html, css и нет javascript. Оглавление представляет из себя обычный (не раскрывающийся) список, нет поиска, списка индексированных слов и избранного.
Пример справки формата HTML (для сравнения - эта же справка в формате Web Help)

Также применяются и другие форматы справок - PDF, в формате документов Word, e-Book, JavaHelp и другие.

При необходимости можно преобразовать один формат справки в другой, например преобразовать формат CHM к формату Microsoft Word (или наоборот).

Компиляция (сборка) - объединение отдельных файлов (html, css, javascript) в один файл. Пример скомпилированного файла - .chm.
Декомпиляция - операция, обратная компиляции (разборка единого файла на составляющие его части).

Контекстно-зависимая справка

Контекстно-зависимая справка позволяет пользователям легко переходить к разделам справки, касающимся выполняемых ими операций в той или иной программе.

Для создания контекстно-зависимой справки используются справки формата CHM (для этого нужно, чтобы справка была "прикручена" к программе).
Справка программы обычно вызывается при щелчке по кнопке Help (Справка), которая имеется в большинстве программ, или с помощью клавиши F1. При этом открывается справка программы со всем ее содержимым.

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

Элементы справки

Справка состоит из нескольких элементов:

Содержание справки - набор страниц справки

Оглавление - обеспечивает переход к нужной странице справки
Оглавление также часто называют TOC (table of contents). Оглавление представляет из себя раскрывающийся список и расположено на левой стороне окна справки. Все пункты (под-пункты, страницы) оглавления помечены специальными значками.

Индекс (Index) - список индексированных (ключевых) слов. В список включаются слова (сочетания слов), которые облегчают пользователям справки переход к нужному разделу справки или к разъяснению некоторых слов и терминов. Список индексированных слов создается автором справки.

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

Избранное (Favorites или Bookmark) - Создается пользователем справки. В список избранного пользователь может включить все нужные ему разделы справки.

Примечания :
1. В более широком смысле к программам для создания справок можно отнести также программы, которые способны создавать видео-обучающие материалы (так называемые скринкасты ) - см. Снимки экрана . В данный обзор включены некоторые из программ, подобного рода.
2. Вы можете создать справочник по любой теме, используя специальные программы - Записные книжки . Но такие справки нельзя разместить в Интернете, т.к. они просматриваются в программах-создателях. Поэтому эти справки создаются только для личного пользования.

Файл в формате CHM предназначен для отображения справочной документации. Скомпилированный файл справки в формате HTML (.chm) разработан корпорацией.

Файл справки в формате CHM (Compiled Help Modules) по умолчанию открывается утилитой, встроенной в операционную систему. Для открытия файла в этом формате достаточно два раза кликнуть по файлу CHM мышью, или открыть файл в соответствующей программе, которая имеет справочную информацию в виде файла данного типа, из меню управления приложения.

Чем еще можно открыть файл справки с расширением CHM? С помощью сторонних программ, файл справки CHM можно открыть в программах: 7-Zip, и некоторых других.

Не открывается файл CHM

В некоторых случаях, файл справки с расширением CHM не открывается:

• если файл CHM находится на сетевом диске, то для открытия файла нужно скопировать файл справки на компьютер
• если в имени файла есть кириллица или специальные символы, то нужно переименовать файл, дав файлу имя буквами латинского алфавита

Не отображается содержимое файла CHM

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

На написание этой статьи меня надоумил случай, происшедший со мной. Я писал обзор программы IrfanView. Программа поддерживает русский язык, но файлы для русификации программы, устанавливаются после установки программы. После установки языкового пакета, я запустил файл справки в программе, и увидел, что содержимое CHM файла не отображается.

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

Что делать? На самом деле, я знаю, что следует сделать, так как ранее уже сталкивался с подобной проблемой. Я продумал, что некоторые пользователи также могут столкнуться с таким вариантом запуска документа. Человек надеется получить ответы на свои вопросы, а вместо этого, получает пустое содержание файла справки, отображается только оглавление.

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

После этого откроется окно «Свойства: имя_файла». В нижней части окна вы увидите предупреждение: «Осторожно: этот файл получен с другого компьютера и, возможно, был заблокирован с целью защиты компьютера».

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

Выводы статьи

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