PolyPDFプラグインの作成 | 開発者ガイド

オフィスのシンボルを PolyPDF に追加します。コードもマーケットプレイスも承認待ちもありません。

現在のアプリ: PolyPDF 1.5.2 (ビルド 24) · パッケージ形式: PolyPDF 1.3.1+ · プラグインのインストールと実行には、1.4.1+ の PolyPDF Pro が必要です

チームがすべてのシートに同じ方位記号、改訂三角形、または部屋タグをスタンプする場合、そのセットを自分でパッケージ化し、単一のファイルとして同僚に渡すことができます。これには、テキストエディター、描画ツール、およびノードが必要です。パッケージの構築は無料です。現在のアプリでプラグインコンテンツをインストール、実行、編集するには、PolyPDF Pro が必要です。

プラグインはプログラムではなくデータです

PolyPDF プラグインは、アートワークと JSON の署名付きフォルダーです。 JavaScript エントリポイントはなく、パッケージ内の何も実行されません。
パッケージには、シンボルカタログ、その SVG アートワーク、および JSON で記述されたフォームが含まれています。 PolyPDF は、取り消し可能な 1 回の手順でフォームをレンダリングし、独自のジェネレーターを実行し、その結果を通常の注釈として図面に追加します。
この取引は意図的です。恣意的な動作を放棄する代わりに、プラグインは顧客の図面を漏洩したり、アプリを破壊したりすることはなく、安全にインストールできるようになるまでの審査プロセスも必要ありません。

人々がそれを使って何を構築するか

シートの真北に一致する北向きの矢印、改訂三角形、部屋と機器のタグ、詳細マーカー、溶接記号、ADA および防火記号、公共設備の吹き出し - オフィス独自の標準記号セットであり、毎回正しい印刷サイズでスタンプされます。
シンボルはインチ単位のサイズで配置され、描画された比率を維持し、回転し、キャプションを付けることができます。キャプションを付けることができます。キャプションは下に北向き矢印、図形の内側にはリビジョン番号または部屋番号を表示します。
配置されると、これらは通常の注釈になります。選択可能、移動可能、スタイル設定可能、エクスポート可能で、後でプラグインをオフにしたり削除したりしても、そのまま残ります。

プラグインでは決してできないこと

コードを実行します。 JavaScript、WASM、ネイティブライブラリはありません。
ネットワークに到達します。いかなる種類のリクエストも一切ありません。外部参照を含むアートワークはインストール時に正確に拒否されるため、シートを開いたときにシンボルがホームに電話をかけることはできません。
書類を読んでください。プラグインには、ページのサイズ、回転、クリックした場所が通知されます。テキスト、注釈、ファイル名、PDF バイトではありません。
ファイルをタッチしたり、ライセンスの詳細を確認したり、既存の注釈を変更したり、何かを保存したりできます。
これはアーキテクチャ上のものであり、強制することを約束するポリシーではありません。いずれにも API はありません。

あなたが書くもの

プラグインはフォルダーです。マニフェストには、マニフェストの内容と、[ツール] メニューに何を追加するかが説明されています。カタログにはシンボルとその印刷サイズがリストされています。アセットはプレーンな SVG ファイルです。

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

どのように構築するか

1 ファイル、依存関係なし、Node 18 以降。レイアウト、マニフェスト、権限名、カタログ、アートワークが受け入れられるかどうかなど、何かを書き込む前にパッケージ全体を検証し、ファイルに名前を付け、問題があれば修正します。

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

次に、PolyPDF にインストールします。 プラグイン… ▸ ファイルからインストール.

そのサインについて

ユーザーは生成したキーを使用して署名します。PolyPDF は、それがユーザーとファイルの送信先の両方にとって何を意味するのかを考慮します。

パッケージがビルドされてから変更されていないことを確認し、プラグインをキーに固定します。つまり、他の人によって署名された更新は拒否されます。
署名は PolyPDF のレビューや承認ではありません。 PolyPDF 内に同梱されるプラグインは PolyPDF によって署名されています。自分で署名したプラグインは、明確にラベルが付けられた別の階層になります。
プラグインをインストールする人には、まず同意画面が表示されます。つまり、プラグインで何ができるか、キーのフィンガープリント、パッケージのチェックサムが平易な言葉で表示されます。プラグインマネージャーのその行には次のように書かれています ファイルからインストール インストールされている限り。
秘密キーをバックアップします。インストールはそれに固定されているため、キーを紛失した場合、ユーザーは次のリリースを使用する前にアンインストールする必要があります。

完全なガイド

The complete reference — every manifest field, the package format, the artwork rules, versioning, distribution and a troubleshooting section — ships with PolyPDF at docs/plugins/PLUGIN-AUTHORING.md、実際に動作するサンプルプラグインと一緒に、約 1 分で構築してインストールできます。

マーケットプレイスはありません。プラグインファイルは配布物です。イントラネット、リリース、または電子メールに配置します。ダウンロードの横にそのチェックサムとキーのフィンガープリントを公開すると、誰でも他人のファイルではなくあなたのファイルを取得したことを確認できます。

質問

ランタイムが意図した描画タスクを表現できない場合は、それを回避するのではなく、そう言ってください。新しいランタイムはアプリに同梱されており、ユーザーが実際に必要としているものを知ることで、次のランタイムがどのように選択されるかがわかります。

サポートに連絡する