ONLYOFFICE Desktop Editors にプラグインを追加する方法
重要: 本手順は ONLYOFFICE Desktop Editors 4.1.2 以降で、プラグイン（サードパーティーアドオン）がサポートされています。ソースコードは GitHub で公開され、ライセンスは AGPL v.3（エディタ本体）と MIT（プラグイン）です。
概要
ONLYOFFICE Desktop Editors は、オフラインで文書、スプレッドシート、プレゼンテーションを編集できるデスクトップ用のアプリケーションです。バージョン 4.1.2 からはサードパーティー製のプラグインを導入できます。プラグインを利用すると、OCR、音声読み上げ、YouTube 挿入、クリップアート、チェスなどの機能をエディタに追加できます。
前提条件
- ONLYOFFICE Desktop Editors がインストール済みであること。Debian/Ubuntu/Mint や Red Hat 系のインストール手順は公式ドキュメントを参照してください。
- Git が使える環境（プラグインリポジトリのクローン用）。
- 選んだプラグインフォルダに config.json、index.html、pluginCode.js が含まれていること。
プラグインをダウンロードする
プラグインのソースは GitHub にあり、ライセンスは MIT です。リポジトリ全体をローカルに複製するには次のコマンドを実行します。
git clone https://github.com/ONLYOFFICE/sdkjs-plugins.gitこのコマンドで得られるフォルダ内に各プラグインのサンプルと実装が含まれています。
使いたいプラグインを選ぶ
リポジトリ内の各フォルダから必要なプラグインを選択します。主な提供プラグイン例:
- YouTube: 文書やスライドに YouTube の動画を挿入します。
- OCR: 画像やスクリーンショットからテキストを認識します。
- Speech: 選択したテキストを音声に変換します。
- ClipArt: クリップアートを挿入します。
- Chess: 文書内でチェスをプレイできます。
選定のヒント: OCR は画像の解像度や言語に依存します。Speech は対応する音声エンジンやブラウザ API の違いで挙動が異なる場合があります。
選んだプラグインをエディタに追加する手順
- 選択したプラグインのフォルダを開きます。
- フォルダ内に次のファイルがあることを確認します: config.json、index.html、pluginCode.js。
- これらのファイルをすべて選択してアーカイブ（zipなど）します。
- 作成したアーカイブの拡張子を
.pluginに変更します。 - Desktop Editors のメイン画面に
.pluginファイルをドラッグ＆ドロップします。
ヒント: アーカイブ作成時に余分な階層が入るとプラグインが認識されないことがあります。config.json と index.html がアーカイブのルートにあることを確認してください。
プラグインを使う
ドキュメントを開くか新規作成します。左側パネルに「プラグイン」アイコンが表示されます。クリックすると追加済みプラグインの一覧が開きます。
プラグインのアイコンまたは矢印をクリックして機能を展開します。たとえば ClipArt の場合はクリップアート一覧が表示され、カーソルを置いた位置へ挿入できます。
よくある問題と対処法
- プラグインが表示されない: アーカイブ内のファイル構成を確認してください。config.json がない、またはパスが異なると読み込めません。
- 機能が動作しない: プラグインが外部 API（YouTube、音声合成など）を使う場合、ネットワークや API の利用制限が原因になることがあります。
- OCR の精度が低い: 入力画像の解像度を上げるか、前処理（傾き補正、コントラスト調整）を行ってください。
重要: セキュリティの観点から不明な提供元のプラグインは実行しないでください。プラグインは任意のスクリプトを含むため、信頼できるソースのみを使用します。
代替アプローチ
- 公式マーケットプレイスや組織内の配布サーバー経由で管理されたプラグイン配布を検討する。集中管理すればセキュリティと互換性の確認が容易になります。
- カスタム機能が少数であれば、外部ツールで処理してから結果を文書に貼り付けるワークフロー（例: OCR を外部サービスで実行してからテキストを挿入）も実用的です。
開発者向けミニメソッド（自分でプラグインを作る手順）
- リポジトリのサンプルを参考に新規フォルダを作成する。
- config.json でメタ情報と権限を定義する。
- index.html で UI を作る。シンプルな HTML+CSS を推奨。
- pluginCode.js で ONLYOFFICE API を使ってエディタと連携する。
- ローカルで動作確認後、ファイルをアーカイブして .plugin として読み込む。
注意: API の詳細は ONLYOFFICE の公式 API ドキュメントを参照してください。
役割別チェックリスト
- ユーザー
- 必要なプラグインをダウンロードして .plugin にする
- Desktop Editors にドラッグ＆ドロップして動作確認する
- 管理者
- 組織で許可するプラグイン一覧を作成する
- 配布済みプラグインのバージョン管理と安全性を確認する
- 開発者
- config.json の権限設定を最小限にする
- ブラウザコンソールでエラーを監視する
テストケースと受け入れ条件
- 成功条件: プラグインを追加後、エディタのプラグインパネルに表示され、機能を実行できる。
- 失敗条件: config.json が欠落している、またはアーカイブ内の構成が正しくない場合は読み込みに失敗する。
互換性と移行の注意点
- ONLYOFFICE のメジャーバージョンアップ時に API が変更される可能性があります。アップグレード前にプラグインの互換性を検証してください。
- プラグインは OS（Windows/Mac/Linux）上の Desktop Editors で動作しますが、プラットフォーム固有の差異（ファイルパスや外部コマンド呼び出し）に注意が必要です。
マインドセットと判断基準
- 目的に合うかを最優先に: 即時の利便性が重要か、長期的な保守性が重要かで実装方針が変わります。
- セキュリティ優先: 未検証プラグインは隔離環境で動作確認してから本番利用します。
参考リンク
- ONLYOFFICE Desktop Editors 公式ドキュメント
- ONLYOFFICE API ドキュメント
- dev.onlyoffice.org（サポートフォーラム）
要点まとめ
- プラグインは GitHub の sdkjs-plugins リポジトリから入手できます。
- 必要ファイルをアーカイブして拡張子を .plugin に変更し、エディタにドラッグ＆ドロップします。
- セキュリティ、互換性、テストを事前に確認してください。
短いお知らせ（社内配信用） ONLYOFFICE Desktop Editors に外部プラグインを追加できるようになりました。必要なプラグインは GitHub リポジトリから取得し、.plugin ファイルをエディタにドラッグ＆ドロップするだけで利用可能です。詳細は公式ドキュメントを参照してください。
