https://github.com/textpattern/textpattern-plugins-website
Textpattern CMS Plugins website.
https://github.com/textpattern/textpattern-plugins-website
textpattern textpattern-plugin textpattern-website web-design website
Last synced: 8 months ago
JSON representation
Textpattern CMS Plugins website.
- Host: GitHub
- URL: https://github.com/textpattern/textpattern-plugins-website
- Owner: textpattern
- License: gpl-2.0
- Created: 2018-01-09T17:05:39.000Z (about 8 years ago)
- Default Branch: main
- Last Pushed: 2024-07-22T07:31:34.000Z (over 1 year ago)
- Last Synced: 2025-04-29T11:25:38.953Z (9 months ago)
- Topics: textpattern, textpattern-plugin, textpattern-website, web-design, website
- Language: JavaScript
- Homepage: https://plugins.textpattern.com
- Size: 2.46 MB
- Stars: 7
- Watchers: 9
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Textpattern plugins website
[](https://travis-ci.com/textpattern/textpattern-plugins-website)
Official 2020+ plugins website of the [Textpattern](https://textpattern.com/) project. **Requires Textpattern 4.8.2 or later.**
Pulls supporting data from the [Textpattern curated plugins list repository](https://github.com/textpattern/textpattern-curated-plugins-list).
## 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.
## Requirements
Building this repository requires:
* [Node.js](https://nodejs.org/)
* [Grunt](https://gruntjs.com/)
* [Composer](https://getcomposer.org/)
## Setup
### Installing required tools
The project uses [Grunt](https://gruntjs.com/) to run tasks. First make sure you have base dependencies installed: [Node.js](https://nodejs.org/) and [Grunt](https://gruntjs.com/). You can install Node using the [installer](https://nodejs.org/), Composer using the [installer](https://getcomposer.org/), and Grunt with npm:
```ShellSession
$ npm install -g grunt-cli
```
Consult the Grunt documentation for more instructions if necessary.
### Installing dependencies
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:
```ShellSession
$ cd textpattern-plugins-website
$ npm install
$ composer install
```
**npm** installs Node modules for Grunt and **composer** installs PHP libraries.
## Building
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:
```ShellSession
$ grunt @task@
```
Where the `@task@` is either `build` or `watch`.
* The `build` task builds the project.
* The `watch` task will launch a task that watches for file changes; the project is then automatically built if a source file is modified.
## Shortcodes
Textpattern 4.7 introduced support for user-definable `` attributes (and also the short tags syntax ``), 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](https://docs.textpattern.com/tags/shortcodes/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:
`type` is used to explain the replacement method that is available. For example, `shortcodes`, `alternative plugin`, `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.
For example:
### Image
To create a HTML5 image snippet:
`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-width` and `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:
For example, image with an alternative dark theme version and a set width and height in pixels:
### Video
To create a HTML5 video snippet:
`poster-url`, `name`, `description` and `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.
For example:
### File
To create a file download snippet:
`category` and `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.
For example:
## Plugins used
All plugins we use are installed via Composer:
* [`etc_cache`](https://github.com/etc-plugins/etc_cache) ✓ Composer
* [`smd_thumbnail`](https://github.com/bloke/smd_thumbnail) ✓ Composer
## License
Licensed under the [GPLv2 license](https://github.com/textpattern/textpattern-plugins-website/blob/master/LICENSE).