Como habilitar o desenvolvimento de plugins nos editores de desktop do ONLYOFFICE

O ONLYOFFICE Desktop Editors não possui documentação para uma opção "Habilitar desenvolvimento de plugins". O fluxo de trabalho recomendado é instalar seu próprio plugin através do Gerenciador de Plugins, colocá-lo na pasta de plugins local e, opcionalmente, substituir a cópia instalada por um link simbólico para sua pasta de código-fonte. Para inspecionar erros e usar pontos de interrupção, inicie o aplicativo desktop com a flag de depuração documentada. Esses são passos distintos: o modo de depuração expõe as ferramentas de desenvolvedor, enquanto instalar ou vincular o plugin o torna disponível para o editor.

A documentação atual da API do ONLYOFFICE descreve esse mesmo fluxo de trabalho para desktop e também documenta uma opção para manter o modo de depuração ativado entre as inicializações. Não encontrei nenhum aviso oficial sobre uma nova opção de ativação/desativação do modo de desenvolvimento que altere essas etapas. Este guia segue as instruções oficiais disponíveis em 6 de outubro de 2026. Os caminhos podem variar de acordo com o tipo de instalação, portanto, confirme o caminho para sua plataforma antes de alterar os arquivos.

Escolha um fluxo de trabalho de desenvolvimento de plugins

AbordagemIdeal paraTroca
Instale um .pluginarquivo compactado no Gerenciador de Plugins.Primeira instalação, testes rápidos ou alterações ocasionais.Simples e com suporte, mas você precisa recompilar e reinstalar o arquivo após cada alteração no código-fonte.
Vincule a pasta do plugin instalado à sua pasta de origem.Edições frequentes durante o desenvolvimentoRemove a duplicação de pacotes, mas requer o caminho correto para cada usuário e uma recarga ou reabertura do sistema para que as alterações sejam aplicadas.
Inicie com a flag de depuração.Inspecionando a saída do console, os frames do plugin ou os pontos de interrupção.Habilita ferramentas de desenvolvedor; não instala nenhum plugin nem carrega automaticamente código não confiável.

Para a maioria dos desenvolvedores, use o arquivo compactado uma única vez para registrar o plugin e, em seguida, utilize um link simbólico para iterações futuras. Adicione a flag de depuração apenas ao diagnosticar o código. Deixe a variante persistente desativada, a menos que você precise das ferramentas de desenvolvedor em cada inicialização.

Prepare os arquivos do plugin.

Comece com um diretório de plugins local contendo pelo menos os arquivos necessários para o seu plugin, incluindo `plugins.json` config.jsone ` index.htmlplugins.xml`. O arquivo de configuração deve ter um GUID de plugin válido e apontar para a página inicial e os recursos do plugin usando o esquema de plugins do ONLYOFFICE. Use os plugins de exemplo oficiais ou a documentação da API para obter o esquema completo; um GUID malformado, um caminho quebrado ou uma configuração inválida podem impedir que o plugin seja exibido.

O GUID config.jsongeralmente tem o formato ` asc.{YOUR-GUID}<GUID>`. O Desktop Editors usa o GUID como nome da pasta do plugin, mas omite o asc.prefixo. Mantenha o mesmo GUID no diretório de origem, no arquivo compactado e no caminho de instalação. Não reutilize o GUID de um plugin integrado ou de outro plugin instalado.

Instale o plugin pela primeira vez.

  1. Coloque os arquivos e subpastas do plugin em um arquivo ZIP. Os arquivos em si devem estar na raiz do arquivo compactado, e não dentro de uma pasta de projeto separada.
  2. Alterar a extensão do arquivo de .zippara .plugin.
  3. Abra o ONLYOFFICE Desktop Editors, selecione a aba Plugins e clique em Gerenciador de Plugins .
  4. Abra "Meus plugins" , escolha "Instalar plugin manualmente" , selecione o .pluginarquivo e confirme.

O plugin deverá aparecer na aba Plugins do editor aberto e em editores abertos posteriormente. O método de arquivamento manual funciona sem conexão com a internet. A instalação pelo Marketplace destina-se a plugins prontos para uso; não substitui o carregamento de sua própria versão de desenvolvimento.

Use um link simbólico para uma iteração mais rápida.

Após a primeira instalação, o Desktop Editors armazena uma cópia em um sdkjs-pluginsdiretório. Substitua essa cópia por um link simbólico para sua pasta de origem para que você possa editar os arquivos de trabalho diretamente. Feche o Desktop Editors antes de alterar a pasta do plugin de teste instalado. Mantenha um backup ou certifique-se de que sua pasta de origem esteja intacta e remova apenas a pasta que corresponde ao GUID do seu plugin de teste.

Sistema operacionalDiretório de plugins do usuário
Windows%LOCALAPPDATA%\ONLYOFFICE\DesktopEditors\data\sdkjs-plugins\
macOS~/Library/Application Support/asc.onlyoffice.ONLYOFFICE/data/sdkjs-plugins/
Linux~/.local/share/onlyoffice/desktopeditors/sdkjs-plugins/

Dentro do diretório, o nome do link é o GUID entre chaves, sem o asc.prefixo. Por exemplo, se o GUID de configuração for asc.{91EAC419-EF8B-440C-A960-B451C7DF3A37}, o nome da pasta ou do link será {91EAC419-EF8B-440C-A960-B451C7DF3A37}.

Windows

Abra o Prompt de Comando como administrador, caso sua conta ou política do Windows exija isso. Após fechar os editores e mover a pasta do plugin de teste instalado para outro local, crie o link do diretório:

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

Substitua ambos os marcadores de posição pelo GUID e pelo caminho completo do seu diretório de origem. O destino do link não deve existir.

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}"

Use os caminhos da sua edição instalada; versões empacotadas ou em sandbox podem armazenar dados do usuário em outro local. Após editar o código-fonte, reabra o documento ou recarregue o plugin, conforme necessário. O link simbólico evita a reconstrução do arquivo, mas as alterações podem não ser aplicadas até que o editor recarregue o plugin.

Inicie editores de desktop com ferramentas de desenvolvedor.

