ONLYOFFICEデスクトップエディターでプラグイン開発を有効にする方法

ONLYOFFICE Desktop Editorsには、「プラグイン開発を有効にする」というスイッチは記載されていません。推奨されるワークフローは、プラグインマネージャを使用して独自のプラグインをインストールし、ローカルのプラグインフォルダに配置し、必要に応じてインストール済みのコピーを作業用ソースフォルダへのシンボリックリンクに置き換えることです。エラーを検査したり、ブレークポイントを使用したりするには、ドキュメントに記載されているデバッグフラグを指定してデスクトップアプリを起動します。これらは別々の手順です。デバッグモードでは開発者ツールが公開され、プラグインをインストールまたはリンクするとエディタで使用できるようになります。

ONLYOFFICE APIの最新ドキュメントには、このデスクトップワークフローに関する記述があり、起動後もデバッグモードを有効にしておくためのフラグについても記載されています。これらの手順を変更する新しい開発モード切り替え機能に関する公式な通知は見つかりませんでした。このガイドは、2026年10月6日時点で公開されている公式の手順に基づいています。インストールタイプによってパスが異なる場合があるため、ファイルを変更する前にご使用のプラットフォームのパスを確認してください。

プラグイン開発ワークフローを選択してください

ほとんどの開発者にとって、アーカイブはプラグインの登録に一度だけ使用し、その後はシンボリックリンクを使用して繰り返し使用するのが適切です。デバッグフラグはコードの診断時のみ追加してください。開発者ツールを毎回起動時に必要としない限り、永続的なバージョンはオフにしておいてください。

プラグインファイルを準備する

config.jsonまず、プラグインに必要なファイル（およびを含む）が少なくとも含まれているローカルのプラグインディレクトリを作成しますindex.html。設定ファイルには有効なプラグインGUIDを指定し、ONLYOFFICEプラグインスキーマを使用してプラグインのエントリページとアセットを指定する必要があります。完全なスキーマについては、公式のサンプルプラグインまたはAPIドキュメントを参照してください。GUIDの形式が不正であったり、パスが壊れていたり、設定が無効であったりすると、プラグインが表示されない場合があります。

GUID はconfig.json通常 の形式ですasc.{YOUR-GUID}。デスクトップエディタは GUID をプラグインフォルダ名として使用しますが、asc.プレフィックスは省略します。ソースディレクトリ、アーカイブ、インストールパスで同じ GUID を使用してください。組み込みプラグインまたは他のインストール済みプラグインの GUID を再利用しないでください。

プラグインを初めてインストールする

1. プラグインのファイルとサブフォルダをZIPアーカイブにまとめてください。ファイル自体は、別のプロジェクトフォルダの中ではなく、アーカイブのルートディレクトリに配置する必要があります。
2. アーカイブ拡張子を から に変更し.zipます.plugin。
3. ONLYOFFICEデスクトップエディターを開き、「プラグイン」タブを選択して、「プラグインマネージャー」をクリックします。
4. 「マイプラグイン」を開き、「プラグインを手動でインストール」を選択し、.pluginファイルを選択して確認します。

プラグインは、開いているエディタの「プラグイン」タブ、および後から開いたエディタにも表示されます。手動でアーカイブをインストールする方法は、インターネット接続がなくても動作します。マーケットプレイスからのインストールは、すぐに使用できるプラグインを対象としており、独自の開発ビルドを読み込む方法の代替となるものではありません。

反復処理を高速化するためにシンボリックリンクを使用する

初回インストール後、Desktop Editorsはsdkjs-pluginsディレクトリにコピーを保存します。そのコピーをソースフォルダへのシンボリックリンクに置き換えて、作業ファイルを直接編集できるようにしてください。インストール済みのテストプラグインフォルダを変更する前に、Desktop Editorsを閉じてください。バックアップを作成するか、ソースフォルダが破損していないことを確認してから、テストプラグインのGUIDに一致するフォルダのみを削除してください。

ディレクトリ内では、リンク名はasc.プレフィックスを除いた中括弧内の GUID です。たとえば、構成 GUID が の場合asc.{91EAC419-EF8B-440C-A960-B451C7DF3A37}、フォルダ名またはリンク名は となります{91EAC419-EF8B-440C-A960-B451C7DF3A37}。

Windows

Windowsアカウントまたはポリシーで管理者権限が必要な場合は、コマンドプロンプトを管理者として開きます。エディタを閉じ、インストール済みのtest-pluginフォルダを別の場所に移動したら、ディレクトリリンクを作成します。

mklink /D "%LOCALAPPDATA%\ONLYOFFICE\DesktopEditors\data\sdkjs-plugins\{YOUR-GUID}" "C:\path\to\your\plugin"

両方のプレースホルダーをGUIDとソースディレクトリへのフルパスに置き換えてください。リンク先は既に存在していない必要があります。

macOS

