Contents
- What you need
- 1. Install
- 2. License
- 3. Make the preview page
- 4. Enable Radish on a product
- 5. Rooms you supply
- 6. How shoppers use Radish
- 7. Change the wording
- 8. Translating
- 9. Clean-up
- 10. Colors
- Troubleshooting
- Getting help
A guide for shop owners. Version 1.0.0.
v1.3 beside a heading: the version a feature arrived in. Gold: needs Radish Gold, the paid add-on.
What you need
- WordPress 6.7 or later
- WooCommerce 10.0 or later
- PHP 8.2 or later, with the GD or Imagick extension, which resizes uploaded artwork and room photos
1. Install
Two plugins:
- Radish for WooCommerce: free. Base features included.
- Radish Gold: paid version. Requires the free version to activate. Adds features for shop owners and your shoppers.
Gold’s download is a package. Extract its contents into an existing folder (e.g. a “Radish” folder inside your existing default Downloads folder)
WooCommerce should be activated and configured first.
Plugins → Add New → Upload Plugin, choose the free zip, install, activate. Repeat this step for the gold version.
Note: Uploading the package zip itself gives “The package could not be installed. No valid plugins were found.”
2. License Gold
WooCommerce → Radish → License
- The free version is a stand-alone plugin and will work whether or not Gold is installed and activated.
- The key is on your receipt, and in your account at paperpixelstudio.com.
- Paste it into the key field and click Activate. If valid and activated correctly, the tab should now show Active on this site and the date updates run to.
- Until a key is active, Gold’s features stay off.
Moving to another site
- Each activation is tied to one URL.
- On the old site, click Release this site. Gold’s features will deactivate and the license is now available for another url.
- If you don’t release the old site first, the new site will return the error This key has no activations left. Release it from another site first. when you try to activate the license there.
Check again
Check again checks with paperpixelstudio.com and pulls fresh information about the license key. You can use it after renewing a license, after releasing a site, or when a new version isn’t showing, but you know your key should give you access to it.
When a license expires
- Gold keeps working as is. It will no longer have access to updates.
- I hate nag screens like everyone, so you’ll only get one reminder, with Renew, License settings and Remind me later options, every three months.
- After renewing, click Check again. (see above)
If the license server can’t be reached
Radish Gold periodically checks to see if there are updates and to refresh your license information. If for some reason Radish Gold can’t reach the license server, everything continues to work without interuption.
What the messages mean
| It says | What to do |
|---|---|
| This key has no activations left | Release it on a site you no longer use |
| That key belongs to a different product | It’s for a different product from Paper Pixel Studio |
| License key not recognized | Check for a typo, then your receipt |
| This key has been disabled or revoked | Get in touch |
| Cannot confirm this key | Usually a temporary network issue. Try Check again later |
3. Make the preview page
The preview is a shortcode. It can go on any page.
- WooCommerce → Radish → Preview page
- Optional: pick a starting artwork and room in the builder. Leave both empty to let the shopper choose.
- Copy the shortcode into a page and publish it.
On the page: the room preview shows up faded, with one button, Hang it on a wall, which opens the preview full screen. Its wording: WooCommerce → Radish → Customize text, Opening the preview.
The shortcode
[radish_preview]
| Attribute | What it does |
|---|---|
art |
Opens with this artwork: its Radish file name, an attachment ID, or a URL on this site. |
room |
Opens with this room: its slug from the Rooms tab, or a photo by attachment ID or URL. |
art_w |
Width of the artwork upon first launching the preview. |
art_h |
Height of the artwork upon first launching the preview. |
All optional. The builder writes them.
Product page link Gold
This is the page that will open when the Radish button on a product page is clicked.
- WooCommerce → Radish → Preview page, choose the published page under Product page link.
- Save.
- This adds a button to product with Radish enabled, which opens the preview page with that artwork already hanging.
- Unset: choose the ‘no link’ option from the list.
- Uses Radish’s colors to maintain readable contrast.
4. Enable Radish on a product
Edit the product, Product data → Radish tab.
- For artwork sold in sizes: use WooCommerce’s variable product.
- For single pieces, like an original painting or one print from an edition: use WooCommerce’s simple product. See Single pieces.
| Field | What it does |
|---|---|
| Room preview | Switches it on. Off by default. |
| Default artwork | The flat artwork file, not a framed mockup. Used for every size without its own. |
| One row per variation | Its Size, the Image it uses, and the Crop needed to fit. |
Note: We recommend creating flat artwork in each ratio your pieces come in (minimum short side of image is 400px) so that a 5×7 inch and a 8×10 inch piece will display accurately. If you don’t provide those images, Radish will visually crop the default artwork file (without altering the actual file) when those other ratios are chosen for display by your shopper.
The artwork file
- Upload the flat artwork in the Product data → Radish tab. Minimum pixel size is 400px on the long edge.
- Or Choose from library to use an image already in the media library. Radish makes its own 400px copy; the library’s file stays as it is.
- Each size row has the same choice: Upload or From library.
- Radish keeps one copy, 400 pixels on the long edge, as a JPEG. A print-resolution file should not be used as it gains nothing and a small image is all that’s needed for Radish to hang on the wall.
- Radish will always maintain the ratio and not crop the file.
- Stored in
wp-content/uploads/radish/art/, not the media library. - Deleted by an hourly cleanup once no product uses it.
Single pieces
- Size on the Radish tab. Width then height, in the same units as the rest of the shop, as the artwork hangs. It’s required for the artwork to show as an option on the published preview page.
- The Shipping dimensions aren’t used as they describe the piece as packaged. A rolled canvas might ship at 27 × 3 × 3 and hang at 27 × 41.
- Artwork: a straight-on photo of the piece, cropped to its edges (without a frame or any wall showing).
- Out of stock: drops out of the preview. With Gold, the preview button is hidden from the product page.
- One in stock, or sold one at a time can’t hang twice on one wall.
Inches or centimeters
Radish follows the dimension unit under WooCommerce → Settings → Products.
- Centimeters, millimeters or meters: shoppers see and type centimeters, room setup shows meters, and
40x50reads as centimeters. - A size naming its unit, such as
40x50 cmor16x20 in, reads in that unit either way.
Sizes and cropping
- Pieces visually crop from the center to fill the “canvas”. A 3:4 image loses a little when presented for a 5×7 piece, and a lot for a square one.
- The Crop column shows how much the chosen art file will be visible for that variation size.
- If you feel too much of the image is hidden, hover the row, click Choose, pick a file already created in the proper ratios for that shape. Reset returns to the default artwork.
Sizes that can’t be read
- Sizes are read from the variation’s attribute. “8×10”, “16 x 20” and “11×14 in” all work.
- Any unreadable size is shown in red, not offered to scale. The same is true if you do not have a variation called “Size”
- Fix: rename the size to one of those three accepted patterns, such as
16x20or40x50 cm.
Seeing everything at once
WooCommerce → Radish → Artwork: every product with Radish enabled, and its sizes.
- Hidden products show as Hidden from the catalog. Shoppers never see them.
- This is a WooCommerce feature, not one from Radish, and it can be found in Publish → Catalog visibility on the product edit screen.
- In the catalog: Shop and search results or Shop only. Not: Search results only or Hidden.
5. Rooms you supply
These are room mockup images you upload and preconfigure. You must have at least one of these.
WooCommerce → Radish → Rooms
- Offered to everyone, signed in or not.
- Without Gold, these are the only rooms shoppers can use.
- With Gold, still worth adding: but shoppers can start without a photo until they upload their own.
- Add a room and choose a photo. A clear, empty wall works best; a slight angle is fine.
- Name it. Shoppers pick rooms by name.
- Drag the four handles to the wall’s corners, where ceiling and floor meet its side edges. Getting them as accurate as possible improves the results Radish delivers.
- Measure something on the wall: a door frame, window or light switch. Just make sure it is something on the wall, not in front of it.
- Enter its real length, then click Save this room.
The toolbox lists what’s missing, and shows the wall’s approximate size once it’s saved.
6. How shoppers use Radish
- Presses Hang it on a wall. The preview opens full screen.
- Chooses a room.
- Picks artwork and a size. It appears on the wall to scale.
- Moves it, swaps artwork or size, and adds it to the cart.
Layouts:
- Computer, wide photo: controls along the top.
- Computer, tall photo: controls down the right side. Radish picks whichever shows the room photo larger.
- Phone: a tray at the bottom that they can slide up to reveal more controls. Room, artwork, size and cart always show
- Phone on its side: similar to the computer layout, but sized for mobile.
Help inside the preview
- ? beside the X numbers every visible control and lists what each does.
- Wording follows the device: mouse or touch.
- On phones, the sheet opens first.
- Opens only when pressed.
- Sentences: Customize text, and the translation template.
Each layout, with its controls numbered. Numbers match across layouts.
- Room: choose a room. With Gold, also a photo of the shopper’s own wall.
- Artwork: swap the selected piece.
- Size: sizes the piece is sold in.
- Add artwork Gold: hang another piece. Up to 20 per wall.
- Arrange Gold: align, space evenly, or remove the selected pieces.
- More, or Download this picture: download a picture of the wall, labeled with the site and size. Under More with a wide photo on a computer. Holds the wall and measuring tools on a shopper’s own photo.
- Save Gold: save the room and its pieces. Signed-in customers only. A dot means unsaved changes.
- Add to cart: add every piece on the wall at its shown size.
- Close: return to the page. Asks first if pieces aren’t in the cart.
- ?: numbers every control and lists what each does.
- The wall: drag a piece to move it. Arrow keys move the selection. With Gold, Shift-click or drag across bare wall to select several.
- Size line: approximate size of what’s on the wall.
- Total: price of everything on the wall.
- Handle, phones only: tap or drag up for more controls.
Closing
- X, Escape or the back button.
- With Free, guests are prompted to add the piece to their cart, or leave and lose their progress.
- With Gold, guests are prompted add all on the wall pieces to their cart, or leave and lose their progress.
- With Gold, signed in users are prompted to save their room and add all pieces to their cart, save the room without adding to the cart, or leave without saving.
- Nothing changed: closes without asking.
Keyboard
Radish works without needing a mouse.
- Tab order: the piece on the wall, each wall corner while marking, each measuring point while measuring, then the toolbar.
- Arrow keys move whatever has focus. Shift for a bigger step.
- Enter or Space selects the piece.
- Escape closes an open menu, the dialog or list open over Radish, then Radish itself.
- See Gallery Walls section below for selecting/moving multiple pieces at once.
Screen readers
Tested with NVDA in Brave on Windows.
- Every control has a name, and menus say whether they’re open.
- Two copies of the same piece are told apart: “1 of 2”, “2 of 2”.
- Two or more pieces on the wall are told apart: “1 of 2”, “2 of 2”.
- To move a piece with the arrow keys, switch NVDA to focus mode on it first: NVDA+Space.
— In focus mode, use tab to navigate between pieces on the wall
Known gaps
- With a mouse or finger, moving a piece, a wall corner, or a measuring point, means dragging. The arrow keys are the only alternative.
- Status line messages aren’t always read out.
- Not tested with JAWS, VoiceOver or TalkBack.
- Wall corner handles are small on touch screens.
- Colors tab Gold: the square in WordPress’s color picker has no screen reader name. Type the color into its box instead. This is a WordPress accessibility failing, not Radish.
The downloaded picture
Download this picture saves the room with the pieces on it, labeled with your site’s name and URL, and approximate size if the wall is measured, otherwise not to scale.
Their own photo Gold
- Room list: Click Use a photo of my own room, or Open another room photo for a signed-in customers.
- The shopper drags four points to the wall’s corners and measures one object on it. Just like shop owners do when adding the rooms in WooCommerce → Radish → Rooms
- Offered measurements: light switch plate, interior door, window, baseboard, each showing the length it assumes. Or their own. Drags the measuring line handles to the top and bottom (typically) of the object they’re measuring. It must be something on the wall to assign an accurate measurement.
- Reset the wall. Sometimes photos aren’t straight-on, which may require some guessing of the placement of the blue wall handles, and may require dragging them outside the boundaries of the photo. Clicking this brings corners dragged off the photo back inside it.
- Until a customer saves their room, their photo remains only in their browser, not uploaded to your server, and they’re told so.
- Only one room photo can be used at a time. Uploading a new one replaces it, and closing the page discards it, unless it has been saved.
- Room photos must be under 8Mb.
- Signed-in customers can save it unless you switch that feature off. See Saved rooms.
Gallery walls Gold
Shoppers are allowed up to 20 pieces on a wall.
- Add: Add artwork.
- To select several pieces, use Shift key, or drag a box around them.
- Arrange: remove selected piece(s), line up edges or centers, distribute three+ pieces evenly, across or down.
- Add the whole wall to the cart at once.
- The toolbar shows the wall’s subtotal.
- Keyboard: Shift+Enter adds a piece to the selection. Delete takes down the selection.
Saved rooms Gold
- Signed-in customers get up to 6 rooms, wall marked and measured. Any user with
Shop managerrole (and site admins) have no limit. - On by default. Off: untick Let signed-in customers save rooms at the foot of WooCommerce → Radish → Rooms. Rooms configured on this tab are still available. Saved rooms stop being offered and are deleted 90 days after last use.
Saving:
- Nothing is saved until the customer saves.
- Save shows on their own rooms, with a dot notifying them of unsaved changes.
- Closing with unsaved changes offers: save and add the wall to the cart, just save, or leave without saving.
- A save holds the photo, wall, measurement, and each pieces’s size, variation (or product, for a single piece) and place on the wall.
- Prices and titles aren’t saved; they come from the shop when the room opens.
- A piece no longer in the shop: the rest come back, and the customer is told how many are missing.
- Deleting a saved room is immediate.
- At 6 rooms, saving another asks which to replace, then to confirm.
Walls on your rooms:
- Saved the same way. Count toward the 6.
- Store the pieces and which room, never a copy of your photo.
- Use the room’s current wall and measurement. Re-measure the room and every save on it follows.
- Room deleted: the save opens with its pieces and no photo, and asks the customer to choose another room.
Photos a customer keeps Gold
| Largest file accepted | 8 MB |
| Stored at | 2000 px on the longest edge |
| Kept for | 90 days after last use; opening the preview counts as use |
- Re-encoded in the customer’s browser before upload, all IPTC and other metadata is scrubbed before upload. The original file and its camera data, location included, stay on their device unaltered.
- Stored as a JPEG with a random name in
wp-content/uploads/radish/customers/, outside the media library. - No other customer or user can see it.
7. Change the wording
WooCommerce → Radish → Customize text
- Every sentence a shopper sees can be replaced.
- Empty fields use the default. Clear the field to return to default.
- Gold’s sentences show while Gold is active. Their wording is kept if Gold is switched off and this tab saved.
Tokens are filled in when the sentence shows. Keep the braces.
| Token | Becomes |
|---|---|
{w} |
the piece’s width, in the shop’s unit |
{h} |
the piece’s height, in the shop’s unit |
{n} |
the number of pieces |
8. Translating
No translations are included. However, we do provide templates, in each plugin’s languages folder: radish-for-woocommerce.pot (free) and radish-gold.pot (Gold).
- Open one in Poedit or any PO editor.
- Translate. Save as
radish-for-woocommerce-{locale}.mo(orradish-gold-{locale}.mo), for exampleradish-for-woocommerce-fr_FR.mo. - Put the
.moinwp-content/languages/plugins/. Create the folder if needed. - Set Settings → General → Site Language to that language.
%sand%dplaceholders carry a note saying what each is. Numbered ones such as%1$scan be reordered. PO files should go inwp-content/languages/plugins/and never in Radish’s own folder because updates will delete them there.- Customize text wins over a translation, box by box. Empty boxes follow the translation.
- Customize text is one wording for every language. For wording that varies by language, leave the box empty and translate it instead.
9. Clean-up
WooCommerce → Radish → Clean-up
One box, unticked by default: Remove everything from the database when this plugin is deleted. It applies to both plugins.
- Unticked: deleting the plugin removes nothing. Use when reinstalling or moving hosts (transferring your site from one server to another intact).
- Ticked, deleting the free plugin clears its settings, rooms, wording and product settings, and deletes the artwork and room photo files.
- Ticked, deleting Gold clears the license key, customers’ saved rooms and their photos.
- Delete Gold first. WordPress won’t delete the free plugin while Gold is installed, even deactivated.
- Deleting doesn’t release the license. Use Release this site on the License tab first!
10. Colors Gold
WooCommerce → Radish → Colors
- Set the main color, the text on it, warnings and the keyboard focus ring.
- The main color is used on main buttons such as Add to cart, on selected choices, and on the product page link.
- Under the colors, each pair is checked against WCAG AA. A pair that falls short shows in red with what it needs, but still saves.
- Click Default in any of the color pickers to reset the color.
Troubleshooting
Own photos, gallery walls, saved rooms or product links missing. Ensure Radish Gold is activated, and has an activated key on the License tab. Saved rooms also need enabling on the Rooms tab.
No room in the preview. Without Gold, shoppers only get your rooms. Add one under WooCommerce → Radish → Rooms. Radish will show a blank preview space until at least one room is fully configured.
A product has no preview link. Gold Enable Room preview, ensure Default artwork is uploaded, and a published page is set under Preview page → Product page link. A single piece also needs its size, and stock, to show up.
A single piece isn’t in the preview. Its Size values on the Radish tab is empty, or it’s out of stock.
A size is red: can’t be shown to scale. The products variation size couldn’t be read. Rename it, such as 16x20 or 40x50 cm.
A shopper’s measurement looks wrong. Usually the four blue points aren’t at the wall’s corners, or the measured object isn’t on the wall. Anything nearer the camera than the wall reads too big and shrinks everything else. Only measure items on the wall.
Gold says it needs a newer Radish for WooCommerce. Update Radish for WooCommerce under Dashboard → Updates.
Gold says it was made for an earlier Radish for WooCommerce. Update Radish Gold. Until then it stays switched off.
Toolbar controls look wrong on my theme. Report it, with the theme name.
Getting help
hello@paperpixelstudio.com
Include your WordPress, WooCommerce and PHP versions, your theme name, author, and version, and what you were doing. Tools → Site Health → Info lists the versions.