PopClip: розширення сценаріїв

() translation by (you can also view the original English article)

PopClip-це відмінна утиліта, що як тільки ви звикнете до нього, дуже важко жити без. Цей туторіал покаже, як писати розширення сценаріїв на прикладі розширення.

У цьому уроці я покажу вам, як створити PopClip розширення шляхом будівництва прибудови, що дозволить поглянути на Біблію посилатися, щоб бути обраний, уточнюючі довідки на англійській або тайському мовою з допомогою веб-API, і вставити відповідний вірш(и) на місці. Ви навчитеся створювати розширення PopClip, який використовує PHP-скрипт, регулярний вираз для активації налаштувань, які користувач може редагувати і за допомогою гарячих клавіш для зміни уподобань.

Визначення Вашого Розширення

Перше, що треба зробити, це вирішити, що розширення буде робити. Ви завжди повинні створювати кожне розширення з одного функціональністю на увазі. Так як я місіонер, я пишу нотатки про віршах Біблії весь час. Я б хотів мати розширення, яке буде приймати ссилочку Біблії і вставити цей вірш або вірші в мій документ на тайській і англійській мовах. Тому розширення буде робити саме це!

Але, іноді мені може знадобитися той чи інший мову. Таким чином, модуль повинен мати панель налаштувань і гарячих клавіш для зміни уподобань. Це може звучати як багато роботи, але PopClip дозволяє легко.

Я знайшов відмінний сайт, Ефесян 4:14, що дає можливість для скачування вірші з Біблії короля Джеймса англійською та тайському Біблії короля Джеймса. Так як я працюю з тайської мови, от тільки Біблій, які мені потрібні. Вони також мають багато інших мов. Таким чином, можна додати, що мова може вас зацікавити.

Popclip Ресурсів

Якщо ви тільки недавно встановили PopClip, будь ласка, прочитайте PopClip Керівництво користувача в першу чергу. Підручник, створити власні розширення для PopClip, дає відмінне Введення в PopClip і як зробити розширення, які не потребують будь-якого програмування. Цей підручник буде зосереджена на нарощування програмування сценарію для PopClip.

Pilotmoon дає повний список plist в конфігурації параметри файлу. Завжди ставляться до цього як до актуальної документації розширення інтерфейсу для PopClip.

Продовження буде написаний на PHP. Якщо Ви не знаєте, як програмувати на PHP, відмінний курс відео можна знайти на tuts+: в PHP Основи.

Структура Файлу

Де ви будете працювати на своєму комп'ютері, створіть каталог з ім'ям popclipBible.popclipext. Цей каталог буде виглядати як звичайний файл, але коли ви клацніть правою кнопкою миші на ньому і виберіть меню спливаюче меню Показати вміст пакету, він буде показувати вміст цього каталогу. Вам потрібно створити файли конфігурації.файл plist, bible.php і Біблії.PNG в каталог.

Конфіг.plist-це plist файл описано в наступному розділі. bible.php буде містити PHP-скрипт повинен бути виконаний. Біблія.PNG-це графічний файл для розширення. Все це завантажити файл нагорі.

Файл Plist

Все розширення для PopClip почати з plist файл з ім'ям config.plist файл. Цей файл говорить PopClip як розширення вписується у світ PopClip. Повний plist файл для цього розширення:


<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
  <key>Actions</key>
	<array>
		<dict>
			<key>After</key>
			<string>paste-result</string>
			<key>Image File</key>
			<string>bible.png</string>
			<key>Script Interpreter</key>
			<string>/usr/bin/php</string>
			<key>Shell Script File</key>
			<string>bible.php</string>
			<key>Title</key>
			<string>Bible</string>
		</dict>
	</array>
	<key>Options</key>
	<array>
		<dict>
			<key>Option Identifier</key>
			<string>biblekjv</string>
			<key>Option Type</key>
			<string>boolean</string>
			<key>Option Label</key>
			<string>KJB</string>
		</dict>
	<dict>
		<key>Option Identifier</key>
		<string>biblethaikjv</string>
		<key>Option Type</key>
		<string>boolean</string>
		<key>Option Label</key>
		<string>Thai KJV</string>
	</dict>
	</array>
	<key>Extension Description</key>
	<string>Lookup Bible verses in Popclip.</string>
	<key>Extension Identifier</key>
	<string>com.customct.popclip.extension.bible</string>
	<key>Extension Name</key>
	<string>Bible</string>
	<key>Long Running</key>
	<true/>
	<key>Regular Expression</key>
	<string>(.*\d+\:\d+(\-\d+)*)</string>
	<key>Required Software Version</key>
	<integer>701</integer>
