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). Эта часть кода будет извлечь стих из Библии короля Джеймса, если он был указан в настройках (переменная $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. Пусть все знают, как вы используете его в комментариях!