翻訳への貢献

Playground のドキュメントをあらゆる言語に翻訳できます。このページでは、Playground ドキュメントの翻訳に貢献するための包括的なガイドを提供しています。

どうすれば翻訳に貢献できますか?

他のドキュメントページへの貢献と同じワークフローを使用します。WordPress/wordpress-playground をフォークして変更内容を PR として送信したり、GitHub UI を使用してページを直接編集したりできます。

情報

Playground Docs への貢献方法の詳細については、貢献するにはどうすればいいですか? を参照してください。

翻訳実装の詳細

情報

Docusaurus ウェブサイト (Playground Docs のエンジン) での翻訳管理の詳細については、Docusaurus Docs の国際化セクションを参照してください。

Docs サイトで利用可能な言語は、packages/docs/site/docusaurus.config.jsで定義されています。例:

i18n: {
  defaultLocale: 'en',
  path: 'i18n',
  locales: ['en', 'fr'],
  localeConfigs: {
	en: {
		label: 'English',
		path: 'en',
	},
	fr: {
		label: 'French',
		path: 'fr',
	},
  },
}

翻訳されたドキュメントページは、WordPress/wordpress-playground リポジトリにあります。

packages/docs/site/i18n/ の下には、各言語用のフォルダがあります。たとえば、es (スペイン語) の場合は、packages/docs/site/i18n/es フォルダがあります。

各言語フォルダの下には、docusaurus-plugin-content-docs/current フォルダがあります。例えば、es (スペイン語) の場合は、packages/docs/site/i18n/es/docusaurus-plugin-content-docs/current フォルダがあります。

docusaurus-plugin-content-docs/current の下に、元のドキュメントと同じファイル構造 (packages/docs/site/docs の下と同じファイル構造) が複製される必要があります。

たとえば、es (スペイン語) の場合、次の翻訳ファイルが存在します: packages/docs/site/i18n/es/docusaurus-plugin-content-docs/current/main/intro.md

言語のフォルダーにファイルがない場合、デフォルトの言語の元のファイルが読み込まれます。

新しい言語が追加されると (PR #1807 を参照)、packages/docs/site から npm run write-translations -- --locale <%LANGUAGE%> を実行して、特定の言語に翻訳できるメッセージを含む JSON ファイルを生成できます。

適切な i18n docusaurus.config.js 構成と i18n の下のファイルを使用して、プロジェクトのルートから npm run build:docs を実行すると、dist の下に各言語の特定のフォルダーが作成されます。

言語をローカルでテストする方法

既存の言語をローカルでテストするには、次のようにします。

利用可能な言語のいずれかの配下のファイルを変更（翻訳）します：packages/docs/site/i18n/{%LANGUAGE%}/docusaurus-plugin-content-docs/current
/packages/docs/site から、テストしたい言語のバージョンを実行します。例えば、es をテストするには次のようにします。

npm run dev -- --locale es

言語スイッチャー - 言語を変更するための UI 要素

「言語スイッチャー」は、Docusaurus (Playground Docs の背後にあるドキュメントエンジン) によって提供される UI 要素であり、ユーザーはこれを使用して特定のページの言語を変更できます。

翻訳版の可視性を高めるには、次の行を packages/docs/site/docusaurus.config.js に追加して言語スイッチャーを表示できます。

{
  type: 'localeDropdown',
  position: 'right',
},

これにより、ヘッダーにドロップダウンが生成され、各ファイルの言語バージョンに直接アクセスできるようになります。

このドロップダウンで特定の言語を有効にするのは、翻訳済みのページが十分に多い場合のみにすることを強くお勧めします。翻訳済みのページが少ない状態で有効にした場合、ユーザーはその言語に切り替えても、どのページもその言語に翻訳されないという状況に陥ります。

言語スイッチャーで言語を公開する

言語の i18n セットアップが完了し、i18n の下に正しいファイル構造が配置されると、すべての言語が利用できるようになります。

これらの言語バージョンのドキュメントは、その言語に翻訳されたページが十分に増えるまで、言語スイッチャーでは非表示にしておく必要があります。より正確に言うと、少なくともドキュメントセクションが特定の言語に完全に翻訳され、以下のセクションも含まれている場合にのみ、言語スイッチャーでその言語を公開することをお勧めします。

言語スイッチャーに特定の言語が表示されない場合でも、翻訳されたファイルを含む PR がマージされると翻訳されたページが公開されるため、翻訳されたページを追加する作業は引き続き進行します。

fr 言語がドキュメントハブページ (クイックスタートガイド、Playground Web インスタンス、Playground について、ガイドなど) が完全にフランス語に翻訳された最初の言語であると仮定すると、そのブランチの docusaurus.config.js は次のようになり、npm run build:docs によって fr サブサイトが適切に生成され、localeDropdown 言語スイッチャーにはフランス語のみが表示されます。

  {
    "i18n": {
      "defaultLocale": "en",
      "path": "i18n",
      "locales": [
        "en",
        "fr"
      ],
      "localeConfigs": {
        "en": {
          "label": "English",
          "path": "en"
        },
        "fr": {
          "label": "French",
          "path": "fr"
        }
      }
    }
  },
  {
    "type": "localeDropdown",
    "position": "right"
  }

言語スイッチャーをローカルでテストする

localeDropdown をローカルでテストしたところ、ローカルでは表示されるものの、翻訳されたページが見つからないため、期待通りに動作しないことがわかりました。しかし、本番環境では問題なく動作するようです。

どのフォークからでも localeDropdown をテストすることができ、プロジェクトのルートから実行できます。

npm run build:docs
npm run deploy:docs

これにより、フォークしたリポジトリの GitHub ページに 3 つのバージョンのドキュメントが生成されます。

https://<%GH-USER-WITH-FORK%>.github.io/wordpress-playground/
https://<%GH-USER-WITH-FORK%>.github.io/wordpress-playground/es/
https://<%GH-USER-WITH-FORK%>.github.io/wordpress-playground/fr/

localeDropdown 機能をテストするための 1 つの方法は、それをフォークされたリポジトリの GitHub Pages にデプロイすることです。

1 ページをある言語に翻訳するプロセス

推奨される方法は、.md ファイルを元のパス (packages/docs/site/docs) からコピーし、目的の言語パス (packages/docs/site/i18n/{%LANGUAGE%}/docusaurus-plugin-content-docs/current) に貼り付けることです。packages/docs/site/docs のファイル構造を複製することが重要です。

packages/docs/site/i18n/{%LANGUAGE%}/docusaurus-plugin-content-docs/current の下のファイルを翻訳し、新しい変更を PR に反映させることができます。

PR がマージされると、そのページの翻訳バージョンが https://wordpress.github.io/wordpress-playground/{%LANGUAGE%} の下に表示されます。

レビュープロセス

レビューのプロセスを円滑にするために、元のコンテンツを翻訳されたコンテンツの近くにコメントしておくことをお勧めします。たとえば、次のようになります。

<!--
👋 Hi! Welcome to WordPress Playground documentation.

Playground is an online tool to experiment and learn about WordPress. This site (Documentation) is where you will find all the information you need to start using Playground.
-->

👋 Olá! Bem vindo a documentação oficial do WordPress Playground.

WordPress Playground é uma ferramenta online onde podes testar e aprender mais sobre o WordPress. Nesta página(Documentação) irá encontrar todas as informações necessárias para começar a trabalhar com o Playground.

<!--
<p class="docs-hubs">The WordPress Playground documentation is distributed across four separate hubs (subsites):</p>
-->
<p class="docs-hubs">A documentação do WordPress Playground está dividida em quatro hubs(subsites):</p>

レビュープロセスを改善するには、PR の言語に一致するレビュアーを探してください。https://make.wordpress.org/polyglots/ に投稿し、ロケールタグ（例：日本語の場合は #ja）を付けてレビュアーを依頼してください。これにより、日本語の GTE に通知されます。

どうすれば翻訳に貢献できますか?​

翻訳実装の詳細​

言語をローカルでテストする方法​

言語スイッチャー - 言語を変更するための UI 要素​

言語スイッチャーで言語を公開する​

言語スイッチャーをローカルでテストする​

1 ページをある言語に翻訳するプロセス​

レビュープロセス​