</dict>
</plist>

Як видно, це файл даних XML-формату. Цей файл даних говорить PopClip все, що потрібно знати, щоб запустити розширення.

Це голі кістки plist в необхідних для цього розширення. Основний словник, ключі дії та параметри. Це основні елементи для забезпечення розширення функціональності. Я опишу їх більш докладно нижче. Інші ключі:

Опис Розширення
Даний ключ дає опис того, що розширення буде робити. Це повинно бути коротким, але описовим.

Розширення Ідентифікатора
Цей ключ дає унікальний ідентифікатор розширення. Я це мій сайт для повного унікальність. Це може бути будь-буквено-цифровий послідовну, але щось читабельне-це завжди приємно.

Розширення Імені
Цей ключ має ім'я, розширення. Я просто називаю це Біблія.

Тривалі
Цей параметр має значення True, так як це буде робити веб-API виклик, який займе деякий час, щоб закінчити за рахунок чистого швидкості. Це просто PopClip відображати значок очікування при виконанні дії.

Якщо розширення не займе багато часу, вона повинна бути помилковою.

Регулярний Вираз
Значення цього ключа являє собою регулярний вираз, який дозволить почати розширення, тільки якщо він стверджує, правда для виділеного тексту. Написати регулярний вираз, яке відповідає лише посиланням на Біблію, він не буде показувати розширення Біблії на будь виділений текст.

Добре використовувати цю функцію. З'являтися з будь-яким набором тексту робить його більш важким для користувача розширення. Подумайте про те, як хтось захоче використовувати розширення і створить гарний регулярний вираз для цього випадку.

Якщо ви трохи іржавий на написанні регулярних виразів, то вам варто прочитати цю статтю на чисту Туц+.

Необхідна Версія Програмного Забезпечення
Цей ключ вказує версію PopClip, що це розширення потреб.

Дії

Клавіші дій для визначення дій, що розширення буде виконувати. Є багато можливостей, але цей підручник буде зосередитися тільки на необхідних речей. Вони полягають в наступному:

Після
Це вказує на дію, яка виконуватиметься після виконання скрипта. вставити-результат буде вставити в найкращі програми, що текст скрипта виводить з.

Файл Зображення
Цей ключ вказує значок, використовуваний для даного розширення. Оскільки іконка в тому ж районі, як розширення, ви можете просто послатися на файл: Біблія.ПНГ. Якщо ви хотіли зберегти іконки в підкаталозі розширення, можна використовувати відносну посилання на цей файл.

Інтерпретатор Сценаріїв
Цей ключ визначає інтерпретатор буде використовуватися для обробки сценаріїв. Оскільки я роблю цю програму на PHP, він повинен посилатися на PHP-інтерпретатор за замовчуванням на всіх комп'ютерах Mac: /usr/Бен/РНР. Ви можете розмістити повний шлях до будь-перекладач, який ви хочете використовувати для запису розширення.

Файл Сценарію Оболонки
Цей ключ визначає файл в каталог розширень для запуску. Ім'я файлу: bible.php.

Назва
Цей ключ називається розширення: Біблія.

Варіанти

Ключові параметри містить масив словників. Один словник для кожної опції на панелі параметрів для розширення. Для цього продовження, користувач повинен мати можливість вставити з Біблії kjv або Тайська Біблія kjv. Оскільки у мене є два варіанти для цього розширення, я буду описувати кожен ключ в словнику варіанти і сказати, що я використовував для кожного варіанту.

Ідентифікатор Параметра
Цей ключ дасть PopClip унікальне ім'я параметра необхідно для розширення. Це використовується в змінну середовища, яка передається в Вашу програму. Для двох варіантів, ці ідентифікатори будуть використовуватися: biblekjv і biblethaikjv.

Тип Варіант
Цей параметр визначає, який тип опціону це. Це може бути або логічне значення (так чи ні), рядок (будь-яка рядок), або кілька (ви дати список варіантів, і користувач може вибрати з них). Тип boolean є те, що необхідно для цього розширення.

Мітка Варіант
Цей ключ визначає текст, який буде використовуватися в панелі варіантів для розширення. За це розширення, мітки KJB і Тайський упо буде працювати.

З цими параметрами, визначеними у файлі plist, привілейована група буде створена для редагування переваг. Як це буде виглядати:

Bible Extension Preferences — Розширення Переваги Біблії

Сценарій

Тепер скрипт повинен бути написаний. Повний скрипт:


