Momonga Linux ドキュメント群には、少々お作法がありますので、 それを以下に述べます。
Momonga Linux に置かれる文書の分量から、文書の ルート要素には article が使われると想定してあります。
docbook-style-xsl スタイルシートパッケージは DocBook の ジェネリックなスタイルシートですので、 ルート要素に article 以外[4]を使っても平気だと思うのですが、 article 以外は試していません。
また、docbook.xsl ドライバで changelog.html
を生成する処理が article に依存しています。誰かかっこよく書いてください。
Momonga Linux ドキュメント群で使用しているスタイルシートのうち
docbook.xsl は、各 <sect1> を
個別の html ファイルを生成して書き出す設定にしてあります。
このときのファイル名は、各 <sect1> の id 属性で
決定されます。たとえば、
<sect1 id="kakikata">
としてあるセクションは kakikata.html で
生成されます。
<sect1>タグに id 属性を設定していないセクションは、
ar01s
という名前で生成されます。article 1 の セクション ?? という
意味です。
??.html
このファイル名では、article の中での section の順番によって 名前が変ってしまうので、外部からリンクを張る必要のあるセクションには id 属性をつけてファイル名を固定してください。
ただし、docbook.xsl スタイルシート中に <revhistory>
の内容からchangelog.html という名前決めうちで
更新履歴の html ファイルを生成する処理が入っていますので、
<sect1> の id 属性に "changelog" をセットするのは避けてください。
また、id 属性に空白を含めることはできないので注意してください。
<sect2> 等につけられるアンカについても同じで、外部からリンクを 張る必要がある場合は id 属性をつけてください。
Momonga Linux ドキュメント群では、よく登場する言葉を実体定義し、 ドキュメント本体にはそれへの参照を書いています。
なんか、よくわからない言葉ですが、 早い話が < みたいな html で良くみられるヤツを定義してつかっているということです。
例えば,
&molong; ドキュメント群では、よく登場する言葉を実体定義し、
みたいな感じでかいています。
このようなことをする理由としては、
&molong; -> Momonga Linux のような実体定義で Momomonga 的な誤字が防止できます。
また &morong; のような存在しない実体への参照は xml パーサが怒ってくれるかもしれません。
&svnsaba; -> svn.momonga-linux.org のような実体定義で Web 用の svn サーバが他のマシンに移ったとき、 定義部分を書きかえるだけですみます。
&dora; -> Shingo Akagaki <dorami@bu.iij4u.or.jp> のような実体定義で打鍵量がおっとろしく減ります。 誤字・脱字防止効果もあります。
rpm の changelog とかはもぅ大変なことに.. 結構自分の名前も正しく打てぬものですね。
すると思ったんですが、たいして役にたたんかったよぅ(T_T
rpm の changelog とかはもぅ大変なことに.. 結構自分の名前も正しく打てぬものですね。
実体定義ファイルは docs/momonga.ent です。
<!ENTITY molong "Momonga Linux">
<!ENTITY moshort "Momonga">
このようなかたちで定義されてますので、適宜追加してください。
ドキュメントの文法が間違っていると、http://www.momonga-linux.org/ にある本体がいつまでたっても更新されなかったり、 Momonga-Docs (予定) としてパケジされる時にエラーが出て OmoiKondara が止まったりします。 そういう事態を避けるために、subversion に commit する前に以下のようにしてローカルでチェックしてから commit しましょう。
$ xmllint --noout --valid Hoge-HOWTO.xml