Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MDN/Writing_guidelines/Howto/Write_an_api_reference/Sidebars を更新 #22755

Merged
merged 2 commits into from
Aug 1, 2024
Merged

MDN/Writing_guidelines/Howto/Write_an_api_reference/Sidebars を更新 #22755

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3081740
2024/07/26 時点の英語版に基づき更新
mfuji09 Jul 28, 2024
a4ca5f3
Update index.md
mfuji09 Aug 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 11 additions & 19 deletions files/ja/mdn/writing_guidelines/howto/write_an_api_reference/sidebars/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: API リファレンスサイドバー
slug: MDN/Writing_guidelines/Howto/Write_an_api_reference/Sidebars
l10n:
sourceCommit: 188594e189f5e73267faf2626adbb84d26128b15
---

{{MDNSidebar}}
Expand Down Expand Up @@ -59,12 +61,12 @@ API サイドバーを作成するには、次の 3 つの手順を実行する
そのため、例えば "Response" とすると、 以下のようなリンクが生成されます。

```html
<li><a href="/ja/docs/Web/API">Response</a></li>
<li><a href="/ja/docs/Web/API/Response">Response</a></li>
```

いくつかの例外があります。
例えば "guides" サブメンバーには、関連するガイド/チュートリアルへのリンクを定義するリンク情報 (タイトルとスラッグ) が 1 つ以上含まれています。
この場合、スラッグは MDN の docs ルート — `https://developer.mozilla.org/_<言語コード>/docs` — の最後に追加され、MDN のどこにでも記事を含めることができます。
例えば "guides" サブメンバーには、関連するガイド/チュートリアルを指す URL が含まれています。
この場合、URL は MDN の docs ルートの最後 — `https://developer.mozilla.org/<言語コード>` — の最後に追加され、MDN のどこにでも記事を含めることができます。

以下が利用可能なメンバーです。
これらはすべて技術的にはオプションですが、これらを省略する代わりに空の配列を含めることを強く推奨します。
Expand All @@ -75,28 +77,18 @@ API サイドバーを作成するには、次の 3 つの手順を実行する
"Response" の場合は [https://developer.mozilla.org/ja/docs/Web/API/Response](/ja/docs/Web/API/Response) へのリンクが生成されます。
3. `"methods"` — 値は、 {{domxref("Navigator")}} や {{domxref("Window")}} で生成されたインスタンス化メソッドなど、仕様が他の API に関連付けられたインターフェイスに追加するメソッドを含む配列です。
膨大な数のメソッドがある場合は、最も人気のあるものだけをリストアップするか、リストの先頭に置くことを検討するとよいでしょう。
"fetch()" を実行すると [https://developer.mozilla.org/ja/docs/Web/API/fetch](/ja/docs/Web/API/fetch) へのリンクが張られます。
"fetch()" は [https://developer.mozilla.org/ja/docs/Web/API/Window/fetch](/ja/docs/Web/API/Window/fetch) へのリンクが張られます。
同じ API が所有するインターフェイスのメンバーであるメソッドを重複してリストアップしないようにしましょう。
4. `"properties"` — 値は、 API に関連付けられたすべてのプロパティを含む配列です。
これには API 仕様で定義されているインターフェイスのメンバーであるプロパティや、API が他のインターフェイス上で定義しているプロパティを含めることができます。
膨大な数のプロパティがある場合は、最も人気のあるものだけをリストアップするか、リストの先頭に配置することを検討するとよいでしょう。
"Headers.append" を実行すると、 [https://developer.mozilla.org/ja/docs/Web/API/Headers/append](/ja/docs/Web/API/Headers/append) へのリンクが生成されます。
5. `"events"` — 値は、 API の仕様やその他の場所で定義されている API に関連するすべてのイベントを含む配列です。
5. `"events"` — 値は配列で、API の一部であるイベントの_title_が格納され、APIの_not_部分であるインターフェイスで定義されます(API内のインターフェイス(`interfaces`)に属するイベントは既定では文書化されます)。
mfuji09 marked this conversation as resolved.
Show resolved Hide resolved
膨大な数のイベントがある場合は、最も人気のあるものだけをリストアップするか、リストの先頭に置くことを検討するとよいでしょう。
"animationstart" を実行すると、 [https://developer.mozilla.org/ja/docs/Web/Events/animationstart](/ja/docs/Web/API/Element/animationstart_event) へのリンクが生成されます。
6. `"guides"` — 値は、API の使用方法を説明するガイドへのリンクを定義する1つ以上のオブジェクトを含む配列です。
各オブジェクトは、ガイド記事を指す部分的な URL を含む "url" と、リンクのリンクテストを定義する "title" の2つのサブメンバーを含みます。
例として、次のようなオブジェクトがあります。

```json
{
"url": "/docs/Web/API/Detecting_device_orientation",
"title": "Detecting device orientation"
}
```

"Detecting device orientation" というタイトルのリンクを生成し、 [https://developer.mozilla.org/ja/docs/Web/API/Device_orientation_events/Detecting_device_orientation](/ja/docs/Web/API/Device_orientation_events/Detecting_device_orientation) を指すようにします。

例えば、`"Document: selectionchange"` は [選択 API](/ja/docs/Web/API/Selection_API) の一部ですが、`Document` はそうではないので、配列にイベントを追加し、[選択 API](/ja/docs/Web/API/Selection_API) のトピックからリンクします。
6. `"guides"` — 値は文字列の配列で、それぞれが API を使用する方法を説明するガイドトピックに対応しています。
文字列は、言語パスの後のガイドの URL アドレスの部分が入ります。すなわち、ガイド URL の`/docs/...` の部分です。
例えば、`https://developer.mozilla.org/ja/docs/Web/API/Fetch_API/Using_Fetch` にあるトピック「フェッチの使用」にリンクする場合、ガイドの配列には "/docs/Web/API/Fetch_API/Using_Fetch " が入ります。
7. `"dictionaries"` — API の一部であるすべての辞書を一覧にした文字列の配列。
一般的に、特別な意味がある場合や、複数のページから参照する必要がある場合を除き、複数のプロパティやメソッドで使用される辞書のみをここにリストアップすべきです。
"CryptoKeyPair" は [https://developer.mozilla.org/ja/docs/Web/API/CryptoKeyPair](/ja/docs/Web/API/CryptoKeyPair) へのリンクを生成します。
Expand Down
Loading