-
Notifications
You must be signed in to change notification settings - Fork 4
/
readme.txt
177 lines (118 loc) · 7.02 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
=== 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](http://themeforest.net/item/food-cook-multipurpose-food-recipe-wp-theme/4915630) theme.
For food blogs that are not based on the food-cook theme, It is possible to create a [custom post type](https://wordpress.org/plugins/custom-post-type-ui/) 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.
<pre><code>
<?php echo do_shortcode( '[embed_nutrition_label]' ) ?>
</code></pre>
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.
<pre>
<code>
[embed_nutrition_label]
</code>
</pre>
= How to Video =
https://www.youtube.com/watch?v=oM1LoVSacss
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](https://github.com/nutritionix/nutrition-label) which we have tweaked and used here.
We at [www.globalfoodbook.com](http://www.globalfoodbook.com) are open source and agile proponents. We have open sourced this plugin on [github](https://github.com/globalfoodbook/nutrition-facts-label) 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.0 =
* 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](https://github.com/globalfoodbook). 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 [email protected]: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]`