MDN wants to learn about developers like you: https://qsurvey.mozilla.com/s3/d6d7ff2e2f9c

この記事は翻訳作業中です。

MDN での主な二つの作業、つまるところほとんどのMDN貢献者が行うことになるのは、 既存のページを編集すること、または新しいページを作成することです。この記事では、それぞれをどのように行うのかについての基本を紹介します。

このページは翻訳中です。 ユーザガイドのコンテンツの作成ページは、少し前の内容が日本語訳されたものです。

既存のページを編集する

編集はとても簡単です。

  • 訂正したいページを見つけたら、右上の「編集」ボタンをクリックしてください。
  • ページが書式設定オプションによってリロードされるので、直接情報を追加または削除できるようになります。
  • 段落を追加したり、テキストを削除したり、見出しを挿入したり、書いたり編集したりするための基本的な機能の多くを使用することができます。MDNの組み込みエディターの使い方についてはMDN のエディタガイドEditor UI elementsを参照してください。

変更をプレビューする

どのように変更を確認するのか。

  • ページタイトルの上にある「変更をプレビュー」ボタンをクリックします。
  • 新しいウィンドウまたはタブにリビジョンを含むプレビューページが開きます。
  • このボタンをクリックするたびに、最新の変更内容でプレビューページが更新されます。

ページをプレビューしても進行状況は保存されませんので、開いている編集タブを閉じないように注意してください。

リビジョンのコメント

変更をプレビューした後は、リビジョンを保存することになります。保存する前に、下部にあるリビジョンコメントボックスを探し、他の寄稿者に変更を加えた理由を知らせるコメントを残してください。 たとえば、新しいセクションを追加したり、いくつかの単語を変更して用語をより一貫させたり、段落を書き換えて言語を明確にしたり、冗長であったため情報を削除したなど、他の寄稿者が変更履歴を追いやすいものが望ましいです。

タグ

ページの編集セクションの下に、ページの内容と機能を記述するタグを追加または削除することができます。 適用するタグの情報については、ページに正しくタグを付ける方法を参照してください。

レビューが必要な場合

専門家、または経験豊富な寄稿者が編集内容を確認する必要がある場合は、技術レビュー(コード、API、または技術の場合)、編集レビュー(散文、文法、コンテンツの場合)、またはテンプレートレビュー(KumaScriptコードの場合)を保存する前にボックスがオンになっていることを確認します。

添付ファイル

画像を追加するために、既存のページにファイルを添付したい場合は、ページの下部からアップロードしたいファイルを選択します。 

保存、破棄、または編集を続行するには

編集作業が終わり、プレビューに満足すれば、ページタイトルの右側にある緑色の「公開」ボタンをクリックして、作業やコメントを保存することができます。そのまま編集を続行したい場合は、「公開して編集を続行」ボタン をクリックするして、そのまま作業を続けることができます。

ページタイトルの右側にある赤い「破棄」ボタンをクリックすると編集内容を破棄できます。なお、破棄された編集内容は元に戻りません。

リビジョンコメントボックスでエンターキーを押すと、「公開して編集を続行」ボタンを押した場合と同じ結果になります。

適正な編集を保存しようとするのに、変更が不正なものであるとして保存できなかった場合、MDNのアドミンチームにメールを送って助けを求めてください。

新しいページを作成する

新しい記事をどこに置くべきか分からなくても、心配する必要はありません。それをどこ置いても、わたしたちはそれを見つけて適正な場所に移動するか、それが最も理にかなっている場合は既存のコンテンツにマージします。 あなたはページを完璧にすることについても心配する必要はありません。私たちみんなでコンテンツをきれいに美しくします。

新しいページを作成するには、いくつかの方法があります。

ページ作成の権限を得る

セキュリティ対策として、新しく作成したアカウントにはページを作成する権限はありません。権限がないアカウントで作成しようとする場合、ページを作成するための手引きページが表示されます。ページを作成する方法は2つあります。

  • ページの作成を依頼する。依頼するには題名を「Create page: <ページの名前>」とするドキュメンテーション・リクエスト・バグを報告してください。URLフィールドには(もし知っていれば)MDNにおける位置を入力してください。また、コメントではなぜそのページを作成する必要があるかを説明してください。
  • ページ作成の権限を申請する。ページ作成の権限を申請して、それが認められた場合、下記の方法でページを作成することができます。権限を申請するにはMDNのアドミンチームにメールを送ってください。メールの内容にはあなたのユーザーネームと権限を申請する理由(例えば、新しいAPIのドキュメンテーションを書くために多くの新しいページを作成する必要がある、用語集に新しい用語を追加するためなど)を書いてください。申請する前に、サイトの内容に何らかの役に立つ貢献をしており、また一定の期間貢献をしてからにするべきです(時間の長さはあくまでも一つの考慮なので、何か固定の期間があるわけではありません)。

「存在しないページ」へのリンクをクリック