<?php
//
// Array for converting English Bible book names 
// to thai. Not eloquent, but works.
//
$book = array();
$book['Genesis']='ปฐมกาล';
$book['Exodus']='อพยพ';
$book['Leviticus']='เลวีนิติ';
$book['Numbers']='กันดารวิถี';
$book['Deuteronomy']='เฉลยธรรมบัญญัติ';
$book['Joshua']='โยชูวา';
$book['Judges']='ผู้วินิจฉัย';
$book['Ruth']='นางรูธ';
$book['1Samuel']='1ซามูเอล';
$book['2Samuel']='2ซามูเอล';
$book['1Kings']='1พงศ์กษัตริย์';
$book['2Kings']='2พงศ์กษัตริย์';
$book['1Chronicles']='1พงศาวดาร';
$book['2Chronicles']='2พงศาวดาร';
$book['Ezra']='เอสรา';
$book['Nehemiah']='เนหะมีย์';
$book['Esther']='เอสเธอร์';
$book['Job']='โยบ';
$book['Psalms']='สดุดี';
$book['Proverbs']='สุภาษิต';
$book['Ecclesiastes']='ปัญญาจารย์';
$book['SongofSongs']='เพลงซาโลมอน';
$book['Isaiah']='อิสยาห์';
$book['Jeremiah']='เยเรมีย์';
$book['Lamentations']='เพลงคร่ำครวญ';
$book['Ezekiel']='เอเสเคียล';
$book['Daniel']='ดาเนียล';
$book['Hosea']='โฮเชยา';
$book['Joel']='โยเอล';
$book['Amos']='อาโมส';
$book['Obadiah']='โอบาดีย์';
$book['Jonah']='โยนาห์';
$book['Micah']='มีคาห์';
$book['Nahum']='นาฮูม';
$book['Habakkuk']='ฮาบากุก';
$book['Zephaniah']='เศฟันยาห์';
$book['Haggai']='ฮักกัย';
$book['Zechariah']='เศคาริยาห์';
$book['Malachi']='มาลาคี';
$book['Matthew']='มัทธิว';
$book['Mark']='มาระโก';
$book['Luke']='ลูกา';
$book['John']='ยอห์น';
$book['Acts']='กิจการของอัครทูต';
$book['Romans']='โรม';
$book['1Corinthians']='1โครินธ์';
$book['2Corinthians']='2โครินธ์';
$book['Galatians']='กาลาเทีย';
$book['Ephesians']='เอเฟซัส';
$book['Philippians']='ฟีลิปปี';
$book['Colossians']='โคโลสี';
$book['1Thessalonians']='1เธสะโลนิกา';
$book['2Thessalonians']='2เธสะโลนิกา';
$book['1Timothy']='1ทิโมธี';
$book['2Timothy']='2ทิโมธี';
$book['Titus']='ทิตัส';
$book['Philemon']='ฟีเลโมน';
$book['Hebrews']='ฮีบรู';
$book['James']='ยากอบ';
$book['1Peter']='1เปโตร';
$book['2Peter']='2เปโตร';
$book['1John']='1ยอห์น';
$book['2John']='2ยอห์น';
$book['3John']='3ยอห์น';
$book['Jude']='ยูดา';
$book['Revelation']='วิวรณ์';

//
// Send a GET requst using cURL
// @param string $url to request
// @param array $get values to send
// @param array $options for cURL
// @return string
//
function curl_get($url, array $options = array())
{
    $defaults = array(
        CURLOPT_URL => $url,
        CURLOPT_HEADER => 0,
        CURLOPT_RETURNTRANSFER => TRUE,
        CURLOPT_TIMEOUT => 4
    );

    $ch = curl_init();
    curl_setopt_array($ch, ($options + $defaults));
    if( ! $result = curl_exec($ch))
    {
        trigger_error(curl_error($ch));
    }
    curl_close($ch);
    return $result;
}

