Программа 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: (Язык проекта) выберите русский язык. Если вы не будете использовать кириллицу, можете оставить предложенный по умолчанию английский язык.
- В области Table of contents: (Оглавление) введите черновое оглавление, например, как показано на рисунке выше. Для обозначения дочерних разделов используйте клавишу Tab. Все оглавление проекта на данном этапе вводить не требуется. Можно оставить оглавление, предложенное по умолчанию, а потом во время работы со структурой проекта переименовать и/или удалить разделы.
- Чтобы импортировать оглавление из существующего проекта, щелкните ссылку Import from existing project... Поддерживается импорт из файлов в формате CHM, HHP, HND.
- Чтобы создать проект с введенным черновым оглавлением, нажмите на кнопку Create project (Создать проект). В результате будет создан проект с черновой структурой.
- Чтобы создать пустой проект без оглавления, нажмите на кнопку Create empty project (Создать пустой проект).
- Сохраните проект. Для этого выберите File \ Save, либо щелкните Save на панели быстрого доступа.
Инструкция по работе с HelpNDoc на русском языке
Если вы пишете документацию на русском языке, дополнительно необходимо:
- выбрать русскую кодировку;
- отключить синхронизацию названий и идентификаторов разделов;
- подключить русские словари для спелл-чекера;
- перевести на русский язык шаблоны выходных документов.
Подробное описание того, как это сделать, смотрите в электронной книге «Разработка документации в HelpNDoc». Пошаговые инструкции, иллюстрации с пояснениями и выносками рассчитаны на обычного пользователя ПК.
Другие материалы о программе HelpNDoc
- HelpNDoc — бесплатная альтернатива Help+Manual
- Добавление разделов в проект HelpNDoc
- Создание CHM-файла в бесплатной программе HelpNDoc
- HelpNDoc – проблемы и способы их решения
