Consolidate asset documentation and clarify RTL support (v1.6.28)
This commit is contained in:
@ -7,7 +7,7 @@ This directory contains assets for the WordPress.org plugin repository.
|
||||
- `banner/` - Banner images for the plugin page header
|
||||
- `banner-772x250.jpg` - Standard banner (772x250px)
|
||||
- `banner-1544x500.jpg` - Retina banner (1544x500px)
|
||||
|
||||
|
||||
- `icon/` - Plugin icon images
|
||||
- `icon-128x128.jpg` - Standard icon (128x128px)
|
||||
- `icon-256x256.jpg` - Retina icon (256x256px)
|
||||
@ -32,7 +32,8 @@ This directory contains assets for the WordPress.org plugin repository.
|
||||
|
||||
- Screenshots should be numbered sequentially starting with 1
|
||||
- They should match the descriptions in the `readme.txt` file
|
||||
- Dark theme versions of banners and icons can be provided by appending `-rtl` to the filename
|
||||
- Right-to-Left (RTL) language versions of banners and icons can be provided by appending `-rtl` to the filename
|
||||
- There is no official support for dark mode versions of assets in the WordPress.org repository
|
||||
|
||||
## Example Filenames
|
||||
|
||||
@ -46,4 +47,4 @@ assets/
|
||||
│ └── icon-256x256.jpg
|
||||
└── screenshots/
|
||||
├── screenshot-1.jpg
|
||||
```
|
||||
```
|
||||
@ -1,6 +1,6 @@
|
||||
# WordPress.org Plugin Submission Assets Guide
|
||||
|
||||
This document explains how to prepare and upload assets for WordPress.org plugin submission.
|
||||
This document explains how to prepare and upload assets for WordPress.org plugin submission. This is the main reference document for all asset-related information.
|
||||
|
||||
## WordPress.org SVN Repository Structure
|
||||
|
||||
@ -14,9 +14,9 @@ When submitting a plugin to WordPress.org, you'll work with an SVN repository th
|
||||
banner-1544x500.png
|
||||
screenshot-1.png
|
||||
/tags/ # Contains tagged releases
|
||||
/1.0.0/
|
||||
/1.6.27/
|
||||
[plugin files]
|
||||
/1.0.1/
|
||||
/1.6.26/
|
||||
[plugin files]
|
||||
/trunk/ # Contains the current version of the plugin
|
||||
[plugin files]
|
||||
@ -93,6 +93,33 @@ Note: `-rtl` is specifically for Right-to-Left language support, not for dark th
|
||||
svn commit -m "Initial plugin submission"
|
||||
```
|
||||
|
||||
## Image Conversion Tools
|
||||
|
||||
For converting SVG to PNG or creating different sizes of images, you can use:
|
||||
|
||||
- **Graphic Design Software**:
|
||||
- Adobe Photoshop
|
||||
- Adobe Illustrator
|
||||
- Affinity Designer
|
||||
- Affinity Photo
|
||||
- GIMP (free, open-source)
|
||||
- Inkscape (free, open-source)
|
||||
- Pixelmator
|
||||
|
||||
- **Online Converters**:
|
||||
- [SVG to PNG Converter](https://svgtopng.com/)
|
||||
- [Convertio](https://convertio.co/svg-png/)
|
||||
- [CloudConvert](https://cloudconvert.com/svg-to-png)
|
||||
|
||||
- **Command Line** (using ImageMagick):
|
||||
```bash
|
||||
# For 256x256 icon
|
||||
convert -background none -size 256x256 assets/icon/icon.svg assets/icon/icon-256x256.png
|
||||
|
||||
# For 128x128 icon
|
||||
convert -background none -size 128x128 assets/icon/icon.svg assets/icon/icon-128x128.png
|
||||
```
|
||||
|
||||
## Resources
|
||||
|
||||
- [WordPress Plugin Developer Handbook - Plugin Assets](https://developer.wordpress.org/plugins/wordpress-org/plugin-assets/)
|
||||
|
||||
@ -30,17 +30,16 @@ This document outlines the requirements for assets when submitting a plugin to t
|
||||
## Current Status
|
||||
|
||||
### Icon
|
||||
- ✅ SVG source available
|
||||
- ✅ PNG files created (`icon-256x256.png` and `icon-128x128.png`)
|
||||
- ✅ SVG source available in `assets/icon/icon.svg`
|
||||
- ✅ PNG files created in `assets/icon/icon-256x256.png` and `assets/icon/icon-128x128.png`
|
||||
|
||||
### Banner
|
||||
- ✅ Both sizes available
|
||||
- ✅ Properly renamed versions created in `assets/banner-png/`
|
||||
- ✅ Both sizes available in `assets/banner/`
|
||||
- ✅ Properly named files: `banner-772x250.png` and `banner-1544x500.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/`
|
||||
- ✅ One screenshot available in `assets/screenshots/screenshot-1.png`
|
||||
- ✅ Screenshot description in readme.txt updated to reference only one screenshot
|
||||
|
||||
## SVN Directory Structure
|
||||
|
||||
@ -49,15 +48,14 @@ When submitting to WordPress.org, your SVN repository will have this structure:
|
||||
```
|
||||
/assets/
|
||||
icon-256x256.png
|
||||
icon-128x128.png
|
||||
banner-772x250.png
|
||||
banner-1544x500.png
|
||||
screenshot-1.png
|
||||
screenshot-2.png
|
||||
screenshot-3.png
|
||||
/tags/
|
||||
/1.0.0/
|
||||
/1.6.27/
|
||||
[plugin files]
|
||||
/1.0.1/
|
||||
/1.6.26/
|
||||
[plugin files]
|
||||
/trunk/
|
||||
[current plugin files]
|
||||
@ -65,10 +63,17 @@ When submitting to WordPress.org, your SVN repository will have this structure:
|
||||
|
||||
## 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
|
||||
1. Ensure all files follow the proper naming convention
|
||||
2. Upload all assets to the WordPress.org SVN repository in the `/assets` directory using these commands:
|
||||
|
||||
```bash
|
||||
# Copy assets to WordPress.org SVN assets directory
|
||||
cp assets/icon/icon-256x256.png /path/to/wordpress-svn/assets/
|
||||
cp assets/icon/icon-128x128.png /path/to/wordpress-svn/assets/
|
||||
cp assets/banner/banner-772x250.png /path/to/wordpress-svn/assets/
|
||||
cp assets/banner/banner-1544x500.png /path/to/wordpress-svn/assets/
|
||||
cp assets/screenshots/screenshot-1.png /path/to/wordpress-svn/assets/
|
||||
```
|
||||
|
||||
## Resources
|
||||
|
||||
|
||||
@ -1,11 +1,15 @@
|
||||
# WordPress.org Banner Requirements
|
||||
# WordPress.org Banner Files
|
||||
|
||||
For WordPress.org plugin submission, you need:
|
||||
This directory contains banner files for the WordPress.org plugin repository.
|
||||
|
||||
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 `/assets/` directory of your WordPress.org SVN repository
|
||||
## Files in this Directory
|
||||
|
||||
These files have been renamed from the original files to match WordPress.org's naming-convention and file format requirements.
|
||||
- `banner-772x250.png` - 772x250 pixel PNG banner (required for WordPress.org)
|
||||
- `banner-1544x500.png` - 1544x500 pixel PNG banner for high-DPI displays (optional for WordPress.org)
|
||||
- `banner-1544x500.pxd` - Source file for editing in Pixelmator
|
||||
|
||||
## WordPress.org Submission
|
||||
|
||||
For detailed information about WordPress.org banner requirements and submission process, please see the main asset documentation:
|
||||
|
||||
[WordPress.org Plugin Submission Assets Guide](../WORDPRESS_ORG_ASSETS.md)
|
||||
|
||||
@ -1,32 +1,16 @@
|
||||
# WordPress.org Icon Requirements
|
||||
# WordPress.org Icon Files
|
||||
|
||||
For WordPress.org plugin submission, you need to:
|
||||
This directory contains icon files for the WordPress.org plugin repository.
|
||||
|
||||
1. Convert the SVG icon to PNG format
|
||||
2. Create a 256x256 and 128x128 pixel version
|
||||
3. Name them `icon-256x256.png` and `icon-128x128.png`
|
||||
4. Place them in the `/assets/` directory of your WordPress.org SVN repository
|
||||
## Files in this Directory
|
||||
|
||||
## How to Convert
|
||||
- `icon.svg` - Source SVG icon
|
||||
- `icon-256x256.png` - 256x256 pixel PNG icon (required for WordPress.org)
|
||||
- `icon-128x128.png` - 128x128 pixel PNG icon (optional for WordPress.org)
|
||||
- `icon-1024x1024.pxd` - Source file for editing in Pixelmator
|
||||
|
||||
You can use tools like:
|
||||
- Inkscape (free, open-source)
|
||||
- Adobe Illustrator
|
||||
- Adobe Photoshop
|
||||
- Affinity Designer
|
||||
- Affinity Photo
|
||||
- GIMP
|
||||
- Pixelmator
|
||||
- Online converters like https://svgtopng.com/
|
||||
## WordPress.org Submission
|
||||
|
||||
## Command Line Conversion (if you have ImageMagick installed)
|
||||
For detailed information about WordPress.org icon requirements and submission process, please see the main asset documentation:
|
||||
|
||||
```bash
|
||||
# For 256x256 icon
|
||||
convert -background none -size 256x256 assets/icon/fix-plugin-does-not-exist-notices-icon.svg assets/icon/icon-256x256.png
|
||||
|
||||
# For 128x128 icon
|
||||
convert -background none -size 128x128 assets/icon/fix-plugin-does-not-exist-notices-icon.svg assets/icon/icon-128x128.png
|
||||
```
|
||||
|
||||
After creating the PNG file, it should be uploaded to the WordPress.org SVN repository in the assets directory.
|
||||
[WordPress.org Plugin Submission Assets Guide](../WORDPRESS_ORG_ASSETS.md)
|
||||
|
||||
@ -1,7 +1,14 @@
|
||||
# WordPress.org Screenshot Requirements
|
||||
# WordPress.org Screenshot Files
|
||||
|
||||
For WordPress.org plugin submission, you need:
|
||||
This directory contains screenshot files for the WordPress.org plugin repository.
|
||||
|
||||
1. Screenshot in PNG format
|
||||
2. Named `screenshot-1.png`
|
||||
3. Place it in the `/assets/` directory of your WordPress.org SVN repository
|
||||
## Files in this Directory
|
||||
|
||||
- `screenshot-1.png` - Main screenshot showing the plugin in action
|
||||
- `screenshot-1.pxd` - Source file for editing in Pixelmator
|
||||
|
||||
## WordPress.org Submission
|
||||
|
||||
For detailed information about WordPress.org screenshot requirements and submission process, please see the main asset documentation:
|
||||
|
||||
[WordPress.org Plugin Submission Assets Guide](../WORDPRESS_ORG_ASSETS.md)
|
||||
Reference in New Issue
Block a user