Use your own prefix, ideally a reverse DNS-style prefix. Provide a string which uniquely identifies this extension. The ist file has the following structure. PopClip will display the appropriate string for the user's preferred language if possible, with fallback to the en string. Alternatively, you can supply a dictionary mapping language code ( en, fr, etc.) to a string. If you supply a string value, that string is always used. A common error is to enter a number as a string type.įields with the type "String or Dictionary" can take either a String or Dictionary value. Make sure that you set each field the correct type.consist of solid black figure on a transparent backgroundįor example, here is the full-size icon file for 'Sort':.Icons may be created in any graphics program. The icon is displayed in the PopClip popup itself, and also in the preferences window and on the web site (if published). Here is an example of the plist for 'Translate Tab', as viewed in Xcode:Įxtensions may include icons to represent actions. Alternatively, use a dedicated plist editor such as the excellent PlistEdit Pro. You can generate a blank plist with Xcode or use this example as a basis: ist. The plist contains information about the extension, and also defines one or more actions. _ist - Signature (official Pilotmoon extensions only)Įvery extension must contain a ist file. Here is an example package structure, using the 'Say' extension: PopClip stores its installed extensions in ~/Library/Application Support/PopClip/Extensions/. popclipext package, PopClip will attempt to load and install it. To view the contents of a package, right click it in Finder and choose 'Show Package Contents'. Such a directory will be treated as a package by Mac OS X. popclipext packageĪ PopClip extension consists of a property list called ist, plus (optional) additional files such as the icon and any required scripts, all contained in a directory whose name ends with. zip extension and unzipping it, to reveal a. You can examine an existing PopClip extension by renaming it with a. popclipextz filesįor distribution on the PopClip Extensions page, extensions are zipped and renamed with the extension. Filter by whether the text contains a URL, email address or file path.Īnatomy of a PopClip Extension About.Filter by whether cut, copy or paste is available.Filter by application (either include or exclude).Filter by matching a regular expression.Open an HTTP URL, with the selected text URL-encoded and inserted.Īll extensions have access to the following filtering mechanisms, to help prevent them appearing when they are not useful: Run a shell script, with the selected text passed as an environment variable. Run an AppleScript, with the selected text embedded. Invoke a Mac OS X Service, passing the selected text. There are five main kinds of actions supported by PopClip extensions. Be careful about the extensions you create, and be wary about loading extensions you get from someone else. Please be aware that PopClip extensions can contain arbitrary executable scripts. Run the following command at the Terminal, then Quit and restart PopClip:ĭefaults write LoadUnsignedExtensions -bool YES If you find this gets annoying while you are testing your work, you can turn off the warning. Extension Signingīy default, PopClip will display a warning dialog when you try to install your own extension, because it is not digitally signed by Pilotmoon Software. I reserve the right to change or remove features in future versions of PopClip at any time. You need to be comfortable with creating and editing plist files, scripts, and so on. Please note that user-created extensions are not an officially supported part of PopClip. These instructions are designed to help a technically competent person to create their own PopClip extension. Here are some other repos you might find interesting: Don't worry about signing the extension, I will take care of that.I choose which extensions to publish at my sole discretion. If you contribute an extension, I will assume you are happy for me to publish your contributions on the main PopClip extensions page.Contributor credits are are shown in the readme file of each individual extension. CreditsĪll the extensions and documentation were created by Nick Moore except where stated. PopClipExtension.xcodeplugin - Plist definition file for use with Xcode or PlistEdit Pro.Īll extension source files are published under the MIT License (see LICENSE) unless noted otherwise in the readme files of individual extensions. ist - The main page is auto-generated using ist to specify the contents. Source/ - Source files for the extensions. Docs/ - Image files and resources referred to in this README file.Įxtensions/ - Distributable versions of the extensions (zipped, with `.popclipextz` extension).
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |