Pular para o conteúdo
Idiomas · Português (Brasil)

Criar um plugin do PolyPDF | Guia do desenvolvedor

Adicione os símbolos do seu escritório ao PolyPDF. Sem código, sem mercado, sem fila de aprovação.

Aplicativo atual: PolyPDF 1.5.2 (build 24) · Formato do pacote: PolyPDF 1.3.1+ · A instalação e execução de plug-ins requer PolyPDF Pro em 1.4.1+

Se sua equipe carimbar a mesma seta norte, triângulo de revisão ou etiqueta de sala em cada folha, você mesmo poderá embalar esse conjunto e entregá-lo aos seus colegas como um único arquivo. É necessário um editor de texto, uma ferramenta de desenho e Node. Construir um pacote é gratuito; instalar, executar e editar o conteúdo do plug-in no aplicativo atual requer o PolyPDF Pro.

Um plugin são dados, não um programa

  • Um plugin PolyPDF é uma pasta assinada de arte e JSON. Não há ponto de entrada JavaScript e nada no pacote é executado.
  • Seu pacote fornece um catálogo de símbolos, a arte SVG e um formulário descrito em JSON. PolyPDF renderiza o formulário, executa seu próprio gerador e adiciona o resultado ao desenho como anotações comuns em uma única etapa que pode ser revertida.
  • A troca é deliberada: você desiste do comportamento arbitrário e, em troca, seu plug-in não pode vazar os desenhos de um cliente, não pode quebrar seu aplicativo e não precisa de nenhum processo de revisão antes que alguém possa instalá-lo com segurança.

O que as pessoas constroem com isso

  • Setas norte correspondentes ao norte verdadeiro de uma folha, triângulos de revisão, etiquetas de salas e equipamentos, marcadores de detalhes, símbolos de soldagem, símbolos ADA e de segurança contra incêndio, legendas de serviços públicos - um conjunto de símbolos padrão do próprio escritório, sempre carimbados no tamanho de impressão correto.
  • Os símbolos são colocados em polegadas, mantêm suas proporções desenhadas, giram e podem carregar uma legenda - embaixo para uma seta norte, dentro da forma para um número de revisão ou número de sala.
  • Uma vez colocadas, elas são anotações normais: selecionáveis, móveis, estilizáveis, exportáveis e ainda estão lá se o plugin for posteriormente desligado ou removido.

O que um plugin nunca pode fazer

  • Execute o código. Sem JavaScript, sem WASM, sem biblioteca nativa.
  • Alcance a rede. Nenhum pedido, de qualquer tipo, jamais - obras de arte que contenham uma referência externa são recusadas no momento da instalação, precisamente para que um símbolo não possa telefonar para casa quando uma folha for aberta.
  • Leia seus documentos. Um plugin informa o tamanho da página, a rotação e onde você clicou. Nem o texto, nem as anotações, nem o nome do arquivo, nem os bytes do PDF.
  • Toque nos seus arquivos, veja os detalhes da sua licença, altere uma anotação existente ou salve qualquer coisa.
  • Isso é arquitetônico, não uma política que prometemos aplicar: não há API para nada disso.

O que você escreve

Um plugin é uma pasta. O manifesto descreve o que é e o que adiciona ao menu Ferramentas; o catálogo lista seus símbolos e seus tamanhos impressos; os ativos são arquivos SVG simples.

my-plugin/
  manifest.json          identity, permissions, commands, the form
  data/symbols.json      each symbol: id, label, artwork, size in inches
  assets/*.svg           the artwork
  icons/icon.png         optional, 256 x 256

Como você constrói

Um arquivo, sem dependências, Node 18 ou mais recente. Ele valida todo o pacote antes de escrever qualquer coisa – layout, manifesto, nomes de permissão, seu catálogo e se sua arte é aceitável – e nomeia o arquivo e a correção para qualquer coisa errada.

curl -O https://www.polypdf.com/plugins/polypdf-plugin-pack.mjs

node polypdf-plugin-pack.mjs keygen --out ~/.polypdf-keys
node polypdf-plugin-pack.mjs pack my-plugin --key ~/.polypdf-keys/polypdf-plugin-key.pem

Em seguida, instale-o no PolyPDF: Plug-ins… ▸ Instalar a partir do arquivo.

Sobre essa assinatura

Você assina com uma chave gerada por você e o PolyPDF é cuidadoso com o que isso significa - tanto para você quanto para as pessoas para quem você envia o arquivo.

  • Ele confirma que o pacote não foi alterado desde que você o construiu e fixa seu plugin à sua chave: uma atualização assinada por qualquer outra pessoa é recusada.
  • Uma assinatura não é uma revisão ou aprovação do PolyPDF. Os plug-ins fornecidos dentro do PolyPDF são assinados pela PolyPDF; um plug-in que você mesmo assina é uma camada separada e claramente identificada.
  • Qualquer pessoa que instalar seu plug-in verá primeiro uma tela de consentimento: o que ele pode fazer em linguagem simples, a impressão digital da sua chave e a soma de verificação do pacote. Sua linha no Plugin Manager diz Instalado a partir de um arquivo enquanto estiver instalado.
  • Faça backup de sua chave privada. Como as instalações estão fixadas nele, uma chave perdida significa que os usuários devem desinstalar antes de poderem fazer a próxima versão.

O guia completo

A referência completa – cada campo de manifesto, o formato do pacote, as regras de arte, controle de versão, distribuição e uma seção de solução de problemas – vem com o PolyPDF em docs/plugins/PLUGIN-AUTHORING.md, junto com um plugin de exemplo funcional que você pode construir e instalar em cerca de um minuto.

Não há mercado. Um arquivo de plugin é a distribuição: coloque-o na sua intranet, em um release ou em um email. Publique sua soma de verificação e sua impressão digital ao lado do download e qualquer pessoa poderá verificar se obteve seu arquivo e não o de outra pessoa.

Perguntas

Se o tempo de execução não puder expressar a tarefa de desenho que você tem em mente, diga-o em vez de contorná-la – novos tempos de execução são fornecidos com o aplicativo, e saber o que as pessoas realmente precisam é como o próximo será escolhido.

Contate o suporte