ONLYOFFICE’s diary

OSSドキュメントエディタの使い方やヒントをご紹介します

ONLYOFFICE Plugin Marketplaceにプラグインを公開する方法

ここでは、プラグインを作成するための基本的なステップを順を追ってご説明します。

  1. 準備
  2. コーディング
  3. プラグインスタイルの調整
  4. ローカライズ
  5. プラグインを公開するための準備
  6. テスト
  7. 公開

ステップ1.準備

  1. プラグインを作成し、ONLYOFFICE Plugin Marketplaceで公開するには、GitHubにアカウントが必要です。既存のアカウントにサインインするか、新しいアカウントを作成してください。
  2. プラグインマーケットプレイスレポジトリをフォークしてください:https://github.com/ONLYOFFICE/onlyoffice.github.io。 次のアドレスでリポジトリを取得します https://github.com/YOUR-USERNAME/ONLYOFFICE/onlyoffice.github.io

  3. このリポジトリからあなた自身のGitHub Pagesサイトを構築し、後でウェブ版でプラグインをテストしてください。その方法をGitHubの公式ドキュメントでご参照ください。

  4. フォークをローカルコンピュータにクローンしてください。
  5. onlyoffice.github.io/sdkjs-plugins/content/プラグイン用のフォルダを追加してください。

https://api.onlyoffice.com/content/img/plugins/new-folder.png

ステップ2.コーディング

プラグインを開発します。ここでプラグイン構造の説明書に従ってください。プラグインフォルダには、プラグインが動作するために必要な3つのファイル、config.jsonindex.htmlpluginCode.jsが含まれている必要があります。

https://api.onlyoffice.com/content/img/plugins/plugins-structure.png

プラグインのコードを書くときは、プラグインメソッドイベントをご利用ください。

ステップ3. プラグインスタイルを調整する

ONLYOFFICEスタイルシートindex.htmlファイルに追加し、プラグインをONLYOFFICEエディタスタイルに調整してください。

<link rel="stylesheet" href="https://onlyoffice.github.io/sdkjs-plugins/v1/plugins.css">

https://api.onlyoffice.com/content/img/plugins/controls.png

ステップ4.ローカライズ

翻訳を追加したい各言語のための.jsonファイルとプラグインディレクトリ内のtranslationsフォルダを作成します。ローカライズして翻訳を適用するには、このガイドに従ってください。

ステップ 5. プラグインを公開する

1.プラグインの「詳細情報(About)」ウィンドウを作成します。簡単な説明とプラグインのバージョン、開発会社名とそのHPへのリンクを追加してください。この説明書に従って、config.json ファイルに「詳細情報(About)」のバリエーションを作成しましょう。

https://api.onlyoffice.com/content/img/plugins/about-variation.png

2.プラグイン用のアイコンを用意し、resourcesフォルダに配置してください。この説明書に従って、config.jsonファイルにアイコンのパラメータを指定します。

プラグインマーケットプレイスで正しく表示されるためには、プラグイン用のアイコンを8個用意する必要があります。アイコンの拡大縮小は、ライトテーマ、ダークテーマともに4種類(125%, 150%, 175%, 200%)をご用意ください。

3.プラグインの詳細説明、インストールと使用方法、既知の問題などを追加できる readme ファイルを忘れないでください。このファイルは、メインのプラグインフォルダに配置してください。

ステップ6. テスト

準備したすべてのファイルをプラグインフォルダに入れ、リモートリポジトリにプッシュしてください。これで完了です。あとは、デスクトップ版やWeb版のONLYOFFICEエディタに接続して、テストしてみましょう。

1.ONLYOFFICE Desktop Editorsプラグインをテストしてください。

このアプリは、--ascdesktop-support-debug-infoフラグで、デバッグモードで実行することができます。これを行うには、使用するオペレーティングシステムに応じて、こちらのガイドに従ってください。

https://api.onlyoffice.com/content/img/plugins/hello-world.gif

2.Web版でプラグインをテストしてください。

拡張機能を作成するには、onlyoffice.github.io/store/plugin-dev/extension/inject.js ファイルを開き、URL_to_PLUGIN 変数に GitHub Pages サイトのプラグインへのパスを代入してください。

var URL_TO_PLUGIN = "https://YOUR-USERNAME.github.io/onlyoffice.github.io/sdkjs-plugins/content/helloworld/"

onlyoffice.github.io/store/plugin-dev/extensionフォルダは、新しい拡張機能です。それをブラウザにアップロードし、ONLYOFFICE Document Serverを実行し、プラグインマネージャプラグインを見つけてください。

これは、プラグインマネージャでプラグインを開き、ライトとダークテーマの両方でマイプラグインタブでどのように見えるかをチェックすることが重要であることに留意してください。必要であれば、プラグイン表示を改善してください。

https://api.onlyoffice.com/content/img/plugins/plugin-manager.png

ステップ7.プラグインを公開する

ONLYOFFICEプラグインマーケットプレイスで他のユーザーがあなたのプラグインを利用できるようにしたい場合、フォークからhttps://github.com/ONLYOFFICE/onlyoffice.github.ioプルリクエストを作成することによって公開を提案してください。プラグインが正しく動作すれば、プルリクエストは承認され、プラグインマーケットプレイスに表示されるようになります。

マーケットプレイスのリポジトリに課題を投稿することで、プラグインの開発について議論したり、機能をリクエストしたり、バグを報告したりすることができます。