この記事は、新しい協力者に既存ページの編集と、新規ページを作成する手順を紹介します。
既存ページの編集
ページを編集するには以下のようにします。
- ページの右上隅付近にある「編集」ボタンをクリックしてください。
- ページが編集インターフェイス付きで読み込み直され、情報を直接追加したり削除したりできます。
- 書いたり編集したりするために、基本機能以外に段落を追加したり、テキストを削除したり、見出しを挿入したりすることができます。
MDN の組み込みエディターの使い方について詳しくは、MDN エディター UI のガイドのエディターの UI 要素を参照してください。
変更のプレビュー
変更がどのように見えるかを確認するには、以下のようにします。
- ページの上端または下端の編集機能の中にある「プレビュー」ボタンをクリックします。
- 新しいウィンドウまたはタブに、編集中のリビジョンを表示するプレビューページが開きます。
- このボタンをクリックするたびに、最新の変更内容でプレビューページが更新されます。
ページをプレビューしても進行状況は保存されませんので、開いている編集タブを閉じないように注意してください。
リビジョンのコメント
変更をプレビューしたら、このリビジョンを保存しましょう。保存する前に、編集ボックスより下にあるリビジョンコメントボックスを探して、他の寄稿者に変更を加えた理由を知らせるコメントを残してください。たとえば、新しいセクションを追加したり、いくつかの単語を変更して用語をより統一させたり、段落を書き換えて言語を明確にしたり、冗長であったため情報を削除したなどです。
目次
記事の「ジャンプ先」の節は、ページの見出しにリンクする自動生成されたリストです。見出しを編集することで、このリンクも編集することができます。「翻訳についての説明」を選択して「目次」ドロップダウンの値を変更することで、目次全体を消したり、リンクの数を減らしたりすることもできます。
タグ
ページの編集セクションの下に、ページの内容と機能を記述するタグを追加または削除できます。 適用するタグの情報については、ページに正しくタグ付けする方法を参照してください。
レビューが必要な場合
専門家、または経験豊富な寄稿者が編集内容を確認する必要がある場合は、技術レビュー (コード、API、技術などの場合)、編集レビュー(散文、文法、コンテンツの場合) を要求することができるので、保存する前に適切なボックスがオンになっていることを確認してください。
添付ファイル
より明確な説明を追加するために、既存のページにファイルを添付したい場合は、ページの下部からアップロードしたいファイルを選択します。画像をアップロードするときは、画像最適化ツールを使用してファイルをできるだけ小さくしてダウンロードしてください。これにより、ページの読み込み時間が短縮され、 MDN の全体的なパフォーマンスが向上します。お手持ちのツールがあれば、それを使用できます。それ以外の場合は、便利なウェブツールである TinyPNG をお勧めします。
公開、破棄、編集の続行
編集作業が終わり、プレビューに満足すれば、ページタイトルかページ最下部の右側にある緑色の「公開」ボタンをクリックして、作業やコメントを保存することができます。そのまま編集を続行したい場合は、「公開して編集を続行」ボタンをクリックするして、編集インターフェイスを開いたまま作業を続けることができます。
気が変わったら、赤い「破棄」ボタンをクリックすると編集内容を破棄できます。なお、変更を破棄すると完全に破棄されます。。
リビジョンコメントボックスでEnterキーを押すと、「公開して編集を続行」ボタンを押した場合と同じ結果になります。
メモ: 保存しようとしたとき、変更が不正であるとして保存できず、内容が MDN にとって適切だと思った場合は、 MDN の管理者チームにメールを送って、助けを求めてください。
ページ作成権限の取得
セキュリティ上の理由から、新しく作成されたアカウントでは、新しいページを作成することができません。ページを作成しようとすると、ページを作成するための手引きページが表示されます。ページを作成する方法は2つあります。
- ページの作成を依頼する。これを行うには、文書の要求の問題を登録し、タイトルを "Create page: <ページ名>" としてください。テンプレートの URL 欄には、分かれば MDN 上でページを作成したい場所を記入してください。コメントのテキストには、なぜこのページを作成する必要があるかについての情報を記入してください。
- ページ作成の権限を申請する。ページ作成の権限を申請して、それが認められた場合、下記の方法でページを作成することができます。権限を申請するには MDN の管理者チームにメールを送ってください。メールの内容にはあなたのユーザー名と権限を申請する理由 (例えば、新しい API の文書を書くために多くの新しいページを作成する必要がある、用語集に新しい用語を追加するためなど) を書いてください。申請する前に、サイトの内容に何らかの役に立つ貢献をしており、また一定の期間協力をしてからにするべきです (時間の長さはあくまでも一つの考慮なので、何か固定の期間があるわけではありません)。
新しいページを作成する
ページ作成権限があれば、新しいページの作成を開始できます。
新しい記事をどこに置くべきか分からなくても、心配する必要はありません。それをどこ置いても、わたしたちはそれを見つけて適正な場所に移動するか、それが最も理にかなっている場合は既存のコンテンツにマージします。あなたはページを完璧にすることについても心配する必要はありません。私たちみんなでコンテンツをきれいに美しくします。
新しいページを作成するには、いくつかの方法があります。
「存在しないページ」へのリンク
ほとんどの Wiki と同様に、 MDN ではまだ存在しないページへのリンクを作成することができます。 たとえば作成者は、 API のメンバーのページを作成する前に、すべてのメンバーのリストを作成することができます。 MDN では、存在しないページへのリンクは通常赤字で表示されます。
「存在しないページ」へのリンクからページを作成するには
- MDN にログインしていて、ページ作成権限を取得してください。ログインしていない場合は、「存在しないページ」のリンクは、404 (ページが見つかりません) というエラーを表示します。
- 「存在しないページ」のリンクをクリックしてください。ページ作成権限があれば MDN エディターの UI が開き、新しくページを作成する準備が整います。
- ページの内容を書き込んで保存します。
リンクなしで新しいページを作成
別のページからリンクせずに新しいページを作成するには、ブラウザの URL フィールドに一意のページ名を入力します。たとえば、次のように入力します。
https://developer.mozilla.org/en-US/docs/FooBar
MDN は "FooBar" というタイトルの新しいページを作成し、エディターを開いて新しいページにコンテンツを追加することができます。エディターモードの使用方法については、この記事の「既存のページを編集する」セクションを参照してください。
別のページからリンクせずに新しいページを作成するには
- MDN にログインしていて、ページ作成権限を取得する
- ブラウザーの URL 欄に下記のように入力する
https://developer.mozilla.org/en-US/docs/new
MDN は新しいページを作成し、エディターを開いて新しいページにコンテンツを追加することができます。エディターモードの使用方法については、この記事の「既存のページを編集する」セクションを参照してください。
既存のページのサブページを作成
既存のページの下の階層にサブページを作成することができます。
- 「親」ページで、詳細設定メニュー (ツールバーの歯車アイコン) をクリックすると、「新しいサブページ」をクリックします。
- 新しい文書を作成するためのエディタービューが開きます。
- 「タイトル」欄に文書のタイトルを入力します。
- 必要に応じてスラッグ欄を変更します。たとえば、タイトルが長い場合により短い URL が適切である場合などです。この欄はエディターが、タイトルの中の空白をアンダースコアに置き換えて自動的に記入しますが、 URL の最後の部分のみを変更します。
- 目次欄では、ページの目次に自動的に表示する見出しレベルを選択します。必要がない場合は「目次なし」を選択します。
- エディターペインにページの内容を書き込んで変更を保存します。エディターモードの使用方法については、この記事の「既存のページを編集する」セクションを参照してください。
既存のページを複製
新しいページの土台として使用したい書式を持つ既存のページがある場合は、そのページを「複製」し、それから内容を変更してください。
- 元のページで、詳細設定メニュー（ツールバーの歯車アイコン）をクリックし、「このページを複製」をクリックします。 新しい文書を作成するためのエディタービューが開きます。
- 新しいコンテンツに適切となるようにページタイトルを変更します。 スラッグ欄は、「タイトル」欄を変更すると自動的に更新されます。
- 必要に応じて、スラッグ欄のパスを変更して、新しい文書を文書階層の別の部分に配置します。帆殿の場合では、必要ありません。複製されたページはふつう、元のページと同様の内容w持っており、同様の位置に配置する必要があるからです。
- 目次欄で、ページの目次に自動的に表示する見出しレベルを選択します。必要がない場合は「目次なし」を選択します。
- エディターペインにページの内容を書き込んで、変更を保存します。エディターモードの使用方法については、この記事の「既存のページを編集する」セクションを参照してください。
既存のページからリンク
これは、いくつかの方法の組み合わせです。現在存在しているページから、新しいページへのリンクを作成し、挿入したリンクをクリックします。
- 既存ページのテキスト内の (意味のある) どこかの場所に新しいページの名前を入力します。
- その名前をハイライトしてエディターツールバーからリンクアイコン (
) をクリックします。'Update Link' のダイアログが開き、 'Link To' 欄が強調されています。 - 既定では URL 欄の最初に "/ja/docs/" が挿入されます。 "/ja/docs/" の後にページ名を入力します。ページ名はリンクテキストと同じである必要はありません。
- OK をクリックしてリンクを作成、挿入します。
ページがまだ存在しない場合、リンクは赤く表示されます。ページがすでに存在する場合、リンクは青く表示されます。新しいページを作成したいが、ページタイトルがすでに取られている場合、まずはすでにあるページの編集を助けたり改良したりするのがもっと意味があるのではないのかを確認してください。そうでない場合、新しいページに別の名前を考えてリンクを作成します。ガイドラインの page naming guide を参照してください。
新しいページに中身を追加するには、 (エディターを保存して閉じた後に) 作成したばかりの赤いリンクをクリックします。新しいページがエディターモードで開かれて、書き始められます。エディターモードの使用については、この記事の既存のページを編集する節を参照してください。
ページ内容の更新
KumaScript のマクロの MDN 対応や、他のページの内容の統合は、パフォーマンス上の理由でページをキャッシュする必要により妨げられることがあります。ページはソースから構築され、その出力は将来のリクエストのためにキャッシュされます。そのため、マクロ (テンプレート) や (Page マクロを使用した) 統合はマクロやその出力、統合された素材の内容のその後の変更が反映されません。
- ページを手動で更新するには、ウェブブラウザーで強制的に再読み込みしてください。 MDN はこれを検知してページの再構築を起動し、更新されたマクロの出力や統合されたページ内容を引き出します。
- ページを定期的に自動再構築するよう設定することもできます。これは、ページが頻繁に更新されると予想されない限り使用するべきではありません。詳しくはページの再生成を参照してください。