https://github.com/threadi/download-list-preview
Addition for downloadlist-plugin
https://github.com/threadi/download-list-preview
Last synced: 5 months ago
JSON representation
Addition for downloadlist-plugin
- Host: GitHub
- URL: https://github.com/threadi/download-list-preview
- Owner: threadi
- Created: 2023-07-08T12:37:13.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-11-23T12:39:39.000Z (over 1 year ago)
- Last Synced: 2024-11-23T13:30:02.945Z (over 1 year ago)
- Language: PHP
- Homepage: https://wordpress.org/plugins/download-list-block-with-icons/
- Size: 16.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Download List with Icons Preview
This plugin adds the possibility to show generated preview-images on each entry of a "Download List Block with Icons"-block. The plugin "Download List Block with Icons" is necessary to use this plugin.
A new iconset will be added to enable the preview. This can be selected per list to display a preview of the files it contains.
## Hints
The preview images are generated through WordPress. Whether and how they are created depends on whether WordPress and the hosting support the respective data format. For example, ghostscript is required in the hosting to generate preview images of PDF files.
The preview images are used via style. If you want to display them larger, an individual style adjustment is necessary.
## Usage
### For user
1. Download the release ZIP (not the source ZIP).
2. Install this plugin ZIP in your backend.
3. Activate the plugin.
### For developer
1. Checkout the repository in your plugin folder of your development environment.
2. Activate the plugin in WordPress backend.
## Translations
I recommend to use [PoEdit](https://poedit.net/) to translate texts for this plugin.
### generate pot-file
Run in main directory:
`wp i18n make-pot . languages/download-list-preview.pot`
### update translation-file
1. Open .po-file of the language in PoEdit.
2. Go to "Translate" > "Update from POT-file".
3. After this the new entries are added to the language-file.
### export translation-file
1. Open .po-file of the language in PoEdit.
2. Go to File > Save.
3. Upload the generated .mo-file and the .po-file to the plugin-folder languages/
## Check for WordPress Coding Standards
### Initialize
`composer install`
### Run
`vendor/bin/phpcs --extensions=php --ignore=*/vendor/* --standard=ruleset.xml .`
### Repair
`vendor/bin/phpcbf --extensions=php --ignore=*/vendor/* --standard=ruleset.xml .`
## Check for WordPress VIP Coding Standards
Hint: this check runs against the VIP-GO-platform which is not our target for this plugin. Many warnings can be ignored.
### Run
`vendor/bin/phpcs --extensions=php --ignore=*/vendor/* --standard=WordPress-VIP-Go .`