文書名命名規則

このページの内容は MDN スタイルガイド に統合予定です。統合完了後には自動的にリダイレクトされるようになります。

MDC Wiki 文書の命名規則は比較的容易なものですが、わたしたちが加えた breadcrumb 拡張 の利点を最大限に生かすために、命名規則に従うことは重要です。

文書名を選ぶ時には、MDC 記述者ガイド も参考にしてください。

MDC 日本語版では、MDC 英語版の文書を翻訳した場合における文書の名前は英語版と同じ、つまり Custom Templates はそのまま Custom Templates とするという方針を採用しています。それ以外の、MDC 日本語版独自文書については以下の命名規則に従うか、もしくは作成しようとしている文書が含まれるカテゴリで定められている命名規則に従ってください。なお、日本語版で最初に作成するけれども、英語版にも将来的には翻訳することで作成する予定がある場合には、文書名を同じにする規則が優先されます。以下の命名規則に従った形で、英語版にその文書を作成したときにも問題が起こらないよう選択してください。

 

一般的な規則

大文字・小文字

記事名は、(すべての語を大文字から始める) 先頭文字大文字化規則ではなく (最初の語と固有名詞のみを大文字で始める) sentence style の大文字化規則を使うべきです :

  • : "A new method for creating JavaScript rollovers"
  • : "A New Method for Creating JavaScript Rollovers"
当分の間、これらの大文字化規則は新規記事にのみ適用されるものとなります。MDC にはこれらの規則に従わない多くの記事がありますが、今すぐそれらを修正しないでください。将来のどこかの時点で古いページ名について修正案の作成と修正を行う予定です。-- dria 09:20, 14 March 2006 (PST)

1ページの記事

他で使わないタイトルを持つコンテンツ

もし追加する記事または他のコンテンツが wiki で 1 ページしか必要ないなら、単純に記事の名前をそのままページ名にしてください。

例えば、1 ページの記事の "A new approach to JavaScript rollovers" というページは、単純に A new approach to JavaScript rollovers にできます。 そのコンテンツのタイトルが固有である限り、これは簡単で好ましい方法です。

他で使う可能性のあるタイトルを持つコンテンツ

可能な限り記事名を単純にするために、記事のタイトルは衝突しないようなものにするべきです。不可能なら、タイトルの前にトピック名とコロンを空白なしでつけてください。

例えば、"Optimization" という記事を作成する際に、記事を単純に "Optimizatin" と名づけると wiki 内のさまざまなトピックにおける最適化の記事と衝突します。もし CSS に特化した最適化であれば、他で利用される可能性のないタイトル (例えば CSS optimization) に変更することができます。

もし、二つ以上の記事が同じ "自然な" タイトルを持つ場合、あいまい性解消のページ に記述してください。

可能な限り wiki 内では他で利用する可能性のないタイトルを利用するのが最もいい方法です。

複数ページに渡る記事

もし、追加しようとしている記事が複数ページに渡るとき、下記のページ名規則を利用してください。この規則を利用すれば、breadcrumb 拡張 の利点を活用できます。

注意 : 最初の "Learning JavaScript" ページを付け加えてください。breadcrumb 拡張 の動作のために、コロンで区切られたそれぞれの記事名は誘導ページを分離するために必要です。

それぞれの記事で、誘導のための階層構造を作るのに breadcrumb 拡張 を利用したい場合、ここで述べられているようなコロン区切りのページ名を利用する必要があります。

ドキュメントのタグと貢献者

 最終更新者: ethertank,