//
// Function:          getBibleVerse
//
// Description:      This function is for retrieving a Bible
//                   verse from the api.preachingcentral.com
//                   web site.
//
// Inputs:
//          $verse       The verses to be searched for.
//          $version     The version of the bible to use.
//
function getBibleVerse($verse, $version) {
	global $book;

	$result = "";
	$raw = urlencode($verse);
	$xml = curl_get("http://api.preachingcentral.com/bible.php?passage=$raw&version=$version");
	$xml_parser = xml_parser_create();
	xml_parse_into_struct($xml_parser, $xml, $vals, $index);
	xml_parser_free($xml_parser);

	$first = 0;
	$quote = 0;

	foreach ($vals as $xml_elem) {
		if(strcmp($xml_elem['tag'],"TEXT") === 0) {
			if($quote == 0) {
				$result = $result . ' "' . $xml_elem['value'];
				$quote = 1;
			} else {
				$result = $result . " " . $xml_elem['value'];
			}
		}
		if(strcmp($xml_elem['tag'],"RESULT") === 0) {
			if($first == 0) {
				if(strcmp($version, "thai") === 0) {
					//
					// The site only return book names in English. Translate them
					// to Thai.
					//
					$blist = explode(" ", $xml_elem['value']);
					$bname = '';
					$bver = '';
					if(count($blist) == 3) {
						$bname = $blist[0] . $blist[1];
						$bver = $blist[2];
					} elseif (count($blist) == 4) {
						$bname = $blist[0] . $blist[1] . $blist[2];
						$bver = $blist[3];
					} else {
						$bname = $blist[0];
						$bver = $blist[1];
					}
					$result = $book[$bname] . " " . $bver;
				} else {
					//
					// English is fine here.
					//
					$result = $xml_elem['value'];
				}
				$first = 1;
			} else {
				$result = $result . '"' . "\n\n" . $xml_elem['value'];
			}
			$quote = 0;
		}
	}
	return $result . '"';
}

//
// Get the PopClip Environment variables for the
// extension.
//
$verse = trim(getenv('POPCLIP_TEXT'));
$qKJV = getenv('POPCLIP_OPTION_BIBLEKJV');
$qThaiKJV = getenv("POPCLIP_OPTION_BIBLETHAIKJV");
$keycode = intval(getenv('POPCLIP_MODIFIER_FLAGS'));
$results = "";


//
// If the preference is set to KJV or the command key
// is pressed, then get the verse from the English KJV
// and add it to the result. If both the command key
// and the control key is pressed, then get the KJV also.
//
if(($qKJV[0] == '1')||($keycode == 1048576)||($keycode == 1310720)) {
	$results .= getBibleVerse($verse, "kjv") . "\n" ;
}

//
// If the preference is set to the Thai KJV or the
// control key is press then get the verse from the
// Thai KJV and add it to the result. If both the
// command key and the control key is pressed,
// then get the Thai version also.
//
if(($qThaiKJV[0] == '1')||($keycode == 262144)||($keycode == 1310720)) {
	$results .= getBibleVerse($verse, "thai") . "\n";
}

//
// Anything echoed from the script will be pasted in
// to the top most application by PopClip. If the results
// is nothing, then return the verse.
//
if(strcmp($results,"")===0) {
	echo $verse;
} else {
	echo $results;
}

?>

Першим ділом в скрипт масив назв книг в Біблії. Цей масив призначений для перекладу англійської книги назви своїм тайським еквівалентом. Веб-API, розширення використовує тільки дає посилання на англійській мові. Так, англійські назви книги Біблії повинен бути переведений на Тайська мова.

Перша функція є допоміжною функцією. Він є PHP рутина для запиту інформації з веб-сайту за допомогою Curl і повертаючи результати викликає програмі. Введення URL-адреси запиту.

Друга функція є основною функцією для обробки Біблійний вірш. Він буде просити вірш Біблії і обробити отриманий XML в більш зручному вигляді для подальшої вставки в текстовий редактор або те, що в даний час програма активно. Параметри фактичного вірш Біблії і цілевказівником, для яких Біблія просити. Для короля Джеймса Біблії короля Якова. Тайський Біблії, це тайський. Ви можете отримати інші коди за посиланням вище сайті.

Отримання інформації з навколишнього середовища

PopClip відправляє дані на скрипт через змінні оточення. Це простий спосіб спілкування. Це, як отримати доступ до цієї інформації.


//
// Get the PopClip Environment variables for the
// extension.
//
$verse = trim(getenv('POPCLIP_TEXT'));
$qKJV = getenv('POPCLIP_OPTION_BIBLEKJV');
$qThaiKJV = getenv("POPCLIP_OPTION_BIBLETHAIKJV");
$keycode = intval(getenv('POPCLIP_MODIFIER_FLAGS'));
$results = "";

Функції PHP функції getenv() буде витягувати змінну середовища наведено в рядок для виклику функції. Всі змінні середовища-це рядки і повинні бути використані в якості таких. Різні змінні оточення:

POPCLIP_TEXT
Ця змінна є вибір, коли PopClip був викликаний. Оскільки користувач розширення може вибрати зайві прогалини, я завжди хотів використовувати функція TRIM (), щоб видалити зайві пробіли.

