Textpattern plugins website
Official 2020+ plugins website of the Textpattern project. Requires Textpattern 4.8.2 or later.
Pulls supporting data from the Textpattern curated plugins list repository.
Supported web browsers
- Chrome, Edge, Firefox, Safari and Opera the last two recent stable releases.
- Internet Explorer 11.
- Firefox ESR latest major point release.
Older versions of the above and other browsers may work, but these are the ones we verify.
Building this repository requires:
Installing required tools
The project uses Grunt to run tasks. First make sure you have base dependencies installed: Node.js and Grunt. You can install Node using the installer, Composer using the installer, and Grunt with npm:
$ npm install -g grunt-cli
Consult the Grunt documentation for more instructions if necessary.
After you have the base dependencies taken care of, you can install the project's dependencies. Navigate to the project's directory, and run the dependency manager:
$ cd textpattern-plugins-website $ npm install $ composer install
npm installs Node modules for Grunt and composer installs PHP libraries.
This repository hosts sources and needs to be built before it can be used. After you have installed all dependencies, you will be able to run tasks using Grunt, including building:
$ grunt @task@
@task@ is either
buildtask builds the project.
watchtask will launch a task that watches for file changes; the project is then automatically built if a source file is modified.
Textpattern 4.7 introduced support for user-definable
<txp:output_form /> attributes (and also the short tags syntax
<txp::...>), allowing for our own version of 'shortcodes' within articles (note: remember to also use
notextile. when within Textile content). This site uses the following tags:
Superceded plugin flag
Plugins can be flagged as 'superseded' when there is deemed a better method to achieve the same end task. For example, newer core Textpattern tags/attributes have been developed, a more modern alternative plugin, or if Textpattern custom short-tags and shortcodes can be used instead.
The shortcode creates an alert block on the page showing an advisory listing the new method and a link to the new methods' documentation.
To create a superceded plugin flag:
<txp::superseded type="" location="" />
type is used to explain the replacement method that is available. For example,
core tags, etc. Please try to keep the naming convention consistent throughout the CMS if possible.
location is the full URL to the replacement method; be that documentation and/or examples via shortcodes, the webpage of the alternative plugin, the documentation page of the core tags, etc.
<txp::superseded type="shortcodes" location="https://example.com/example.html" />
To create a HTML5 image snippet:
<txp::media_image id="" dark-option="" set-width="" set-height="" />
id accepts either a single image ID, or comma separated image IDs if you want multiple images. For blogs/articles the ideal image width is
832 pixels for the standard resolution version and
1664 pixels for the double resolution version (which is optional, but should be provided if possible).
dark-option is optional (for a single image ID), for if you need to provide an alternative image when website is in Dark Mode.
set-height are optional (for a single image ID), for if you need to provide explicit maximum dimensions (in pixels) for an image. Otherwise (when not set), images default to being fully responsive (expanding to fill their container).
For example, comma separated image IDs:
<txp::media_image id="41, 42, 50" />
For example, image with an alternative dark theme version and a set width and height in pixels:
<txp::media_image id="51" dark-option="52" set-width="400" set-height="125" />
To create a HTML5 video snippet:
<txp::media_video width="" height="" mp4-url="" webm-url="" poster-url="" name="" description="" duration-seconds=""/>
duration-seconds are optional, but should be provided if possible to provide valid Schema.org microdata. If not used, remove those attributes from your shortcode.
<txp::media_video width="640" height="480" mp4-url="/video/video1.mp4" webm-url="/video/video1.webm" poster-url="/video/video1-poster.png" name="Cat video" description="My great video of cats." duration-seconds="20" />
To create a file download snippet:
<txp::media_file category="" filename="" large-button="" />
filename are interchangeable (use one or the other, where appropriate) - if both are provided then
category is used in preference and
filename is ignored.
large-button is optional. If set to
1, this will render a larger style button.
<txp::media_file category="current-release-zip" large-button="1" />
All plugins we use are installed via Composer:
Licensed under the GPLv2 license.