Erstellen Sie Ihre eigene benutzerdefinierte Erweiterung für PopClip

PopClip ist eine unserer beliebtesten Apps auf Mactuts + und einer der Gründe, warum Erweiterungen unterstützt werden. Sie können mit PopClip Aktionen für den ausgewählten Text ausführen, wodurch es vielseitig einsetzbar ist. Ob Sie einen Link in einem anderen Browser öffnen, den ausgewählten Text in Google suchen oder ihn als Aufgabe hinzufügen möchten, PopClip bietet einen iOS-Stil Ein Popup-Menü, mit dem Sie diese Aufgaben ganz einfach ausführen können.

In diesem Tutorial werde ich zeigen, wie einfach es ist, es zu erstellen dein eigenes Erweiterung für PopClip, um eine benutzerdefinierte Aktion auszuführen.


Was ist PopClip??


PopClip bietet ein Menü im iOS-Stil, das mit Erweiterungen weiter angepasst werden kann

PopClip (4,99 $) ist eine App für OS X, die bei der Textauswahl ein iOS-ähnliches Popup-Menü bietet. Es wird hauptsächlich zum Ausschneiden, Kopieren und Einfügen verwendet - wiederum sehr ähnlich wie bei iOS. Wo es wirklich interessant wird, ist die Möglichkeit, Erweiterungen zu installieren, um mehr zu tun, als nur die Zwischenablage hinzuzufügen.

Zum Zeitpunkt des Schreibens standen über 92 Erweiterungen zum kostenlosen Download zur Verfügung. Diese Erweiterungen reichen vom Öffnen eines Links in Google Chrome über die Veröffentlichung von ausgewähltem Text bei Facebook bis hin zu Anführungszeichen für ausgewählten Text und vieles mehr.

Spitze: Es gibt viele Erweiterungen, und ich möchte Sie dazu ermutigen, einen Blick darauf zu werfen, alle auf der PopClip-Erweiterungsseite.

Ich benutze regelmäßig PopClip und füge eine Erweiterung hinzu, um ausgewählten Dinge zu meiner Lieblings-App "Things" hinzuzufügen.


Wie sie gebaut sind

PopClip unterstützt Erweiterungen, die auf verschiedene Arten geschrieben werden:

  • Mac OS X-Dienst
  • AppleScript
  • Shell-Skript
  • URL
  • Tastendruck

Beide URL und Tastendruck Sie benötigen keine Programmierkenntnisse, um sie zu erstellen. Wenn Sie die URL einer Website kennen, die Text oder eine bestimmte Tastenkombination enthalten kann, können Sie eine eigene Erweiterung erstellen.

Die restlichen drei werden mit erstellt Skripting Sprachen. Sie können Text auf fortgeschrittenere Weise bearbeiten. Für dieses Tutorial werde ich eine Erweiterung mit der. Erstellen URL Methode.

EIN URL Die Erweiterung erfordert nur zwei Dateien, unsere Erweiterungskonfigurationsdatei und ein Symbol, das im Popup-Menü angezeigt wird, wenn wir Text auswählen.


Unser eigenes bauen

Es gibt eine große Auswahl an Erweiterungen, die wir verwenden können, aber es gibt keine, die genau zu unseren Anforderungen passt. Als Beispiel zeige ich Ihnen, wie Sie eine PopClip-Erweiterung erstellen, die Mactuts + nach dem ausgewählten Text durchsucht.

Um dies zu tun, werde ich Ihnen nicht zeigen, wie man einen von Grund auf neu erstellt, sondern stattdessen einen Teil des vom Entwickler bereitgestellten Beispielcodes verwenden und Änderungen vornehmen, um unsere Anforderungen zu erfüllen. So erhalten Sie eine gute Vorstellung davon, wie die Erweiterung funktioniert und welche Änderungen wir vornehmen müssen, um mit der Erstellung eigener Erweiterungen zu beginnen.

Tipp: Wir benötigen nur einen Texteditor, um Änderungen vorzunehmen. TextEdit ist nicht ideal für die Bearbeitung von Code, daher würde ich TextWrangler empfehlen, der nicht nur eine großartige App ist, sondern auch kostenlos!


1. Erstellen Sie einen Ordner


Sie können diesen Ordner an einem beliebigen Ort erstellen, da er ab sofort nur noch von irgendwo verwendet werden kann

Erstellen Sie auf Ihrem Desktop (oder wo immer Sie möchten) einen Ordner mit dem Namen Mactuts. Hier speichern wir unsere Erweiterungsdateien, bevor wir sie in eine geeignete PopClip-Erweiterung umwandeln.


2. Laden Sie den Quellcode herunter

Auf der Entwickler-Site von PopClip Extension können wir einige Beispiel-Quellcodes herunterladen. Unter der Überschrift Gesamtübersicht, Sie sehen die Arten von Aktionen, die PopClip unterstützt. Wir möchten den Beispielcode für die URL Aktion, die der Quellcode für die ist Google Übersetzer Erweiterung.

Sie sehen zwei Dateien in der Ansicht, die Config.plist und TranslationIcon.png. Wir interessieren uns nur für die Config-Datei.


