Создание и настройка проекта в HTML Help Workshop
- Главная
- Блог
- Справка
- Создание и настройка проекта в HTML Help Workshop
Установив необходимые бесплатные программы, мы разобрали исходный файл api.chm и получили 64 файла (подробнее смотрите материал Декомпиляция CHM-файла). Это основная часть исходника. Именно эти файлы мы будем редактировать, чтобы обновить CHM. Но для сборки обновленного CHM-файла отредактированных файлов будет недостаточно. Чтобы собрать новый CHM-файл при помощи бесплатной программы HTML Help Workshop, вам также потребуется файл проекта. Поэтому прежде, чем перейти к редактированию, рассмотрим, как создать проект в HTML Help Workshop, и научимся собирать обновленный CHM-файл.
Создание проектаЧтобы создать проект с базовыми настройками:
- Запустите HTML Help Workshop из меню Пуск.
- Выберите File / New.
- В окне New
- Для продолжения нажмите на кнопку Далее. В следующих пунктах описания данный шаг будет опущен.
- В окне New Project — — Destination укажите название проекта и путь к папке, в которой он будет создан: C:\test\decompiled\new_prj.hhp. Можно также нажать на кнопку Browse и указать эти данные стандартным для ОС Windows способом.
- В окне New Project — — Existing Files пометьте все флажки, чтобы добавить в проект извлеченные из CHM файлы.
- В окне New Project — — Table of Contents нажмите Browse и выберите файл C:\test\decompiled\api.hhc.
- В окне New Project — — Index нажмите Browse и выберите файл C:\test\decompiled\api. hhk.
hhk.- В окне New Project — — HTML Files нажмите Add, выберите и добавьте все .htm-файлы из папки decompiled.
- В окне New Project — — Finish нажмите на кнопку Готово.
Будет создан проект для сборки справки. Файл проекта должен быть автоматически сохранен в выбранной папке.
Настройка проекта и тестовая сборка нового CHM-файла
Далее необходимо указать название справки, которое будет отображаться в строке заголовка окна справки, выбрать файл раздела, который будет открываться по умолчанию при запуске справки, а также включить расширенный поиск и избранное.
Указать название справки, раздел по умолчанию и включить простой поиск:- На вкладке Project щелкните Change Project Options.
- В окне Options на вкладке General введите название справки в поле Title. В оригинале это HTML Help API Reference
- В раскрывающемся списке Default file: выберите файл ov_main.htm.
- Чтобы включить простой поиск, перейдите на вкладку Compiler, пометьте флажок Compile full-text search information и нажмите на кнопку ОК. Если сначала не включить простой поиск, это все равно придется сделать после активации расширенного поиска.
Включить расширенный поиск и избранное:
- На вкладке Project щелкните Add/Modify Window Definitions.
- В окне Add a New Window Type введите название для нового типа окна, например, new, и нажмите на кнопку ОК.
- В окне Window Types перейдите на вкладку Navigation Pane.
- В группе Tabs пометьте флажки Search tab, Advanced search, Favorites tab и нажмите на кнопку ОК. Окно Window Types будет закрыто.
- На вкладке Project снова щелкните Change Project Options, перейдите на вкладку Files и в поле Compiled file: проверьте путь к папке и название нового файла справки. Назовем его new_api.chm. В поле Compiled file: должно отображаться c:\test\decompiled\new_api.chm.
- Нажмите на кнопку ОК.
- Выберите File / Save Project. Все должно быть готово к тестовой сборке справки.
Собрать новый CHM-файл
- Выберите File / Compile или на панели инструментов щелкните Compile HTML file.
- В окне Create a compiled file проверьте, чтобы для сборки был выбран файл текущего проекта, и нажмите на кнопку Compile.
- Перейдите в папку decompiled и запустите файл new_api.chm. Должен получиться следующий результат. Панель инструментов будет немного отличаться от оригинала.
Добавить кнопки на панель инструментов:
- В окне HTML Help Workshop на вкладке Project щелкните Add/Modify Window Definitions.
- В окне Window Types перейдите на вкладку Buttons.
- В группе Button Types пометьте флажки напротив тех кнопок, которые должны быть на панели инструментов, и снимите флажки напротив тех кнопок, которые необходимо скрыть.
- Нажмите на кнопку ОК.
- Выберите File / Save Project.
- Пересоберите справку. Должен получиться следующий результат.
Должен получиться следующий результат.Файлы, извлеченные из оригинального CHM, и файл проекта, созданный в HTML Help Workshop, вместе составляют новый исходник. Далее с ним можно работать: вносить изменения, дополнять, сокращать и т.д. этому посвящена следующая статья Внесение изменений и сборка нового CHM-файла.
Поделитесь статьей с друзьями:
- Справка
Добавить комментарий
Рубрики
- Help+Manual
- Справка
- Форматы
- Программы (HAT)
- Полезные советы
- Работа с текстом
- Контроль качества
- Из книг
Илья Жуков
Технический писатель
Последние статьи
HTML Help Workshop – бесплатная программа для создания и редактир
- Главная
- Блог
- Программы (HAT)
- HTML Help Workshop – бесплатная программа для создания и редактирования CHM
В 1997 году Microsoft выпустила новый формат справки, HTML Help (CHM), а также бесплатную программу для создания и редактирования справки в этом формате — HTML Help Workshop.
Последние обновления формата и программы, HTML Help 1.4, вышли в 2002 году. Так как формат-преемник, MS Help 2, не стал публичным, формат HTML Help (CHM) и сегодня остается стандартом справки для платформы Windows.
Основные сведения о HTML Help Workshop
- При помощи HTML Help Workshop можно создать CHM-файл.
- При помощи HTML Help Workshop можно «отредактировать» CHM-файл: декомпилировать CHM-файл, отредактировать файлы, входящие в его состав, а затем снова собрать CHM-файл.
- Файл компилятора hhc.exe, входящий в состав HTML Help Workshop, используется для компиляции CHM-файлов во всех программах разработки справки и пользовательской документации: Help&Manual, HelpSmith, HelpNDoc и др. В RoboHelp файл компилятора интегрирован (Гультяев А.К. Help. Разработка справочных систем: учебный курс. СПб., 2004: 246).
- HTML Help Workshop в большинстве случаев корректно работает с русским языком, но иногда возникают проблемы с кодировкой файлов содержания (файлы с расширением . hhc).
- MS HTML Help Workshop поддерживает Юникод не полностью. Для корректной сборки русского CHM-файла нужно не только задать правильные языковые настройки в проекте (русский язык + шрифт с русской кодировкой), но и выбрать
- Скачать бесплатную программу HTML Help Workshop можно с сайта компании-разработчика.
hhc).
Пошаговые инструкции и дополнительная информация
- Подробное описание формата HTML Help смотрите в статье Формат HTML Help.
- Пошаговую инструкцию по декомпиляции CHM-файлов можно найти в статье Декомпиляция CHM-файла.
- Чтобы отредактировать файлы, извлеченные из CHM во время декомпиляции, а затем собрать CHM-файл снова, необходимо создать проект в программе HTML Help Workshop. Новый проект также потребуется для создания CHM-файла с нуля. Пошаговая инструкция создания проекта в HTML Help Workshop приведена в статье Создание и настройка проекта в HTML Help Workshop.
- Сам процесс редактирования файлов, извлеченных из CHM, а также последующая сборка CHM-файла подробно рассмотрены в статье Внесение изменений и сборка нового CHM-файла.
Поделитесь статьей с друзьями:
- Программы (HAT)
Добавить комментарий
Рубрики
- Help+Manual
- Справка
- Форматы
- Программы (HAT)
- Полезные советы
- Работа с текстом
- Контроль качества
- Из книг
Илья Жуков
Технический писатель
Последние статьи
загрузок Microsoft HTML Help | Microsoft Узнайте
Твиттер LinkedIn Фейсбук Эл.
адрес
- Статья
- 2 минуты на чтение
Все загружаемые файлы справки в формате HTML теперь доступны в Центре загрузки Microsoft.com.
Примечание
Последняя версия технологии справки HTML — 1.4, как и SDK. Последняя версия справки HTML Семинар 1.3. По состоянию на июнь 2009 г. нет HTML Help Workshop 1.4.
HTML Help Workshop
Скачать HTMLHELP.EXE
Японская версия HTML Help Workshop также доступна 9003 HALLMIML HOLD HOLD HOLD DIMINTIONMI
HTMLMLEMLPJ. документация включает следующие файлы.
Руководство по созданию HTML-справки (Htmlhelp.chm)
Показывает, как планировать, создавать и компилировать проекты справки с помощью HTML Help Workshop.
Справка HTML Справка по элементу управления ActiveX (Hhaxref.chm)
Объясняет параметры, команды и методы элемента управления ActiveX справки HTML.
Справочник по API справки HTML (Api.chm)
Охватывает команды, структуры и уведомления для HTML Help API.
Справочник HTML (Htmlref.chm)
Базовый HTML-справочник для авторов справки.
Справка для средства просмотра справки HTML (Viewhlp.chm)
Распространяемый набор разделов, предоставляющих справку для средства просмотра справки HTML. Они могут быть настроены в соответствии с вашими потребностями.
Файл библиотеки HTML Help API (Htmlhelp.lib)
Лицензионное соглашение с конечным пользователем
Лицензионное соглашение с конечным пользователем (EULA) является частью загрузки справки в формате HTML.
Вы можете ознакомиться с соглашением перед загрузкой продукта.
Системные требования
Перед использованием HTML-справки необходимо установить на компьютере Microsoft Internet Explorer (3.0 или выше). Рекомендуется Internet Explorer 4.0 или более поздней версии. Если вы еще этого не сделали, загрузите последнюю версию Internet Explorer. Для получения дополнительной информации посетите https://www.microsoft.com/ie.
Справка в формате HTML требует около 8 МБ свободного места на диске.
Примечания
[!Важно]
Закройте все открытые экземпляры HTML Help Workshop перед переустановкой или обновлением до новой версии. В противном случае элемент управления ActiveX справки HTML может быть зарегистрирован неправильно.
Для установки щелкните правой кнопкой мыши ссылку на нужный файл, выберите «Сохранить объект как» и выберите место на локальном компьютере. После загрузки файла вы можете дважды щелкнуть по нему, чтобы запустить программу установки.
Пользователи Windows XP, 2000, ME и 98 не должны запускать Hhupd.exe. Любые срочные обновления будут обрабатываться с помощью пакетов обновлений или Центра обновления Windows.
- Пользователи Windows XP и 2000 могут получать обновления из Центра обновления Microsoft Windows.
- Пользователи Windows ME могут получать обновления из Центра обновления Windows ME.
- Пользователи Windows 98 могут получать обновления на странице 811630 Security Update.
Пакет установки и обновления справки HTML (любая языковая версия Hhupd.exe) не будет работать в системе Windows NT, если у вас нет прав администратора.
Добавление каких-либо новых функций в HTML-справку не планируется.
Создание пользовательских файлов справки технической поддержки с Microsoft HTML Help Workshop
Как специалист службы поддержки, вы, вероятно, снова и снова получаете одни и те же вопросы от пользователей. Чтобы сэкономить время и усилия, вы, вероятно, создали документы часто задаваемых вопросов, которые рассылаете пользователям по электронной почте.
А поскольку сообщения электронной почты, как правило, теряются или удаляются, вы, вероятно, будете рассылать одни и те же часто задаваемые вопросы снова и снова. Альтернативное решение предполагает использование Microsoft HTML Help Workshop для создания стандартных скомпилированных файлов справки, которые вы размещаете на локальном сервере. Затем вы можете отправлять ярлыки к файлам справки, которые пользователи могут добавлять на свои рабочие столы или в меню «Пуск», где они будут легко доступны.
У этого решения есть два преимущества: во-первых, наличие файла на сервере означает, что если вам когда-нибудь понадобится добавить или изменить информацию, вам нужно будет сделать это только один раз, и обновление будет немедленно доступно для всех в сети. Во-вторых, каждый, кто использует операционную систему Windows, знаком с форматом файла справки и понимает, что файл справки является источником для получения ответов на вопросы. Таким образом, они, естественно, обратятся к нему за информацией в случае необходимости.
Я покажу вам, как получить и использовать HTML Help Workshop, который можно загрузить бесплатно, для создания простых, но эффективных файлов справки, которые вы можете использовать для распространения часто задаваемых вопросов среди пользователей вашей сети.
Загрузка и установка HTML Help Workshop
Чтобы загрузить HTML Help Workshop, откройте в браузере страницу HTML Help Downloads на сайте Центра загрузки Майкрософт. Там вы увидите несколько вариантов загрузки. Если вы используете Windows 9x или Windows NT, вы должны сначала загрузить пакет обновления HTML-справки (Hhupd.exe), который обновит справочную систему HTML до последней версии. Затем вы можете загрузить файл HTML Help Workshop (Htmlhelp.exe). Если вы используете Windows 2000 или Windows XP, вам не нужен пакет обновлений, и вы можете просто загрузить семинар.
Установка HTML Help Workshop очень проста — просто запустите исполняемый файл, чтобы начать процедуру установки, и примите все настройки по умолчанию. Для установки требуется около 4 МБ свободного места на жестком диске.
Организация вашей информации
После того, как вы загрузили и установили HTML Help Workshop, вы готовы приступить к работе. Первым делом нужно организовать вашу информацию. Для этого вам нужно создать свой список часто задаваемых вопросов с помощью текстового процессора, чтобы у вас была свобода легко организовывать свои мысли. Но не беспокойтесь о каком-либо форматировании, так как вам нужно будет сохранить файл в текстовом формате. После того, как вы организовали свой FAQ, вы просто копируете и вставляете содержимое FAQ в HTML Help Workshop.
Предположим, что ваша организация недавно внедрила Windows XP, и вы получаете много вопросов об анимированном персонаже в помощнике по поиску. Люди задают три основных вопроса:
- Как отключить анимированный персонаж?
- Как включить анимированного персонажа?
- Есть ли другие анимированные персонажи на выбор?
Далее предположим, что вы уже создали FAQ, который отвечает на эти вопросы, объясняя шаги, связанные с выполнением каждой из этих операций, и сохранили его в виде текстового документа, который теперь вы хотите преобразовать в файл справки.
Создание файлов тем
Файлы справки HTML начинаются как набор документов, называемых темами. В приведенном выше примере каждый вопрос и ответ в FAQ будут преобразованы в отдельный файл темы. Как только вы запустите HTML Help Workshop, просто нажмите кнопку «Создать» на панели инструментов. Вы увидите диалоговое окно «Создать», в котором вам будет предложено выбрать один из доступных типов файлов. Программа HTML Help Workshop требует, чтобы каждая из ваших тем находилась в HTML-файле, поэтому выберите HTML-файл из списка и нажмите OK.
На этом этапе вы увидите, что в окне появится шаблон HTML-документа с диалоговым окном над ним, предлагающим ввести название темы. В случае примера FAQ фактический вопрос будет служить названием темы. Введите первый вопрос в диалоговом окне «Заголовок HTML», как показано на рис. A .
| Рисунок А |
| При преобразовании часто задаваемых вопросов в файл справки вы можете использовать вопрос в качестве заголовка темы. |
Когда вы нажмете «ОК», вы увидите, что указатель вставки появится в документе после тега
, и вы сможете вставить ответ на вопрос в документ. Чтобы правильно отформатировать документ, вы можете использовать некоторые из основных тегов форматирования HTML. Например, вы можете выделить заголовок ответа жирным шрифтом и разделить шаги тегами абзаца, как показано на Рисунок B .| Рисунок В |
| Вы вставите ответ в тело HTML-файла и при желании сможете применить базовые теги форматирования. |
Если вы не знакомы с тегами форматирования HTML, вы можете найти подробную информацию, раскрыв меню «Справка» и выбрав команду «Справочник по тегам HTML». Когда вы закончите, нажмите кнопку Сохранить, сохраните файл как Q1.htm, а затем закройте окно документа. Повторите эти шаги для каждого вопроса в вашем FAQ, назвав оставшиеся документы Q2. htm, Q3.htm и т. д.
После создания основных HTML-файлов для файла справки вам необходимо создать титульный лист. Эта страница действительно нуждается только в одной описательной строке в теле. В нашем примере я буду использовать фразу Изменить настройки анимированного персонажа в Search Companion, и сохранить файл как T1.htm.
Создание оглавления
Теперь, когда вы создали файлы разделов для каждого из вопросов FAQ и титульной страницы, вы создадите оглавление для своего файла справки. Нажмите кнопку «Создать» на панели инструментов, и когда вы увидите диалоговое окно «Создать», выберите «Оглавление» из списка и нажмите «ОК».
В этот момент вы увидите пустой документ в окне и новую вертикальную панель инструментов слева. Нажмите кнопку «Вставить заголовок» на вертикальной панели инструментов. Когда вы увидите диалоговое окно «Запись оглавления», введите «Search Companion» в текстовом поле «Заголовок записи» и нажмите кнопку «Добавить». Когда вы увидите диалоговое окно «Путь или URL-адрес», введите «T1. htm» в текстовом поле «Файл или URL-адрес» и нажмите «ОК». Чтобы продолжить, снова нажмите OK.
Затем нажмите кнопку «Вставить страницу» на вертикальной панели инструментов. Когда вы увидите диалоговое окно с запросом, хотите ли вы вставить запись в начало оглавления, нажмите «Нет». Затем вы снова увидите диалоговое окно «Запись оглавления». На этот раз введите первый вопрос в текстовое поле «Заголовок записи» и нажмите кнопку «Добавить». Когда вы увидите диалоговое окно «Путь или URL-адрес», введите «Q1.htm» в текстовом поле «Файл или URL-адрес» и нажмите «ОК». Затем снова нажмите OK, чтобы продолжить.
Затем вы можете повторить эти шаги, чтобы создать записи на странице для каждого из вопросов в вашем FAQ. Сохраните файл как TechHelp.hhc. На этом этапе оглавление вашего файла справки будет выглядеть примерно так, как показано на Рисунок C .
| Рисунок C |
| После того, как вы создадите записи страниц в оглавлении для каждой темы в вашем FAQ, вы увидите развернутый основной формат файла справки. |
Создание файла проекта
После создания файлов темы и оглавления необходимо создать файл проекта. Файл проекта создается с помощью мастера и будет содержать список всех файлов, которые HTML Help Workshop будет использовать для компиляции файла справки.
Чтобы начать, нажмите кнопку «Создать» на панели инструментов. Когда вы увидите диалоговое окно «Создать», выберите «Проект» из списка и нажмите «ОК». Когда появится мастер создания нового проекта, следуйте инструкциям на экранах, в которых предлагается указать имя проекта и выбрать файлы темы, заголовка и оглавления.
Когда вы закончите работу с мастером, вы увидите содержимое файла проекта, как показано на рис. D .
| Рисунок D |
| Файл проекта содержит список всех файлов, которые HTML Help Workshop использует для процедуры компиляции. |
Компиляция файла справки
Теперь, когда вы создали файл проекта, вы готовы скомпилировать файл справки. Нажмите кнопку «Сохранить все файлы и скомпилировать» на вертикальной панели инструментов, чтобы начать операцию компиляции.
Когда операция компиляции будет завершена, вы увидите в окне отчет, указывающий на успех операции, как показано на Рисунок E . Если в операции компиляции возникнут какие-либо ошибки, вы увидите сообщения об ошибках, описывающие проблемы. На этом вы закончили создание файла справки и можете закрыть Мастерскую справки HTML.
| Рисунок Е |
| Когда операция компиляции будет завершена, вы увидите отчет в окне HTML Help Workshop. |
Проверка файла справки
После создания первого файла справки вы можете получить доступ к папке, содержащей скомпилированный файл справки в формате HTML, и протестировать его. Файл справки будет иметь то же имя, что и файл проекта, но расширение будет CHM. В нашем примере я назвал файл TechHelp, но вы можете легко переименовать файл CHM во что угодно.
Чтобы проверить файл справки, просто дважды щелкните файл CHM. Когда вы это сделаете, вы увидите окно с двумя панелями, в котором названия тем находятся слева, а содержание темы — справа, как показано на рисунке 9.0161 Рисунок F .
| Рисунок F |
| После компиляции файла справки его можно проверить, дважды щелкнув файл CHM. |
Пересмотр вашего файла справки
Если вам когда-нибудь понадобится добавить, отредактировать или удалить информацию из вашего файла справки, вы можете сделать это, запустив HTML Help Workshop, чтобы отредактировать существующие файлы тем или создать новые. Затем вы создадите новый файл оглавления, а также новый файл проекта, а затем перекомпилируете его.
Изучение дополнительных функций HTML Help Workshop
Когда дело доходит до распространения часто задаваемых вопросов среди пользователей в большой сети, вы обнаружите, что создание файлов справки с помощью Microsoft HTML Help Workshop — это простой и эффективный способ донести информацию до ваших пользователей.