Lag din egen tilpassede utvidelse for PopClip

PopClip er en av våre favorittprogrammer på Mactuts +, og en av grunnene til at det er støtte for utvidelser. Du kan utføre handlinger på valgt tekst ved hjelp av PopClip som gjør den ekstremt allsidig, uansett om du vil åpne en kobling i en annen nettleser, søke etter den valgte teksten i Google eller legge den til som en oppgave til ting, popClip gir en iOS-stil popup-menyen som gjør det enkelt å gjøre disse oppgavene.

I denne veiledningen vil jeg demonstrere hvor lett det er å lage din egen utvidelse for PopClip å utføre en tilpasset handling.


Hva er PopClip?


PopClip gir en iOS-stil meny som kan tilpasses videre med utvidelser

PopClip ($ 4,99) er en app for OS X som gir en iOS-lignende popup-meny når du velger tekst. Hovedbruken er å klippe, kopiere og lime inn - igjen, veldig lik iOS. Hvor det virkelig blir interessant er muligheten til å installere utvidelser for å gjøre mer enn bare legge til utklippstavlen.

Ved skrivingstid var det over 92 utvidelser tilgjengelig for nedlasting gratis. Disse utvidelsene varierer fra å åpne en kobling i en Google Chrome, legge ut valgt tekst til Facebook, legge til anførselstegn rundt valgt tekst og mer.

Tips: Det er mange utvidelser, og jeg oppfordrer deg til å ta en titt, som alle finnes på PopClip-utvidelsessiden.

Jeg bruker PopClip regelmessig og bruker en utvidelse for å legge til valgt tekst til ting, min favoritt app.


Hvordan de er bygget

PopClip støtter utvidelser skrevet på flere forskjellige måter:

  • Mac OS X-tjeneste
  • Apple
  • Shell Script
  • URL
  • Tastetrykk

Både URL og Tastetrykk krever ingen programmeringskunnskap for å lage dem. Så lenge du kjenner nettadressen til en side som kan inkludere litt tekst eller trykke på en bestemt kombinasjon av nøkler, kan du opprette din egen utvidelse.

De resterende tre blir opprettet ved hjelp av skripting språk. De kan manipulere tekst på en mer avansert måte. I forbindelse med denne opplæringen skal jeg opprette en utvidelse ved hjelp av URL metode.

EN URL utvidelse krever bare to filer, utvidelseskonfigurasjonsfilen og et ikon som skal vises på hurtigmenyen når vi velger litt tekst.


Bygg vår egen

Det er et stort utvalg av utvidelser som vi kan bruke, men det kan ikke være en som passer akkurat til våre behov. Som et eksempel skal jeg vise deg hvordan du bygger en PopClip-utvidelse som kan søke Mactuts + for den valgte teksten.

For å gjøre dette vil jeg ikke vise deg hvordan du bygger en fra begynnelsen, men i stedet bruker vi noen av prøvekoden fra utvikleren og gjør endringer i den som passer til våre behov. Dette gir deg en god ide om hvordan utvidelsen fungerer og hvilke endringer vi må gjøre for å begynne å lage egne utvidelser.

Tips: Vi trenger bare en tekstredigerer for å gjøre endringer. TextEdit er ikke ideell for redigeringskode, så jeg vil anbefale noe som TextWrangler som ikke bare er et flott app, men det er gratis også!


1. Lag en mappe


Du kan lage denne mappen hvor som helst, det vil bare være et sted å jobbe fra for nå

På skrivebordet ditt (eller hvor du vil), opprett en mappe som heter mactuts. Dette er hvor vi lagrer utvidelsesfilene før vi gjør det til en riktig PopClip-utvidelse.


2. Last ned kildekoden

På utviklingsstedet for PopClip Extension kan vi laste ned noen eksempler på kildekoden. Under overskriften Generell oversikt, Du ser hvilke handlinger PopClip støtter. Vi vil laste ned eksempelkoden for URL handling, som er kildekoden for Google Oversetter forlengelse.

