htdocsを編集する

htdocsに関する一般事項

• だれがhtdocsを編集できるのか
• htdocsを編集するには何が必要か
• HTMLを有効にする
• NetBSD.org の表記法
• .listファイルとは何者か?
• XML に変換する
• .xml (docbook-website) ファイルの取扱手順
• ファイル名を変更またはファイルを移動する
• 旗リンクの後に empty.gif がくっついているのは、何か理由があるのか?
• XML テンプレートファイル
• ページが web サーバーに反映される方法や時間はどうなっているか?

web サイト全体の構造はどうなっているか?

• 概観
• 各ディレクトリーの役割は?
• 各ファイルの役割は?

特定のエリアへ追加する

• NetBSDを稼働させているサイト のギャラリーを追加する
• NetBSD in action のギャラリーに追加する
• ニュースの項目を追加する
• イベントを追加する
• メーリングリストのページへの追加や編集をする
• 雇用コンサルタント

---

htdocsに関する一般事項

だれがhtdocsを編集できるのか (トップ)

NetBSD CVSツリーに書き込み権限を持つ人であれば、 だれでもチェックアウトや変更ができます。 事実、そうして欲しいのです。 特に開発者が機能やドライバーを追加する時には、 該当するハードウェアやポートのホームページを更新すべきです。 cvs.NetBSD.orgにはNetBSD.orgのログイン名を利用してログインし、 htdocsをチェックアウトしてください。

CVS commit 権限がないユーザーは、 anoncvs で htdocs をチェックアウトして、パッチを www@NetBSD.org までメールで送ってください。 後述の説明も参照してください。

htdocsを編集するには何が必要か (トップ)

HTMLを有効にする (トップ)

変更した後には、 www/weblint や、それよりも良いのは http://validator.w3.org/ のようなHTMLチェッカーで一通りチェックすべきです。 index.htmlへのリンクをはるURLは、最後のindex.htmlを 省くべきです。 weblintをお使いでしたら、~/.weblintrcに以下の記述を 追加するとよいでしょう。

extension Netscape

NetBSD.org の表記法 (トップ)

リンク、 mailto その他の参照においては必ず NetBSD.org と書くようにし、 これ以外の書き方 (Netbsd.org, netbsd.org, ……など) はしないようにしてください。

.listファイルとは何者か? (トップ)

.list ファイルは過去の遺物です!
既存の .list ファイルはすべて XML に変換してください。 詳細はこの節をご覧ください。

XML に変換する (トップ)

全体的な変更が簡単にできるようにするため、現在、 NetBSD の web サイトは XML (docbook-website) に変換中です。 2004-11-15 以降、 XML 以外のファイルを編集する必要があるときは、編集と同時に XML に変換することになっています。 htdocs/scripts/list2xml スクリプトは、通常の .html ファイルの変換のほか、旧来の .list の変換にも役立つでしょう。 ただし、このスクリプトはタグの単純な置換をいくつかするだけであり、 実行後に多くの手作業が必要ですので、どうぞご注意ください。 特に、すべてのタグを適切な順序で閉じることが必要です。

.xml ファイルを生成あるいは変換した際には、各 <table> タグや <sect[1-4]> タグに “id” 属性をつけたことを確認してください。これは、 xsltproc が独自に ID 属性を生成して、 .html ファイルを再生成する度に ID 属性が更新されることがないようにするためです。 また、 “&” は “&” に、 /sys は /usr/src/sys に、 適宜置きかえてください。

ある HTML タグを、等価な XML に変換する方法がわからない場合は、 システムにインストールされている textproc/docbook-website のなかに便利な例があるかもしれません。そしてもちろん、 www@ メーリングリストに遠慮なく助けを求めていただいて結構です。

目次を自動生成する場合は、以下のコードを含めておきます。

<sect1 role="toc">

これを含めておくと、すべての <sect2> に、 その配下の <sect3> がぶら下がった形の目次が生成されます。

ファイルを XML に変換した後は、そのファイルを htdocs/layout.xml ファイルに書き加えて web サイトを再生成することを忘れないでください。 詳細はこの後の項目をご覧ください。

.xml (docbook-website) ファイルの取扱手順 (トップ)

