Итак, вы создали программное обеспечение, которое собираетесь продать и неплохо на этом заработать. Программа, скомпилирована, отлажена и протестирована. Единственное, чего ей не хватает, - это файла помощи. Ни одно серьезное программное обеспечение не обходится без модуля справочной информации и руководства пользователя. Это придает программе законченный вид и показывает заботу о пользователе. В этом обзоре будет рассмотрена программа Help&Manual от компании , способная генерировать help-файлы самых различных форматов.
Главным преимуществом программы является ее универсальность. С ее помощью можно получить файл справочной информации в любом из наиболее распространенных на сегодняшний день форматов (CHM, HLP, HXS, HTML, PDF, RTF, EXE, XML). Интуитивно понятный интерфейс делает программу простой в освоении. Основной блок программы составляет текстовый редактор, мало отличимый от MS Word как по интерфейсу, так и по количеству возможностей.
Интерфейс программы
Интерфейс состоит из двух областей. Первая – это панель Navigation с древовидной структурой содержания файла. Вторая – редактор страниц.
В дереве задается вся структура файла содержания, так как его будет видеть пользователь. Здесь задаются заголовки папок и страниц. Для каждого элемента дерева можно задать собственную иконку и статус. В зависимости от статуса элемент выделяется своим цветом (желтый - редактируется, голубой - требует доработки, белый - готов), тем самым делая работу по наполнению страниц более наглядной.
Редактор страниц состоит из трех закладок: Topic Options (опции), Page Editor (редактор страницы), XML Source Code (исходник в формате XML).
На первой закладке определяются основные параметры текущей страницы: идентификатор страницы, идентификатор окна, в котором она будет открываться, ключевые слова, якорь по умолчанию, компиляторы, включающие данную страницу в конечный файл.
Вторая закладка – это непосредственно сам редактор, на котором пользователь пишет текст, форматирует его, добавляет таблицы, рисунки, медиафайлы, ссылки, якоря и прочее.
Третья закладка – это исходный текст страницы в формате XML. При желании пользователь имеет возможность редактировать страницу прямо в исходнике или добавлять сюда код, который невозможно ввести с помощью редактора (хотя такое трудно себе представить).
Рассмотрим некоторые важные инструменты редактора.
Якоря
Якорем в программе называется невидимая метка в тексте страницы, к которой будет осуществляться переход по ключевому слову или по гиперссылке. Добавляя якорь, мы указываем для него идентификатор и ключевые слова. Все ключевые слова, указанные как целиком для страниц, так и для якорей, будут выводиться на странице "Указатель (Предметный указатель, Index) сгенерированных файлов помощи". Щелкнув по выбранному ключевому слову, будет осуществлен переход к объекту, на который то ссылается: страницу или якорь.
Гиперссылки
Условия
Если есть необходимость добавить в проект текстовый блок, который должен отображаться только в избранных форматах файлов помощи, то на помощь придет инструмент "Условие".
В параметрах этого инструмента выбираются форматы компилируемых файлов и ставится логическое условие IF, IFNOT или ELSE (если, если не, иначе). После применения этого инструмента выделенный текстовый блок заключается в красные маркеры.
Текстовые переменные
В параметрах проекта можно задать несколько предопределенных параметров, таких как заголовок, автор, копирайт, номер версии и т. д. Эти параметры можно выводить на страницах с помощью текстовых переменных. Кроме предопределенных параметров можно добавлять собственные текстовые параметры, которые также будут доступны в списке переменных.
Комментарии
При написании помощи нередко ее автору требуется вставить на страницу текст, интересный только ему. Эту роль в программе выполняет инструмент "Комментарий". Он вставляет на страницу текстовый блок желтого цвета, который при компиляции файла игнорируется.
Свойства проекта
В окне свойств проекта можно задать основные настройки будущего файла помощи. Все настройки разбиты на девять групп.
В первой группе задаются свойства, не зависящие от формата будущего файла. Это значения текстовых переменных (как предопределенных, так и заданных дополнительно), настройки языка, шрифт по умолчанию, каталоги с картинками, собственное хранилище картинок и прочее.
По умолчанию в программе определено одно окно с идентификатором Main. Пользователь имеет возможность добавлять новые окна и задавать для каждого из них собственные настройки. Все это делается во второй группе настроек. Здесь задаются такие параметры, как наличие у окна заголовка, цвета фона, позиция. Для файлов формата CHM и HLP здесь можно настроить набор кнопок, которые будут доступны в окне файла помощи.
Следующие семь групп содержат индивидуальные настройки для каждого формата файла помощи. Например, параметры страницы для RTF или доступность текста для выделения и копирования в файле eBook(EXE).
Внешние компоненты
Из дополнительных средств Help&Manual хочется обратить внимание на три внешние компоненты, помогающие в написании инструкции.
Первая – это мощный фотограф скриншотов Screen Capture. Данная утилита позволяет делать снимка произвольной области экрана и даже отдельных элементов интерфейса: панелей инструментов, областей ввода и прочего. Более подробно, в качестве самостоятельного приложения, она описана в статье "Фотографируем окна".
Второй инструмент – это редактор шаблонов Print Manual Designer для будущих файлов в формате PDF. Здесь можно задать разметку страниц и с помощью текстовых переменных определить, как будет выводиться исходный текст в будущем файле. Шаблон, созданный в этом редакторе, сохраняется в файле MNL и в свойствах проекта подключается к настройкам формата PDF.
И последнее приложение, на которое следует обратить внимание, - это графический редактор Impict. Это довольно простой (но не примитивный) и удобный графический редактор, достаточный для нужд написания документации. Оперируя небольшим набором графических примитивов, данная утилита позволяет с легкостью создавать схемы, рисунки и диаграммы, а накладываемые эффекты позволяют сделать каждый объект изображения по-своему уникальным. Из объектов, создаваемых редактором, особо хочется выделить объект "Лупа", позволяющий увеличить изображение, на которое он накладывается. Этот инструмент будет очень полезен при работе со скриншотами с большим количеством мелких деталей.
Компиляция файла помощи
Когда текст справки набран, содержание наполнено, ссылки, якоря и изображения расставлены, можно приступить к компиляции конечного файла. В окне компиляции нужно выбрать формат конечного файла, указать его имя и расположение. После чего нажать кнопку "OK". И все! Через несколько секунд готовый файл будет перед вами.
Удобной особенностью режима компиляции является возможность включения в скомпилированный файл опций файлов других форматов. Например, в исходном тексте у вас присутствуют условия, выводящие текстовые блоки только для файлов HLP. Но однажды вам понадобилось собрать файл в формате PDF и включить туда упомянутые текстовые блоки. Для этого вам не понадобится переписывать исходный текст проекта, достаточно в окне компиляции выбрать формат файла PDF и поставить галочку Classic Winhelp (.HLP). Cледует заметить, что для компиляции файлов CHM и HLP понадобятся собственные компиляторы. Если они не установлены в системе, их можно скачать .
Резюме
Без тени сомнения можно заявить, что Help&Manual является лучшим на сегодняшний день генератором файлов помощи. Универсальность, удобство редактора, мощные инструменты, простые и наглядные механизмы структуризации и связи страниц делают его таковым.
Help and Manual - Программа для работы с форматами справки, точнее позволяющая создавать файлы различных help-форматов и хи редактирование. Для удобства их создания в программу встроен WYSIWYG редактор. Все созданные проекты можно сохранить в различных форматах: HTML Help 1.x, Winhelp, Microsoft Help 2.0, Adobe PDF, e-Books, Browser-based help и т.д.. Кроме этого, программа позволяет конвертировать help-файлы из одного формата в другой. Помимо программ для работы с текстовой разметкой в Help & Manual включены утилиты для создания скриншотов и редактирования этих графических файлов.
Новое в версие 5.4.0:
Документация исходного кода с Microsoft Sandcastle
Microsoft Sandcastle
-это инструмент командной строки, для автоматического создания документации для компонентов и проектов Visual Studio. Sandcastle сканируя исходный код создает полностью отформатированную платформу справки из классов и функций.
Обычно, вывод Sandcastle не всгда доступен для редактирования - программа сканирует исходные блоки и комментария и создает завершенную документацию в формате CHM.
Реализация Sandcastle в Help & Manual немного иначе. Сначла происходит импорт проекта Sandcastle и после чего преобразовывается в проект Help & Manual . В последствие чего можно приниматься редактировать это как любой обычный проект Help & Manual , добавляя информацию, изменяя структуру и так далее. Можно также преобразовать к любому из форматов, поддерживаемых Help & Manual : не только CHM, но и PDF, Webhelp и так далее. Вы также получаете другие функции Help & Manual , как авторская разработка команд, условный вывод, мульти-сборка с командной строкой, создание интерфейса и так далее.
Новый разработчик и функции PDF
Help & Manual 5.4
идет с обновленной версией Manual Designer
. Эта программа - инструмент визуальной разметки, разработки шаблонов PDFs и их печтных версий руководства. С этим обновлением улучшено и реализовано много пользовательских запросов.
Новый Manual Designer идет с улучшенными функциями вывода: Теперь, когда перемещаете объекты мышью, редактор автоматически выводит на экран направляющие линии, для более удобного выравнивания объектов. Теперь можно объединить объекты как группы и управлять группой как дним объектом. "Объекты привязки" теперь допускается привязывать для каждой стороны объекта к границам страницы или полям - это дает гибкость разметки, которая автоматически адаптируется, когда изменяется формат бумаги или поле расположения.
Сейчас все объекты могут быть определены как гиперссылки PDF, чтобы сделать их активируемыми по щелчку. Ссылки могут указать на раздел темы, номер страницы руководства PDF, или к внешним файлам или веб-адресу. Точно так же можно, у каждого раздела шаблона PDF может быть своя собственная доступная для редактирования пользовательская запись в оглавлении "Закладок" файла PDF. Это означает, что можно добавить записи Закладок для пользовательских страниц и разделов, которые ранее не были включены, как Индекс или Содержание (TOC стиль печати) разделов.
Незначительные улучшения и исправления ошибок
* Новое диалоговое окно Импорта: Карта разберается из импортируемых документов RTF до существующих стилей.
* TOC Создает сортировку тегов: Создание тегов, выводимых на экран в Оглавлении и в Проводнике Проекта, теперь сортируются в алфавитном порядке.
* Выпадающие переключатели, которые отмечены как "защищенный текст", теперь экспортируются с ключом "translate=false".
* Таблицы в Печати/PDF: Во время печати таблицы имели обыкновение игнорировать свою ширину контента, чтобы включить авто уменьшение размера снимков экрана, которые не соответствовали странице печати.
Новое решение берет другой подход: сначала тестируется, на сколько таблица широка, чем достущено шириной печати и только после уменьшает масштаб, если так нужно. Таблицы, которые соответствуют странице, более не масштабируются.
* Диалоговое окно Ссылок: Новые опции, для копирования заголовоков темы в заголовках ссылок и в полях советов/подсказок. Теперь одним щелчком правой кнопки или сочетанием клавиш для Вставки Гиперссылки.
* Синхронизация проекта: Более усовершенствованные проверки выполнения для неизменных названий тем и заголовков.
* Изменение XML-схемы: Били реализованы некоторая мета теги, дляы сохранения дополнительной информации о разделах.
* Ключевые слова списка раздела теперь автоматически сортируются, при сохранении темы.
* Более быстрый редактор: Были сделаны внутренние улучшения в редакторе разделов, сейчас он выполняет меньше проверок при каждом нажатии клавиш. На современных компьютерах улучшение скорости whenwill, вероятно, только будет примечательным, редактируя через медленную сеть и удаленные соединения.
* Немецкий UI: Отчеты по проекту не работали с выбором одного из текстов состояния темы по умолчанию.
* Редактор горячей точки: Оптический незначительный сбой исправлен, ID темы не всегда выводился на экран правильно, когда горячая точка была вновь открыта для редактирования.
* Webhelp языками с справа налево: В TOC Webhelp были неправильно выровнены по левому краю длинные заголовки более чем в одну строку текста.
* Windows 7: Help & Manual теперь пользуется преимуществом новых возможностей панели задач Windows 7 (отображение процесса на кнопке панели задач)
* PDF: лучшен межстрочный интервал для азиатского текста смешенного с английским текстом, мелкими оптическими цветовыми фонами таблиц, улучшен экспорт объектов OLE
* Справка HTML: улучшен сценарий инициализации разделов, автоматически раскрывающий переключатель, содержащий критерии поиска при использовании функции поиска
* Текстовые переменные могут теперь использоваться вместо простого текста в ID таблицах, переключателях и изображениях
И многое другое...
Название: Help and Manual
Версия: 5.4.0 build 1173
Дата: 04.06.2010
Разработчик: EC Software GmbH
Интерфейс: EN / DE / RU
Рег-Код: Встроенно
Платформа: Windows 7/Vista/XP/2000
Размер: 39,27 Mb
Скачать | Download - Help and Manual
Внимание! Если Вы согласны со всем, что написано выше, нажмите Скачать , что бы загрузить этот файл. Данные материалы собраны в свободном распространении и в сети Интернет, и предназначены только для ознакомления. Все права на программы, фильмы и др. контент, принадлежат их авторам. Администрация сайта не несёт никакой ответственности за дальнейшее использование данных файлов. Если Вы являетесь разработчиком программного обеспечения, представленного на данном ресурсе и считаете, что размещение каких либо файлов, нарушает Ваши авторские права, тогда , и мы удалим ссылки на эти файлы.
Author-it import officially included
Version 7.1 can read and import Author-it project files directly. This makes the transition from Author-It to Help+Manual much easier than before, because the new import feature retains the internal structure of an Author-It project.
Team Foundation Server and Microsoft Sandcastle
We have implemented support for Team Foundation Server 2015 (version control) and for the last Microsoft Sandcastle version 2.7.2. Visual Studio source code documentation with Sandcastle has been made much easier now.
PDF improved
A lot of work went into the updated PDF export. Version 7.1 comes with an updated PDF engine and automatically applies proper widow/orphan control to the text. Dedicated page breaks inside table cells have been implemented and a rare problem with distorted math formulas in PDF has been fixed.
Windows EXE eBooks
Our proprietary eBook format keeps becoming more popular as a replacement for compiled HTML Help files on Windows and we have updated the eBook viewer with several new features. Now you can separate the eBook viewer (the executable) from the data file and use one viewer with multiple data files. This creates a smaller package if you deploy your help in the eBook format. Execution of external files, in particular additional PDF files has been improved.
Miscancellous improvements and fixes
Multiple TOCs: we have implemented separate default topics for each TOC. The default topic can now be specified separately for each TOC by right-clicking on a topic and selecting “Set as default topic”.
PDF: named destinations bug fix, tables always repeated their first row when a page break occurred in a table
Variables are no longer sorted automatically and support multiple selections. The variables dialog window has move buttons to move variables up and down and an additional button to sort them manually.
Impict: minor modifications
Print Manual designer: optical glitches on 150% screen dpi fixed, undo order was mixed up in some cases
Snippets: preview in snippet dialog calculated margins with screen pixels instead of device-independent units, resulting in a somewhat distorted snippet preview
Insert Web Video: when the “custom web content” pointed a local HTML helper file (e.g. a video helper page in the baggage list), the video was automatically considered a “local video” and not custom web content.
HTML Help (.chm) import: extended import options to split header and topic body, the importer now supports the CSS rule “@import url(xxxxx.css);” and parses the additional CSS files.
Version control: Checking out a versionized repository failed (VSS, SVN, TFS). A project was not saved on close, when a topic of a merged project was selected. Visual Source Safe – the manual checkout and checkin where disabled.
Windows eBooks: the configuration page for Windows eBooks includes an option to switch on the debug function.
Windows eBooks: the publish dialog and publish task dialog enable output file extensions <> “.exe”. When the extension is not “.exe”, H&M creates a data package only, without the viewer.
Windows eBooks: the eBook viewer has been updated to support the multi-data-file command line interface and extended hotkeys for runtime zoom.
Word (DOCX) export: wrong indents in bullet lists and wrong numbering fixed, page width calculation did not take the page gutter into account (this could result in oversized graphics not exactly fitting the available space)
Winhelp (.hlp) import: keyword index and TOC were not properly encoded when the source was a Russian Winhelp file.
Possible error in Publishing tasks: it was possible to specify an MNL file as the template for DOCX output, causing an error when the publishing task was executed.
HTML Help (.chm) export: standard CHM skins (black, blue, grey) triggered a Javascrip error when the print function from the toolbar was used to print the complete chapter.
Tables with alternating row colors: when a table with alternating row colors was placed in a snippet and an uneven amount of rows got removed by conditional tags during the export, the alternating row colors were wrong.
Search & replace find result list: copy & print buttons were unintentionally disabled.
Help & Manual - программа для создания справочных руководств в форматах CHM, PDF, RTF и электронных книг в виде исполняемых файлов. Вы являетесь разработчиком и нуждаетесь в приложении, которое поможет вам создавать руководства к вашим программам? Или просто занимаетесь изготовлением различных книг в электронном формате? Help & Manual - это то, что вам нужно. Эта программа позволяет создавать разнообразные руководства с такой же легкостью, как если бы вы создавали их в стандартном текстовом редакторе. Help & Manual имеет встроенные средства редактирования XML, поддерживает вкладки, шаблоны и кодировку Unicode.
Вы можете применять уже готовые скины, использовать текстовые переменные и стили, ставить ссылки на отдельных частях изображений, добавлять к редактируемым разделам закладки и комментарии. Готовые руководства можно сохранять в форматах HTML (с поддержкой JavaScript), CHM, PDF, Word и в виде исполняемых файлов. Кроме того, вы можете распечатывать эти руководства. В программу входит набор дополнительных инструментов, позволяющих создавать скриншоты экрана, редактировать изображения, подсвечивать синтаксис более 50 языков, создавать отчеты по проектам и пользоваться контекстным поиском. Help & Manual поддерживает словари OpenOffice для проверки орфографии. Помимо базовой версии программы, существуют также её серверная и профессиональная версии, позволяющие, помимо всего прочего, сохранять проекты в форматы ePUB и Visual Studio, редактировать HTML скины и работать над проектами сразу нескольким пользователям. Серверная версия Help & Manual может использоваться в локальных сетях.