Du får se to filer i visningen, Config.plist og TranslationIcon.png. Vi er bare interessert i Config-filen.


Her ser koden ut når den åpnes / limes inn i en tekstredigerer (i dette tilfellet TextMate)

Hovedkonfigurasjonsfilen til en utvidelse er det som kalles en Eiendomsliste fil, ellers kjent som en plist. Du har kanskje hørt om dem før, da det er den samme filtypen som OS X bruker til å lagre preferanser for applikasjoner. Det er basert på et format kjent som XML. Ta noen minutter å gjøre deg kjent med formatet.

Ser kjent ut? XML er designet for å fungere på samme måte som HTML, Markup-språket som brukes til å bygge websider.

Tips: Hvis du vil vite mer om egenskapslister, har Apples utviklerbibliotek en flott introduksjonsartikkel du kan lese

Hvis du ikke er kjent med GitHub, kan du laste ned utvidelsen direkte. (Høyreklikk lenken og velg Last ned fil som ... , lagrer den til mactuts mappe vi opprettet tidligere).


3. La oss redigere!

Nå skal du ha lagret Config.plist filen til din mactuts mappe. La oss redigere den filen i et tekstredigeringsprogram.

Som du har sett, har denne filen en rekke forskjellige konfigurerbare alternativer. Du vil legge merke til at et alternativ kalles a Nøkkel. Disse forteller PopClip at utvidelsen er i stand til å gi viss informasjon. Vi vil ikke endre noen nøkler, men i stedet vil vi endre informasjonen innenfor.

Trinn 1


Det første vi endrer er navnet og beskrivelsen av utvidelsen

Først av alt, må vi endre vår Forlengelsesnavn og Utvidelsesbeskrivelse. Finn linjen som har nøkkel for dette og endre navnet som er i strengen under, for øyeblikket skrevet som "Google Translate" tilsvarende. Husk, ikke endre nøkkelen.

Nå som du har endret navnet på utvidelsen, la oss endre beskrivelsen for å bedre reflektere hva den gjør. Bruk de samme trinnene som ovenfor, endre beskrivelsen for å bedre beskrive hva vår Mactuts + søkeutvidelse vil gjøre. Jeg lar deg bestemme hva du skal skrive.

Steg 2


Vi må også oppdatere versjonen, da dette er den første Mactuts-utvidelsen noensinne!

Nå, siden dette er første gang, vil vi lage denne utvidelsen, la oss få det til versjon 1. Plasser versjonstallet nær toppen av filen og endre dette fra 2 til 1.

Du har kanskje lagt merke til at, i motsetning til navnet på utvidelsen, er dette noe som kalles en Integer og ikke string. Integer betyr bare at du bare angir et tall, så ingen bokstaver eller spesialtegn.

Trinn 3


Identifikatoren må endres som den er unik for hver utvidelse og utvikler

Hver utvidelse trenger en unik måte å bli identifisert på. I stedet for å bruke det navnet, bruker den en spesiell identifikator som ser ut som et domenenavn som er skrevet i omvendt. I denne kildekoden ser du den skrevet som følger:

com.pilotmoon.popclip.extension.google-translate

Endre dette til følgende:

com.mactuts.extension.mactuts-søk

Selv om vi endret navnet på utvidelsen, ville PopClip fortsatt få dette forvirret hvis vi hadde utvidelsen og Google Translate-utvidelsen installert samtidig.

Trinn 4

Nå er det på tide å kontrollere hvordan utvidelsen faktisk fungerer. Vår utvidelse vil søke Mactuts + for teksten du har valgt. For å gjøre dette må vi vite hva vår søkeadresse er.

Åpne en ny kategori eller et vindu med Mactuts + lastet og søk etter søkeordet "TEST". Når søket er fullført, ta en titt på adressefeltet. Du bør se følgende adresse:

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

Fra dette kan vi se at vi søkeadressen er:

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

Du kan teste dette ved å skrive inn adressen ovenfor og deretter et hvilket som helst søkeord du vil ha til nettleserens adressefelt. Når siden laster, ser du søket du ønsket.