.xml ファイルから .html ファイルを構築するためには、少なくとも textproc/libxslt と textproc/docbook-website をインストールしておく必要があります。これらは meta-pkgs/netbsd-www に含まれています。 meta-pkgs/netbsd-www のバージョンが 1.4 であることを確認してください。

.html ファイルを生成するには、対象のディレクトリーで make を実行するだけです。 .html ファイルに正しい "Generated from" が含まれるようにするため、 必ず、 .xml ファイルを commit した後に .html ファイルを生成してください。

layout.xml にファイルを追加した場合は、 htdocs の最上層で make を実行する必要があります。

ファイル名を変更またはファイルを移動する (トップ)

htdocs 以下でファイルの移動や名称変更をする場合は、以下の手順をとることを 推奨します:

旗リンクの後に empty.gif がくっついているのは、何か理由があるのか? (トップ)

各ページの最後にあるNetBSDの'旗' リンクには以下のものがあります:

このような効果があります:

ひどいやり方ではありますが、きちんと表示してくれます。

XML テンプレートファイル (トップ)

XML を書き始める人のために、htutils/templates 以下にテンプレートファイルをいくつか用意してあります。 内容を書き加える場合は、既存のページと見比べてみてください。

ページが web サーバーに反映される方法や時間はどうなっているか? (トップ)

NetBSD の web ページは CVS の "htdocs" リポジトリーに蓄積されます。 セキュリティー上の理由から、この htdocs リポジトリーは、毎時間ごとに www.NetBSD.org に (rsync を使って) コピーされ、 そのコピーからローカルにチェックアウトされています。 これをおこなうスクリプトは htutils/scripts/update.http にあり、毎時 40 分ごろに実行されます。 htdocs をコミットすると、 それが公開されるまでに最大一時間かかることになります。

ただし、 Gnats データベース (http://www.NetBSD.org/Gnats/) 、 changes/changes*.html や changes/pkg-changes*.html にある pkgsrc とソースの変更点、 changes/rss-*.xml にある RSS ファイルなど、 一部のファイルについては htdocs には含まれず、 web サーバー上の cron ジョブディレクトリーで各種スクリプトを使って生成されています。 これらのスクリプトへアクセスするには、 "htutils/changes/*" をチェックアウトします。

---

web サイト全体の構造はどうなっているか?

概観 (トップ)

各ディレクトリーの役割は? (トップ)

各ファイルの役割は? (トップ)

---

特定のエリアへ追加する

“NetBSDを稼働させているサイト” のギャラリーを追加する (トップ)

htdocs/gallery/addsite.htmlページから送信された NETBSD GALLERY ADDITION 電子メールを受け取った場合は、こうします:

手でhtdocs/gallery/sites.dataを編集し、 makeを実行する方法もあります。

“NetBSD in action” のギャラリーに追加する (トップ)

できれば、スクリーンショットにはそれが NetBSD システムのものであることが簡単にわかるような内容を含めてください。 簡単な方法は、 X 端末で uname -a コマンドの出力を表示しておくことです。

ニュースの項目を追加する (トップ)

ほとんどのニュース項目はhtdocs/changes/index.xmlにあります (.xml ファイルに関する記述をごらんください) 。 特定のポートに影響する変更はhtdocs/ports/*/にあるニュースの章からも リンクをはってください。

重要なコードのニュース項目は src/doc/CHANGES ファイルにも記述すべきです。

せっかちな人向けのお手軽 ``howto'' (ただし、詳細な説明も読んでください):

イベントを追加する (トップ)

メインの index ページには "Upcoming Events" (これからのイベント) というリンクもあります。 このリンクは News entries 同様に自動的に更新されます:

cd .../htdocs/gallery
$EDITOR events.xml
make events.html

cd .../htdocs
make index.html
MSG="Added Event Foo" make commit

メーリングリストのページへの追加や編集をする (トップ)

メーリングリスト ページに載っていないメーリングリストがある場合の手順:

雇用コンサルタント (トップ)

「雇用コンサルタント」ページ (gallery/consultants.html) に項目を追加する場合は、 あらかじめ、相手方の web サイトに私たちのホームページに戻るためのリンクを用意することや、 そのサイトで NetBSD に触れることを、関係者に頼んでおいてください。 もちろん、相手方の URL が生きていてアクセス可能であることも確認する必要があります。