J.5. Написание документации #
Для редактирования исходных файлов документации удобнее всего использовать редактор с режимом редактирования XML, особенно если он также поддерживает языки схем XML, в частности синтаксис DocBook.
Заметьте, что по историческим причинам исходные файлы документации имеют расширение .sgml
, хотя сейчас в них используется синтаксис XML. В связи с этим может потребоваться изменить параметры редактора при выборе подходящего режима.
J.5.1. Emacs #
Для редактирования документов XML в Emacs наиболее популярным режимом является nXML. Он позволяет вставлять теги и проверять корректность разметки, а также имеет встроенную поддержку DocBook. Подробную документацию вы можете найти в руководстве nXML.
Рекомендованные параметры для данного режима можно посмотреть в src/tools/editors/emacs.samples
.