Привет всем подписчикам и просто всем хорошим людям. Сегодня мы с вами рассмотрим локализацию справочной системы. Вообще, справка является очень нужной частью ПО: помогает ознакомить пользователя с основными возможностями программы и найти ответ на свой вопрос, не обращаясь в службу технической поддержки и выполняет другие не менее важные задачи. К примеру, локализация справки для русскоязычных (в данном случае) пользователей для любого софта позволит расширить географию распространения вашего продукта и даст новых покупателей. Немного теории по справке:
1. Справка может быть как оффлайн, так и онлайн. Мы будем рассматривать первый вариант. Во втором обычно это страничка в сети интернет или подобие системы Wiki и перевод для неё необходимо делать непосредственно на сайте справочной системы.
2. Различные варианты по назначению. Например это руководства и инструкции (мы их и рассмотрим), небольшие руководства типа "Быстрый старт" и "С чего начать", а также FAQ (ответы на часто задаваемые вопросы). Последние могут встречаться в руководствах и размещаются обычно в конце справочной системы.
3. Форматы могут быть также разными:
Это может быть RTF или DOC документ. Поправить его можно и в Word, к примеру.
Html документы, которые могут быть расположены и на вашем ПК, а не только в интернете. Обычно это html файлы, CSS и JS. Редактировать также можно редакторами.
PDF известен всем, редактировать его также наверное учить не нужно.
CHM (мы его и будем сегодня использовать) - формат контекстной справки, вызывается по F1. Cостоит из сжатых HTML страниц и иллюстраций.
HXS (MSHC) — форматы справки для Visual Studio. Файлы представляют собой zip-архивы с html файлами и изображениями. Используются в основном для документирования кода.
Расмотрим вариант, что английская версия справки у нас есть и на её основе мы будем делать русскую. В проекте будет использоваться справка для программы Advanced Installer. Данная программа предназначена для создания инсталляторов. В будущем планируется создать серию постов по этой огромной теме.
Русскую локализацию для Advanced Installer уже долгое время делает уважаемый loginvovchyk, но для справки я своими силами и в свободное время локализацию потихоньку делаю, так как активно её использую. Когда закончу полностью - неизвестно пока.
Для локализации мы будем использовать программу Help & Manual 7.2. Вообще данная программа предназначена для создания различных справочных систем, но локализацию в ней сделать также нетрудно.
Итак, запускаем Help & Manual и выбираем "Файл -> Открыть". В выпадающем меню рядом с названием файла выбираете тип файла HTML Help File (*.chm):
Далее выбираем преобразовать и открыть:
Выбираем место сохранения выходного файла. Естественно меняем путь. Лучше создать папку на рабочем столе или в документах заранее, так как при импорте будет создано очень много различных файлов. Просто на рабочий стол лучше не сохранять:
После изменения пути нажимаем "Продолжить с", тем самым проверяем дополнительные параметры импорта (настраивайте как вам нужно) и нажимаете "Импорт":
Операция займёт некоторое время. Ожидаем и после импорта получаем:
Открываем любую тему в оглавлении и делаем перевод, например "Введение":
Редактирование производится так-же, как и в обычном Word. Также можно править код в ручном режиме (вкладка XML):
Ну и обязательно настройте тему в её опциях. Заголовок, ключевые слова и т.п:
Редактирование заголовка темы, отображаемого в дереве, можно сделать в контекстном меню оглавления и выбрать "Редактор заголовка".
Если, к примеру, нам нужно заменить изображение на странице, то выбираем свойства изображения:
Открываем изображение, которое будет заменено:
Программа спросит нас, копировать ли изображение в первую папку -> соглашаемся. Получаем:
Конечно, можно подготовить и отредактировать скриншот заранее. Тут я просто заменил картинку, взятую из русифицированной версии программы. Можно картинки и не менять, но вашим пользователем в будущем будет сложнее разобраться, если интерфейс останется английским, а программа будет на русском. В конце концов и у вас получится красивая справка.
После редактирования разделов сохраните проект:
Для публикации в формате CHM нам потребуется установить программу HTML Help Workshop от Microsoft . После установки пропишите в настройках программы Help & Manual путь к файлу компилятору hhc.exe
После этого возможна публикация вашей справки через меню "Файл -> Опубликовать".
На этом всё на сегодня. Спасибо за внимание. Если что пропустил - прошу комментировать.