はじめに
多人数で html を書く場合の規則についてまとめてあります。 そうしないと多人数でドキュメントを書くという作業が大変になりがちです。 また、ユーザ会のドキュメントは、CVS で管理されています。そうすることで だれが、いつ、どの様な理由でどういう変更を加えたかを明確にできるからです。 ちなみに、http://ja.openoffice.org/source/browse/ja/www/からweb でも CVS のいつ、だれが、どういう理由でファイルを変更した、加えたなどを見ることが出来ます。
ディレクトリ構成
トップディレクトリ
/
/stylesheets/ ... スタイルシートはすべてここに入れてください。ファイル名の競合が無いように
あるカテゴリが存在すれば、適切なディレクトリを掘り、
./cathegory ... html を入れる
./cathegory/images ... gif, png など画像
./cathegory/archives ... 他のテンプレート、lzh などで固めたものなどそれ以外の物。
このようにしておくと、作成者側の管理が楽です。
文字のエンコーディングについて
UNICODE(UTF-8)を用いることになっています。SJIS は困ったエンコードなので使えません。 ISO-2022-JP も良いのですが、同じ言葉に違う表現が可能なのでCVSが狂う可能性が あるので使えません。
改行コードについて
改行は LF にすることが原則です。CVS が狂いますので、これは絶対に守ってください。
デザインの統一(テンプレートとスタイルシート)
デザインについては範囲でなるべくあわせてください。
テンプレート集がありますので、これを使ってください。
まだ、出来たばかりなのでこれを周到していないページも多いですが、その際は
ぜひ知らせてください。なるべく対処させていただきます。
あまりにも違う場合は ML で議論したいと思います。
できればフォント/フォントのサイズなどは指定しないでください。
また、スタイルシートはトップディレクトリに全て集約してあります。
html に埋め込んだりしないでください。
また、サブディレクトリには自分のスタイルファイルは置かないようにしてください。
最後に、スタイルシートを用いる際は以下のように
<link rel="stylesheet" href="/stylesheets/basic_sc.css" type="text/css">
絶対パスを用いて指定してください。
ファイル名の拡張子は html
好みの問題で、どうでもいいといえばいいのですが、html にしてください。
いわゆる全角英数字の禁止
いわゆる全角英数字は使わずに、いわゆる半角英数字を使用してください。
他サイト/絶対リンクの禁止
このサイトでは、他のサイトにミラーされてもかまわない設計にしたいので、 コンテンツに対しては、リンク集以外の http://somewhere.org/ の様な他サイトへの リンクを禁止します。しかしながら ja.openoffice.org で実現できない/しづらい ものに関しては、その限りではありません(Cf. Stylesheet, 挙動が ブラウザによって違う)。 また、http://ja.openoffice.org/ 以下の内容に関しても http://ja.openoffice.org/somewhere/some.html のようなリンクを張らないでください。相対リンクを用いてください。
Id tag を入れる
テンプレートには $Id: html_coding.html,v 1.34 2003/12/30 01:44:28 maho Exp $ な感じのものがついているので、 新たに文書を作成する場合は、$Id$ と変更してください。これで CVS の機能として、変更した日時、変更した人が記録されます。 テンプレートを使わない場合は(あまり無いとは思いますが)
<div align=right> $Id$ </div>
を入れてください。
制作者の名前を入れる
ユーザ会では、ライセンスは LGPL/SISSL ですが、OpenOffice.org の方針として 著作者は JCA にサインすることが推奨されています。簡単に説明すると、 StarSuite/StarOffice に取り込む際に、LGPL が適用されているとソース開示という 困難が生じる場合があるからです。それを防ぐための JCA ですが、著作者は全く それによって権利が減るものではありません。ですが、面倒です。 著作者は JCA にサインした場合はそのまま、それ以外の場合は、 暫定的にJCA にサインした物の連名にします。しかし制作者はその名誉を 保持する必要があります。さらに、JCA にサインした後に著作者として著作権を主張出来るために、 例として以下の行を付け足してください。なお、テンプレートを用いる場合が殆どだと思いますが、 その際は該当する場所を書き換えてください。重要な協力者がいれば、書き足してください。
<div id="writers-and-designers> 制作者: 山田太郎、山田花子<br>
デザイナーの作成者の名前を入れる
もし、テンプレートを利用した場合(ほとんどの場合だと思いますが)、 は書き直す必要はありません。他にデザインの協力を得た場合はデザインの欄に追加しましょう。 例えば
<div id="writers-and-designers"> 制作者:山田太郎<br> デザイン:山田花子, 山口太郎 </div>
と書き加えてください。
文法規則
なるべくならば another html lint などを通して頂いて、文法的に妥当な html を 書いてください。どんな環境/ブラウザでも見ることが出来るように工夫しています。