mozilla
Your Search Results

    MDN スタイルガイド

    註: この記事は MediaWiki から MindTouch Deki への移行に伴い修正中です。

    以下は、MDC で記事の整形やレイアウトを行うのに私たちの現状での "最良の" 方法を反映した、MDC 特有のガイドです。もちろん時を経るに従って変化しますので、例外を許さないルールではなく強い勧告として受け取ってください。

    これらのガイドラインに反するようなことを行うことが必要になった時には、気楽に考えてください。だれもあなたを非難しません。このガイドラインにできる限り従えばいいのです。

    註: 一般的に、あなたがやりたいことが WYSIWYG エディタを用いて行えない場合、おそらく、そのことをするために別の方法を考えるべきです。WYSIWYG エディタは私たちが薦めることのほとんどをカバーしています。

    もし、ガイドラインについての質問があれば、Eric Shepherd まで連絡するか、irc://irc.mozilla.org の IRC チャンネル #devmo にて聞いてください。もしくは、MDC 日本語版向けの irc://irc.mozilla.gr.jp の IRC チャンネル #mdc-ja もご利用ください。

    また、これらのガイドラインでカバーされていないことを知る必要がある場合は、MindTouch Deki User Manual を読んでみてください。 

    訳注: 翻訳時の作業方法など、日本語版特有の事項については(現時点ではまだ DekiWiki に対応していませんが)MDC 日本語版における翻訳についてのページで説明しています。

    基本

    章、段落、改行

    新しい章を始めるには、適切な見出しレベルをツールバーの Format メニューから選択してください。もし、3 つか 4 つ以上の見出しレベルが必要なら、記事を深くネストしたものにするよりも、複数のページに分割して、それらの記事にリンクするようにすることを考えてみることを推奨します。

    キーボードのエンター(もしくはリターン)キーを押すことで、新しいパラグラフを始めることができます。単に改行を挿入したい場合は、シフトキーを押しながらエンタキーを押すことでそれを行うことができます。

    テキスト整形とスタイル

    必要とするであろうほとんどの整形オプションは編集モードに入ったときに現れるエディタツールバーに用意されています。ツールバーの 2 列目には太字、イタリック、下線、テキストの打ち消しなどのボタンがあります。マウスカーソルをボタンに近づけることで各ボタンの機能を説明するツールチップが表示されます。

    3 列目には追加の整形のオプションがあります。Style メニューでは私たちが頻繁に使ういくつかの定義済スタイルを選択することができます。これらのほとんどは目的が十分に明白です。

    註: "Note" スタイルは重要な註を付記するために用いられ、このように表示されます。
    警告: 同じように、"Warning" スタイルはこのように警告のための囲みを生成します。

    Format メニューには、見出しと "Normal" と "Formatted" スタイルを含んだ、追加の整形オプションがらあります。Normal は普通の本文テキストであり、一方の Formatted は Transformation メニューが利用できるようになります

    Transformation

    Transformation は Formatted テキストに適用するための整形方法の指定を可能にします。例えば、次のコードサンプルで考えてください。

    int foo(char *bar) {   int l = strlen(bar);
      printf("Length of string %s is %d\n", bar, l);
      return l;
    }
    

    これは非常に基本的なコードサンプルであり、見せるには非常にアピール的なものではありません。Formatted フォーマットを利用することで、シンタックスハイライトを適用することができます。その結果は次の通りです。

    int foo(char *bar) {
        int l = strlen(bar);
        printf("Length of string %s is %d\n", bar, l);
        return l;
    }
    

    これはコードを参照することを簡単にします。例えば、サンプルの 3 行目は printf() 標準 C ライブラリ関数を用いているということがすぐにわかります。

    リンクを挿入するには 2 つの方法があります。1 つ目の方法として、2 つの角括弧で囲んでリンクを表現する MediaWiki 記法を使うことができますが、言語コードをリンクに含めることを忘れないでください(例:"en/Article name here")。

    Insert/Edit Link ツールを用いてリンクを挿入することもできます。これはリンクのアドレス(MDC 内部・他サイト)を手打ちするか、リンクしたい記事を探すためにサイト内をブラウジングするかの両方のユーザインタフェースを提供するダイアログを呼び出します。

    リンクエディタはリンクしたいページだけでなく、その方が好ましいならば、同様に、そのページ内の個々の章を簡単に見つけ出す機能【訳注: ページ内リンク】を提供します。また、画像および他のファイルへのリンクを挿入することも簡単です。

    編集に署名する

    自分の編集に署名することができます。3 つのチルダ(~~~)を入力することで、自分のユーザ名ページへのリンクとなっている自分のユーザ名が挿入されます。4 つのチルダ(~~~~)を入力することで、自分のユーザ名とその編集時点での日付と時刻がひと続きで挿入されます。これは ノート (Talk)ページで特に便利です。例:

    Sheppy (3 つのチルダ)

    and

    Sheppy 19 Aug 2008 (4 つのチルダ)

    外部リンク

    外部サイトへのリンクは内部 Wiki ページとまさに同様の方法で行えます。リンクエディタダイアログでリンクのための完全な URL を入力するだけです。例: Visit the Mozilla Project Web サイトを訪れてください

    テキストの本文に URL を埋め込むだけでもリンクになります。: http://www.mozilla.org/.

    また、 Mozilla の Bugzilla データベースへのバグへ簡単にリンクするためのテンプレートも提供しています。:

    バグ 322603
    

    結果は次のようになります。:

    バグ 322603

    タグ

    Wiki の各ページにはタグが付けられるべきです。タグを追加するには、記事の最後にあるタグ一覧の "タグの追加と編集" をクリックするだけです。各記事には適切な多くのタグがあるかもしれません。例えば、AJAX プログラミングにおける JavaScript の使用についての記事には、"JavaScript" と "AJAX" の両方のタグが付くでしょう。

    Wiki マークアップを強制的に無視する

    パーサーによって解釈されない Wiki マークアップという特別な記述を必要とする場合は、次のように "plain" CSS クラスを用いるだけです。:

    <span class="plain">'''この Wiki マークアップは解釈されません'''</span>
    

    '''この Wiki マークアップは解釈されません'''

    その他のリファレンス

    MDC 特有

    外部

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

    Contributors to this page: Kakurady, Shimono, ethertank, Foximer, RxOrca, Victory, Okome, Potappo, TAKA
    最終更新者: ethertank,