diff options
| -rw-r--r-- | files/ja/mdn/structures/page_types/api_reference_page_template/index.html | 54 |
1 files changed, 26 insertions, 28 deletions
diff --git a/files/ja/mdn/structures/page_types/api_reference_page_template/index.html b/files/ja/mdn/structures/page_types/api_reference_page_template/index.html index e59690ef30..13c0aea64a 100644 --- a/files/ja/mdn/structures/page_types/api_reference_page_template/index.html +++ b/files/ja/mdn/structures/page_types/api_reference_page_template/index.html @@ -5,42 +5,41 @@ tags: - API - Template - reference page - - テンプレート translation_of: MDN/Structures/Page_types/API_reference_page_template --- <p>{{MDNSidebar}}</p> -<div class="blockIndicator note"> -<h2 id="Remove_before_publishing" name="Remove_before_publishing">公開前に削除してください</h2> +<div class="notecard note"> +<h2 id="Remove_before_publishing">公開前に削除してください</h2> -<h3 id="Title_and_slug" name="Title_and_slug">タイトルとスラッグ</h3> +<h3 id="Title_and_slug">タイトルとスラッグ</h3> <p>API リファレンスページでは、<em>そのページで説明しているインターフェイスの名前</em>を<em>タイトル</em>にしてください。例えば、 <a href="/ja/docs/Web/API/Request">Request</a> インターフェイスのページでは、<em>タイトル</em> を <em>Request</em> にしてください。</p> <p><em>スラッグ</em> (URL の最後の部分) も、<em>そのページで説明しているインターフェイスの名前</em>にしてください。したがって、 <code>Request</code> のスラッグは <em>Request</em> です。これはふつう、自動的に設定されます。</p> -<h3 id="Top_macros" name="Top_macros">先頭で使用するマクロ</h3> +<h3 id="Top_macros">先頭で使用するマクロ</h3> -<p>既定では、テンプレートの先頭に5つのマクロ呼び出しがあります。以下のアドバイスに従って、更新や削除をしてください。</p> +<p>既定では、テンプレートの先頭に 5 つのマクロ呼び出しがあります。以下のアドバイスに従って、更新や削除をしてください。</p> <ul> - <li>\{{APIRef("<em>グループデータ名</em>")}} — これは左端にあるサイドバーを生成し、現在のページに関連するクイックリファレンスのリンクを表示します。例えば、 <a href="/ja/docs/Web/API/WebVR_API">WebVR API</a> の中の各ページは同じサイドバーを持ち、この API 内の他のページを指します。 API で正しいサイドバーを生成するには、 KumaScript の GitHub リポジトリにグループデータの項目を追加し、マクロ呼び出しの中で<em>グループデータ名</em>のところに項目名を入れる必要があります。これを行う方法についてのガイドは <a href="/ja/docs/MDN/Contribute/Structures/API_references/API_reference_sidebars">API リファレンスサイドバー</a>を参照してください。</li> - <li>\{{Draft}} — this generates a <strong>Draft</strong> banner that indicates that the page is not yet complete, and should only be removed when the first draft of the page is completely finished. After it is ready to be published, you can remove this.</li> - <li>\{{SeeCompatTable}} — this generates a <strong>This is an experimental technology</strong> banner that indicates the technology is <a href="/ja/docs/MDN/Contribute/Guidelines/Conventions_definitions#Experimental">experimental</a>). If the technology you are documenting is not experimental, you can remove this. If it is experimental, and the technology is hidden behind a pref in Firefox, you should also fill in an entry for it in the <a href="/ja/docs/Mozilla/Firefox/Experimental_features">Experimental features in Firefox</a> page.</li> - <li>\{{SecureContext_Header}} — this generates a <strong>Secure context</strong> banner that indicates the technology is only available in a <a href="/ja/docs/Web/Security/Secure_Contexts">secure context</a>. If it isn't, then you can remove the macro call. If it is, then you should also fill in an entry for it in the <a href="/ja/docs/Web/Security/Secure_Contexts/features_restricted_to_secure_contexts">Features restricted to secure contexts</a> page.</li> - <li>\{{Deprecated_Header}} — this generates a <strong>Deprecated</strong> banner that indicates the technology is <a href="/ja/docs/MDN/Contribute/Guidelines/Conventions_definitions#Deprecated_and_obsolete">deprecated</a>. If it isn't, then you can remove the macro call.</li> - <li>\{{Interface_Overview("<em>GroupDataName</em>")}} {{Experimental_Inline}} — this generates the main body of the page (Constructor, Properties, Methods and Evenets)</li> + <li>\{{APIRef("<em>グループデータ名</em>")}} — これは左端にあるサイドバーを生成し、現在のページに関連するクイックリファレンスのリンクを表示します。例えば、 <a href="/ja/docs/Web/API/WebVR_API">WebVR API</a> の中の各ページは同じサイドバーを持ち、この API 内の他のページを指します。 API で正しいサイドバーを生成するには、 KumaScript の GitHub リポジトリにグループデータの項目を追加し、マクロ呼び出しの中で<em>グループデータ名</em>のところに項目名を入れる必要があります。これを行う方法についてのガイドは <a href="/ja/docs/MDN/Contribute/Howto/Write_an_API_reference/Sidebars">API リファレンスサイドバー</a>を参照してください。</li> + <li>\{{Draft}} — これは、 <strong>Draft</strong> バナーを生成してページがまだ完成していないことを示すもので、ページの最初の草稿が完全に完成した場合にのみ削除するべきものです。公開できる状態になったら、これを削除することができます。</li> + <li>\{{SeeCompatTable}} — これは、 <strong>This is an experimental technology</strong> バナーを生成して、技術が<a href="/ja/docs/MDN/Guidelines/Conventions_definitions#experimental">実験的</a>であることを示します。文書化しようとしている技術が実験的でない場合は、これを削除することができます。実験的な技術であり、その技術が Firefox のプレハブに隠されている場合は、 <a href="/ja/docs/Mozilla/Firefox/Experimental_features">Firefox における試験的機能</a>のページにそのための項目を記入する必要があります。</li> + <li>\{{SecureContext_Header}} — これは <strong>Secure context</strong> バナーを生成し、その技術が<a href="/ja/docs/Web/Security/Secure_Contexts">安全なコンテキスト</a>でのみ利用可能であることを示します。そうでない場合、マクロ呼び出しを削除することができます。存在する場合は、<a href="/ja/docs/Web/Security/Secure_Contexts/features_restricted_to_secure_contexts">安全なコンテキストに制限されている機能</a>ページにも項目を記入してください。</li> + <li>\{{Deprecated_Header}} — これは <strong>Deprecated</strong> バナーを生成し、その技術が<a href="/ja/docs/MDN/Guidelines/Conventions_definitions#deprecated_and_obsolete">非推奨</a>であることを示します。そうでない場合は、このマクロを削除することができます。</li> + <li>\{{Interface_Overview("<em>GroupDataName</em>")}} {{Experimental_Inline}} — これはページの本文 (コンストラクター、プロパティ、メソッド、イベント) を生成します。</li> </ul> -<h3 id="Tags" name="Tags">タグ</h3> +<h3 id="Tags">タグ</h3> -<p>In an API reference page, you need to include the following tags (see the <em>Tags</em> section at the bottom of the editor UI): <strong>API</strong>, <strong>Reference</strong>, <strong>Interface</strong>, <em>the name of the API</em> (e.g. <strong>WebVR</strong>), the name of the interface (e.g. <strong>Request</strong>), <strong>Experimental</strong> (if the technology is <a href="/ja/docs/MDN/Contribute/Guidelines/Conventions_definitions#Experimental">experimental</a>), <strong>Secure context</strong> (if it is available in a secure context only), and <strong>Deprecated</strong> (if it is <a href="/ja/docs/MDN/Contribute/Guidelines/Conventions_definitions#Deprecated_and_obsolete">deprecated</a>).</p> +<p>In an API reference page, you need to include the following tags (see the <em>Tags</em> section at the bottom of the editor UI): <strong>API</strong>, <strong>Reference</strong>, <strong>Interface</strong>, <em>the name of the API</em> (e.g. <strong>WebVR</strong>), the name of the interface (e.g. <strong>Request</strong>), <strong>Experimental</strong> (if the technology is <a href="/ja/docs/MDN/Guidelines/Conventions_definitions#experimental">experimental</a>), <strong>Secure context</strong> (if it is available in a secure context only), and <strong>Deprecated</strong> (if it is <a href="/ja/docs/MDN/Guidelines/Conventions_definitions#deprecated_and_obsolete">deprecated</a>).</p> <p>Optionally, you can elect to include some other tags that effective represent terms people might search for when looking for information on that technology. For example on WebVR interface pages we include <strong>VR</strong> and <strong>Virtual reality</strong>.</p> -<h3 id="Browser_compatibility" name="Browser_compatibility">ブラウザーの互換性</h3> +<h3 id="Browser_compatibility">ブラウザーの互換性</h3> -<p>To fill in the browser compat data, you first need to fill in an entry for the API into our <a href="https://github.com/mdn/browser-compat-data">Browser compat data repo</a> — see our <a href="/ja/docs/MDN/Contribute/Structures/Compatibility_tables#The_new_way_The_browser_compat_data_repo_and_dynamic_tables">guide on how to do this</a>.</p> +<p>To fill in the browser compat data, you first need to fill in an entry for the API into our <a href="https://github.com/mdn/browser-compat-data">Browser compat data repo</a> — see our <a href="/ja/docs/MDN/Structures/Compatibility_tables#the_new_way_the_browser_compat_data_repo_and_dynamic_tables">guide on how to do this</a>.</p> <p>Once that is done, you can show the compat data for the interface with a \{{Compat(…)}} macro call.</p> </div> @@ -51,14 +50,14 @@ translation_of: MDN/Structures/Page_types/API_reference_page_template <p>{{InheritanceDiagram}}</p> -<h2 id="Constructor" name="Constructor">コンストラクター</h2> +<h2 id="Constructor">コンストラクター</h2> <dl> <dt>{{DOMxRef("NameOfTheInterface.NameOfTheInterface")}}</dt> <dd>Creates a new instance of the {{DOMxRef("NameOfTheInterface")}} object.</dd> </dl> -<h2 id="Properties" name="Properties">プロパティ</h2> +<h2 id="Properties">プロパティ</h2> <p><em>Also inherits properties from its parent interface, {{DOMxRef("NameOfParentInterface")}}.</em> (Note: If the interface doesn't inherit from another interface, remove this whole line.)</p> @@ -69,7 +68,7 @@ translation_of: MDN/Structures/Page_types/API_reference_page_template <dd>etc.</dd> </dl> -<h2 id="Methods" name="Methods">メソッド</h2> +<h2 id="Methods">メソッド</h2> <p><em>Also inherits methods from its parent interface, {{DOMxRef("NameOfParentInterface")}}.</em> (Note: If the interface doesn't inherit from another interface, remove this whole line.)</p> @@ -80,7 +79,7 @@ translation_of: MDN/Structures/Page_types/API_reference_page_template <dd>etc.</dd> </dl> -<h2 id="Events" name="Events">イベント</h2> +<h2 id="Events">イベント</h2> <p>Listen to these events using <code><a href="/ja/docs/Web/API/EventTarget/addEventListener">addEventListener()</a></code> or by assigning an event listener to the <code>on<em>eventname</em></code> property of this interface.</p> @@ -92,13 +91,14 @@ translation_of: MDN/Structures/Page_types/API_reference_page_template <dd>Fired when ... include description of when event fires<br> Also available via the <code><a href="#">oneventname2</a></code> property.</dd> <dt>etc.</dt> + <dd>Fired when ...</dd> </dl> -<h2 id="Examples" name="Examples">例</h2> +<h2 id="Examples">例</h2> -<p>Fill in a simple example that nicely shows a typical usage of the interfaces, then perhaps some more complex examples (see our guide on how to add <a href="/ja/docs/MDN/Contribute/Structures/Code_examples">code examples</a> for more information).</p> +<p>Fill in a simple example that nicely shows a typical usage of the interfaces, then perhaps some more complex examples (see our guide on how to add <a href="/ja/docs/MDN/Structures/Code_examples">code examples</a> for more information).</p> -<pre class="brush: js notranslate">my code block</pre> +<pre class="brush: js">my code block</pre> <p>And/or include a list of links to useful code samples that live elsewhere:</p> @@ -108,7 +108,7 @@ translation_of: MDN/Structures/Page_types/API_reference_page_template <li>z</li> </ul> -<h2 id="Specifications" name="Specifications">仕様書</h2> +<h2 id="Specifications">仕様書</h2> <table class="standard-table"> <thead> @@ -132,13 +132,11 @@ translation_of: MDN/Structures/Page_types/API_reference_page_template </tbody> </table> -<h2 id="Browser_compatibility_2" name="Browser_compatibility_2">ブラウザーの互換性</h2> - -<div class="hidden">このページの互換性一覧表は構造化データから生成されています。データに協力していただけるのであれば、 <a class="external" href="https://github.com/mdn/browser-compat-data">https://github.com/mdn/browser-compat-data</a> をチェックアウトしてプルリクエストを送信してください。</div> +<h2 id="Browser_compatibility_2">ブラウザーの互換性</h2> <p>{{Compat("path.to.feature.NameOfTheInterface")}}</p> -<h2 id="See_also" name="See_also">関連情報</h2> +<h2 id="See_also">関連情報</h2> <ul> <li>Include list of</li> |