POPCLIP_OPTION_BIBLEKJV
Ця змінна є параметром про отримання вірш з Біблії короля Джеймса. Він являє собою рядок, що містить символ 1, Якщо True, в іншому випадку він містить символ 0.

POPCLIP_OPTION_BIBLETHAIKJV
Ця змінна є параметром про отримання вірш з тайського короля Джеймса. Він являє собою рядок, що містить символ 1, Якщо True, в іншому випадку він містить символ 0.

POPCLIP_MODIFIER_FLAGS
Це говорить використовувати те, що клавіші були натиснуті в той час як PopClip дій був обраний. Все пройшло в змінній середовища є рядком. Тому, струни повинні бути переведені на легкий у використанні, а також Формат. Я використовувати intval() функція для перетворення рядка в ціле число.

Всі різні ключові значення кодів наведено в PopClip розширення на github.

Як видно, кожен параметр в налаштуваннях для розширення має свої власні відповідні змінні оточення.

Змінної $result також має значення порожнього рядка для наступних двох розділах, щоб заповнити.

Обробка змінних оточення

Основною частиною будь-якого розширення PopClip приймати змінні, які передаються в навколишнє середовище і зробити щось корисне з ним.


//
// If the preference is set to KJV or the command key
// is pressed, then get the verse from the English KJV
// and add it to the result.
//
if(($qKJV[0] == '1')||($keycode == 1048576)||($keycode == 1310720)) {
	$results .= getBibleVerse($verse, "kjv") . "\n" ;
}

Ця частина коду буде витягти вірш з Біблії короля Джеймса, якщо він був вказаний в налаштуваннях (змінна $qKJV) або Command була натиснута при виборі PopClip дій ($код 1048576). Він також буде просити його, якщо як контролювати і командного не було натиснуто жодної клавіші ($код 1310720). Оскільки змінна $qKJV є рядком, яка є 1 або 0, ви можете перевірити перший символ повинен бути символом 1. Таким чином, це не процес в число. Що може заощадити час!

Якщо умова істинно, то і вірші виходять з допомогою getBibleVerse (функції) і додається до $результуючий рядок.


//
// If the preference is set to the Thai KJV or the
// control key is press then get the verse from the
// Thai KJV and add it to the result.
//
if(($qThaiKJV[0] == '1')||($keycode == 262144)||($keycode == 1310720)) {
	$results .= getBibleVerse($verse, "thai") . "\n";
}

Тут він схожий. Якщо Тайський Король Джеймс версії був обраний в налаштуваннях ($qThaiKJV) або клавіша Ctrl, утримуючи при виборі PopClip дій ($код 262144), потім Тайський Король Джеймс версії буде запропоновано. Він також буде просити його, якщо як контролювати і командного не було натиснуто жодної клавіші ($код 1310720).

Якщо умова істинно, то і вірші виходять з допомогою getBibleVerse (функції) і додається до $результуючий рядок.


//
// Anything echoed from the script will be pasted in
// to the top most application by PopClip. If the results
// is nothing, then return the verse.
//
if(strcmp($results,"")===0) {
	echo $verse;
} else {
	echo $results;
}

Ось, результати повинні бути луною. Але, якщо буфер результатів порожній, то вірш повинен бути відображений. Якщо порожній рядок повторюється, він ефективно видаляє те, що було вибрано. Оскільки всі опції, можна отримати тут з $results змінна порожня. Хороша практика програмування говорить нам завжди приймати кожну можливість до уваги.

Використання

Коли розширення завантажується в PopClip і переваги встановлюються, розширення проста у використанні. Просто виділіть текст, який є посиланням на Біблію.

Коли з'явиться PopClip бар, виберіть білий Біблію і вибір буде змінено вірш. Тут уподобання були створені для упо і ThaiKJV версії для друку.

Якщо текст не відповідає регулярному виразу в Біблії посилання, то іконка Біблія не будуть показані.

Вибір не віршЦе допомагає економити нерухомості на PopClip-бар. Всякий раз, коли ви створюєте розширення, думати про те, як звести до мінімуму непотрібні явища розширення.

Резюме

Тепер у вас є акуратний розширення PopClip для отримання вірші з веб-сайту і вставити їх в додаток. Навіть краще, тепер ви знаєте, як створити панель налаштувань для свого розширення, дістатися до цієї інформації від вашого розширення, маніпулювати виділений текст і вставити його назад в ТОП самих додатків. Ви можете взяти цей код і розгорнути його або використовувати його як каркас для власного розширення PopClip. Нехай усі знають, як ви використовуєте його в коментарях!