Программа для создания файла справки chm
У вас хороший продукт, но пользователи задают одни и те же вопросы каждый день?
Почта переполнена, и техподдержка не может расслабиться ни на минуту?
Продукт уже вылизан и понятен, но постоянно приходится тратить время на звонки?
Регулярные запросы на онлайн-демонстрации?
Сделайте для своих пользователей удобное руководство всего за несколько дней, а затем годами экономьте до половины рабочего времени тех.поддержки.
Помогите людям самим разобраться в вашем продукте без необходимости обращаться к вам и тратить ваше время, деньги и нервы.
Напишите документацию один раз и опубликуйте ее сразу в нескольких форматах – от файла помощи, встроенного в десктопную программу или мобильное приложение, до онлайн-руководства, интегрированного в сайт продукта или SaaS-сервиса.
Сэкономьте свое время уже на этапе создании документации. Dr.Explain автоматизирует всю рутину: создание и аннотацию скриншотов, импорт старых документов, индексацию контента, настройку визуальных стилей, публикацию на сервере.
СКАЧАТЬ И НАЧАТЬ РАБОТУ
Работайте бесплатно сколько потребуется!
Наверняка, эта история про вас .
Часто документацию пишут не только технические писатели, но и
- программисты-разработчики,
- QA-специалисты,
- инженеры технической поддержки,
- бизнес-аналитики,
- маркетологи,
- продакт-менеджеры,
- руководители отделов разработки
- и даже директора IT-компаний.
Если в проекте вы отвечаете за руководство пользователя и справочную документацию, то Dr.Explain – ваш инструмент.
Мы разработали Dr.Explain для себя и таких же айтишников, кто
- хочет быстро создать руководство пользователя к своей разработке, но не хочет сильно погружаться в эту тему;
- занят, чтобы заниматься установкой сложных CMS-систем;
- не готов тратить десятки тысяч рублей на дорогие техписательские пакеты и учебные курсы по ним;
- понял всю бессмысленость фразы «хелпы никто не читает»;
- устал городить комбайны из MS Word, утилит-конвертеров и вспомогательных инструментов;
- мечтает все делать и хранить в одной программе и не переделывать по несколько раз;
- стремится сосредоточиться на разработке продукта и его продвижении, а не утопать в его постоянной поддержке;
- не хочет еще больше увеличивать затраты на тех.поддержку, внедрение и сопровождение;
- уважает свой продукт и своих клиентов и считает, что в хорошем продукте должна быть хорошая документация.
Почему именно в Dr.Explain быстро,удобно и выгодно делать файл справки или руководство пользователя?
Интегрированная утилита захвата и анализа программных окон и экранов (скриншотов), помогающая быстро создавать технические иллюстрации.
Лаконичный и продуманный до клика интерфейс.
Специализированный текстовый редактор, ориентированный на создание файлов справки и документации для программного обеспечения.
Редактор аннотаций изображений для быстрого создания пояснительных выносок на ваших технических иллюстрациях и скриншотах.
Моментальный предпросмотр результата в печатном и web-форматах.
Создание контекстной помощи для web-систем и десктопных приложений.
Быстрое обновление иллюстраций и скриншотов при выходе новой версии вашего программного продукта.
Адаптивность web-форматов под мобильные устройства.
Создание пользовательской документации из единого источника в различных форматах: файлы справки CHM, web-руководства в формате HTML, DOC, и PDF с оглавлением и ссылками.
Визуальный контроль за состоянием проекта с использованием механизма статусов.
Русскоязычная документация и поддержка от разработчиков. Готовые примеры руководств пользователя.
Стильные настраиваемые шаблоны с современным material-дизайном.
Функции поиска и индексации в on-line справке без программирования и баз данных на стороне сервера.
Специальные рублевые цены и удобство приобретения лицензий у российского юрлица.
СКАЧАТЬ И НАЧАТЬ РАБОТУ
Работайте бесплатно сколько потребуется!
Что вы разрабатываете?
Для этого необходимо создать руководство пользователя.
Желательно - быстро, качественно, недорого
Dr.Explain – как раз для этого.
Для тиражных («коробочных») десктопных B2C и B2B продуктов
Признайтесь, вы сами много раз пользовались кнопкой F1 в программах.
Это же удобно, когда встроенный хелп-файл открывается из любого места программы именно на нужном разделе. Так?
Кстати, удобный захват и автоматические разбор и аннотация скриншотов из окон вашего приложения сэкономят вам часы работы, которые вы потратили бы при описании пользовательского интерфейса в другом решении.
Для SaaS-сервисов и Web-систем
Согласитесь, что создать контекстную онлайн-справку для web-сервиса или портала – задача, порой сравнимая по трудозатратам с разработкой самого сервиса. Если делать ее в лоб и без правильных инструментов, конечно.
С Dr.Explain вы не только быстро напишете саму документацию и опубликуете ее на своем сервере. Используя настраиваемые визуальные шаблоны, вы легко интегрируете онлайн-справку в общий дизайн вашего сайта. А добавив в код сайта вызов лишь одного JavaScript-а и несколько строчек в HTML-разметку, вы получите полноценную контекстную помощь, которая будет показываться в popup-окнах для важных элементов и блоков web-страниц.
Представьте также, что поиск и индекс в такой онлайн-справке работают полностью «из коробки». Никакого программирования или, чего хуже, установки и настройки скриптов и баз данных не требуется. Все работает даже на голых бесплатных хостингах или просто в сетевых папках.
Для мобильных и кросс-платформенных приложений
Уже задумывались, в каком формате поставлять руководство пользователя для мобильного аппа или для кросс-платформеного решения?
PDF, чистый или compiled HTML, ссылка на внешнее онлайн-руководство на сайте или все форматы сразу? Не проблема! Просто экспортируйте свой проект из Dr.Explain в различные форматы документации и используйте их так, как будет удобно вашим пользователям.
Заметьте, все создаваемые в Dr.Explain HTML-based форматы имеют адаптивную верстку и удобны для использования на мобильных устройствах. Ваши пользователи это оценят.
Для внутренних разработок IT-отделов производственных и сервисных компаний, банков, научно-исследовательских организаций
Пишете системы и инструменты не для рынка, а для использования внутри вашей организации? Тут нет жестокой борьбы за лояльность клиентов, но без нормальной пользовательской документации тоже никуда. Ваши бухгалтеры, маркетологи, продажники и производственники задергают вас вопросами. А потом вообще живьем съедят. Будете заниматься только тех.поддержкой.
Наверняка, у вас уже есть хотя бы readme-файл, написанный в MS Word?
Но ваши разработки постоянно эволюционируют, усложняются. База знаний растет, а с ней растет и хаос в документации. Наступает момент, когда readme-файла уже явно недостаточно. Вы хотите без проблем обновлять документацию в одном месте и быстро доставлять ее актуальную версию всем конечным пользователям.
Так используйте Dr.Explain! Импортируйте в него всю существующую документацию из различных источников, а дальше работайте с одним структурированным проектом и публикуйте руководства пользователя в любых форматах по необходимости.
Режим многопользовательской работы над одним проектом вам также в помощь!
Для корпоративных решений и систем для госсектора (B2G)
Ох уж этот «кровавый энтерпрайз». Корпораты и госы требуют на приемке пользовательскую документацию по ГОСТ? Знакомо!
Dr.Explain имеет функцию автоматизированной поддержки ГОСТ 34 и ГОСТ 19. Программа контролирует и автоматизирует поддержку требований этих государственных стандартов в проектах. Экономьте время и нервы. Они вам понадобятся в других задачах.
Кстати, Dr.Explain – включена в "Единый реестр российских программ для электронных вычислительных машин и баз данных (реестр отечественного ПО) Минкомсвязь РФ". Госструктуры и компании с госучастием сами пользуются нашим ПО. Так что, с нами проще!
Истории успеха наших пользователей
Вот лишь некоторые из историй наших пользователей .
Dr.Explain экономит ресурсы отдела техподдержки Бастион Груп
Dr.Explain значительно облегчил пользователям астрологической программы "Вега Матрица" процесс обучения и освоения
Создание наглядной документации в Dr.Explain помогло компании 2V сократить нагрузку на техподдержку: пользователи легко осваивают продукты без помощи операторов
Компания OrangeCat Software давно забыла о создании документации без Dr.Explain как о плохом сне
Коллеги из компаний ниже очень заняты, чтобы писать подробные кейсы.
Поэтому мы просто гордимся тем, что в их проектах им помогает Dr.Explain.
Результаты наших клиентов
Посмотрите, что изменится у вас .
Николай Вальковец 2V Мы значительно сократили время работы техподдержки с новыми клиентами на этапе подключения. Раньше требовалось проводить онлайн презентации и видео конференции для новых клиентов, объясняя особенности программы. Сейчас же, один раз постаравшись максимально подробно всё описать, мы избавили себя и нашу техподдержку от этой работы.
Ольга Михеева ELMA Во-первых, обеспечили быстрое создание и редактирование пользовательской документации по продуктам ELMA, а также публикацию материалов в виде онлайн-справки на сайте. Во-вторых, разгрузили техподдержку.
Олег Гранишевский Софтолоджик Во-первых, продукты обрели определенную цельность. Второе - однотипных вопросов в техподдержку стало поступать меньше. Нам, как разработчикам, стало проще его поддерживать и развивать.
Евгений Бояркин Медиком Нами была создана справочная система, без которой наше ПО не могло бы считаться полноценным продуктом и завоевать лояльность пользователей, которую мы видим сейчас.
Владимир Баранов EasyData При наличии качественной и полной документации смогли продвигать свои разработки и поставлять их на рынок. Пользователи наших программных продуктов довольны. Разработчики документации также довольны инструментом!
Дмитрий Лашхиа Актион-МЦФЭР Раньше вопросов, приходящих через обращения, было очень много. На их решение уходило очень много времени. С помощью Dr.Explain мы сократили число таких вопросов. Теперь пользователи могут самостоятельно изучать созданную нами документацию в разрезе того или иного функционала. Так мы сэкономили время нашей службы поддержки.
Наталья Обухова CRM Expert После изменения подхода к работе с пользовательской документацией техподдержка сидит довольная, потому что клиенты начали читать справку и перестали задавать большинство вопросов.
Михаил Русаков OrangeCat Software Мы забыли о самодельном процессе сборки документации в различных форматах на бесплатных инструментах как о плохом сне. Оба наших продукта являются "живыми" - всё время что-то меняется. Мы даже не можем себе сейчас представить, как поддерживать справку в актуальном состоянии без Dr.Explain!
Уверены, что ваши результаты будут еще интереснее .
СКАЧАТЬ И НАЧАТЬ РАБОТУ
Работайте бесплатно сколько потребуется!
О нашей команде разработки и принципах нашей работы
Dr.Explain – международный проект.
За 15 лет его развития мы узнали о хелп-файлах, руководствах пользователя, инструкциях и мануалах практически все.
Мы сразу разрабатывали Dr.Explain для международного рынка. И только после завоевания успеха у пользователей по всему миру, в 2010 году мы полностью адаптировали проект и для российского рынка.
Мы учли всю отечественную специфику: требования стандартов к разрабатываемой документации, особенности работы отечественных IT-компаний, специфику процессов оплаты и лицензирования, необходимость наличия русскоязычного интерфейса, документации и техподдержки.
Все наши разработчики – специалисты с профильным IT-образованием и многолетним опытом разработки сложных коммерческих продуктов.
Качество нашей работы подтверждено не грамотами, рейтингам или конкурсами. Оно подтверждено самым железобетонным показателем - деньгами наших пользователей.
Русскоязычная техническая поддержка у нас оказывается непосредственно разработчиками. Я лично так же постоянно общаюсь с нашими пользователями.
Любой вопрос будет не просто «очень важен для нас». Он будет решен без бюрократии, максимально быстро и эффективно.
Мы не останавливали работу ни на день даже в период COVID-карантина.
Мы ценим ваше время, ваш бизнес, ваше Дело!
Журавлев Денис
Директор ООО "Индиго Байт"
Руководитель проекта Dr.Explain
Формат 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+Manual 7. Но как показывает практика, примерно в 50% случаев заказчик или работодатель принимает решение в пользу любых бесплатных программ. С бесплатными программами дела обстоят примерно так же, как с ремонтно-строительными работами: все просто, если знать как. Рассмотрим, как отредактировать справку в формате CHM при помощи бесплатных программ HTML Help Workshop и Notepad++.
Редактируя справку в формате HTML Help при помощи бесплатных программ, я придерживаюсь следующего порядка работы, который выработал на практике:
- Подготовка программ и материалов.
(извлечение из CHM редактируемых файлов; подробное описание состава CHM смотрите в материале Формат HTML Help).
(для сборки CHM с аналогичным функционалом).
(с поэтапной проверкой внесенных изменений).
Подготовка программ и материалов
Чтобы отредактировать CHM-справку в рамках поставленных задач, выполните следующие подготовительные мероприятия:
- Скачайте HTML Help Workshop по ссылке и установите с настройками по умолчанию.
- Запустите HTML Help Workshop из меню Пуск. Если установка прошла успешно, должно открыться окно программы следующего вида.
- Скачайте Notepad++ по ссылке и установите с настройками по умолчанию. Для выполнения описанных выше задач подойдет любой бесплатный текстовый редактор, например, Блокнот, Atom и т.п.
- Запустите Notepad++ из меню Пуск. Если установка прошла успешно, должно открыться окно программы следующего вида.
- Подготовьте рисунок, который необходимо вставить в Чтобы вставить текст перевода поверх оригинала, подойдет любой, в том числе бесплатный, графический редактор. Если вы работаете в ОС Windows, можно использовать Paint.
- Подготовьте текст на английском языке.
- Подготовьте переводы.
Отдельно скажу несколько слов о текстах и переводах. Для целей данной статьи можно использовать любой онлайн генератор рыбного текста, например, BlindtextGenerator. Чтобы научиться редактировать CHM, этого будет достаточно. Для не учебного проекта вам потребуется профессионально подготовленный текст, а также перевод, выполненный профессиональным переводчиком. Даже если вы самостоятельно составите текст на русском языке, пользоваться онлайн переводчиками я не рекомендую. В Интернет есть масса обзоров, в которых разбираются ошибки систем машинного перевода. Чтобы получить качественный перевод, лучше воспользоваться услугами профессионалов. Найти квалифицированного переводчика можно на онлайн биржах. Я пользуюсь бесплатным сервисом по подбору переводчиков Переводчик.me. Пробовал и другие бесплатные сервисы, но остановился на этом из-за удобного поиска и доступности ресурса. Аналогичным образом можно найти технического писателя: на биржах удаленной работы и профессиональных форумах.
За рамками целей и задач редактирования CHM, обозначенных выше в материале Как отредактировать CHM-файл, остается простое обновление справки, когда нужно что-то удалить и что-то добавить на языке оригинала. В этом случае порядок работы с бесплатными программами и процесс редактирования будет аналогичный. Здесь я также рекомендую заранее проработать изменения в структуре, написать новые тексты, сделать скриншоты. Дополнительно необходимо обозначить разделы, абзацы, предложения, которые нужно отредактировать, удалить или переместить. Для этого подойдут любые привычные средства, в том числе шариковая ручка и бумажный блокнот. Для работы со структурой рекомендую использовать средства, обеспечивающие максимальную наглядность, чтобы было видно, что было до, и что должно быть после внесения изменений. Из бесплатных программ это в первую очередь FreeMind, из платных — MindManager или EdrawMax. Для работы с текстом рекомендую использовать текстовый редактор с проверкой орфографии.
Разумеется, если вы используете Help+Manual 7, вышеупомянутого многообразия не потребуется. Встроенного визуального редактора будет вполне достаточно для оперативной переработки структуры и контента. Более того, с Help+Manual 7 эту же работу можно выполнить в 2-3 раза быстрее, так как предварительную подготовку материалов делать заранее не нужно. Данному способу редактирования CHM будет посвящена отдельная статья.
Но вернемся к бесплатным программам. После того, как все необходимые материалы были подготовлены, переходим к декомпиляции CHM-файла. Следуйте пошаговым инструкциям, и вы научитесь самостоятельно вносить изменения в CHM-файлы, а также оцените возможности данного метода на практике.
Внесение изменений и сборка нового CHM-файла
Перед тем, как приступить непосредственно к редактированию содержимого CHM-файла, подытожим выполненные заранее подготовительные работы. Определившись с бесплатными программами, которые будут использоваться для редактирования CHM, мы декомпилировали оригинальный CHM-файл. Далее мы создали новый исходник (полученные файлы + файл проекта HTML Help Workshop) и научились собирать обновленный CHM-файл с аналогичным функционалом. Во время редактирования мы будем регулярно выполнять сборку обновленного CHM, чтобы оперативно находить и исправлять ошибки.
Создание и настройка проекта в HTML Help Workshop
Декомпиляция CHM-файла
Файл в формате CHM представляет собой скомпилированный HTML. В него могут входить HTML-страницы, рисунки, таблицы стилей, скрипты и другие файлы. Подробное описание состава CHM смотрите в материале Формат HTML Help. Результирующий файл в формате CHM не редактируется. Отредактировать можно только файлы, входящие в его состав. Извлечь файлы или декомпилировать CHM можно при помощи бесплатной программы HTML Help Workshop.
Редактирование CHM бесплатными программами
Если заказчику или работодателю не принципиально, какое программное обеспечение использовать, я предпочитаю редактировать CHM в Help+Manual 7. Но как показывает практика, примерно в 50% случаев заказчик или работодатель принимает решение в пользу любых бесплатных программ. С бесплатными программами дела обстоят примерно так же, как с ремонтно-строительными работами: все просто, если знать как. Рассмотрим, как отредактировать справку в формате CHM при помощи бесплатных программ HTML Help Workshop и Notepad++.
Как отредактировать CHM-файл
Пользовательская документация для приложений, работающих в ОС Windows, чаще всего поставляется в формате CHM как встроенная в программу справка. Технические писатели, технические переводчики, а также другие специалисты, занимающиеся разработкой и локализацией программного обеспечения, нередко сталкиваются с необходимостью внести изменения в CHM-файл. Если есть исходник, это не представляет особых проблем. Если исходника нет, внесение изменений в CHM — непростая, но решаемая задача. Продолжая тему работы с форматом HTML Help (CHM), я расскажу о том, как отредактировать CHM-файл, если нет исходника.
Установка 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)
Читайте также: