Início
» Dicas para PC
»
Ativar o desenvolvimento e a depuração de plugins para desktop do ONLYOFFICE
Ativar o desenvolvimento e a depuração de plugins para desktop do ONLYOFFICE
Não é necessário ativar uma opção separada para desenvolvimento de plugins nos editores de desktop do ONLYOFFICE. Crie um plugin, instale o .pluginpacote através do Gerenciador de Plugins e inicie o aplicativo de desktop --ascdesktop-support-debug-infoquando precisar de ferramentas de depuração. Os editores de desktop e web utilizam procedimentos de carregamento diferentes, portanto, comece com o fluxo de trabalho específico para desktop descrito abaixo.
Prepare um pequeno projeto de plugin
Estas instruções aplicam-se aos editores de desktop ONLYOFFICE no Windows, macOS e Linux. Utilize uma instalação de desktop atualizada e um editor de código para arquivos de texto simples. A documentação oficial trata a instalação manual de plugins e a depuração por desenvolvedores como funcionalidades separadas; o Marketplace de Plugins não é necessário para desenvolver e testar um plugin local. Um exemplo "Olá, Mundo!" é uma verificação inicial útil, pois isola o carregamento do plugin de serviços mais complexos.
1. Crie a pasta de origem
Crie uma pasta chamada hello-world-plugin. Adicione um config.jsonarquivo de manifesto e um index.htmlponto de entrada. Opcionalmente, adicione uma icon.pngimagem se o seu manifesto fizer referência a uma. Mantenha a pasta fora do diretório de instalação do aplicativo para que as atualizações de software não sobrescrevam seus arquivos de trabalho.
Mantenha o manifesto do plugin e seu arquivo HTML de ponto de entrada juntos em uma pasta de desenvolvimento; um ícone local é opcional.
2. Defina o manifesto e gere seu próprio GUID.
O manifesto informa ao ONLYOFFICE qual arquivo HTML carregar e quais editores podem executar o plugin. O exemplo a seguir é compatível com o editor de documentos. Substitua o GUID de exemplo por um UUID recém-gerado antes da instalação: execute o comando New-Guidno Windows PowerShell ou uuidgenno macOS ou Linux e, em seguida, formate o valor como asc.{YOUR-UUID}. Cada plugin distinto precisa de seu próprio identificador.
Use JSON válido: sem vírgulas à direita, chaves correspondentes e um arquivo real para cada ponto de entrada ou ícone referenciado. Para um plugin de planilha ou apresentação, use os valores apropriados em EditorsSupportvez de presumir que um plugin exclusivo para documentos aparecerá em todos os lugares. Compare a estrutura com o guia de início rápido oficial do Hello World .
O arquivo config.json identifica o plugin e restringe seu uso aos editores que ele suporta.
3. Implemente o ponto de entrada.
Em index.html, carregue a biblioteca da API do plugin ONLYOFFICE, adicione um botão e faça com que o botão chame . O exemplo de início rápidowindow.Asc.plugin.executeMethod("PasteText", ["Hello World!"]) do fabricante fornece o HTML completo e o URL da biblioteca; copiar esse exemplo é mais seguro do que tentar adivinhar a inicialização ou a sintaxe da API. Salve o arquivo como UTF-8. Se você planeja trabalhar offline, lembre-se de que uma página que importa sua biblioteca de plugins ou outros recursos de um URL online ainda precisa que esses recursos sejam carregados.
O arquivo de ponto de entrada contém a interface e a chamada JavaScript que o editor utiliza quando o plugin é executado.
Instale e execute seu plugin de desenvolvimento.
4. Crie o arquivo .plugin
Selecione os arquivos dentro da pasta de origem, compacte-os em um arquivo ZIP e renomeie a extensão do ZIP de .zippara .plugin. A raiz do arquivo deve conter config.jsone index.html, e não um segundo hello-world-plugindiretório contendo os arquivos. No Windows, habilite a exibição de extensões de nome de arquivo no Explorador de Arquivos para evitar a criação acidental de arquivos hello-world.plugin.zip. . As instruções oficiais de instalação do Desktop Editors oferecem suporte explícito à instalação manual sem conexão com a Marketplace.
Antes de renomear o arquivo ZIP com a extensão .plugin, compacte o conteúdo da pasta do plugin, e não da pasta que a contém.
5. Importe o pacote do Gerenciador de Plugins.
Abra um documento editável no ONLYOFFICE Desktop Editors. Selecione Plugins > Gerenciador de Plugins > Meus plugins > Instalar plugin manualmente . A aparência exata do gerenciador pode variar de acordo com a versão, mas esta ação é o caminho de instalação manual documentado. Não se trata da configuração de URL de desenvolvedor separada do Marketplace.
Em um documento, abra Plugins, depois Gerenciador de Plugins e acesse Meus plugins para realizar a instalação manual.
6. Selecione o arquivo e verifique sua entrada no menu.
Selecione seu hello-world.pluginarquivo na caixa de diálogo de arquivos e abra-o. O plugin instalado deverá ficar disponível na aba Plugins. Caso não esteja presente, verifique o manifesto, o GUID, o tipo de editor compatível e o diretório raiz do arquivo antes de alterar as configurações do aplicativo. Se o menu não atualizar imediatamente após a instalação, tente reabrir o documento.
Na caixa de diálogo de seleção de arquivos, escolha o arquivo .plugin; não selecione a pasta de origem original.
7. Teste o plugin em um documento descartável.
Abra um documento de teste em branco, execute o plugin Hello World na aba Plugins e clique no botão correspondente. Confirme se as palavras " Hello World!" aparecem no documento. Isso verifica mais do que apenas a instalação: confirma que a interface do plugin foi carregada e que a chamada da API do editor alcançou o documento. Não teste plugins que alteram o conteúdo em um arquivo insubstituível.
Execute o plugin instalado dentro de um documento descartável e verifique o conteúdo do documento resultante.
Ative a depuração para o desenvolvimento de plugins.
8. Reinicie os Editores de Área de Trabalho com a flag de depuração.
Feche completamente o ONLYOFFICE Desktop Editors e, em seguida, inicie o aplicativo a partir de um terminal com a flag de depuração oficial. Use o comando correspondente ao seu sistema operacional e local de instalação:
Prompt de Comando do Windows:"%ProgramFiles%\ONLYOFFICE\DesktopEditors\DesktopEditors" --ascdesktop-support-debug-info
Linux (localização padrão do pacote):"/opt/onlyoffice/desktopeditors/DesktopEditors" --ascdesktop-support-debug-info
O comando do Windows acima usa a expansão de variáveis do Prompt de Comando, não a sintaxe do PowerShell; no PowerShell, chame o executável com seu caminho completo resolvido. Se o seu aplicativo foi instalado em um local não padrão, substitua o caminho real do executável. Você também pode adicionar o parâmetro ao campo Destino de um atalho na área de trabalho do Windows. Consulte os comandos de modo de depuração da área de trabalho do ONLYOFFICE para obter detalhes da plataforma.
Com o documento aberto, clique na área de edição e pressione F1 ou clique com o botão direito em um campo editável da barra de ferramentas e escolha " Inspecionar elemento" . Nas Ferramentas de Desenvolvedor, selecione o iframe do plugin para inspecionar o código da interface e os registros. O código passado para o plugin callCommandé executado no frameEditorcontexto, portanto, alterne entre os frames quando necessário. A referência de depuração do plugin explica essa distinção e como usar pontos de interrupção. A depuração pode expor o conteúdo do documento e detalhes de tempo de execução; não compartilhe registros brutos sem verificá-los.
Após ativar a depuração, inspecione o iframe do plugin relevante nas Ferramentas de Desenvolvedor; as mensagens do console aqui apresentadas são ilustrativas.
Reduza o ciclo de edição e teste sem modificar os plugins integrados.
Após a instalação manual, o ONLYOFFICE copia um plugin para um diretório com nome GUID dentro do seu perfil de usuário. Os locais documentados são: %LOCALAPPDATA%\ONLYOFFICE\DesktopEditors\data\sdkjs-plugins\no Windows, ~/Library/Application Support/asc.onlyoffice.ONLYOFFICE/data/sdkjs-plugins/no macOS e ~/.local/share/onlyoffice/desktopeditors/sdkjs-plugins/no Linux. A pasta com nome GUID omite o prefixo asc.usado no manifesto.
Para evitar a criação de um novo arquivo para cada alteração, os desenvolvedores podem fechar o aplicativo, substituir a pasta de plugins instalada por um link simbólico para a pasta de origem de trabalho e reabrir o documento após a edição. Isso é opcional e os comandos exatos para o link variam de acordo com o sistema operacional. Consulte as instruções oficiais de desenvolvimento para desktop antes de prosseguir. Não substitua as pastas de plugins padrão/inclusas nem modifique o pacote do aplicativo macOS: o fornecedor alerta que a remoção de plugins padrão pode comprometer a integridade do pacote e causar falhas.
Verifique a configuração de desenvolvimento.
Três verificações indicam que o fluxo de trabalho está pronto: o plugin personalizado aparece em Plugins , o teste "Olá Mundo" insere texto em um novo documento e as Ferramentas de Desenvolvedor abrem após a inicialização com a flag de depuração. Se a interface estiver em branco ou a instalação falhar, confirme se o manifesto é analisado como JSON, se o GUID começa com `<nome_do_plugin>` asc., index.htmlse existe no caminho relativo declarado e se todos os recursos necessários estão presentes. O guia oficial de erros do plugin aborda essas falhas comuns. Um plugin instalado não garante que todos os recursos implementados funcionem; repita a mesma verificação após cada alteração no código.