So sieht der Code aus, wenn er in einen Texteditor (in diesem Fall TextMate) geöffnet / eingefügt wird

Die Hauptkonfigurationsdatei einer Erweiterung heißt a Immobilienliste Datei, auch bekannt als Plist. Möglicherweise haben Sie bereits davon gehört, da es sich um denselben Dateityp handelt, den OS X zum Speichern von Voreinstellungen für Anwendungen verwendet. Es basiert auf einem Format, das als bekannt ist XML. Nehmen Sie sich einige Minuten Zeit, um sich mit dem Format vertraut zu machen.

Ähnlich aussehend? XML funktioniert ähnlich wie HTML, die Auszeichnungssprache, die zum Erstellen von Webseiten verwendet wird.

Spitze: Wenn Sie mehr über Property Lists erfahren möchten, bietet die Developer Library von Apple einen großartigen Einführungsartikel, den Sie lesen können

Wenn Sie mit GitHub nicht vertraut sind, können Sie die Erweiterung direkt herunterladen. (Klicken Sie mit der rechten Maustaste auf den Link und wählen Sie aus Datei herunterladen als… , Speichern Sie es auf die Mactuts Ordner, den wir zuvor erstellt haben).


3. Lassen Sie uns bearbeiten!

Inzwischen solltest du das gerettet haben Config.plist Datei in Ihrem Mactuts Mappe. Lassen Sie uns diese Datei in einem Texteditor bearbeiten.

Wie Sie gesehen haben, verfügt diese Datei über verschiedene konfigurierbare Optionen. Sie werden feststellen, dass eine Option als a bezeichnet wird Schlüssel. Diese sagen PopClip, dass die Erweiterung bestimmte Informationen bereitstellen kann. Wir werden keine ändern Schlüssel, Stattdessen ändern wir die Informationen innerhalb.

Schritt 1


Als erstes ändern wir den Namen und die Beschreibung der Erweiterung

Zunächst müssen wir unsere ändern Erweiterungsname und Erweiterungsbeschreibung. Suchen Sie die Zeile mit der Schlüssel und ändern Sie den Namen, der sich in der folgenden Zeichenfolge befindet, derzeit als "Google Translate" geschrieben. Denken Sie daran, ändern Sie den Schlüssel nicht.

Nun, da Sie den Namen der Erweiterung geändert haben, ändern wir die Beschreibung, um besser darzustellen, was sie tut. Ändern Sie die Beschreibung wie oben beschrieben, um besser zu beschreiben, was unsere Mactuts + Sucherweiterung tun soll. Ich überlasse es Ihnen, zu entscheiden, was Sie schreiben sollen.

Schritt 2


Wir müssen auch die Version aktualisieren, da dies die erste Mactuts-Erweiterung überhaupt ist!

Da dies zum ersten Mal die Erweiterung ist, erstellen wir sie Version 1. Positionieren Sie die Versionsnummer oben in der Datei und ändern Sie diese Version ab 2 zu 1.

Sie haben vielleicht bemerkt, dass dies, anders als der Name der Erweiterung, etwas heißt Ganze Zahl und nicht String. Ganzzahl bedeutet nur, dass Sie nur eine Zahl angeben, also keine Buchstaben oder Sonderzeichen.

Schritt 3


Der Bezeichner muss geändert werden, da er für jede Erweiterung und jeden Entwickler eindeutig ist

Jede Erweiterung benötigt eine eindeutige Identifikation. Anstelle des Namens wird ein spezieller Bezeichner verwendet, der wie ein umgekehrter Domänenname aussieht. In diesem Quellcode sehen Sie es wie folgt geschrieben:

com.pilotmoon.popclip.extension.google-translate

Ändern Sie dies wie folgt:

com.mactuts.extension.mactuts-search

Selbst wenn wir den Namen der Erweiterung ändern, wird PopClip immer noch verwirrt, wenn unsere Erweiterung und die Google Translate-Erweiterung gleichzeitig installiert werden.

Schritt 4

Nun ist es an der Zeit zu kontrollieren, wie die Erweiterung tatsächlich funktioniert. Unsere Erweiterung durchsucht Mactuts + nach dem ausgewählten Text. Dazu müssen wir wissen, wie unsere Suchadresse lautet.

Öffnen Sie eine neue Registerkarte oder ein neues Fenster, wenn Mactuts + geladen ist, und suchen Sie nach dem Schlüsselwort „TEST“. Wenn die Suche abgeschlossen ist, werfen Sie einen Blick auf die Adressleiste. Sie sollten die folgende Adresse sehen:

http://mac.tutsplus.com/?s=TEST

Daraus können wir erkennen, dass wir die Suchadresse lautet:

http://mac.tutsplus.com/?s=

Sie können dies testen, indem Sie die oben angegebene Adresse und anschließend ein beliebiges Stichwort in die Adressleiste Ihres Browsers eingeben. Sobald die Seite geladen ist, wird die gewünschte Suche angezeigt.