Para depurar um plugin, feche completamente o Desktop Editors e inicie-o novamente com o comando --ascdesktop-support-debug-info`. Use o comando correspondente ao seu sistema operacional; se você instalou o aplicativo em um local personalizado, ajuste o caminho do executável.

Windows

Execute o seguinte comando no Prompt de Comando:

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

Como alternativa, edite o campo Destino de um atalho adicionando um espaço e o sinalizador após o caminho do executável. Isso afetará as execuções por meio desse atalho.

Linux

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

macOS

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

Com o aplicativo em execução, clique dentro de um documento e pressione F1, ou clique com o botão direito do mouse em um campo editável da barra de ferramentas e escolha Inspecionar elemento . Nas ferramentas de desenvolvedor, selecione o iframe do plugin para inspecionar seu próprio JavaScript e registros. O código passado para callCommandé executado no frame do editor, chamado frameEditor, portanto, seus erros e pontos de interrupção podem aparecer em um contexto diferente do código da interface do usuário do plugin.

A flag opcional --ascdesktop-support-debug-info-keep=1mantém o modo de depuração ativado entre as execuções. Para desativar o estado persistente, execute com `--disable-debug` --ascdesktop-support-debug-info-keep=0; use `--disable-debug` --ascdesktop-support-debug-info-keep=defaultpara retornar ao estado padrão. Ferramentas de desenvolvimento persistentes são convenientes em uma máquina de teste dedicada, mas mantê-las ativadas em uma estação de trabalho compartilhada adiciona desordem e mantém as ferramentas de inspeção disponíveis quando você não precisa delas.

Verifique se a configuração de desenvolvimento funciona.

  • O plugin aparece com o nome que configurou na aba Plugins.
  • Após uma alteração na fonte, reabrir o documento ou recarregar o plugin exibirá o comportamento atualizado.
  • As ferramentas de desenvolvedor são abertas com F1ou através da opção Inspecionar elemento após a inicialização com a flag de depuração.
  • Os registros do código da interface do usuário do plugin aparecem quando o iframe do plugin é selecionado; os comandos do documento são inspecionados em frameEditor.

Se o plugin estiver faltando, verifique se ele config.jsonestá index.htmlna raiz do arquivo, se o GUID é válido e se a pasta usa o GUID sem o asc.prefixo. Confirme se o link aponta para o diretório de origem e não para um diretório pai que o contenha. Se o plugin aparecer, mas se comportar como uma versão antiga, feche e abra o documento novamente para que o editor recarregue os arquivos vinculados.

O que esta configuração não permite

O parâmetro de depuração para desktop não é uma permissão global para o desenvolvimento de plugins. Instalar um arquivo ou colocar uma pasta no diretório de plugins suportados torna o plugin disponível; o parâmetro de depuração expõe as ferramentas de inspeção. Da mesma forma, as instruções para carregar um plugin por URL em um editor web não se aplicam automaticamente a editores de desktop. Use o fluxo de trabalho de instalação e depuração específico para desktop descrito acima.

Estas instruções dizem respeito a plugins para os editores de desktop do ONLYOFFICE. Elas não explicam como ativar plugins no DocSpace, como configurar plugins do lado do servidor no ONLYOFFICE Docs ou como publicar um plugin no Marketplace. Para esses fluxos de trabalho, consulte a documentação oficial do produto correspondente.

Referências oficiais

Deixar um comentário

Como conectar os editores de desktop do ONLYOFFICE a um servidor ownCloud

Como conectar os editores de desktop do ONLYOFFICE a um servidor ownCloud

Conecte os editores de desktop ONLYOFFICE ao seu servidor ownCloud, faça login, abra arquivos na nuvem, gerencie a conexão e solucione problemas comuns de configuração.

Como corrigir o alto uso da CPU no Collabora Online causado pelo loolwsd / coolwsd

Como corrigir o alto uso da CPU no Collabora Online causado pelo loolwsd / coolwsd

Solucione problemas de alto uso da CPU no Collabora Online identificando processos de kit ocupados, verificando métricas e logs, ajustando a simultaneidade e a limpeza, e verificando as correções com segurança.

Como personalizar o ONLYOFFICE Docs com seu logotipo e cores.

Como personalizar o ONLYOFFICE Docs com seu logotipo e cores.

Aprenda como personalizar o ONLYOFFICE Docs com um logotipo de cabeçalho e cores de interface, incluindo limites de licença, configuração JSON do tema, caminhos do Docker e testes.

Fix Dark Mode Text Visibility Issues in LibreOffice Calc

Fix Dark Mode Text Visibility Issues in LibreOffice Calc

Fix hard-to-read text in LibreOffice Calc by checking the app theme, cell font and fill colors, styles, and conditional formatting—then verify print output.

Corrigir o erro “Documento bloqueado por usuário desconhecido” no LibreOffice

Corrigir o erro “Documento bloqueado por usuário desconhecido” no LibreOffice

Remova o aviso de bloqueio de usuário desconhecido do LibreOffice com segurança. Verifique as sessões ativas, proteja uma cópia, remova apenas bloqueios obsoletos verificados e teste o documento.

Corrigir texto árabe e hebraico da direita para a esquerda no LibreOffice Writer

Corrigir texto árabe e hebraico da direita para a esquerda no LibreOffice Writer

Corrija textos em árabe ou hebraico que fluem, se alinham ou se misturam incorretamente com o inglês no LibreOffice Writer. Ative o layout de texto complexo, defina a direção do parágrafo e verifique o resultado.

LibreOffice Calc VLOOKUP vs XLOOKUP: A Beginner-Friendly Functions Guide

LibreOffice Calc VLOOKUP vs XLOOKUP: A Beginner-Friendly Functions Guide

Learn VLOOKUP and XLOOKUP in LibreOffice Calc, including exact matches, left lookups, not-found results, reverse search, INDEX/MATCH alternatives, and common errors.

Como corrigir o erro “Falha na validação da prova WOPI” no Collabora Online

Como corrigir o erro “Falha na validação da prova WOPI” no Collabora Online

Solucione problemas de falhas na validação de provas WOPI do Collabora Online verificando chaves de descoberta, rotação de chaves, URLs de proxy, carimbos de data/hora e listas de permissões de hosts.

Como ativar o controle de alterações por padrão no ONLYOFFICE Docs

Como ativar o controle de alterações por padrão no ONLYOFFICE Docs

Ative o recurso "Controlar alterações" para todos em um documento do ONLYOFFICE, mantenha-o ativo após a reabertura e entenda as limitações de uma configuração padrão global.

Como configurar os tempos limite de inatividade para sessões de edição do Collabora

Como configurar os tempos limite de inatividade para sessões de edição do Collabora

Compare os tempos limite por visualização, fora de foco, ociosidade do documento, salvamento automático e proxy do Collabora Online e, em seguida, escolha e verifique as configurações para sua implementação.