Instalar plugins no ONLYOFFICE Desktop Editors

O que são plugins do ONLYOFFICE

Plugins (ou add-ons) estendem a funcionalidade dos editores de documentos, planilhas e apresentações do ONLYOFFICE, permitindo tarefas como OCR, inserção de vídeos do YouTube, conversão de texto em fala, cliparts e até jogos simples como xadrez.

Definição rápida: plugin — pacote com arquivos (config.json, index.html, pluginCode.js) que o editor carrega para oferecer funcionalidades adicionais.

Importante: Desde a versão 4.1.2, o ONLYOFFICE Desktop Editors é distribuído sob a licença AGPL v3. O código-fonte está disponível no GitHub.

Faixa de uso e casos de uso

• Inserir vídeos do YouTube em documentos e apresentações.
• Fazer OCR (reconhecimento de texto) em imagens e capturas de tela.
• Converter trechos de texto em fala (TTS).
• Inserir cliparts e objetos prontos em documentos.
• Adicionar entretenimento ou demonstrações (ex.: jogar xadrez dentro de um documento).

Requisitos mínimos

• ONLYOFFICE Desktop Editors 4.1.2 ou superior.
• Acesso ao repositório de plugins (GitHub) ou arquivos de plugin prontos.
• Permissões de leitura/escrita no diretório local onde vai empacotar o plugin (para usuários que instalam localmente).

Baixando os plugins disponíveis

O código-fonte dos plugins está disponível no GitHub sob licença MIT. Para clonar o repositório completo, execute:

git clone https://github.com/ONLYOFFICE/sdkjs-plugins.git

Abra a pasta clonado e navegue até o plugin desejado.

Como escolher um plugin

Abra a pasta do repositório e selecione o plugin que atenda à sua necessidade. Exemplos disponíveis:

• YouTube — inserir vídeos do YouTube.
• OCR — reconhecer texto em imagens e screenshots.
• Speech — selecionar texto e converter em fala.
• ClipArt — inserir cliparts prontos.
• Chess — jogar xadrez dentro do documento.

Dica: leia o arquivo README dentro da pasta do plugin para ver dependências específicas ou requisitos adicionais.

Empacotando e instalando um plugin

Mini-metodologia (passos claros):

1. Abra a pasta do plugin escolhido. Ela deve conter pelo menos estes arquivos: config.json, index.html e pluginCode.js.
2. Selecione todos os arquivos do plugin.
3. Compacte-os em um arquivo ZIP ou similar (no seu gerenciador de arquivos preferido).
4. Renomeie a extensão do arquivo compactado para .plugin (por exemplo: meu-plugin.plugin).
5. Abra o ONLYOFFICE Desktop Editors.
6. Arraste e solte o arquivo .plugin na página principal do editor (drag-and-drop) ou siga a interface de importação se disponível.

Nota: O empacotamento deve manter a estrutura de arquivos do plugin; não coloque a pasta inteira do repositório dentro do zip, apenas os arquivos do plugin.

Usando plugins dentro do editor

1. Abra ou crie um documento no ONLYOFFICE Desktop Editors.
2. No painel esquerdo aparecerá o ícone Plugins. Clique nele para ver a lista de plugins instalados.

3. Clique na seta ao lado do plugin desejado para abrir suas opções e iniciar a ação (por exemplo, listar cliparts).
4. Para inserir um clipart, posicione o cursor no local desejado e clique no item desejado.

O clipart selecionado será inserido no documento.

Checklist por função

Administrador (instalação em múltiplas máquinas ou ambiente corporativo):

• Verificar versão mínima do ONLYOFFICE (>= 4.1.2).
• Auditar e aprovar plugins por política interna de segurança.
• Distribuir plugins empacotados para usuários ou via imagem/deploy centralizado.
• Testar plugins em ambiente de homologação antes de liberar produção.

Usuário final (instalação local):

• Confirmar presença de config.json, index.html e pluginCode.js no pacote.
• Empacotar corretamente em .plugin.
• Fazer backup de documentos antes de testar plugins novos se estiver inseguro.

Alternativas e quando não usar plugins

• Se a sua organização proíbe execução de código de terceiros, prefira ferramentas nativas ou extensões oficiais suportadas.
• Para integração avançada entre sistemas, uma API server-side pode ser mais apropriada do que um plugin local.
• Quando precisar de suporte centralizado e gerenciamento de versões, use um processo de deployment corporativo em vez de instalações ad-hoc por usuários.

Compatibilidade e migração

• Plugins desenvolvidos para a API do ONLYOFFICE podem exigir ajustes ao migrar entre grandes versões do editor.
• Antes de atualizar o ONLYOFFICE em produção, valide os plugins críticos em um ambiente de teste.
• Mantenha controle de versão dos plugins (por exemplo, tag no repositório) para poder reverter se necessário.

Solução de problemas comum

• Plugin não aparece no painel: verifique se o arquivo .plugin contém config.json na raiz e está nomeado com extensão .plugin.
• Plugin carrega, mas falha ao executar: abra as ferramentas de desenvolvedor (se disponível) para ver erros no console e verifique dependências referenciadas por URL.
• Funcionalidade limitada: alguns plugins podem depender de acesso à internet (ex.: YouTube). Confirme conectividade e políticas de firewall.

Segurança e privacidade

• Plugins podem executar código dentro do contexto do editor; utilize apenas plugins de fontes confiáveis.
• Em ambientes que tratam dados sensíveis, evite plugins que enviem conteúdo a terceiros sem controle explícito.
• Consulte a política de segurança e conformidade da sua organização antes de instalar plugins.

Glossário rápido

• AGPL v3: licença de software livre que exige distribuição do código-fonte quando o software é disponibilizado.
• config.json: arquivo de configuração do plugin com metadados e permissões.
• .plugin: extensão usada pelo ONLYOFFICE para pacotes de plugins.

Links úteis

• Documentação oficial de instalação do ONLYOFFICE Desktop Editors: https://www.onlyoffice.com/
• Documentação da API para criar plugins: https://api.onlyoffice.com/
• Fórum e suporte para desenvolvedores: https://dev.onlyoffice.org/

Resumo final

Instalar um plugin no ONLYOFFICE Desktop Editors é um processo simples: baixar o código, empacotar os arquivos necessários, renomear a extensão para .plugin e carregar no editor. Para ambientes corporativos, aplique checklist de segurança, teste em homologação e gerencie versões. Use alternativas server-side quando a execução local for proibida ou insegura.

Extras: se for criar seu próprio plugin, leia a documentação da API do ONLYOFFICE e siga boas práticas de empacotamento e segurança.