ほとんどのWikiと同様に、MDNではまだ存在しないページへのリンクを作成することができます。 たとえば作成者は、APIのメンバーのページを作成する前に、すべてのメンバーのリストを作成することができます。 MDNでは、存在しないページへのリンクは通常赤字で表示されます。

「存在しないページ」へのリンクからページを作成するには:

  1. MDNにログインしていることを確認してください。(もしログインしていない場合は、「ページが見つからない」リンクが、404(ページが見つかりません)というエラーを表示します。)
  2. 「ページが見つからない」リンクをクリックします。 MDN EditorのUIが開き、新しくページを作成する準備が整います。
  3. ページの内容を書き込んで保存します。
     

リンクなしで新しいページを作成

別のページからリンクせずに新しいページを作成するには、ブラウザのURLフィールドに一意のページ名を入力します。 たとえば、次のように入力します。

https://developer.mozilla.org/en-US/docs/FooBar

MDNは "FooBar" というタイトルの新しいページを作成し、エディタを開いて新しいページにコンテンツを追加することができます。 エディタモードの使用方法については、この記事の「既存のページを編集する」セクションを参照してください。
 

既存のページのサブページを作成

既存のページの下の階層にサブページを作成することができます。

  1. 「親」ページで、詳細設定メニュー(ツールバーの歯車アイコン)をクリックし、「新しいサブページ」をクリックします。 新しい文書を作成するためのエディタビューが開きます。
  2. 「タイトル」フィールドに文書のタイトルを入力します。
  3. 必要に応じてSlugフィールドを変更します。(たとえば、タイトルが非常に長く、URLを短くしたい場合など。)このフィールドは、タイトルのスペースにアンダースコアを代入することで、エディタによって自動的に入力されます。 この場合、文書のURLの最後の部分のみを変更することができます。
  4. TOCフィールドで、ページの目次に自動的に表示する見出しレベルを選択します。必要がない場合は「目次なし」を選択します。
  5. エディタペインにページの内容を書き込んで変更を保存します。 エディタモードの使用方法については、この記事の「既存のページを編集する」セクションを参照してください。
     

既存のページを複製

既存のページが、新しいページに使用できる形式である場合は、そのページを「複製」して内容を変更できます。

  1. 元のページで、詳細設定メニュー(ツールバーの歯車アイコン)をクリックし、「このページを複製」をクリックします。 新しい文書を作成するためのエディタビューが開きます。
  2. 新しいコンテンツに適切となるようにページタイトルを変更します。 Slugフィールドは、Titleフィールドを変更すると自動的に更新されます。
  3. 必要に応じて、Slugフィールドのパスを変更して、新しいドキュメントをドキュメント階層の別の部分に配置します。 (ほとんどの場合では必要ありません。なぜなら、複製されたページは元のコンテンツと似ているため、同様の場所に配置する必要があるためです。)
  4. TOCフィールドで、ページの目次に自動的に表示する見出しレベルを選択します。必要がない場合は「目次なし」を選択します。
  5. エディタペインにページの内容を書き込んで、変更を保存します。 エディタモードの使用方法については、この記事の「既存のページを編集する」セクションを参照してください。

 

存在しないページへのリンクを作成してクリック

これは、いくつかの方法の組み合わせです。現在存在しているページから、新しいページへのリンクを作成し、挿入したリンクをクリックします。

  1. Enter the name of the new page anywhere (that makes sense) in the text of an existing page.
  2. Highlight the name and click the Link icon () in the editor's toolbar. The "Update Link" dialog opens, with the highlighted text in the "Link To" field.
  3. "/ja/docs/" is inserted by default at the beginning of the URL field. Enter the name of the page after "/en-US/docs/". (The page name doesn't have to be the same as the link text.)
  4. Click OK to create and insert the link.

If the page does not already exist, the link is displayed in red. If the page does already exist, the link is displayed in blue. If you want to create a new page but the page title you want is already taken, check first if it makes more sense to help edit and improve the page that is already there. Otherwise, think of a different title for your new page and create a link for it. Refer to the page naming guide for guidelines.

To add content to your new page, click on the red link you just created (after saving and closing the editor). The new page opens in editor mode, so you can start writing. エディタモードの使用については、この記事の 既存のページを編集する 節を参照してください。

ページの内容をリフレッシュする

MDN's support for KumaScript macros and transclusion of content from one page into another can sometimes be hampered slightly by the need for caching of generated pages for performance reasons. Pages are built from their source, and that output is cached for future requests. From then on, any macros (templates) or transclusions (using the Page macro on that page will not reflect changes made to the macro, the macro's output, or the contents of the transcluded material.

  • To update a page manually, you can do a force-refresh in your browser. MDN detects this and triggers a page rebuild, pulling in updated macro output and transcluded page content.
  • You can also configure pages to periodically be rebuilt automatically. This should not be done unless you expect the page to need updating frequently. 詳しくは ページの再生成 を参照してください。

関連項目

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

タグ: 
 このページの貢献者: Spalits00, patilise, sun4geek, hamasaki
 最終更新者: Spalits00,