Skip to content

clintwine/nutrition-facts-label

 
 

Repository files navigation

Nutrition Facts Label

Contributors: (kengimel) Tags: food, nutrition, nutrition facts, nutrition label, food-cook, recipe plugin, shortcode, global food book Requires at least: 3.0.1 Tested up to: 4.4 Stable tag: 1 License: GPLv2 or later License URI: http://www.gnu.org/licenses/gpl-2.0.html

This plugin provides food bloggers with the ability to add nutrition facts label to their recipe post(s).

Description

Our motivation for releasing this plugin is based on a forum discussion on the food-cook theme support site.

We felt that we already had some code that could serve as a basis for producing this plugin, other food bloggers could benefit and possibly improve on.

This plugin will work best on blogs that use food-cook theme.

For food blogs that are not based on the food-cook theme, It is possible to create a custom post type called "recipe" and an ingredients post_meta entry with key "RECIPE_META_ingredients".

We strongly recommended taking this route or using this plugin under the guidance of a Wordpress developer.

From a more technical side, In order to generate a nutrition facts label, you can either generate an image or generate a post_meta key (gfb_recipe_meta_nutrition_facts) that holds JSON data (for each recipe) which is used to generate a nutrition label.

This plugin also includes a meta box within the recipe post edit page in the admin area, which automatically reads the post_meta entry with key "RECIPE_META_ingredients" which mainly contains your ingredients list and uses that to generate the nutrition label.

In order to automatically display a nutrition label on the every recipe, your Wordpress developer should add this line of code to the best possible place.

  <?php echo do_shortcode( '[embed_nutrition_label]' ) ?>

It is also possible to embed this as a short-code from the text editor.

But based on the food-cook recipe page layout your options may appear limited, hence why it is best that a Wordpress developer helps out here.

  [embed_nutrition_label]

How to Video

Nutrition Facts Label Wordpress Plugin Video

This plugin provides food bloggers with the ability to add a nutrition facts label to their recipe post(s).

This plugin provides image download option or short-codes as possible ways of sharing nutritive insights. It also provides an update facility that adds a nutrition facts label to already existing recipe posts.

Big thanks to the guys at nutritionix for sharing their javascript nutrition label which we have tweaked and used here.

We at www.globalfoodbook.com are open source and agile proponents. We have open sourced this plugin on github and will continue to improve this.

We appreciate the help we have received from using other plugins and would like to contribute back to this awesome Wordpress community at every chance possible.

At the moment we are working on improving our algorithms on the backend and would like it if you could join us.

We would love to hear from you on ways this can be improved, give us a shout via the our website or via email (we [at] globalfoodbook.com).

Thanks

How to Use this Nutrition Label?

Login into your Wordpress account. Scroll down to the "Ingredients Section" and list the Ingredients. Press "Generate Label" on the Nutrition Facts Label Generator. The nutrition facts are automatically generated for you. N:B List the ingredients individually including the quantities.

How to Include Nutrition Label on Existing Recipes?

To include nutrition label on existing food recipes, simply press the "Go" button for automatic generation of the nutrition label. For any unsuccessful updates, make sure that the ingredients are placed line by line and in each line they are without commas or fullstops. Then press the "Go" button to generate label.

Installation

  1. Upload /nutrition-facts-label to the /wp-content/plugins directory
  2. Activate the plugin through the Plugins menu in WordPress

Frequently Asked Questions

How do I use this Nutrition Label ?

Login into your Wordpress account. Scroll down to the "Ingredients Section" and list the Ingredients. Press "Generate Label" on the Nutrition Facts Label Generator. The nutrition facts are automatically generated for you. N:B List the ingredients individually including the quantities.

How to Include Nutrition Label on Existing Recipes

To include nutrition label on existing food recipes, simply press the "Go" button for automatic generation of the nutrition label. For the unsuccessful updates, make sure that the ingredients are placed line by line and in each line they are without commas or fullstops. Then press the "Go" button.

Screenshots

  1. Generate Nutrition Facts Label
  2. Update existing recipes.
  3. Sample on the recipe page.

Changelog

1.0

  • Initial Release

1.1

  • Fixes and Modifications
  • Documentation

1.2

  • Bump wordpress compatibile versions

1.5

  • Add configrable NUT_API environment variable

Upgrade Notice

1

  • Initial Release

1.1

  • Fixes and Modifications
  • Documentation

1.2

  • Bump wordpress compatibile versions

1.5

  • Add configrable NUT_API environment variable

Notes to developers

Contributing

If you would like to contribute to our suite of plugins, head on over to Global Food Book Labs. Feel free to fork and contribute back.

  1. Fork it (https://github.com/globalfoodbook/nutrition-facts-label)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Adding Screenshots to the Wordpress repo

  1. Rename each screenshot for each step like this. For step 1 the screenshot is screenshot-1.png.
  2. The banner image is named as banner-772x250.png.
  3. Use an SVN client like smart svn or rapid svn etc to upload these images to the /assets folder.
  4. After this, commit and all will be picked up.

Pushing plugin to Wordpress svn repo

  1. Clone this repo

       `git clone git@github.com:globalfoodbook/nutrition-facts-label.git`
    
  2. cd path/to/nutrition-facts-label

  3. vim .git/config

  4. Add the code below:

       [svn-remote "svn"]
               url = http://plugins.svn.wordpress.org/[plugin_name]/trunk
               fetch = :refs/remotes/git-svn
    
  5. Then merge the master into the new branch:

       `git svn fetch svn`
       `git checkout -b svn git-svn`
       `git merge master`
       `git svn dcommit --username [Wordpress.org username]`
    
  6. Then rebase that branch to the master, and you can dcommit from the master to svn

       `git checkout master`
       `git rebase svn`
       `git branch -d svn`
       `git svn dcommit --username [Wordpress.org username]`
    

About

The nutrition label service wordpress plugin..

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 87.6%
  • PHP 9.3%
  • CSS 2.6%
  • HTML 0.5%