KDevelop. Руководство программиста: Руководство по разработке приложений на C++ для K Desktop Environment (KDE) с использованием KDevelop IDE, Version 1.0 | ||
---|---|---|
. | 9. Создание документации с использованием SGML | След. |
При создании проекта KDevelop подкаталог docs/en уже содержит файл index.sgml с документацией на английском языке и уже сгенерированные файлы HTML формата. Они уже включены в проект, и путь для их инсталляции указывает на KDE HTML каталог. Документация уже адаптирована к вашему наименованию проекта, номеру версии и содержит информацию о программисте. Далее, файл index.html включает содержание руководства по использованию программы. Этот файл открывается системой помощи KDE, когда пользователь запрашивает помощь по работе с вашим приложением; в файл включены инструкция по установке, лицензия GPL и информация о copyright.
При разработке документации вы должны только добавить информацию, специфичную для вашего приложения. Помните, что проект KDE требует запуска "Make Doc-Handbook" из меню "Project" после окончания разработки проекта. Файл index.sgml при этом вновь обрабатывается ksgml2html и генерируется выполненная в KDE-стиле HTML документация. Откройте каталог docs/en в RFV и добавьте logotp3.gif в проект через контекстное меню; затем правильно задайте его свойства для инсталляции логотипа в тот же каталог, где будут расположены HTML файлы - $(kde&_;htmldir)/en/&<;ваш&_;проект&>;/logotp3.gif.