PopClip bruker teksten popclip text som plassholder for teksten du har valgt. Hva dette betyr er at søkeadressen for utvidelsen vår vil være:

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


Vi endrer nå nettadressen som PopClip åpner (med valgt tekst) for å søke Mactuts+

Denne søkeadressen er hva som driver vår utvidelse. I Config-filen, endre string det er under seksjonen for URL til det ovennevnte.

Trinn 5


Vårt ikon som PopClip bruker, må være et 256px firkant med gjennomsiktig bakgrunn og et solidt område i svart

Med hovedsøkfunksjonen konfigurert, må vi legge til et ikon. Ikonet må være en kvadratisk 256px gjennomsiktig PNG. For å spare tid har jeg tatt med en med kildefilen som du kan laste ned og bruke.

Legg til dette (eller ditt eget) ikon til din mactuts mappe. Jeg har kalt ikonet jeg har gitt MactutsIcon.png.


Når vi har lagt til et nytt bilde, må vi oppdatere konfig filen med det nye navnet

Tilbake til Config-filen, må vi endre navnet på Bildefil til den vi bruker nå.

Trinn 6


Endre, endre tittelen på utvidelsen og fjern "nøkkelen" og "strengen" for "Regular Expression"

Endre tittelen på popup-vinduet fra "Oversett" til "Mactuts +". I tillegg fjerner du Nøkkel og string Relatert til Vanlig uttrykk. Dette er en ekstrautstyr som vi ikke trenger.

Trinn 7

Vår forlengelse er nå klar til å gå. For å kunne begynne å bruke det, må vi konvertere det til en PopClip-utvidelse. Alle PopClip-utvidelser er egentlig bare navngitte mapper. Det er ingen konverteringsverktøy eller kommandolinjesporing å gjøre.


Dupliser mappen vi har jobbet med, og gi nytt navn til den, legg til ". Popclipext" til slutten

Først og fremst dupliser mappen. Med den nylig dupliserte mappen, omdøpe den til mactuts.popclipext. Finder vil be deg om å bekrefte at du vil endre navn på den.


Du blir spurt om du er sikker på at du vil legge til en filtillegg i duplisert mappe

4. Installer og test forlengelsen


PopClip vil advare om at denne utvidelsen ikke er signert, noe som betyr at den ikke var godkjent av utvikleren. Som det er helt nytt, er det ok

Når du er konvertert, dobbeltklikk den nylig opprettede filfilen som skal installeres. Du får en advarsel fra PopClip som forklarer at dette ikke er en godkjent utvidelse. Ikke bekymre deg, dette betyr bare at vi ønsker å installere en utvidelse som ikke var fra utviklerens nettsted. Bekreft at du vil installere den, og deretter vil utvidelsen installeres. Når det er installert, ser du det i listen over utvidelser som PopClip har aktivert. På bunnen av listen blir vår nyutviklede Mactuts + forlengelse!


Når installert, vil popclip vise vår nye utvidelse i menyen

Nå for å teste det ut. Fremhev noen tekst hvor som helst, og når PopClip vises, bør du nå se vår Mactuts + søkeknappvisning.


Hvis du velger tekst, vises PopClip-menyen ... sammen med vår nye utvidelse!

Når du klikker på det, åpnes en ny kategori eller et vindu (eller starter) standardleseren din og åpnes direkte til søkeresultatsiden for det du valgte.


Når valgt, vil PopClip åpne en ny fane med den valgte teksten som er søkt på Mactuts+

Wrapping Up

Ved slutten av denne opplæringen håper jeg at du har lært mye av det og begynner å bygge mer avanserte utvidelser. PopClip-utvidelsen utvikler siden på GitHub gir deg kildekoden for alle typer utvidelser, slik at du kan se nøyaktig hvordan de fungerer.

Siden det er utrolig enkelt å bygge en utvidelse for PopClip, trenger du kanskje ikke å vente på at noen skal utvikle en utvidelse du har ventet på, du kan kanskje bygge den selv!