Лучший способ создать страницы справочника?
Что лучший способ состоит в том, чтобы создать страницы справочника? Я должен записать использование стандартных макросов человека или являюсь там некоторым умным пакетом, доступным теперь, когда берет некоторый источник XML-ified и может произвести страницы справочника, HTML, ASCII, и что нет?
Спасибо
4 ответа
Doxygen - это то, что вы ищете. Имейте в виду, что он предназначен для документирования исходного кода, но вы можете легко адаптировать его.
Он также может генерировать html, pdf и латексную документацию.
Если вы хотите написать один раз и сгенерировать различные выходные форматы, такие как manpages, HTML, plain txt или даже PDF, то docbook должен работать лучше всего.
Я ранее использовал GNU-версию nroff под названием groff для написания страниц руководства.
Хорошая вступительная статья об этом здесь:
В сообществе Tcl обычно используется инструмент doctools , который может создавать ограниченное (но полезное) подмножество формата справочной страницы. , подходит для рендеринга с помощью groff или nroff. Он также может напрямую генерировать как простой текст, так и HTML.