aboutsummaryrefslogtreecommitdiff
path: root/files/ja/orphaned/mdn/structures
diff options
context:
space:
mode:
authorFlorian Merz <me@fiji-flo.de>2021-02-11 12:07:59 +0100
committerFlorian Merz <me@fiji-flo.de>2021-02-11 12:07:59 +0100
commit6ef1fa4618e08426b874529619a66adbd3d1fcf0 (patch)
tree890e3e27131be010d82ef957fa68db495006cb0e /files/ja/orphaned/mdn/structures
parent8260a606c143e6b55a467edf017a56bdcd6cba7e (diff)
downloadtranslated-content-6ef1fa4618e08426b874529619a66adbd3d1fcf0.tar.gz
translated-content-6ef1fa4618e08426b874529619a66adbd3d1fcf0.tar.bz2
translated-content-6ef1fa4618e08426b874529619a66adbd3d1fcf0.zip
unslug ja: move
Diffstat (limited to 'files/ja/orphaned/mdn/structures')
-rw-r--r--files/ja/orphaned/mdn/structures/api_references/index.html58
-rw-r--r--files/ja/orphaned/mdn/structures/api_references/what_does_an_api_reference_need/index.html168
-rw-r--r--files/ja/orphaned/mdn/structures/live_samples/simple_live_sample_demo/index.html37
-rw-r--r--files/ja/orphaned/mdn/structures/macros/commonly-used_macros/creating_templates_for_multi-languages/index.html12
4 files changed, 275 insertions, 0 deletions
diff --git a/files/ja/orphaned/mdn/structures/api_references/index.html b/files/ja/orphaned/mdn/structures/api_references/index.html
new file mode 100644
index 0000000000..c1d806b234
--- /dev/null
+++ b/files/ja/orphaned/mdn/structures/api_references/index.html
@@ -0,0 +1,58 @@
+---
+title: API リファレンス
+slug: MDN/Structures/API_references
+tags:
+ - API
+ - Contribute
+ - Guide
+ - Reference
+translation_of: MDN/Structures/API_references
+---
+<div>{{MDNSidebar}}</div>
+
+<div>{{IncludeSubnav("/ja/docs/MDN")}}</div>
+
+<p class="summary">クライアント側の JavaScript API は、ウェブ上で利用可能な技術の大部分を占めています。MDN には、これらの API で使用できる機能とその使用方法を説明する広範囲な参考資料が含まれています。このガイドセットでは MDN で API リファレンス資料を作成する方法について説明します。</p>
+
+<h2 id="Prerequisite_resources" name="Prerequisite_resources">事前に準備するリソース</h2>
+
+<p>API の文書化を開始する前に、次のものが必要です。</p>
+
+<ol>
+ <li><strong>最新の仕様:</strong> W3C 勧告か初期の編集者の草稿かどうかに関わらず、その API をカバーする仕様の最新の草稿 (またはその仕様を参照) を参照する必要があります。通常それはウェブ検索で見つかります。最新のバージョンは「最新草稿」、またはそれに類するものの下にリストされている仕様のすべてのバージョンからリンクされることがよくあります。</li>
+ <li><strong>最新のウェブブラウザー:</strong> <a href="https://nightly.mozilla.org/">Firefox Nightly</a>/<a href="https://www.google.com/intl/en/chrome/browser/canary.html">Chrome Canary</a> のような実験的/アルファ版のものが、あなたが文書化している機能をサポートする可能性が高いはずです。これは初期の/実験的な API を文書化している場合に特に関係します。</li>
+ <li><strong>デモ/ブログ記事/その他の情報:</strong> できるだけ多くの情報を探しましょう。主なインターフェイス/プロパティ/メソッドが何であるか、主要な用途は何であるか、そしてそれを使って簡単な機能を書く方法を学ぶことで、API の仕組みに慣れるための時間を費やすことから始めておくと便利です。</li>
+ <li><strong>有益なエンジニアリングの連絡先:</strong> 仕様、API の標準化に携わっている人、またはブラウザでの実装について質問するためのフレンドリーなエンジニアリング担当者を見つけることは本当に便利です。見つけるのに適した場所は次のとおりです。
+ <ul>
+ <li>関連会社に勤めている場合は、社内のアドレス帳。</li>
+ <li>Mozilla の <a href="https://lists.mozilla.org/listinfo/dev-platform">dev-platform</a> や <a href="https://lists.mozilla.org/listinfo/dev-webapi">dev-webapi</a> のリスト、<a href="https://lists.w3.org/Archives/Public/public-webapps/">public-webapps</a> のような W3C のリストなど、その API の議論に関係する公開メーリングリスト。</li>
+ <li>仕様そのもの。たとえば、 <a href="https://webaudio.github.io/web-audio-api/">Web Audio API</a> の仕様書では著者とその連絡先の詳細が上部に表示されています。</li>
+ </ul>
+ </li>
+</ol>
+
+<h2 id="High_level_structure" name="High_level_structure">高水準の構造</h2>
+
+<dl>
+ <dt><a href="/ja/docs/MDN/Contribute/Structures/API_references/What_does_an_API_reference_need">What does an API reference need?</a></dt>
+ <dd>この記事では完全な API リファレンスに必要なページについて説明します。</dd>
+ <dt><a href="/ja/docs/MDN/Contribute/Structures/Page_types">Page types</a></dt>
+ <dd>MDN に繰り返し使用されるいくつかの種類のページがあります。この記事では、これらのページ種別とその目的、および新しいページを作成するときに使用する各テンプレートとテンプレートの例について説明します。</dd>
+</dl>
+
+<h2 id="Individual_page_features" name="Individual_page_features">個々のページの特徴</h2>
+
+<p>これらの記事では、API リファレンスページに必要な個々のページの特徴を作成する方法について説明します。</p>
+
+<dl>
+ <dt><a href="/ja/docs/MDN/Contribute/Structures/API_references/API_reference_sidebars">API リファレンスサイドバー</a></dt>
+ <dd>MDN API リファレンス記事にサイドバーを含めると、その API に関連する関連インタフェース、チュートリアル、その他のリソースへのリンクが表示されるようにカスタマイズできます。この記事では、この方法について説明します。</dd>
+ <dt><a href="/ja/docs/MDN/Contribute/Structures/Syntax_sections">構文の節</a></dt>
+ <dd>MDN リファレンスページの構文の節には、その機能が持つ正確な構文 (例えば、どのような引数を受け付けるか、どの引数がオプションかなど) を定義する構文ボックスが含まれています。</dd>
+ <dt><a href="/ja/docs/MDN/Contribute/Structures/Code_examples">コード例</a></dt>
+ <dd>MDN には、ウェブプラットフォーム機能の使用方法を示すために、ページ全体に挿入された多数のコード例があります。この記事ではコードの例をページに追加する際に使用できるさまざまなメカニズムと、使用する必要があるものとそのタイミングについて説明します。</dd>
+ <dt><a href="/ja/docs/MDN/Contribute/Structures/Specification_tables">仕様書一覧表</a></dt>
+ <dd>MDN のすべてのリファレンスページは、その API または技術が定義されている仕様または仕様に関する情報を提供する必要があります。この資料では、これらのテーブルの外観とその構成方法について説明します。</dd>
+ <dt><a href="/ja/docs/MDN/Contribute/Structures/Compatibility_tables">互換性一覧表</a></dt>
+ <dd>MDN には、公開されているウェブ文書の互換性一覧表の標準フォーマットがあります。つまり、すべてのブラウザーで共有されているDOM、HTML、CSS、JavaScript、SVG などの技術の文書です。この記事では、機能を使用して MDN ページに互換性データを追加する方法について説明します。</dd>
+</dl>
diff --git a/files/ja/orphaned/mdn/structures/api_references/what_does_an_api_reference_need/index.html b/files/ja/orphaned/mdn/structures/api_references/what_does_an_api_reference_need/index.html
new file mode 100644
index 0000000000..952c49ed70
--- /dev/null
+++ b/files/ja/orphaned/mdn/structures/api_references/what_does_an_api_reference_need/index.html
@@ -0,0 +1,168 @@
+---
+title: API リファレンスには何が必要ですか?
+slug: MDN/Structures/API_references/What_does_an_API_reference_need
+tags:
+ - API
+ - ページ
+ - リファレンス
+translation_of: MDN/Structures/API_references/What_does_an_API_reference_need
+---
+<div>{{MDNSidebar}}</div>
+
+<p class="summary">この記事では、完全な API リファレンスに必要なページについて説明します。</p>
+
+<div class="note">
+<p><strong>メモ</strong>: API リファレンスで作業しているときに書いたり更新したりする必要があるドキュメントのリストを作成し、完了したらチェックを外すことをお勧めします。</p>
+</div>
+
+<h2 id="API_ページの概要">API ページの概要</h2>
+
+<p>An API reference will generally contain the following pages. You can find more details of what each page contains, examples, and templates, in our <a href="/en-US/docs/MDN/Contribute/Structures/Page_types">Page types</a> article.</p>
+
+<ol>
+ <li>Overview page</li>
+ <li>Interface pages</li>
+ <li>Constructor pages</li>
+ <li>Method pages</li>
+ <li>Property pages (including event handlers properties)</li>
+ <li>Event pages</li>
+ <li>Concept/guide pages</li>
+ <li>Examples</li>
+</ol>
+
+<div class="note">
+<p><strong>Note</strong>: We'll be referring to the <a href="/en-US/docs/Web/API/Web_Audio_API">Web Audio API</a> for examples in this article.</p>
+</div>
+
+<div class="note">
+<p><strong>Note</strong>: To create a page as specified below, the easiest way is to go to the parent page you want it to hang off, and choose <em>Cog icon &gt; New sub-article</em>. If you haven't got this option available on your MDN interface, you'll need to request this privilege (ask at <code>mdn-admins@mozilla.org</code>), or ask another MDN contributor to create them for you.</p>
+</div>
+
+<h3 id="概要ページ">概要ページ</h3>
+
+<p>A single API overview page is used to describe the role of the API, its top-level interfaces, related features contained in other interfaces, and other high level details. Its name and slug should be the name of the API plus "API" on the end. It is placed at the top level of the API reference, as a child of <a href="/en-US/docs/Web/API">https://developer.mozilla.org/en-US/docs/Web/API</a>.</p>
+
+<p>例:</p>
+
+<ul>
+ <li>Title: <em>Web Audio API</em></li>
+ <li>Slug: <em>Web_Audio_API</em></li>
+ <li>URL: <a href="https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API">https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API</a></li>
+</ul>
+
+<h3 id="インターフェイスページ">インターフェイスページ</h3>
+
+<p>Each interface will have its own page too, describing the purpose of the interface, listing any members (constructors, methods, properties, etc. it contains), and showing what browsers it is compatible with. A page's name and slug should be the name of the interface, exactly as written in the spec. Each page is placed at the top level of the API reference, as a child of <a href="/en-US/docs/Web/API">https://developer.mozilla.org/en-US/docs/Web/API</a>.</p>
+
+<p>例:</p>
+
+<ul>
+ <li>Title: <em>AudioContext</em></li>
+ <li>Slug: <em>AudioContext</em></li>
+ <li>URL: <a href="https://developer.mozilla.org/en-US/docs/Web/API/AudioContext">https://developer.mozilla.org/en-US/docs/Web/API/AudioContext</a></li>
+</ul>
+
+<ul>
+ <li>Title: <em>AudioNode</em></li>
+ <li>Slug: <em>AudioNode</em></li>
+ <li>URL: <a href="https://developer.mozilla.org/en-US/docs/Web/API/AudioNode">https://developer.mozilla.org/en-US/docs/Web/API/AudioNode</a></li>
+</ul>
+
+<div class="note">
+<p><strong>Note:</strong> We document every member appearing in the interface. You should bear the following rules in mind:</p>
+
+<ul>
+ <li>We document methods defined on the <u>prototype</u> of an object implementing this interface (instance methods), and methods defined on the actual class itself (static methods). On the rare occasions that they both exist on the same interface, you should list them in separate sections on the page (Static methods/Instance methods). Usually only instance methods exist, in which case you can put these under the title "Methods".</li>
+ <li>We do not document inherited properties and methods of the interface: they are listed on the respective parent interface. We do hint at their existence though.</li>
+ <li>We do document properties and methods defined in mixins, though we use the mixin name as interface name. (This is not optimal as the mixin name will not appear in the console, but it prevents the duplication of documentation. We may revisit this in the future.)</li>
+ <li>Special methods like the stringfier (<code>toString()</code>) and the jsonizier (<code>toJSON()</code>) are also listed if they do exist.</li>
+ <li>Named constructors (like <code>Image()</code>  for {{domxref("HTMLImageElement")}} ) are also listed, if relevant.</li>
+</ul>
+</div>
+
+<h3 id="コンストラクタページ">コンストラクタページ</h3>
+
+<p>Each interface has 0 or 1 constructors, documented on a subpage of the interface's page. It describes the purpose of the constructor and shows what its syntax looks like, usage examples, browser compatibility information, etc. Its slug is the name of the constructor, which is exactly the same as the interface name, and the title is interface name, dot, constructor name, then parentheses on the end.</p>
+
+<p>Example:</p>
+
+<ul>
+ <li>Title: <em>AudioContext.AudioContext()</em></li>
+ <li>Slug: <em>AudioContext</em></li>
+ <li>URL: <a href="https://developer.mozilla.org/en-US/docs/Web/API/AudioContext/AudioContext">https://developer.mozilla.org/en-US/docs/Web/API/AudioContext/AudioContext</a></li>
+</ul>
+
+<h3 id="プロパティページ">プロパティページ</h3>
+
+<p>Each interface has zero or more properties, documented on subpages of the interface's page. each page describes the purpose of the property and shows what its syntax looks like, usage examples, browser compatibility information, etc. Its slug is the name of the property, and the title is interface name, dot, then property name.</p>
+
+<p>Examples:</p>
+
+<ul>
+ <li>Title: <em>AudioContext.state</em></li>
+ <li>Slug: <em>state</em></li>
+ <li>URL: <a href="/en-US/docs/Web/API/AudioContext/state">https://developer.mozilla.org/en-US/docs/Web/API/AudioContext/state</a></li>
+</ul>
+
+<ul>
+ <li>Title: <em>AudioContext.onstatechange</em></li>
+ <li>Slug: <em>onstatechange</em></li>
+ <li>URL: <a href="/en-US/docs/Web/API/AudioContext/onstatechange">https://developer.mozilla.org/en-US/docs/Web/API/AudioContext/onstatechange</a></li>
+</ul>
+
+<div class="note">
+<p><strong>Note:</strong> Event handler properties are treated in the same way as regular properties; they are generally listed in a separate section on the interface page though.</p>
+</div>
+
+<ul>
+</ul>
+
+<h3 id="メソッドページ">メソッドページ</h3>
+
+<p>Each interface has zero or more methods, documented on subpages of the interface's page. each page describes the purpose of the method and shows what its syntax looks like, usage examples, browser compatibility information, etc. Its slug is the name of the method, and the title is interface name, dot, method name, then parentheses.</p>
+
+<p>Examples:</p>
+
+<ul>
+ <li>Title: <em>AudioContext.close()</em></li>
+ <li>Slug: <em>close</em></li>
+ <li>URL: <a href="/en-US/docs/Web/API/AudioContext/close">https://developer.mozilla.org/en-US/docs/Web/API/AudioContext/close</a></li>
+</ul>
+
+<ul>
+ <li>Title: <em>AudioContext.createGain()</em></li>
+ <li>Slug: <em>createGain</em></li>
+ <li>URL: <a href="/en-US/docs/Web/API/AudioContext/createGain">https://developer.mozilla.org/en-US/docs/Web/API/AudioContext/createGain</a></li>
+</ul>
+
+<h3 id="イベントページ">イベントページ</h3>
+
+<p>Each event handler property you create will have a corresponding event page, describing the event that causes the handler to fire, documented on a subpage of <a href="/en-US/docs/Web/Events">https://developer.mozilla.org/en-US/docs/Web/Events</a>. Each page describes the purpose of the event and shows what its syntax looks like, usage examples, browser compatibility information, etc. Its slug and title is the name of the event.</p>
+
+<p>Example:</p>
+
+<ul>
+ <li>Title: <em>statechange</em></li>
+ <li>Slug: <em>statechange</em></li>
+ <li>URL: <a href="/en-US/docs/Web/Events/statechange">https://developer.mozilla.org/en-US/docs/Web/Events/statechange</a></li>
+</ul>
+
+<h3 id="Conceptguide_pages">Concept/guide pages</h3>
+
+<p>Most API references have at least one guide and sometimes also a concept page to accompany it. At minimum, an API reference should contain a guide called "Using the <em>name-of-api</em>", which will provide a basic guide to how to use the API. More complex APIs may require multiple usage guides to explain how to use different aspects of the API.</p>
+
+<p>If required, you can also including a concepts article called "<em>name-of-api</em> concepts", which will provide explanation of the theory behind any concepts related to the API that developers should understand to effectively use it.</p>
+
+<p>These articles should all be created as subpages of the API overview page. For example, the Web Audio has four guides and a concept article:</p>
+
+<ul>
+ <li><a href="/en-US/docs/Web/API/Web_Audio_API/Using_Web_Audio_API">https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API/Using_Web_Audio_API</a></li>
+ <li><a href="/en-US/docs/Web/API/Web_Audio_API/Visualizations_with_Web_Audio_API">https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API/Visualizations_with_Web_Audio_API</a></li>
+ <li><a href="/en-US/docs/Web/API/Web_Audio_API/Web_audio_spatialization_basics">https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API/Web_audio_spatialization_basics</a></li>
+ <li><a href="/en-US/docs/Web/API/Web_Audio_API/Porting_webkitAudioContext_code_to_standards_based_AudioContext">https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API/Porting_webkitAudioContext_code_to_standards_based_AudioContext</a></li>
+ <li><a href="/en-US/docs/Web/API/Web_Audio_API/Basic_concepts_behind_Web_Audio_API">https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API/Basic_concepts_behind_Web_Audio_API</a></li>
+</ul>
+
+<h3 id="例">例</h3>
+
+<p>You should create some examples that demonstrate at least the most common use cases of the API. You can put these anywhere that is appropriate, although the recommended place is the <a href="https://github.com/mdn/">MDN GitHub repo</a>.</p>
diff --git a/files/ja/orphaned/mdn/structures/live_samples/simple_live_sample_demo/index.html b/files/ja/orphaned/mdn/structures/live_samples/simple_live_sample_demo/index.html
new file mode 100644
index 0000000000..9e550d81ac
--- /dev/null
+++ b/files/ja/orphaned/mdn/structures/live_samples/simple_live_sample_demo/index.html
@@ -0,0 +1,37 @@
+---
+title: ライブコードサンプルの簡単なデモ
+slug: MDN/Structures/Live_samples/Simple_live_sample_demo
+tags:
+ - MDN Meta
+ - Structures
+ - 例
+translation_of: MDN/Structures/Live_samples/Simple_live_sample_demo
+---
+<div>{{MDNSidebar}}</div>
+
+<h2 id="The_example" name="The_example">例</h2>
+
+<p id="Simple_example_of_a_live_demo">これは、MDN でライブデモを行う方法を示す非常に簡単な例です。詳細については、<a href="/ja/docs/MDN/Contribute/Structures/Live_samples">ライブサンプル</a>を参照してください。</p>
+
+<pre class="brush: html notranslate">&lt;form&gt;
+ &lt;label&gt;Try me&lt;input type="text" name="name"&gt;&lt;/label&gt;
+ &lt;input type="submit" value="go"&gt;
+&lt;/form&gt;</pre>
+
+<pre class="brush: css notranslate">form {
+ border-radius: 10px;
+ background: powderblue;
+}</pre>
+
+<pre class="brush: js notranslate">var f = document.querySelector('form');
+
+f.addEventListener('submit', function(ev) {
+ ev.preventDefault();
+ document.querySelectorAll('input')[1].value = 'sending';
+}, false);</pre>
+
+<p>{{ EmbedLiveSample('The_example', '', '', '') }}</p>
+
+<div class="blockIndicator note">
+<p>注: ローカライズしたページでは、最初の引数の値は、サンプルを含む見出しの ID と同じにしてください.</p>
+</div>
diff --git a/files/ja/orphaned/mdn/structures/macros/commonly-used_macros/creating_templates_for_multi-languages/index.html b/files/ja/orphaned/mdn/structures/macros/commonly-used_macros/creating_templates_for_multi-languages/index.html
new file mode 100644
index 0000000000..a22ce9c70e
--- /dev/null
+++ b/files/ja/orphaned/mdn/structures/macros/commonly-used_macros/creating_templates_for_multi-languages/index.html
@@ -0,0 +1,12 @@
+---
+title: creating templates for multi-languages
+slug: >-
+ MDN/Structures/Macros/Commonly-used_macros/creating_templates_for_multi-languages
+---
+<div>{{MDNSidebar}}</div>
+<div class="note"><strong>註:</strong> このページは執筆中です。</div>
+<h2 id="執筆用memo">執筆用memo</h2>
+<ul> <li>span 要素を使って言語版毎にテンプレートを用意するタイプの「ページ・プロパティ」は「なし(デフォルト)」にする。「English」などにするとテンプレートが英語版とその言語版とで二重に表示される現象が起きる。</li>
+</ul>
+<h2 id="テンプレートの_2_つのタイプ">テンプレートの 2 つのタイプ</h2>
+<h2 id="page.langage_を使わない">page.langage を使わない</h2>