-
Notifications
You must be signed in to change notification settings - Fork 0
/
readme.txt
368 lines (247 loc) · 15.5 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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
=== Meal Tracker ===
Contributors: aliakro
Donate link: https://www.paypal.me/yeken
Tags: meal, tracker, calories, weight, food
Requires at least: 5.7
Tested up to: 6.5
Stable tag: 3.3
Requires PHP: 7.2
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
Allow your users to track their meals and calorie intake for any day.
== Upgrade Notice ==
The initial build of Meal Tracker!
== Description ==
Extend your site by allowing your users to track their meals and calorie intake. Calorie targets for the day can be set by admins, the users or automatically pulled from [Yeken's Weight Tracker](https://wordpress.org/plugins/weight-loss-tracker/ "Yeken's Weight Tracker").
== Documentation ==
For further information read our documentation:
[Meal Tracker - Documentation](https://mealtracker.yeken.uk)
= Core Features =
* [\[meal-tracker\]](https://mealtracker.yeken.uk/shortcodes/meal-tracker.html) shortcode.
* Your user's can log their meals and calorie intake.
* Visual graph to show your user the percentage of their daily allowance used.
* Add meals for Breakfast, Mid-morning, Lunch, Afternoon, Dinner and Evening.
* View total calorie intake for the entire day or a breakdown.
* Each user has their own meal collection.
* Users can create and edit their meals.
= Premium Features =
* **Additional shortcodes** - Enhance your site with extra shortcodes.
* **External APIs** - Allow your users to browse FatSecrets Food and Recipe APIs.
* **Own Meal collection** - Build your own meal collection for your users to explore.
* **Edit user's meals** - Manage your user's meal collections by viewing, editing, and deleting meals.
* **Create and view entries** - Enable your users to create and view meal entries for any date.
* **Edit entries** - Give your users the ability to edit their entries for any selected day.
* **Edit Meals** - Enable your users to modify their saved meals.
* **Calorie Allowance sources** - Retrieve daily calorie limits from external sources, such as YeKen's Weight Tracker.
* **Compress meal items** - Consolidate multiple meal lines into a single entry line.
* **Unlimited meals per user** - Users are no longer restricted to a maximum of 40 meals and can now add as many meals as they wish.
* **Access your user's data** - Access all their entries, meals, and calorie intake
* **Set calorie allowances** - Assign daily calorie allowances for your users.
* **Summary Statistics** - Review summary statistics of your Meal Tracker data and analyze its usage by your users.
* **Fractional meal quantities** - If enabled in the settings, you can use additional quantity options of 1/4, 1/2, and 3/4 when adding meals to an entry.
* **Admin Search** - Search for users by name or email address.
* **Additional settings** - Additional settings for tailoring your Meal Tracker experience.
== 3rd Party Libraries ==
As with most modern software, this plugins utilises other 3rd party plugins. Depending on how you use the plugin (i.e. which shortcodes) determines which libraries maybe used. Below is a list of the 3rd party libraries used:
* [animated.css](https://animate.style/)
* [animatedModal.js](https://joaopereirawd.github.io/animatedModal.js/)
* [Chart.js](https://www.chartjs.org/)
* [FatSecret API](https://platform.fatsecret.com/) - [Terms of Service](https://platform.fatsecret.com/terms)
* [Footable](https://fooplugins.github.io/FooTable/)
* [Font Awesome](https://fontawesome.com/)
* [jQuery Confirm](https://craftpip.github.io/jquery-confirm/)
* [LoadingOverlay](https://gasparesganga.com/labs/jquery-loading-overlay/)
* [notify.js](https://notifyjs.jpillora.com/)
* [Selectize](https://github.com/selectize/selectize.js)
* [ZOZO UI Tabs](http://www.zozoui.com)
* [Zebra Datepicker](https://github.com/stefangabos/Zebra_Datepicker)
YeKen libraries:
* [YeKen Shop API prices](https://shop.yeken.uk) - [Privacy Policy](https://shop.yeken.uk/privacy-policy/)
== Installation ==
1. Login into Wordpress Admin Panel
2. Navigate to Plugins > Add New
3. Search for "Meal Tracker"
4. Click Install now and activate plugin
Read more at [Meal Tracker - Documentation](https://mealtracker.yeken.uk) .
== Frequently Asked Questions ==
= Does it support Yeken's Weight Tracker plugin? =
Yes. If you have have the Pro Plus version of Weight Tracker, a user's calorie allowance can be taken from there.
= Language support =
The plugin is written in English (UK) but is ready for translation. If you wish to add translations, please email me at [email protected]
== Screenshots ==
1. Main view of [meal-tracker] shortcode.
2. "Add meal" view of [meal-tracker] shortcode.
3. Admin UI - summary overview.
4. Admin UI - user summary view.
5. Admin UI - view entry details.
6. Setup Wizard.
7. [meal-tracker] placement.
8. Search an external API for meals.
9. Manually add own meal to meal collection.
== Upgrade Notice ==
3.1 - Communicate and search with meal collections from other WP installs with Meal Tracker installed.
== Changelog ==
= 3.3 =
* New feature: Auto updater that doesn't reply on WordPress.org
= 3.2.4 =
* Various minor bug fixes.
= 3.2.3 =
* Updated features and readme.txt.
= 3.2.2 =
* Improvement: Added messaging from YeKen.uk.
* Bug fix: Changed location of page titles.
= 3.2.1 =
* Bug fix: Can now set a user's calorie limit via admin screens.
* Bug fix: Fixed a couple of localisation function calls.
* Improvement: Added additional sanitising around $_POST, $_GET and $_SESSION.
* Improvement: Added additional escaping around data when written to browser.
* Improvement: Removed an interation over $_POST.
* Improvement: Ran more SQL queries through wpdb->prepare().
* Improvement: Various minor code changes.
* Maintenance: Updated Chart.js to latest library.
* Maintenance: Updated Selectize.js to latest library.
= 3.2 =
* Bug fix: Corrected date format on ['mt-table-entries] shortcode.
Several fixes based upon WordPress's plugin feedback:
* Removed moment.js from plugin and replaced with the version shipped with WP.
* The following are now bundled with the plugin, rather than included via a CDN: FontAwesome, Chart.js, jquery.Confirm
* Included all non minified versions of 3rd party library code and added 3rd party dependencies to readme.
* Added additional data sanitisation in places.
* Several other code tweaks.
= 3.1.7 =
* Security fix: Removed reference to PolyFill ResizeObserver
= 3.1.6 =
* Maintenance: Updated tested with WP 6.5 note.
= 3.1.5 =
* Improvement: When a user is on the Meal Tracker settings tab, if they have not specified all of their user profile in Weight Tracker, then warn them that "Weight Tracker" can not be used as a source.
= 3.1.4 =
* Bug fix: Fixed an issue where user's recently added meals were not appearing within the search results.
= 3.1.3 =
* Bug fix: Fixed PHP error issue when no calorie allowance set.
= 3.1.2 =
* Bug fix: When importing a meal from an external source, don't incorrectly set it to be an admin meal (i.e. searching up in every other users meal searches).
* Improvement: DB change, "added_by_admin" column now defaults to 0 when a row is added into the meal collection table.
= 3.1.1 =
* Version bump for SVN issue.
= 3.1 =
* Improvement: Communicate and search with meal collections from other WP installs with Meal Tracker installed.
* Bug: Decimal places were lost when importing macronutrients via CSV.
= 3.0.13 =
* Updated "Tested upto" statement.
= 3.0.12 =
* Updated "Tested upto" statement.
= 3.0.11 =
* Improvement: Added the ability to translate calendar months, days and today's button.
* Improvement: Added a new argument "chart-hide" to [meal-tracker] to hide the chart.
= 3.0.10 =
* Tested up to version 6.0.
= 3.0.9 =
* Updated "Tested upto" WP version.
= 3.0.8 =
* New setting: "Calories Allowed colour" - specify the calories user colour on the pie chart.
= 3.0.7 =
* Updated version WP compatibility statement.
= 3.0.6 =
* Version bump.
= 3.0.5 =
* Updated translation files.
= 3.0.4 =
* Updated version WP compatibility statement.
= 3.0.3 =
* Bug fix: Removed stray var_dump()
= 3.0.2 =
* Bug fix: In some cases, the side bar was missing from admin user panels.
= 3.0.1 =
* Improvement: Small improvements to documentation.
= 3.0 =
* New feature: CSV Import. Bulk import meals into your meal collection. https://mealtracker.yeken.uk/csv-import.html
* New feature: New shortcode: [mt-chart-entries] which displays a chart of the user's entries. Read more: https://mealtracker.yeken.uk/shortcodes/mt-chart-entries.html
* New feature: New shortcode: [mt-table-entries] which displays a table of the user's entries. Read more: https://mealtracker.yeken.uk/shortcodes/mt-table-entries.html
* New feature: New shortcode: [mt-date-oldest-entry] which displays the date of the user's oldest entry. Read more: https://mealtracker.yeken.uk/shortcodes/mt-date-oldest-entry.html
* New feature: New shortcode: [mt-date-latest-entry] which displays the date of the user's latest entry. Read more: https://mealtracker.yeken.uk/shortcodes/mt-date-latest-entry.html
* New feature: New shortcode: [mt-count-entries] which displays a count of the user's entries. Read more: https://mealtracker.yeken.uk/shortcodes/mt-count-entries.html
* New feature: New shortcode: [mt-count-meals] which displays the number of meals the user has added to their collection. Read more: https://mealtracker.yeken.uk/shortcodes/mt-count-meals.html
* New feature: New shortcode [mt-chart-today] which is used to display the user's progress for today. Read more: https://mealtracker.yeken.uk/shortcodes/mt-chart-today.html
* New feature: New shortcode: [mt-calories-allowance] displays the calorie allowance for today's entry. Read more: https://mealtracker.yeken.uk/shortcodes.html
* New feature: New shortcode: [mt-calories-remaining]] displays the remaining calorie allowance for today's entry. Read more: https://mealtracker.yeken.uk/shortcodes.html
* New feature: New shortcode: [mt-calories-used] displays the calories used for today's entry. Read more: https://mealtracker.yeken.uk/shortcodes.html
* New feature: New shortcode: [mt-calories-used-percentage] displays the percentage of calories used for today . Read more: https://mealtracker.yeken.uk/shortcodes.html
* New feature: Added a "Delete all cache" button a user's profile within the admin area.
* Improvement: Display and change the order of boxes on user summary and profile page (admin).
* Improvement: Set the height of the progress chart in [meal-tracker] shortcode to 200px. This can be overridden using the shortcode argument below.
* Improvement: Added the argument "chart-height", "chart-type", "chart-hide-legend" and "chart-hide-title" to the shortcode [meal-tracker] Read more: https://mealtracker.yeken.uk/shortcodes/meal-tracker.html
* Improvement: Added the argument "url-login" to the shortcode [meal-tracker] Read more: https://mealtracker.yeken.uk/shortcodes/meal-tracker.html
* Improvement: Removed caching layer and integrated the new optimised caching layer that was written from scratch for Weight Tracker.
* Improvement: Upgraded underlying charting library (from Chart.js 2 > 3) and updated related MT code.
* Improvement: Re-factored underlying charting code so cleaner and optimised.
* Improvement: Added 'kcal' to chart labels.
* Improvement: Added Bezier curve to lne graphs.
* Bug fix: Date format is now taken from WordPress admin settings.
* Bug fix: Removed duplicate HTML element with the ID "yk-mt-button-meal-add".
* Bug fix: Replaced incorrect reference to plugin slug used with in gamification.
* Added links to the new Meal Tracker documentation site https://mealtracker.yeken.uk
= 2.5.1 =
* Bug fix: Removed empty line from gamification PHP file.
= 2.5 =
* New Feature: Support for myCred. Reward your users for creating new entries and adding meals to their entries.
= 2.4.4 =
* Updated "Tested upto" statement within readme.txt
= 2.4.3 =
* Signed off as working with 5.6
= 2.4.2 =
* Bug fix: Corrected language domain and path
= 2.4.1 =
* Bug fix: Back slashes are now removed from meal titles and descriptions (when used to escape quotes).
* Improvement: Updated Arabic translations (thanks @Saeed)
= 2.4 =
* New feature: If enabled, MacroNutrient values are displayed on Meal line items.
* Improvement: When settings are saved, entire cache is invalidated.
= 2.3 =
* New Feature: If enabled (via settings) new quantity settings of 1/4, 1/2 and 3/4 are available when adding meals to an entry.
= 2.2 =
* New feature: "Meal Collection" - ability to create a library of meals that your users can search.
* New feature: View, edit and delete meals in your user's meal collections.
* Improvement: Added extra security to Ajax calls to ensure a user cant edit another user's meals.
* Bug fix: Description is correctly updated when modified by a user.
* Bug fix: Removed edit button against meals that a user has added from someone else's collection i.e. restrict user's to editing their own meals.
* Bug fix: Under "Calorie Allowance", allow the setting "User specified" to be saved correctly when not premium
= 2.1 =
* New Feature: Support for FatSecrets Food API (https://platform.fatsecret.com/api/Default.aspx?screen=rapiref2&method=foods.search)
* Improvement: Added "Oz" unit for meals.
= 2.0.2 =
* Bug fix: Added missing text for translations.
* Bug fix: Error being thrown on settings page for external sources.
= 2.0.1 =
* Bug fix: Always create Macronutrient MySQL columns regardless of being enabled.
= 2.0 =
* Improvement: Underlying framework for supporting lookup of meals from external APIs.
* Improvement: FatSecret integration (look up meals from them).
* Improvement: Major overhaul of CSS.
* Improvement: Added unified look that ensures it looks more consistent across various themes.
* Improvement: Added a check on Settings page to check that all MySQL tables are present for the plugin. Option to rebuild them if not.
* Improvement: Basic support for specifying fats, proteins and carbs against meals. This will be expanded in the future to render totals and allow sites to focus on totals other than calories.
* Improvement: Added the underlying frame work for custom fields (although currently only utilised for MacroN fields).
* Bug fix: Fixed quantity error handling.
* Bug fix: Replaced deprecated jQuery code.
= 1.2 =
* Improvement: Added Arabic translations (thanks @Saeed)
* Bug fix: Minor bug fixes throwing PHP errors.
* Bug fix: Incorrect slug used for localisation.
* Bug fix: Warning being thrown for missing array index.
= 1.1 =
* Improvement: Added meal description to "View Entry" page in admin. (#66)
* Improvement: New Setting that enables users to search for meals added by any user. (#61)
* Improvement: New Settings that specify whether users are permitted to add new entries in the past and / or future (#72)
* Improvement: Clearer display names for users. (#73)
* Improvement: Admins can now delete user entries and mark their meals as deleted. (#68)
* Improvement: Options to display summary of entries for today, last 7 days, latest 100 and latest 500 on user data dashboard (#65)
* Improvement: Entry summary on the user data dashboard is now cached for 5 minutes to improve performance.
* Bug Fix: Err was being displayed for meal unit if not description had been set for a meal. (#64)
* Bug Fix: Added POT and en_GB language files. This should aid those that wish to translate the plugin (#74)
* Bug Fix: Minified CSS and JS in front end (#37)
* Bug fix: Fix an issue where Weight Tracker can't be selected correctly as a Calorie Allowance source.
* Bug fix: Responsive fix when adding menu link to Weight Tracker
= 1.0.1 =
* Bug Fix: Removed reference to missing function ws_ls_create_dialog_jquery_code()
= 1.0 =
* Initial Release