search

CondeNast / recipe_plugin

Ziplist Recipe Plugin for Wordpress
http://www.ziplist.com/recipe_plugin
20 stars 13 forks source link

readme

ZipList Recipe Plugin

ZipList recipe formatting for WordPress.

This code is derived from the 1.3.1 build of RecipeSEO released by codeswan.

Formats recipes so they are SEO-friendly. Now fully supports WordPress 4.0.1.

Description

ZipList brings your recipes right to your readers’ tables!

Make your recipes SEO-friendly and more likely to appear in Google's Recipe View search. No need to hand-code your recipes into a sophisticated recipe structure when the ZipList Recipe Plugin will do all the heavy lifting for you, enhancing the findability of your recipe website.

If you’re familiar with the open-source RecipeSEO plugin built by Allison Day, you’ll quickly note that the ZipList Recipe Plugin is an extension of this plugin.

Among the new features added by ZipList are:

Works with WordPress 4.0.1: Updated for full compatibility with WordPress 4.0.1.

Schema/Recipe Support: Automatically integrate Schema.org's Recipe mark-up into your recipe posts to make them more findable by search engines.

Recipe Image Support: Add images within the plugin to appear with your recipe or in your Google Rich Snippet.

Copy/Paste Ingredients: Simply cut a block of ingredients and paste them into one field. No need to add each ingredient one by one into separate fields.

Auto-Populate Recipe Name: The recipe name is automatically replicated inside the plugin, taking the name from the post name, which further enhances SEO.

Add Links to Ingredients or Instructions: Attach affiliate links or links to related recipes from the Ingredients, Instructions or Summary fields with ease. No other plugin enables you to do this.

Bold and Asterisk Styling: Add bold or italicized styling to words or phrases within the Ingredients, Instructions, Summary and Notes sections.

Modified Image Display: Add a recipe image to the plugin so that it displays in a user’s recipe box and shopping list, but then choose to hide it from view on your recipe post and/or print view.

Incorporate Images into Instructions: Now you can easily add step-by-step images to your instructions (or ingredients) from within the plugin.

Notes Field: Add notes to your recipes, such as optional ingredients, required kitchen tools and equipment and/or additional instructions (e.g., freezing, microwave, etc.)

Enhanced Printing Capabilities: Add a copyright statement or URL to appear at the bottom of your printed recipes. Also, display a permalink at the bottom of printed recipes so users can easily find individual recipes on your website.

Multiple Paragraph Support in Summary Section: Users can now add multiple paragraphs to the Summary field within the plugin.

The ZipList Recipe Plugin is very easy use, however we also provide enhanced step-by-step instructions. Please note that the ZipList Recipe Plugin is no longer actively maintained and may not be updated in the future.

Installation

You can download and install the ZipList Recipe Plugin using the built-in WordPress plugin installer. If you download the ZipList Recipe Plugin manually, make sure it is uploaded to "/wp-content/plugins/ziplist-recipe-plugin/".

Activate the ZipList Recipe Plugin in the "Plugins" admin panel using the "Activate" link.

To use the plugin, click the little ZipList Recipe icon on the "Edit Post" pages, right next to the other editor toolbar buttons at the top of the text editor box. Then enter the details about your recipe into the appropriate boxes, and then click the "Add Recipe" button. This will save your recipe, and insert it into your blog post.

The ZipList Recipe Plugin is very easy use, however we also provide enhanced step-by-step instructions. Please note that the ZipList Recipe Plugin is no longer actively maintained and may not be updated in the future.

Frequently Asked Questions

What happened to the Save Recipe button that was on my recipes?

The save recipe button, recipe box and shopping list are no longer available in the plugin, however, the plugin will continue to display your recipes.

How do I edit a recipe with the ZipList Recipe Plugin?

Starting with version 2.4, you'll want to click the spoon and fork icon on the visual editor toolbar to both create and edit a recipe. You no longer need to click on the image placeholder within the blog post to edit a recipe.

Can I use the plugin to add multiple recipes to one post or page?

There should only be one recipe per post or page. The plugin does allow for compound recipes which is one way to include multiple lists of ingredients in your post (e.g., for a salad and a salad dressing).Simply enter your instructions for the main recipe, then start the next line with an exclamation point to create a label, like "!For the Salad Dressing". Then, add the instructions for the secondary recipe. Starting with version 2.4, we no longer support multiple ZipList-formatted recipes within a single post.

When I use ZipList's plugin, where are the recipes stored?

With the ZipList Recipe Plugin, your recipes are stored safely in a separate DB table in your main WP database. The recipe table is named wp_amd_zlrecipe_recipes and you can take a look at it yourself using any WordPress database tools at your disposal.

What happens to my recipes now that ZipList has gone away?

The short answer is "nothing"! :) The ZipList Recipe Plugin simply takes the recipe information from your own database and displays it with SEO annotation. It does this without any connection or communication with the ZipList service and is completely independent. You will continue to enjoy SEO-friendly display of your recipes without any connection to ZipList. Please note that the ZipList Recipe Plugin is no longer actively maintained and may not be updated in the future.

Why do you put a placeholder image into my Edit Post page, instead of my actual recipe?

Because of the way the WordPress text editor works, if you decide to add or remove something from your recipe using the text editor, it can very easily mess up the markup of the code - so the ZipList plugin prevents that from happening by not allowing you to edit the recipe in the text editor.

Screenshots

The ZipList Recipe Plugin icon appears as a fork and spoon on the visual editor toolbar.

Screen Shot 1

It's easy to enter the basic information for your recipes: the title, the ingredients, and the instructions for preparing the recipe.

Screen Shot 2

There is no limit to the number of ingredients you can add.

Screen Shot 3

And if you want to add even more information about your recipe, such as your rating of the recipe, or the serving size, all you have to do is click the "More Options" link, and you can!

Screen Shot 4

You can fill out as many or as few additional options as you would like.

Screen Shot 5

Once you click the "Add Recipe" button, a placeholder image will be inserted into your post where your recipe will go. If you need to edit your recipe, simply click on the spoon and fork icon in the visual editor toolbar (you do not need to click on the recipe placeholder as you did in previous releases of the plugin).

Screen Shot 6

Once you preview or publish the post, your recipe will be there with all your microformats... without any extra work from you!

Screen Shot 7

Changelog

3.1 Documentation Update

3.0 Final Release

2.6 Maintenance Release

2.5 Bugfix Release

2.4 Editor Upgrade, Performance and Bugfix Release

2.3 Emergency Fix for WordPress 3.9 upgrade to TinyMCE v4

2.1/2.2 Bugfix Releases

2.0 Features Release

1.41 Bugfix Release

1.4 Features Release

1.3 Features Release

1.2 Features Release

1.1 Address problem with wp-content reachability of the edit form on some blogs.

1.0 Initial Release

0.9 First iteration, derived from Recipe SEO 1.3.1 -- thanks for the jump-start Allison! (http://sushiday.com/recipe-seo-plugin/)

Other Notes

The save recipe button, recipe box and shopping list features are no longer available or supported in the plugin.

Please note that the ZipList Recipe Plugin is no longer actively maintained and may not be updated in the future.