Программа HelpNDoc предназначена для разработки пользовательской документации. В ней используется принцип единого источника. Созданный в HelpNDoc контент можно экспортировать в форматы CHM, WebHelp (HTML5), PDF, DOCX, EPUB, MOBI, MD и Qt. HelpNDoc корректно работает с русским языком. Если скачать и подключить русские словари для проверки правописания, в редакторе будет работать русский спелл-чекер. В этой статье я расскажу, как создать проект в HelpNDoc.
Чтобы создать новый проект:
- В окне HelpNDoc выберите File (Файл) \ New project (Создать проект). Если все проекты в окне HelpNDoc закрыты, аналогичную команду можно выбрать в группе Common Tasks (Основные задачи).
- В окне New project... (Создание проекта) в поле Project title: (Название проекта) введите название проекта, например: "Руководство пользователя HelpNDoc".
- В раскрывающемся списке поля Project language: (Язык проекта) выберите русский язык. Если вы не будете использовать кириллицу, можете оставить предложенный по умолчанию английский язык.
- В нижней части окна New project... нажмите на кнопку Next (Далее).
- В области Table of contents: (Оглавление) введите черновое оглавление, например, как показано на рисунке выше. Для обозначения дочерних разделов используйте клавишу Tab.
- Чтобы создать проект с введенным черновым оглавлением, нажмите на кнопку Create project (Создать проект). В результате будет создан проект с черновой структурой.
- Задайте русскую кодировку для проекта. Для этого:
- На панели Table of contents (Оглавление) выделите верхний узел в структуре оглавления.
- Перейдите на вкладку Language settings (Настройки языка).
- В раскрывающемся списке Project charset (Кодировка проекта) выберите Cyrillic (Кириллица).
- Сохраните проект. Для этого выберите File \ Save, либо щелкните Save на панели быстрого доступа.
Инструкция по работе с HelpNDoc на русском языке
Если вы пишете документацию на русском языке, дополнительно необходимо:
- отключить синхронизацию названий и идентификаторов разделов;
- подключить русские словари для спелл-чекера;
- перевести на русский язык шаблоны выходных документов.
Подробное описание того, как это сделать, смотрите в электронной книге «Разработка документации в HelpNDoc». Пошаговые инструкции, иллюстрации с пояснениями и выносками рассчитаны на обычного пользователя ПК.
Другие материалы о программе HelpNDoc
- HelpNDoc — бесплатная альтернатива Help+Manual
- Добавление разделов в проект HelpNDoc
- Создание CHM-файла в бесплатной программе HelpNDoc
- HelpNDoc – проблемы и способы их решения
Видеоинструкция: создание проекта в бесплатной программе HelpNDoc
