バージョンごとのドキュメント一覧

J.5. 文書の起草 #

<title>Documentation Authoring</title>

The documentation sources are most conveniently modified with an editor that has a mode for editing XML, and even more so if it has some awareness of XML schema languages so that it can know about <productname>DocBook</productname> syntax specifically. XMLの編集モードを持つエディタを使えばドキュメントソースの編集が非常に便利になります。 更にそれがXMLスキーマ言語を理解すると更に便利になり、DocBook構文を考慮することができるようになります。

Note that for historical reasons the documentation source files are named with an extension <filename>.sgml</filename> even though they are now XML files. So you might need to adjust your editor configuration to set the correct mode. 歴史的な理由により、今はXMLファイルであるドキュメントのソースファイルは.sgml拡張子を持つファイル名称となっていることに注意してください。 ですから、正しいモードになるようにエディタ設定を調整する必要があるかも知れません。

J.5.1. Emacs #

<productname>nXML Mode</productname>, which ships with <productname>Emacs</productname>, is the most common mode for editing <acronym>XML</acronym> documents with <productname>Emacs</productname>. It will allow you to use <application>Emacs</application> to insert tags and check markup consistency, and it supports <productname>DocBook</productname> out of the box. Check the <ulink url="https://www.gnu.org/software/emacs/manual/html_mono/nxml-mode.html"> nXML manual</ulink> for detailed documentation. Emacsと一緒に提供されるnXML Modeは、EmacsXML文書を編集するためのモードとしてもっとも広く使われています。 このモードではEmacsでタグを挿入してマークアップの一貫性をチェックでき、出荷時の状態でDocBookをサポートします。 詳細なドキュメントは、nXML manualを確認してください。

<filename>src/tools/editors/emacs.samples</filename> contains recommended settings for this mode. src/tools/editors/emacs.samplesにはこのモードで使う推奨設定が含まれています。