HelpNDoc

О программе

HelpNDoc – это очень надежный представитель класса программ для создания документации. К таким программам предъявляются некоторые обязательные требования:

• Принцип единого источника. Контент в виде текста и медиа верстается один раз и хранится в качестве одного проекта. А экспортируется (публикуется) в разные форматы.
• Поддержка иерархической структуры документации. То есть, разделы, подразделы… с визуализацией иерархии в виде навигационного меню.
• Возможность создания поискового индекса. Это не просто поиск по контексту, а список ключевых слов, каждое из которых привязано к одному или нескольким подразделам даже в том случае, если данное слово в тексте не встречается.
• Наличие текстового редактора с базовыми инструментами форматирования.

Кратко о работе в программе

Структура

Структура документации (содержание) создается и поддерживается в левом блоке Table of contents. Можно создавать разделы и подразделы (в терминологии программы это Topics), менять их расположение, задавать разделам иконки. После экспорта в любой из форматов левое меню будет присутствовать. В некоторых форматах (chm, html) будет также присутствовать вверху последовательная навигация по разделам.

Манипуляции с содержанием можно производить по правой кнопке мыши (затем выбирая нужную операцию) или на закладке Home главного меню.

Редактор

Редактор текста очень похож на вордовский. Никаких трудностей у среднестатистического пользователя вызвать не может. Есть выделение, списки, таблицы, настройка параметров абзаца… Можно прямо в тело страницы вставлять картинки, видео, html-код, бар-код. На слова можно цеплять гиперссылки на другие разделы (страницы), на интернет-адреса, на файлы.

Есть сниппеты – это некоторый текст, который редактор может запомнить навсегда и вставлять его по вашему указанию в разные места документации. Изменение сниппета повлечет изменения во всех его экземплярах.

Есть библиотека. Это какие-то параметры проекта, например, текущая дата, автор или summary, это все картинки, которые присутствуют в документации. Эта библиотека выведена в интерфейсе в отдельный блок и из нее удобно перетаскивать её элементы в любое место любой страницы. Кода какое-то медиа добавляется на страницу документации, то оно автоматически попадает в Library. Есть небольшая тонкость с видео: например, вы добавляете видео по адресу Youtube, и не одно видео на разные страницы. При добавлении будет открываться библиотечная карточка этого видео, в котором есть поле Library Item Name – обязательно его заполняйте оригинальным для каждого видео именем, иначе в Библиотеку будет сохраняться не новое видео, а перезатираться старое.

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

Для каждого топика документации можно назначить вывод или скрытие строки копирайта, а также заголовка, который фигурирует в table of contents. Эта настройка видна на желтом фоне вверху каждого раздела. Также есть удобный селект Topic properties на закладке Home – в нем все возможные настройки текущего топика.

В связи с тем, что экспорт возможен в разные форматы, в HelpNDoc предусмотрены логические вставки того или иного контента при условии выполнения экспорта в те или иные форматы.

Стилизовать текст можно так же как в Ворде. Редактировать стили – тоже. То есть, внизу справа раздела Styles закладки Write нажать на стрелочку для открытия блока стилей, выделить в левом окошечке нужный стиль и нажать ссылку Edit в правом окошечке.

Экспорт/импорт

Экспорт (Generate) вашего проекта возможен в:

CHM (стандарт пользовательской документации для Windows систем),
HTML (читается любым браузером, можно разместить на сайте для просмотра всем желающим),
DOCX (формат текстового процессора MS Word),
PDF (самый распространенный формат электронных документов),
EPUB (очень распространенный формат для электронных книг),
MOBI (формат электронных книг ридеров для Amazon Kindle),
MD (формат языка верстки Markdown, популярного в IT среде),
QT help (формат справки для пользовательской документации).

Стоит заметить, что не все эти форматы возможно реализовать "из коробки". Для форматов CHM, MOBI и QT help, требуется дополнительный софт, присутствующий на ПК пользователя. Легче всего это софт добывается для CHM – если при экспорте HelpNDoc обнаруживает, что нужного софта нет, то он дает ссылку для скачивания и установки этого софта, т.е., вопрос решается за полминуты.

При экспорте в CHM вы можете получить проблему с кодировкой, например, содержание слева будет в кракозябрах. Решается так: Project Options > Language Settings > выставить Project language = Русский (Россия) и Project charset = cyrillic.

Импорт возможен из форматов DOCX, CHM, HTML, EPUB, MD и некоторых еще. PDF нельзя импортировать.

Для экспорта в тот или иной формат можно переназначить стили форматирования. Выше я написал, как редактировать стили для встроенного редактора. Это форматирование пользователь видит во время редактирования. Но можно изменить формат стиля, допустим, для вывода в HTML: на закладке Home нажать верхнюю половинку кнопки [Generate Help], выделить Build html documentation, открыть закладку Styles overrides, в левом окошечке выделить нужный стиль и отметить его галочкой, в правом окошечке нажать ссылку Edit и задать новое форматирование. Заметьте, что новое форматирование будет применяться только в результатах экспорта в HTML.

Через верхнюю половинку кнопки [Generate Help] очень много кастомных настроек можно осуществить на первой закладке Template Settings шаблона Build html documentation. Здесь можно написать свой CSS вариант для разных классов и id блоков, можно отрегулировать панель содержания (задать ее ширину, скрыть верхнее меню, переименовать пункты верхнего меню), задать свои переводы служебных сообщений... Один нюанс – в первой колонке название параметра часто не соответствует действительности! Выход из этого казуса в том, чтобы читать нижнюю подсказку по параметру, которая возникает при выделении строки параметра.

Можно также создать новый шаблон, продублировав существующий – в таком шаблоне будет еще больше настроек.

Скачать, читать, смотреть