ln -s "/path/to/your/plugin" "$HOME/Library/Application Support/asc.onlyoffice.ONLYOFFICE/data/sdkjs-plugins/{YOUR-GUID}"

Linux

ln -s "/path/to/your/plugin" "$HOME/.local/share/onlyoffice/desktopeditors/sdkjs-plugins/{YOUR-GUID}"

インストール済みのエディションのパスを使用してください。パッケージ版やサンドボックス版では、ユーザーデータが別の場所に保存されている場合があります。ソースを編集した後は、必要に応じてドキュメントを再度開くか、プラグインを再読み込みしてください。シンボリックリンクを使用するとアーカイブの再構築は不要になりますが、エディタがプラグインを再読み込みするまで変更が反映されない場合があります。

開発者ツールを備えたデスクトップエディタを起動します

プラグインをデバッグするには、デスクトップエディタを完全に終了し、次のコマンドで起動します--ascdesktop-support-debug-info。ご使用のオペレーティングシステムに応じたコマンドを使用してください。アプリをカスタムの場所にインストールした場合は、実行可能ファイルのパスを調整してください。

Windows

コマンドプロンプトで以下を実行してください。

"%ProgramFiles%\ONLYOFFICE\DesktopEditors\DesktopEditors" --ascdesktop-support-debug-info

または、ショートカットの「ターゲット」フィールドを編集し、実行可能ファイルのパスの後にスペースとフラグを追加してください。これにより、そのショートカットからの起動に影響します。

Linux

"/opt/onlyoffice/desktopeditors/DesktopEditors" --ascdesktop-support-debug-info

macOS

"/Applications/ONLYOFFICE.app/Contents/MacOS/ONLYOFFICE" --ascdesktop-support-debug-info

アプリが起動したら、ドキュメント内をクリックして を押すかF1、編集可能なツールバーフィールドを右クリックして「要素を検証」を選択します。開発者ツールで、プラグインの iframe を選択して、その JavaScript とログを検証します。 に渡されるコードはcallCommandという名前のエディターフレームで実行されるframeEditorため、エラーやブレークポイントはプラグインの UI コードとは異なるコンテキストで表示される場合があります。

オプションのフラグを--ascdesktop-support-debug-info-keep=1使用すると、起動後もデバッグモードが有効になります。永続的な状態を無効にするには、 を指定して起動します。デフォルトの状態に戻すには--ascdesktop-support-debug-info-keep=0を使用します--ascdesktop-support-debug-info-keep=default。永続的な開発者ツールは専用のテストマシンでは便利ですが、共有ワークステーションで有効にしたままにしておくと、ファイルが散乱し、必要のないときに検査ツールが利用可能になってしまいます。

開発環境が正常に動作することを確認してください。

• プラグインは、設定された名前で「プラグイン」タブに表示されます。
• ソースコードを変更した後、ドキュメントを再度開くかプラグインを再読み込みすると、更新された動作が表示されます。
• デバッグフラグを付けて起動した後、開発者ツールは「要素の検証」機能F1または「要素の検証」機能を通じて開きます。
• プラグインの iframe が選択されると、プラグイン UI コードのログが表示されます。ドキュメント コマンドは で検査されますframeEditor。

プラグインが見つからない場合は、config.jsonとindex.htmlがアーカイブのルートにあること、GUIDが有効であること、フォルダがasc.プレフィックスなしのGUIDを使用していることを確認してください。リンクがソースディレクトリを指しており、親ディレクトリを指していないことを確認してください。プラグインは表示されるものの、古いビルドのように動作する場合は、ドキュメントを閉じて再度開き、エディタがリンクされたファイルを再読み込みするようにしてください。

この設定では以下のことはできません

デスクトップデバッグフラグは、プラグイン開発におけるグローバルな権限スイッチではありません。アーカイブをインストールするか、サポートされているプラ​​グインディレクトリにフォルダを配置することでプラグインが使用可能になります。デバッグフラグは検査ツールを公開するものです。同様に、WebエディタにURLでプラグインを読み込む手順は、デスクトップエディタには自動的に適用されません。上記のデスクトップ固有のインストールおよびデバッグワークフローを使用してください。

これらの手順は、ONLYOFFICEデスクトップエディター用のプラグインに関するものです。DocSpaceでのプラ​​グインの有効化、ONLYOFFICE Docsでのサーバー側プラグインの設定、またはマーケットプレイスへのプラグインの公開方法については説明していません。これらの手順については、対応する公式製品ドキュメントを参照してください。

公式資料

• ONLYOFFICE：プラグインの開発
• ONLYOFFICE：デスクトップエディタ向けプラグインの開発
• ONLYOFFICE：デスクトップエディタへのプラグインのインストールとテスト
• ONLYOFFICE: デスクトップエディタをデバッグモードで実行
• ONLYOFFICE：デスクトップエディタにおけるプラグインのデバッグ
• ONLYOFFICE：公式プラグインのサンプルとソースリポジトリ