DocBook - это универсальный стандартный формат файлов для написания программной документации.
DocBook - это формат файла XML, и поэтому он уже благословлен Microsoft. Это декларативно, зарабатывая это далее слава.
DocBook позволяет вам определить, какие изображения являются снимками экрана, какие строки слов являются командами и т. Д. Что да, на самом деле означает, что это истинная часть семантической сети.
Из-за этого вы можете использовать выражение XPath для поиска всех снимков экрана, всех команд и так далее. Все достойные IDE поддерживают поиск XPath, как и множество небольших бесплатных утилит.
После того, как вы определили, какая строка поиска XPath возвращает желаемое содержимое, вы можете написать небольшую таблицу стилей XSLT самостоятельно или с помощью кого-то другого. Таблица стилей может собирать информацию и генерировать HTML-список (UL LI), список определений (DL DT, DD) или краткую справочную карту. Что угодно. XPath, XSLT и различные языки * ML очень гибкие.
Прочитайте Из DocBook в интегрированные справочные системы для получения информации о том, как автоматически преобразовать стандартный файл DocBook в фирменный и очень практичный файл справки Microsoft Windows HTML.
Для получения дополнительной информации о самом DocBook посетите http://www.docbook.org/ - и получите бесплатные таблицы стилей XSLT для последней версии, пока вы там.
Файлы DocBook могут автоматически конвертироваться во многие форматы файлов, кроме того, который используется в файлах Microsoft Windows WinHelp. Смотрите сайт docbook.org для деталей. Это длинный список поддерживаемых форматов файлов, поэтому приготовьтесь к приятному сюрпризу!
Если у вас уже есть структурированный текстовый редактор XML, вы можете использовать его. Если вы пишете действительно большой файл интерактивной справки, рассмотрите oXygenXML и / или Open Office Writer. Первый является коммерческим продуктом, а второй - бесплатным программным обеспечением с открытым исходным кодом.
Подробнее об использовании Open Office Writer для создания / редактирования файлов DocBook читайте в Начало работы с DocBook в Open Office .