Блог технического писателя Ильи Жукова

Создание проекта в бесплатной программе HelpNDoc

Программа HelpNDoc предназначена для разработки пользовательской документации. В ней используется принцип единого источника. Созданный в HelpNDoc контент можно экспортировать в форматы CHM, WebHelp (HTML5), PDF, DOCX, EPUB, MOBI, MD и Qt. HelpNDoc корректно работает с русским языком. Если скачать и подключить русские словари для проверки правописания, в редакторе будет работать русский спелл-чекер. В этой статье я расскажу, как создать проект в HelpNDoc.

 

Чтобы создать новый проект:

  1. В окне HelpNDoc выберите File (Файл) \ New project (Создать проект). Если все проекты в окне HelpNDoc закрыты, аналогичную команду можно выбрать в группе Common Tasks (Основные задачи).

 

команда создания проекта

 

  1. В окне New project... (Создание проекта) в поле Project title: (Название проекта) введите название проекта, например: "Руководство пользователя HelpNDoc".

 

окно создания проекта

 

  1. В раскрывающемся списке поля Project language: (Язык проекта) выберите русский язык. Если вы не будете использовать кириллицу, можете оставить предложенный по умолчанию английский язык.
  2. В нижней части окна New project... нажмите на кнопку Next (Далее).

оглавление проекта

 

  1. В области Table of contents: (Оглавление) введите черновое оглавление, например, как показано на рисунке выше. Для обозначения дочерних разделов используйте клавишу Tab.
  2. Чтобы создать проект с введенным черновым оглавлением, нажмите на кнопку Create project (Создать проект). В результате будет создан проект с черновой структурой.

 

черновая структура нового проекта

 

  1. Задайте русскую кодировку для проекта. Для этого:
    • На панели Table of contents (Оглавление) выделите верхний узел в структуре оглавления.
    • Перейдите на вкладку Language settings (Настройки языка).
    • В раскрывающемся списке Project charset (Кодировка проекта) выберите Cyrillic (Кириллица).

 

  1. Сохраните проект. Для этого выберите File \ Save, либо щелкните Save на панели быстрого доступа.

 

Инструкция по работе с HelpNDoc на русском языке

Если вы пишете документацию на русском языке, дополнительно необходимо:

  • отключить синхронизацию названий и идентификаторов разделов;
  • подключить русские словари для спелл-чекера;
  • перевести на русский язык шаблоны выходных документов.

Подробное описание того, как это сделать, смотрите в электронной книге «Разработка документации в HelpNDoc». Пошаговые инструкции, иллюстрации с пояснениями и выносками рассчитаны на обычного пользователя ПК.

 

Другие материалы о программе HelpNDoc

  1. HelpNDoc — бесплатная альтернатива Help+Manual
  2. Добавление разделов в проект HelpNDoc
  3. Создание CHM-файла в бесплатной программе HelpNDoc
  4. HelpNDoc – проблемы и способы их решения 

 

Видеоинструкция: создание проекта в бесплатной программе HelpNDoc

 

 

Последние статьи

Как вставить тесты в CHM и WebHelp…

Форматы электронной документации CHM, WebHelp и EWriter давно используются для создания и распространения электронных книг и учебников. Разработать такое учебное пособ...

Читать полностью...

Оформление рисунков в Help+Manual при по…

Рисунки в проекте Help and Manual можно единообразно оформить тремя способами. Во-первых, это можно сделать в графическом редакторе, например в Impict. Во-вторых, для ...

Читать полностью...

Подключение таблицы стилей к проекту Hel…

При работе с форматами, основанными на HTML, для оформления контента в документах можно использовать каскадные таблицы стилей, cascading style sheets или CSS. Данная т...

Читать полностью...

Формулы в HTML Help (CHM)

Я по образованию филолог. Специализируюсь на разработке пользовательской документации на английском и русском языках. С формулами в документации сталкиваюсь редко и по...

Читать полностью...

Импорт документов MS Word в Help+Manual…

Часто технический писатель получает исходные данные от аналитиков, разработчиков, тестировщиков, маркетологов и других специалистов в форматах DOC, DOCX и RTF (реже, и...

Читать полностью...

Поиск в WebHelp находит удаленные раздел…

Во время поддержки проекта справки со временем ряд разделов устаревает. Вы исключаете их из сборки, возможно, даже удаляете из проекта. Собираете выходную документацию...

Читать полностью...

Контекстная справка в приложениях Window…

Понятие контекстной или контекстно-зависимой справки (от англ. context-sensitive help) появилось в 1987 году с выходом формата WinHelp. Изначально контекстная справка ...

Читать полностью...

Как поддерживать скриншоты в актуальном …

Рисунки, схемы, скриншоты и другие изображения являются неотъемлемой частью любой пользовательской документации. Один скриншот с выносками может дать начинающему польз...

Читать полностью...

Книга «Разработка технической документац…

Уважаемые коллеги! Если вам нужно быстро освоить разработку документации по ГОСТ, рекомендую обратить внимание на книгу В.А. Глаголева «Разработка технической документ...

Читать полностью...

Перевод выходных документов в Help and M…

Выбрав русский язык и русскую кодировку в настройках проекта Help and Manual, многие авторы после первой сборки удивляются, увидев в выходных документах английские сло...

Читать полностью...

Размер и расположение окна CHM при перво…

Разработчик справки в формате CHM может задать размер и расположение окна, которые будут использоваться при первом запуске CHM-файла. После того, как пользователь пере...

Читать полностью...

Рваные края скриншотов в Help and Manual…

Многие платные редакторы скриншотов, например, SnagIt, FastStone Capture и др., умеют создавать эффект рваных краев. В сети Интернет можно найти множество видеоуроков ...

Читать полностью...
новое в Help and Manual 9

Новое в Help and Manual 9

23 ноября 2022 года компания EC Software к 25-летнему юбилею выпустила 9-ю версию программного комплекса Help and Manual (выходит c 1997 года). Комплект шаблонов Premi...

Читать полностью...

Создание CHM-справки в бесплатной програ…

KEL CHM Creator — это «новая» хорошо забытая программа, выпущенная в 2012 году, предназначенная для создания и декомпиляции CHM-файлов. Программа не требовательна к ре...

Читать полностью...

KEL CHM Creator — бесплатная программа д…

Если вам нужно создать CHM-файл, и вы больше не хотите пользоваться глючной программой HTML Help Workshop, тогда KEL CHM Creator — это ваш вариант. Программа позволяет...

Читать полностью...
ключевые слова

Ключевые слова в Help+Manual…

Предметный указатель — это список ключевых слов (терминов, основных понятий и т.п.), помогающий читателю быстро найти в документе нужную информацию. В печатной докумен...

Читать полностью...

Все о справке и документации для пользователей!

Следить за новыми статьями:

© Илья Жуков, 2019-2024. Охраняется законом об авторском праве.