技術情報のテンプレート
寄稿 : 大野 圭一 , 2006/05/22
技術情報のテンプレートについて説明します。ここでは書式についてのみ説明していますので、内容については ドキュメント作成ガイドライン を参照してください。
はじめに
サイト内でのページの体裁を統一するためにテンプレートを用意しましたので、技術情報を寄稿する際に使用してください。このテンプレートは ja プロジェクトに限らず使用されている Sample Template に基づいています。寄稿者およびページの概要を記述する部分について変更してありますが、他の部分は同一です。
テンプレート
以下のテンプレートを空のファイル内にコピーすることで技術情報のドキュメントの作成を始めることができます。
上記のテンプレートの内容をコピーしてブラウザから確認することで、記述した内容のチェックができます。
ヘッダー、フッター、左側のメニュー
上記のテンプレートではヘッダーおよびフッターに関する記述はありません。各ページのヘッダー、フッターおよび左側のメニューは自動的に付加されます。ページを記述する際には本文のみ記述します。
寄稿者および日付
寄稿者の氏名と日付は上記のテンプレートにあるように <h1> タグで囲まれたページの見出しの直下に記載してください。「姓 名」で記述するかあるいはログイン ID 等を使用していただいてもかまいません。日付は YYYY/mm/dd の書式でお願いします。このページのページ見出しの直下も参考にしてください。寄稿者名は必須ではありませんので、明記しない場合には「寄稿」で始まる行を削除します。
基本的に mailto を使用したメールアドレスの記載はしていませんが、もしメールアドレスへのリンクを設けたい場合には mailto でリンクを埋め込んで頂いてもかまいません。
<a mailto:"name@domain" >姓 名</a>
ただ、ページ内のアドレス表記を無作為に抽出して広告メールの送信用に収集してしまうソフトもありますので、アドレスを埋め込む際にはご注意ください。
netbeans.org 内には、JavaScript による記述をしているページもあります。実際の記述方法はこのページのソースを参照してください。
テーブルの書式
|
| text | text text |
| text | text text |
|
|
|
| text | text text |
| text | text text |
|
|
|
| header2 | header2 |
| text | text text |
| text | text text |
|
|
3 列形式の書式
Sample Template には、3 列形式の書式についてのテンプレートも説明されていますが、ja プロジェクトの技術情報では使用しません。翻訳の場合には翻訳元の書式に従います。
