diff --git a/@l10n/ja/resources/contribute-documentation/index.md b/@l10n/ja/resources/contribute-documentation/index.md index 7ce7e90cb4..da794ab6a5 100644 --- a/@l10n/ja/resources/contribute-documentation/index.md +++ b/@l10n/ja/resources/contribute-documentation/index.md @@ -103,22 +103,26 @@ Markdownファイルのページは、[frontmatterスタンザ](#frontmatterの 新機能を文書化する場合、その機能が導入されたプログラムのバージョンを示すバッジを含めてください。バッジタグは以下の構造です。 -`{badge href="myurl" date="<リリース日>"}新規: <プログラム> <バージョン番号>{% /badge%}` +

+{% badge href="myurl" date="<リリース日>" %}新規: <プログラム> <バージョン番号>{% /badge%}
+
例えば次のようなバッジ定義になります。 -`{% badge href="https://github.com/XRPLF/clio/releases/tag/2.0.0" date="February 18, 2024" %}新規: Clio v2.0.0{% /badge %}` +

+{% badge href="https://github.com/XRPLF/clio/releases/tag/2.0.0" date="February 18, 2024" %}新規: Clio v2.0.0{% /badge %}
+
次のように表示されます。 {% badge href="https://github.com/XRPLF/clio/releases/tag/2.0.0" date="February 18, 2024" %}新規: Clio v2.0.0{% /badge %} -When updating a feature, replace _New in:_ with _Updated in:_. For example, the following badge definition: - 機能の更新の場合、_新規:_ を _更新:_ に置き換えてください。例えば、次のバッジ定義となります。 `{% badge href="https://github.com/XRPLF/clio/releases/tag/2.1.0" date="May 4, 2024" %} 更新: Clio v2.1.0{% /badge %}` 次のように表示されます。 {% badge href="https://github.com/XRPLF/clio/releases/tag/2.1.0" date="May 4, 2024" %} 更新: Clio v2.1.0{% /badge %} +いくつかのフレーズは自動的にバッジの色を設定し、また`color="purple"`のような色のパラメータをタグに追加することで色を明示的に設定できます。 + 2年以上前の新規/更新バッジは削除するのがベストプラクティスです。 ### 技術用語 @@ -140,10 +144,13 @@ When updating a feature, replace _New in:_ with _Updated in:_. For example, the | トランザクションコスト | トランザクション手数料 | XRP Ledgerでトランザクションを送信するために消費されるXRPの金額。これはトランザクションの`Fee`フィールドで指定されますが、_手数料_ という用語は誰かにお金を支払うことを意味するため、_コスト_ の方が望ましいです。 | | トークン | IOU, issuances, issues, 発行済み通貨 | XRP Ledgerのトークンは、_IOU_ という名前から想像されるように、レジャーの外部にある価値を表すことはできません。必要であれば、_代替可能トークン_ を使用して、非代替性トークン(NFT)と区別してください。 | | ウォレット | ウォレット | 文脈によっては、_ウォレット_ はハードウェア、ソフトウェア、暗号鍵ペア、またはオンラインサービスを指します。意味が明確になるように十分な文脈を提供するか、_キーペア_ や _クライアントアプリケーション_ などの別の表現を使用してください。 | +| WebSocket | web socket, Websockets | Web上での双方向プロトコル。常に単数形でCamelCaseで記述してください。 | | XRP | Ripple, リップル | XRP Ledgerのネイティブデジタルアセットまたは暗号通貨。XRPはレジャーの外部の価値を表すトークンではありません。 | | XRP Ledger | Ripple, リップル, Ripple Network, リップルネットワーク, RCL | XRP Ledgerは、過去に様々な場面で「リップルネットワーク」や「リップルコンセンサスレジャー」あるいは「RCL」と呼ばれていました。これらの名称は、コアサーバのリファレンス実装を開発しているRipple(Ripple Labs)の社名と類似しているため、紛らわしく、廃止されました。 | | XRPL | XRPL | _XRP Ledger_ の略です。_XRPL_ は不明瞭で、_XRP_ のタイプミスのように見えることがあります。 | + + ## Frontmatterのフィールド ***Note: Realmのfrontmatter仕様の詳細は完全には文書化されていません。Realmがクローズドベータを終了したら、リンクを更新する必要があります。*** @@ -175,11 +182,7 @@ navigation: --- ``` -## Markdocのコンポーネント - -これらのファイルは[Markdoc](https://markdoc.dev/)で処理されるため、`{% ... %}`構文で特別なタグを含めることができます。Redoclyの組み込みタグに加えて、このリポジトリには`/@theme/markdoc/`に定義されたいくつかのカスタムタグがあります。 - -### グラフィック +## グラフィック `/docs/img`ディレクトリにグラフィックを保存します。グラフィックを埋め込むには、次の構文を使用します。 @@ -189,7 +192,7 @@ navigation: ![XRPL財団のロゴ](/docs/img/xrplf-logo.png) -### ビデオ +## ビデオ ビデオはYouTubeに保存されます。アップロード後、埋め込み手順をコピーしてドキュメントに貼り付けることができます。 @@ -215,7 +218,7 @@ si=Mbi8diaFTDR2fc20" title="YouTube video player" frameborder="0" allow="acceler autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen> -### テーブル +## テーブル Markdocは、テーブルを生成するための3つの異なる構文スタイルを提供します。 @@ -283,7 +286,7 @@ Markdocは、テーブルを生成するための3つの異なる構文スタイ 可能な限り、これらの基本的なテーブルを使用してください。上記の例で提供されていない特別なフォーマットが本当に必要な場合は、HTML構文を使用してテーブルを作成できます。 -### リンク +## リンク リンクは`[<リンクテキスト>]()`の構文を使用します。 @@ -295,11 +298,11 @@ Markdocは、テーブルを生成するための3つの異なる構文スタイ [XRPL.org](http://xrpl.org)で世界のあらゆる問題の解決策をご覧ください。 -### 共通のリンク +## 共通のリンク 共通的に引用されるページへのリンクを作成するには、`{% raw-partial file="/docs/_snippets/common-links.md /%}`タグをMarkdownファイルに追加し、`[account_infoメソッド][]`や`[Paymentトランザクション][]`などの参照スタイルのリンクを使用できます。common-linksファイルの内容はアルファベット順になっています。(以前はスクリプトで生成されていましたが、現在は手動で管理されています。) -### サンプルコード +## サンプルコード サンプルコードを挿入する場合は、バッククォート(`)文字でコードを囲みます。例えば: @@ -313,14 +316,16 @@ Markdocは、テーブルを生成するための3つの異なる構文スタイ 例えば、 -```javascript
-    const prepared = await client.autofill({
-      "TransactionType": "Payment",
-      "Account": standby_wallet.address,
-      "Amount": xrpl.xrpToDrops(sendAmount),
-      "Destination": standbyDestinationField.value
-  }) -``` +

+```javascript
+const prepared = await client.autofill({
+    "TransactionType": "Payment",
+    "Account": standby_wallet.address,
+    "Amount": xrpl.xrpToDrops(sendAmount),
+    "Destination": standbyDestinationField.value
+})
+```
+
次のように表示されます。 @@ -333,6 +338,14 @@ Markdocは、テーブルを生成するための3つの異なる構文スタイ }) ``` +## Markdocのコンポーネント + +これらのファイルは[Markdoc](https://markdoc.dev/)で処理されるため、`{% ... %}`構文で特別なタグを含めることができます。Redoclyの組み込みタグに加えて、このリポジトリには`/@theme/markdoc/`に定義されたいくつかのカスタムタグがあります。 + +### バッジ + +[新機能](#新機能)をご覧ください。 + ### 部分的なコンテンツ 頻繁に使用するテキストや、ドキュメント内の複数の場所で定期的に更新が必要なテキストがある場合は、再利用のために_snippetファイルを作成できます。 @@ -370,5 +383,78 @@ There I was, happy as a lark, skipping through the daisies, when I shyly handed Alas, if only I had heeded that sage advice, I would not rue the day as I do today. +### Not-Enabledバッジ + +{% not-enabled /%} Markdocコンポーネントは、その機能が本番環境のXRP Ledgerでは利用できないことを示すツールチップ付きの黄色いフラスクアイコンを表示します。投票中だが現在有効になっていない修正についての説明で使用します。例: {% not-enabled /%} + +このタグは自己終了型で、パラメータは必要ありません。 + +### リポジトリリンク + +このタグは、通常コードサンプルである、このサイトのソースコードリポジトリの特定のファイルへのリンクを作成します。例えば、 + +

+{% repo-link path="_code-samples/build-a-desktop-wallet/js/1_ledger-index.js" %}`1-ledger-index/index.js`{% /repo-link %}
+
+ +次のようになります: {% repo-link path="_code-samples/build-a-desktop-wallet/js/1_ledger-index.js" %}`1-ledger-index/index.js`{% /repo-link %} + +サイトのフォークやブランチで作業している場合、サイト設定の変更で一度にすべてのリンクを更新できます。 + + +### 試してみる + +`{% try-it ... /%}` Markdocタグは、WebSocketツールへのリンクをボタンとして提供する便利なショートカットです。このタグは自己終了型です。 + +{% try-it method="account_currencies" server="testnet" /%} + +構文例: + +

+{% try-it method="account_currencies" server="testnet" /%}
+
+ + +ボタンのテキストは英語では "Try it!" で、ローカライゼーションの`translations.yaml`ファイルの`component.tryit`キーを設定することで翻訳できます。 + +このタグは以下のパラメータを受け付けます: + +| パラメータ | 必須? | 説明 | +| ---------- | ----- | ---- | +| `method` | はい | WebSocketツールページで使用するアンカーのID。ほとんどの WebSocket API メソッドでは、これはまさにその API メソッドですが、それ以上のものも含む可能性があります。例えば、異なる `ledger_entry` のバリエーションには、`ledger_entry-nft-page` のような接尾辞が使用されます。新しいメソッドを文書化する場合は、`/resources/dev-tools/components/websocket-api/data/command-list.json` を編集して、そのメソッドを WebSocket ツールに追加する必要があります。 | +| `server` | いいえ | リクエストに使用する特定のサーバ。Clio または `rippled` サーバに固有のメソッドを使用する場合、または、例で使用するデータやAmendmentが特定のテストネットワーク上のみにある場合、サーバを指定する必要があります。 | + +`server`パラメータには以下の値を指定できます。 + +| `server`値 | 使用するサーバ | +| -------------- | ------------- | +| (省略) | デフォルトのサーバ (現在は`s1.ripple.com`) | +| `s1` | RippleのMainnet公開クラスタ`s1.ripple.com`（通常Clioサーバーが提供） | +| `s2` | RippleのMainnetフルヒストリ公開クラスタ`s2.ripple.com`（通常Clioサーバーが提供） | +| `xrplcluster` | 軽量プロキシを前面に配置した`rippled`サーバーが提供する`xrplcluster.com`公開サーバークラスタ | +| `devnet` | テストネットサーバのクラスタ`s.altnet.rippletest.net` | +| `testnet` |開発ネットサーバのクラスタ`s.devnet.rippletest.net` | + +### トランザクション例 + +`{% tx-example ... /%}`Markdocタグは、特定の例示トランザクションを検索するためのボディが事前に入力されたWebSocketツールへのリンクをボタンとして提供する便利なショートカットです。このタグは自己終了型です。例として、 + +{% tx-example txid="1AF19BF9717DA0B05A3BFC5007873E7743BA54C0311CCCCC60776AAEAC5C4635" /%} + +構文例: + +

+{% tx-example txid="1AF19BF9717DA0B05A3BFC5007873E7743BA54C0311CCCCC60776AAEAC5C4635" /%}
+
+ +ボタンのテキストは通常英語では"Query example transaction"で、ローカライゼーションの`translations.yaml`ファイルの`component.queryexampletx`キーを設定することで翻訳できます。 + +このタグは以下のパラメータを受け付けます。 + +| パラメータ | 必須? | 説明 | +| ---------- | ------ | ---- | +| `txid` | はい | 検索するトランザクションの一意のハッシュ。 | +| `server` | いいえ | リクエストに使用する特定のサーバ。可能な値は上記の`{% try-it %}`で定義されているものと同じです。例えば、Mainnetでは有効になっていないAmendmentによって追加されたトランザクションを表示するためには`devnet`を指定する必要があります。 | + {% child-pages /%} diff --git a/resources/contribute-documentation/index.md b/resources/contribute-documentation/index.md index d0cc05fad7..0ce0efdc33 100644 --- a/resources/contribute-documentation/index.md +++ b/resources/contribute-documentation/index.md @@ -218,7 +218,7 @@ si=Mbi8diaFTDR2fc20" title="YouTube video player" frameborder="0" allow="acceler autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen> -### Tables +## Tables Markdoc provides three different syntax styles for generating tables. @@ -428,9 +428,9 @@ The values you can provide to the `server` parameter are as follows: | `server` value | Server to use | |---|---| -| (Omitted) | The WebSocket tool's default server (currently s1.ripple.com) | -| `s1` | Ripple's s1.ripple.com Mainnet public cluster, typically served by Clio servers. | -| `s2` | Ripple's s2.ripple.com Mainnet full-history public cluster, typically served by Clio servers. | +| (Omitted) | The WebSocket tool's default server (currently `s1.ripple.com`) | +| `s1` | Ripple's `s1.ripple.com` Mainnet public cluster, typically served by Clio servers. | +| `s2` | Ripple's `s2.ripple.com` Mainnet full-history public cluster, typically served by Clio servers. | | `xrplcluster` | The `xrplcluster.com` cluster of public servers, typically served by `rippled` servers with a lightweight proxy in front. | | `devnet` | The `s.altnet.rippletest.net` cluster of Testnet servers. | | `testnet` | The `s.devnet.rippletest.net` cluster of Devnet servers. |