Prepare assets for WordPress.org plugin submission (v1.6.23)
76
assets/WORDPRESS_ORG_SUBMISSION.md
Normal file
@ -0,0 +1,76 @@
|
||||
# WordPress.org Plugin Submission Assets Guide
|
||||
|
||||
This document outlines the requirements for assets when submitting a plugin to the WordPress.org plugin repository.
|
||||
|
||||
## Asset Requirements
|
||||
|
||||
### Icon
|
||||
|
||||
- **Format**: PNG
|
||||
- **Size**: 256x256 pixels
|
||||
- **Filename**: `icon-256x256.png`
|
||||
- **Location**: SVN `/assets` directory (not included in the plugin zip)
|
||||
- **Optional**: You can also include `icon-128x128.png` for backward compatibility
|
||||
|
||||
### Banner
|
||||
|
||||
- **Format**: PNG
|
||||
- **Sizes**:
|
||||
- Regular: 772x250 pixels (`banner-772x250.png`)
|
||||
- High-DPI: 1544x500 pixels (`banner-1544x500.png`)
|
||||
- **Location**: SVN `/assets` directory (not included in the plugin zip)
|
||||
|
||||
### Screenshots
|
||||
|
||||
- **Format**: PNG
|
||||
- **Naming**: Sequential numbers (`screenshot-1.png`, `screenshot-2.png`, etc.)
|
||||
- **Location**: SVN `/assets` directory (not included in the plugin zip)
|
||||
- **Important**: The number and order must match the descriptions in the `readme.txt` file
|
||||
|
||||
## Current Status
|
||||
|
||||
### Icon
|
||||
- ✅ SVG source available
|
||||
- ❌ Need to create `icon-256x256.png` from the SVG
|
||||
|
||||
### Banner
|
||||
- ✅ Both sizes available
|
||||
- ✅ Properly renamed versions created in `assets/banner-png/`
|
||||
|
||||
### Screenshots
|
||||
- ❌ Only 1 of 3 referenced screenshots available
|
||||
- ❌ Need to create `screenshot-2.png` and `screenshot-3.png`
|
||||
- ✅ Properly renamed version of the first screenshot created in `assets/screenshots-png/`
|
||||
|
||||
## SVN Directory Structure
|
||||
|
||||
When submitting to WordPress.org, your SVN repository will have this structure:
|
||||
|
||||
```
|
||||
/assets/
|
||||
icon-256x256.png
|
||||
banner-772x250.png
|
||||
banner-1544x500.png
|
||||
screenshot-1.png
|
||||
screenshot-2.png
|
||||
screenshot-3.png
|
||||
/tags/
|
||||
/1.0.0/
|
||||
[plugin files]
|
||||
/1.0.1/
|
||||
[plugin files]
|
||||
/trunk/
|
||||
[current plugin files]
|
||||
```
|
||||
|
||||
## Action Items
|
||||
|
||||
1. Convert the SVG icon to a 256x256 PNG file
|
||||
2. Create the missing screenshots (2 and 3)
|
||||
3. Ensure all files follow the proper naming convention
|
||||
4. Upload all assets to the WordPress.org SVN repository in the `/assets` directory
|
||||
|
||||
## Resources
|
||||
|
||||
- [WordPress Plugin Developer Handbook - Plugin Assets](https://developer.wordpress.org/plugins/wordpress-org/plugin-assets/)
|
||||
- [WordPress Plugin Directory README.txt Standard](https://developer.wordpress.org/plugins/wordpress-org/how-your-readme-txt-works/)
|
11
assets/banner-png/README.md
Normal file
@ -0,0 +1,11 @@
|
||||
# WordPress.org Banner Requirements
|
||||
|
||||
For WordPress.org plugin submission, you need:
|
||||
|
||||
1. Banner images in PNG format
|
||||
2. Two sizes:
|
||||
- `banner-772x250.png` (for regular display)
|
||||
- `banner-1544x500.png` (for high-resolution/retina displays)
|
||||
3. Place them in the root of your SVN assets directory
|
||||
|
||||
These files have been properly renamed from the original files to match WordPress.org requirements.
|
BIN
assets/banner-png/banner-1544x500.png
Normal file
After Width: | Height: | Size: 38 KiB |
BIN
assets/banner-png/banner-772x250.png
Normal file
After Width: | Height: | Size: 15 KiB |
After Width: | Height: | Size: 38 KiB |
After Width: | Height: | Size: 15 KiB |
24
assets/icon-png/README.md
Normal file
@ -0,0 +1,24 @@
|
||||
# WordPress.org Icon Requirements
|
||||
|
||||
For WordPress.org plugin submission, you need to:
|
||||
|
||||
1. Convert the SVG icon to PNG format
|
||||
2. Create a 256x256 pixel version
|
||||
3. Name it `icon-256x256.png`
|
||||
4. Place it in the root of your SVN assets directory
|
||||
|
||||
## How to Convert
|
||||
|
||||
You can use tools like:
|
||||
- Inkscape (free, open-source)
|
||||
- Adobe Illustrator
|
||||
- GIMP
|
||||
- Online converters like https://svgtopng.com/
|
||||
|
||||
## Command Line Conversion (if you have ImageMagick installed)
|
||||
|
||||
```bash
|
||||
convert -background none -size 256x256 assets/icon/fix-plugin-does-not-exist-notices-icon.svg assets/icon-png/icon-256x256.png
|
||||
```
|
||||
|
||||
After creating the PNG file, it should be uploaded to the WordPress.org SVN repository in the assets directory.
|
After Width: | Height: | Size: 1.8 KiB |
After Width: | Height: | Size: 2.7 KiB |
11
assets/icon/fix-plugin-does-not-exist-notices-icon.svg
Normal file
After Width: | Height: | Size: 30 KiB |
18
assets/screenshots-png/README.md
Normal file
@ -0,0 +1,18 @@
|
||||
# WordPress.org Screenshot Requirements
|
||||
|
||||
For WordPress.org plugin submission, you need:
|
||||
|
||||
1. Screenshots in PNG format
|
||||
2. Named sequentially: `screenshot-1.png`, `screenshot-2.png`, etc.
|
||||
3. Place them in the root of your SVN assets directory
|
||||
|
||||
## Important Note
|
||||
|
||||
The readme.txt file references 3 screenshots:
|
||||
1. Error message with explanation notification
|
||||
2. Missing plugin shown in the plugins list with "Remove Notice" link
|
||||
3. Auto-scroll feature that highlights the missing plugin
|
||||
|
||||
However, only one screenshot file is currently available. You need to create and add the other two screenshots to match the descriptions in the readme.txt file.
|
||||
|
||||
After creating all three screenshots with the proper naming convention, they should be uploaded to the WordPress.org SVN repository in the assets directory.
|
BIN
assets/screenshots-png/screenshot-1.png
Normal file
After Width: | Height: | Size: 392 KiB |
After Width: | Height: | Size: 392 KiB |