4. docs 以外のディレクトリ

docs 以下のディレクトリのコンテンツは DocBook という形式のファイルで書かれていて、 ブラウザから見えるhtmlファイルは DocBook から html に変換して生成しています。

この DocBook 形式のファイルについては5.「docbook 形式のファイル」 で改めて説明しますので、 ここではそれ以外のコンテンツについて説明します。

4.1. アナウンス関係の文書

http://www.momonga-linux.org/ のアナウンス関係の文書とは、Momonga Project が新しいアナウンスを出すたびに更新する必要のあるファイルで、現在は


     announcement.html.en
     announcement.html.ja
     index.html.ja
     index.html.en
     momonga.rdf
    

これだけあります。

これらの文書は、アナウンスの内容 [1] が変れば機械的に生成できるので、 announcement.lang というファイルにアナウンスの情報を一括して書いておき、それから各ファイルを生成する方法で作成されています。

また、各 html ファイルのうち、アナウンスとは直接関係ない部分 [2] は、ファイル名.in という名前でおいてあります。

レイアウトの変更や目次の追加などは .in の方をいじってください。

4.2. announcement.lang

以下に、自動生成の元となる announcement.lang の書式を説明します。

[メモ] ファイル名

日本語のファイル名のみ、announcement.jaではなくて announcement.eucjp になっています。

このファイルは、xml 形式で書かれています。 基本的に、書き換えが必要な部分は <item> 〜 </item> の間だけですので、この部分のみ説明します。

ひとつの item 要素が ひとつのアナウンスにあたりますので、 新しいアナウンスを追加する作業は、新しい item 要素を追加する作業に相当します。

以下、 item 要素内で使用できるタグリストです。

account

このアナウンスを書いた人を識別するためのものです。 http://www.momonga-linux.org/ のアカウント名でもいれておいてください。

key

このアナウンスを識別するためのキー情報です。ファイル内で一意になる文字列を書いてください。

date

このアナウンスが発行された日付です。

title

このアナウンスの内容です。

link

このアナウンスからリンクを張る URL です。省略可能で、省略するとどこにもリンクは張られません。

例として、アナウンスのエントリを一つあげておきます。

     <item>
     <account>dora</account>
     <key>rc2</key>
     <date>2002/01/19</date>
     <title>Momonga Linux 1.0 RC2 公開しました。各 FTP サーバにミラーされるまで、今しばらくお待ちください。</title>
     <link>announcement/1_0_rc2.html.ja</link>
     </item>
    
例のようにアナウンスを追加したら、make を実行してきちんと生成されるか確認し svn commit します。

4.3. アナウンス関係以外の文書

docs 以下の文書およびアナウンス関係の文書以外の文書はすべて普通に書かれたファイルです。

html であっても text であっても、仮に pdf や flash だったとしても、 その文書を普通に作成する手段で作成されたものですので、普通に編集して svn commit してください。

html ファイルを新規に追加する時は、 template.html.{ja,en} の必要な部分を書き換えて作成すると楽です。



[1] 例えば、"Momonga Linux 1.0 公開しました。 各 FTP サーバにミラーされるまで、今しばらくお待ちください。"など。

[2] 例えば、index.html.ja の"目次"以下の内容