PolyPDF-Plugin erstellen | Entwicklerleitfaden
Fügen Sie die Symbole Ihres Büros zu PolyPDF hinzu. Kein Code, kein Marktplatz, keine Genehmigungswarteschlange.
Aktuelle App: PolyPDF 1.5.2 (Build 24) · Paketformat: PolyPDF 1.3.1+ · Für die Installation und Ausführung von Plugins ist PolyPDF Pro in 1.4.1+ erforderlich
Wenn Ihr Team auf jedes Blatt den gleichen Nordpfeil, das gleiche Revisionsdreieck oder die gleiche Raumbeschriftung stempelt, können Sie diesen Satz selbst verpacken und als einzelne Datei an Ihre Kollegen weitergeben. Es erfordert einen Texteditor, ein Zeichenwerkzeug und Node. Das Erstellen eines Pakets ist kostenlos; Für die Installation, Ausführung und Bearbeitung von Plugin-Inhalten in der aktuellen App ist PolyPDF Pro erforderlich.
Ein Plugin sind Daten, kein Programm
- Ein PolyPDF-Plugin ist ein signierter Ordner mit Grafiken und JSON. Es gibt keinen JavaScript-Einstiegspunkt und nichts im Paket wird jemals ausgeführt.
- Ihr Paket enthält einen Symbolkatalog, die SVG-Grafik dafür und ein in JSON beschriebenes Formular. PolyPDF rendert das Formular, führt seinen eigenen Generator aus und fügt das Ergebnis als normale Anmerkungen in einem einzigen rückgängig zu machenden Schritt zur Zeichnung hinzu.
- Der Tausch ist gewollt: Sie geben willkürliches Verhalten auf, und im Gegenzug kann Ihr Plugin die Zeichnungen eines Kunden nicht preisgeben, seine App nicht kaputt machen und benötigt keinen Überprüfungsprozess, bevor jemand es sicher installieren kann.
Was Menschen damit bauen
- Nordpfeile, die an den wahren Norden eines Blattes angepasst sind, Revisionsdreiecke, Raum- und Gerätebeschriftungen, Detailmarkierungen, Schweißsymbole, ADA- und Brandschutzsymbole, Hinweise zu Versorgungseinrichtungen – ein büroeigener Standardsymbolsatz, der immer in der richtigen Druckgröße gestempelt wird.
- Symbole werden in einer Größe in Zoll platziert, behalten ihre gezeichneten Proportionen bei, drehen sich und können eine Beschriftung tragen – darunter für einen Nordpfeil, innerhalb der Form für eine Revisionsnummer oder eine Raumnummer.
- Sobald sie platziert sind, handelt es sich um normale Anmerkungen: auswählbar, verschiebbar, gestaltbar, exportierbar und immer noch vorhanden, wenn das Plugin später ausgeschaltet oder entfernt wird.
Was ein Plugin niemals kann
- Code ausführen. Kein JavaScript, kein WASM, keine native Bibliothek.
- Erreichen Sie das Netzwerk. Keine Anfragen jeglicher Art – Kunstwerke mit einer externen Referenz werden zum Zeitpunkt der Installation abgelehnt, damit ein Symbol beim Öffnen einer Seite nicht angezeigt werden kann.
- Lesen Sie Ihre Dokumente. Einem Plugin werden die Seitengröße, die Drehung und die Stelle mitgeteilt, auf die Sie geklickt haben. Nicht der Text, nicht die Anmerkungen, nicht der Dateiname, nicht die PDF-Bytes.
- Berühren Sie Ihre Dateien, sehen Sie sich Ihre Lizenzdetails an, ändern Sie eine vorhandene Anmerkung oder speichern Sie alles.
- Dies ist architektonischer Natur und keine Richtlinie, deren Durchsetzung wir versprechen: Für nichts davon gibt es eine API.
Was du schreibst
Ein Plugin ist ein Ordner. Das Manifest beschreibt, was es ist und was es zum Menü „Extras“ hinzufügt. Der Katalog listet Ihre Symbole und ihre gedruckten Größen auf. Bei den Assets handelt es sich um einfache SVG-Dateien.
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
Wie Sie es bauen
Eine Datei, keine Abhängigkeiten, Knoten 18 oder höher. Es validiert das gesamte Paket, bevor es etwas schreibt – Layout, Manifest, Berechtigungsnamen, Ihren Katalog und ob Ihr Bildmaterial akzeptabel ist – und benennt die Datei und den Fix für etwaige Fehler.
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
Dann installieren Sie es in PolyPDF: Plugins… ▸ Aus Datei installieren.
Über diese Unterschrift
Sie signieren mit einem von Ihnen generierten Schlüssel, und PolyPDF achtet sorgfältig darauf, was das bedeutet – sowohl für Sie als auch für die Personen, an die Sie die Datei senden.
- Es bestätigt, dass das Paket seit der Erstellung nicht verändert wurde, und befestigt Ihr Plugin an Ihrem Schlüssel: Ein von jemand anderem signiertes Update wird abgelehnt.
- Eine Signatur ist keine PolyPDF-Überprüfung oder -Genehmigung. Die in PolyPDF enthaltenen Plugins sind von PolyPDF signiert. Ein Plugin, das Sie selbst signieren, ist eine separate, klar gekennzeichnete Ebene.
- Jeder, der Ihr Plugin installiert, sieht zuerst einen Zustimmungsbildschirm: Was es im Klartext tun kann, den Fingerabdruck Ihres Schlüssels und die Paketprüfsumme. In der Zeile im Plugin-Manager heißt es Aus einer Datei installiert solange es installiert ist.
- Sichern Sie Ihren privaten Schlüssel. Da Installationen daran angeheftet sind, bedeutet ein verlorener Schlüssel, dass Ihre Benutzer die Installation deinstallieren müssen, bevor sie Ihre nächste Version verwenden können.
Der vollständige Leitfaden
Die vollständige Referenz – jedes Manifestfeld, das Paketformat, die Gestaltungsregeln, Versionierung, Verteilung und ein Abschnitt zur Fehlerbehebung – wird mit PolyPDF geliefert unter docs/plugins/PLUGIN-AUTHORING.md, zusammen mit einem funktionierenden Beispiel-Plugin, das Sie in etwa einer Minute erstellen und installieren können.
Es gibt keinen Marktplatz. Eine Plugin-Datei ist die Verteilung: Platzieren Sie sie in Ihrem Intranet, in einer Veröffentlichung oder in einer E-Mail. Veröffentlichen Sie die Prüfsumme und Ihren Schlüssel-Fingerabdruck neben dem Download, und jeder kann bestätigen, dass er Ihre Datei erhalten hat und nicht die einer anderen Person.
Fragen
Wenn die Laufzeit die Zeichnungsaufgabe, die Sie im Kopf haben, nicht ausdrücken kann, sagen Sie es, anstatt sie zu umgehen – neue Laufzeiten werden mit der App ausgeliefert, und wenn Sie wissen, was die Leute tatsächlich brauchen, wird die nächste ausgewählt.