PopClip verwendet den Text popclip text als Platzhalter für den ausgewählten Text. Dies bedeutet, dass die Suchadresse für unsere Erweiterung lautet:

http://mac.tutsplus.com/?s=popclip text


Wir ändern jetzt die URL, die PopClip (mit dem ausgewählten Text) öffnet, um Mactuts zu durchsuchen+

Diese Suchadresse wird unsere Erweiterung unterstützen. Ändern Sie in der Konfigurationsdatei die String das ist unter der Rubrik für URL zu dem darüber.

Schritt 5


Unser von PopClip verwendetes Symbol muss ein 256px-Quadrat mit transparentem Hintergrund und einem durchgehenden schwarzen Bereich sein

Wenn die Hauptsuchfunktion konfiguriert ist, müssen wir ein Symbol hinzufügen. Das Symbol muss ein quadratisches 256px-transparentes PNG sein. Um Zeit zu sparen, habe ich eine in die Quelldatei eingefügt, die Sie herunterladen und verwenden können.

Fügen Sie dieses (oder Ihr eigenes) Symbol Ihrem hinzu Mactuts Mappe. Ich habe das von mir bereitgestellte Symbol benannt MactutsIcon.png.


Nachdem wir ein neues Image hinzugefügt haben, müssen wir die Config-Datei mit dem neuen Namen aktualisieren

Zurück zur Config-Datei müssen wir den Namen der Bilddatei zu dem, den wir jetzt verwenden.

Schritt 6


Ändern Sie schließlich den Titel der Erweiterung und entfernen Sie den "Schlüssel" und "Zeichenfolge" für "regulärer Ausdruck".

Ändern Sie den Titel des Popup-Fensters von "Übersetzen" in "Mactuts +". Entfernen Sie zusätzlich die Schlüssel und String bezüglich Regulären Ausdruck. Dies ist ein optionales Extra, das wir nicht benötigen.

Schritt 7

Unsere Erweiterung ist jetzt fertig. Um mit der Verwendung beginnen zu können, müssen wir sie in eine PopClip-Erweiterung konvertieren. Bei allen PopClip-Erweiterungen handelt es sich eigentlich nur um speziell benannte Ordner. Es gibt kein Konvertierungswerkzeug oder Befehlszeilentricks.


Duplizieren Sie den Ordner, mit dem wir gearbeitet haben, und benennen Sie ihn um, indem Sie am Ende ".popclipext" hinzufügen

Dupliziere zuerst den Ordner. Benennen Sie den neu duplizierten Ordner in um mactuts.popclipext. Der Finder fordert Sie auf zu bestätigen, dass Sie ihn umbenennen möchten.


Sie werden gefragt, ob Sie sicher sind, dass Sie dem doppelten Ordner eine Dateierweiterung hinzufügen möchten

4. Installieren und testen Sie die Erweiterung


PopClip weist darauf hin, dass diese Erweiterung nicht signiert ist. Dies bedeutet, dass sie vom Entwickler nicht genehmigt wurde. Da es ganz neu ist, ist das in Ordnung

Doppelklicken Sie nach der Konvertierung auf die neu erstellte Erweiterungsdatei, um sie zu installieren. Sie erhalten eine Warnung von PopClip, in der Sie darüber informiert werden, dass dies keine genehmigte Erweiterung ist. Keine Sorge, das bedeutet nur, dass wir eine Erweiterung installieren wollen, die nicht von der Entwickler-Website stammt. Bestätigen Sie, dass Sie es installieren möchten, und die Erweiterung wird installiert. Nach der Installation sehen Sie es in der Liste der Erweiterungen, die PopClip aktiv hat. Am Ende der Liste steht unsere neu entwickelte Erweiterung Mactuts +!


Nach der Installation zeigt PopClip unsere neue Erweiterung im Menü an

Nun, um es auszuprobieren. Markieren Sie irgendwo Text und wenn PopClip erscheint, sollten Sie jetzt die Mactuts + -Suchschaltfläche anzeigen.


Durch die Auswahl von Text wird das PopClip-Menü… zusammen mit unserer neuen Erweiterung angezeigt!

Wenn Sie darauf klicken, wird eine neue Registerkarte oder ein neues Fenster geöffnet (oder sogar Ihr Standard-Browser wird geöffnet), und Sie werden direkt zur Suchergebnisseite für das ausgewählte Element geöffnet.


Wenn ausgewählt, öffnet PopClip eine neue Registerkarte, in der der ausgewählte Text in Mactuts gesucht wird+

Einpacken

Am Ende dieses Tutorials hoffe ich, dass Sie viel davon lernen konnten und mit dem Aufbau fortgeschrittener Erweiterungen beginnen konnten. Die PopClip-Erweiterungsentwicklerseite auf GitHub enthält Quellcode für alle Arten von Erweiterungen, damit Sie genau sehen können, wie sie funktionieren.

Da das Erstellen einer Erweiterung für PopClip unglaublich einfach sein kann, müssen Sie möglicherweise nicht darauf warten, dass jemand eine Erweiterung entwickelt, auf die Sie gewartet haben. Sie können sie möglicherweise selbst erstellen!