Plugins panel TODO
Textpattern by itself is capable of doing a lot, especially as you learn to use Page templates, Form templates and core tags in increasingly sophisticated ways. But when your needs cannot be met (or met easily) by core ingenuity alone, you can extend functionality with plugins, whether to produce content and behaviour, enhance configurability or usability, and more.
On this page:
- Uploading plugins
- Plugin cache directory
- Managing plugins
- Updating plugins
- Advice on plugin usage
- Plugin development?
The top part of the Plugins panel is an ‘Install plugin’ field for uploading plugin files.
Installing a standard text (
.txt) plugin goes something like this:
- Find the plugin file you want.
- Copy the plugin file to your clipboard.
- Paste the file into the ‘Install plugin’ textarea box at top of the panel.
- Select the ‘Upload’ button to verify contents.
- Select the ‘Install’ button to finish installation and add plugin to the plugin list table.
- When ready, activate the plugin in the Active column in the plugin list table.
Most of that is pretty straight forward, but let’s touch upon steps 1, 2, and 4 a bit more…
At this time, the Textpattern project doesn’t have a centralized repository for all its community-built plugins, but plugin developers (often called “plugin authors”) generally proceed by the following process to make their plugins available, and thus for others to find them:
Developer websites: Plugin developers typically make their plugins available at their own websites, and once you know who those plugin developers are, you can find their websites via their forum profiles, and often their specific plugin links in the signatures of their forum posts.
GitHub: Plugin developers are increasingly using GitHub to maintain and release their Textpattern plugins. A curated list of Textpattern plugins available via GitHub is at Awesome Textpattern.
Plugin author support forum: Plugin developers initially announce their plugins by creating a plugin support thread for each one in the Plugin author support forum. This provides a vector for finding plugins by monitoring the forum activity or using the forum’s search. Plugin threads are also where you ask questions about using a given plugin, find developer notes about changes, or share ideas for plugin improvement. Whenever you install a plugin, you should always subscribe to it’s associated support thread to keep up with any changes.1
Plugin file anatomy
The plugin itself is a text (
.txt) file. It usually has a header stating the name of the plugin and other details, then the code itself in Base-64 format. Following is an hypothetical example showing the exact structure of a given file:
# Name: abc_myplugin v0.1 # Type: Client side plugin # Brief Description of the plugin # Author: Author name # URL: https://example.com/ # Recommended load order: 5 # …………………………………………………………… # This is a plugin for Textpattern - https://textpattern.com/ # To install: textpattern > admin > plugins # Paste the following text into the 'Install plugin' box: # …………………………………………………………… YTo5OntzOjQ6Im5hbWUiO3M6Njoic21kX2lmIjtzOjY6ImF1dGhvciI7czoxMToiU3RlZiBE YXdzb24iO3M6MTA6ImF1dGhvcl91cmkiO3M6MjI6Imh0dHA6Ly9zdGVmZGF3c29uLmNvbS8i O3M6NzoidmVyc2lvbiI7czo0OiIw…
The Base-64 part on the bottom would normally be much longer, so be sure to copy the entire file when you really do go after one.
Depending on where you find your plugin file, you may be able to view its contents on location and copy the file without downloading it, or you may need to download the file first, open it, and copy the contents locally. Either way, once you have the text file contents copied, paste it into the ‘Install plugin’ textarea box as indicated earlier, and press ‘Upload’.
Verifying plugin file contents
After selecting the ‘Upload’ button, you’ll be shown an intermediate view of the plugin file - a decompiled view - as it was written. You don’t have to do anything here but look for obvious weirdness. For example, if you didn’t see anything at all, that would be a problem, or if the plugin panel disappeared, that should be telling you to retreat. Otherwise, find the ‘Install’ button and select it.
This will add the plugin record to the table, where you can then manage it.
Plugin installation errors
Sometimes large plugins can cause problems when you select the Install button, you might see the following error…
Badly formed or empty plugin code.
This is usually resolved by obtaining and installing a compressed version of the plugin.2 Compressed plugins are equivalent to regular text plugins, but begin with a sequence that looks like this:
H4sIAAAAAAAAA919a3PbRrbg56Rq/kOH8UTkDiWKkh+xJCtXsWWPZxXHa8meeyvjUoFEk8QY BGgAlKz1+L/vefULACk6dvZO3amJRTYa53SfPn3e3YwOHh58LA/uHnSyaK47h+XB/YNOOY8v k4l8iZbVLC/wy3B40Dmv9EQ9…
You’ll need gzip on your web server in order to install compressed plugins, but most web servers have it.
Plugin cache directory
Plugins that you install via the Plugins panel are inserted into the database. There is another method of installing a plugin that involves obtaining the plugin as a file in the standard template format.
Visit the Preferences panel and enter a folder path/name to use as your plugin cache directory. Make sure it exists on your server!
When you have saved the changes, you may upload (via FTP) plugins in the standard template format (not the Base-64 method outlined above)into this nominated directory. Once uploaded, they will be available automatically and are “always on”, but otherwise behave in the same manner as regular plugins.
The bottom part of the panel is a table display for seeing and managing the plugins you’ve uploaded (the table will be empty after a new Textpattern installation).
The plugin table displays the following data columns for each plugin:
- Plugin (name)
All of the column headers can be selected to sort table records in alpha-numeric order by their respective data types, except the Description and Manage columns, which are static.
Beyond that, certain columns have particular value.
Activating a plugin
When you first install a plugin, it’s in a non-utilizable state until you activate it. To activate a plugin, select the ‘No’ link in the Active column. The link will turn to ‘Yes’ and the plugin is ready to use. To deactivate a plugin, which you might do temporarily when troubleshooting errors in your code that could be related to plugins in some way, select the ‘Yes’ link to toggle it off again.
Editing a plugin
Once a plugin is installed, you can make changes to its code. You might do this if you have a special functional need from the plugin, or you find a small bug that the plugin author doesn’t have the time to fix right away. To access the PHP code, select the plugin’s name in the Plugin column of the table. This opens the code in “edit” mode.3 If you edit the plugin and save it, you’ll see a Yes entry for the plugin in the Modified column. Keep in mind that if you update the plugin to a new version later, it will overwrite any custom edits you make.
Plugin help and options
Depending on the plugin, activating it may not make it usable without further effort. Plugins that provide you with specialized functionality through one or more custom tags, for example, will require you to fold those tags into your publishing architecture somehow. It’s through use of those tags, and any other constructs the plugin may require, that the plugin will jump to life. To learn how a plugin is supposed to be used, select the “Help” link in the Manage column of the table.
Some plugins may also provide an ‘Options’ link next to the ‘Help’ link, which opens a special view. These options are neither an Extensions region nor preferences, exactly, but are nevertheless important for helping to make the plugin function as you may need it to.
If you read the plugin’s Help information and find yourself still having trouble, that’s the time to go to the plugin’s support thread. Known issues are often highlighted in the threads (tip: use Google to search long threads), or you can post with questions or issues you have.
Upgrading a plugin is done the same way you first install one, as described earlier. Textpattern will know which plugin it is and overwrite the old plugin code accordingly with no additional input on your part.4
Advice on plugin usage
While plugins can do many things, there is often a misconception that you need plugins to do everything. That is not true with Textpattern. Many long-time users of Textpattern, in fact, pride themselves on using as few plugins as possible, while still creating sophisticated publishing architectures with core capabilities, especially when it comes to building front-ends - true Textpattern jedi.
The prudent website owner, and particularly the site architect, is encouraged to adopt a frugal habit of plugin use and learn the jedi way. That is to say, only install plugins if while learning Textpattern you discover you really do need them. Installing a bunch of plugins right away because they sound cool, or because they provide a quick way of achieving something is not a good way to learn what Textpattern is capable of.
The frugal approach favours two beneficial states. First, you master Textpattern by spending more time learning core capabilities. Second, fewer plugins means less need to update the ones you have, less likelihood of running into issues later when new Textpattern versions are released, and fewer third-party vectors for hackers to possibly exploit, thus better system security.
Here are a few tips for achieving plugin zen:
- Take the time to research if what you want to do can’t be done with core functionality alone. Chances are it can be done, and notably with designing your front-end publishing architecture.5
- Don’t install plugins that you don’t need, even if you think you might need them later, there’s no point. Also, some plugins install their own database tables. You don’t need plugin database tables for nothing.
- If you do install plugins, but don’t use them right away, don’t enable them. Every enabled plugin, used or not, is a potential vector for exploitation, and notably if it’s not well maintained, so having enabled plugins sitting there that you aren’t using increases your odds of being hacked.
- Don’t de-activate plugins you don’t want to use and leave them installed. Again, there’s no point. Delete them. Be one with the Textpattern Force.
You’re in the wrong place! Please see the suite of plugin develop aides for aspiring plugin developers.
As time goes by some plugin authors move on to other pastures - they may abandon their Textpattern plugins, which fall out of repair, or disappear altogether. We call these plugins ‘orphans’, and you’ll see them labeled this way in their respective support forum threads. Sometimes other developers will ‘adopt’ the plugins and maintain them, keeping the original plugin name. If you see a plugin indicated as ‘orphan’, avoid it, and ask in the forum if something else is better. ↩
You can often find compressed plugins where a regular text version is available. If not, you can install the ied_plugin_composer plugin and use that to create you’re own compressed version. ↩
You could also install and used ied_plugin_composer, which not only allows you to edit plugins, but to compile and export them too as entirely new plugins, assuming you make enough custom changes to warrant doing so (etiquette tip: Always give credit to the developers whose code you expand from). ↩
In the event you need to update a plugin you’ve edited, you may like to install rvm_plugin_diff first, a plugin that helps you track down the lines of code you edited in other plugins so you don’t lose track of them and can make the edits again if necessary. Keeping your own edited versions of plugins on GitHub is another way you could maintain your customized versions separate from the plugin developer’s latest releases. ↩
Good places to look and learn about building sophisticated publishing architectures with core functionality include: Tags reference (notably the examples provided on each tag page), Textpattern Tips, all throughout the support forum, but notably in the How? area. ↩