Changeset 1532212

Timestamp:

11/11/2016 10:01:56 AM (9 years ago)

Author:

tero2000

Message:

More information in the readme and two new images added

Location:

give-me-recipes

Files:

• assets/screenshot-1.png (added)
• assets/screenshot-2.png (added)
• trunk/readme.txt (modified) (3 diffs)
• trunk/ts-give-me-recipes.js (modified) (2 diffs)
• trunk/ts-give-me-recipes.php (modified) (4 diffs)

give-me-recipes/trunk/readme.txt

@@ -2 +2 @@
 Contributors: tero2000
 Donate link: startwordpressonline.net
-Tags: widgets, food, recipes, ruoka, resepti, search food, cooking
+Tags: widgets, food, recipes, ruoka, resepti, search food, cooking, food recipes, cocktails, drinks
 Requires at least: 3.3
 Tested up to: 4.6
@@ -13 +13 @@
 == Description ==
 
-This plugin uses Recipe Puppy API to get recipes. User can choose the ingredients like tomato, garlic etc. and / or search with a type of food as well like pasta for example. You can also use the plugin to search for drinks.
+This plugin uses Recipe Puppy API to get food recipes. User can choose the ingredients like tomato, garlic etc. and / or search with a type of food as well like pasta for example. You can also use the plugin to search for drinks like cocktails for example. So instead of just looking for food recipes you can also search for new ideas have to mix proper cocktails like mojitos for example. With the drinks the plugins works the same as well as it works with food recipes.
 
-To use the Recipe Puppy you don't need to have an API key at the moment. 
+To use the Recipe Puppy you don't need to have an API key at the moment. For more information concerning the API visit www.recipepuppy.com
 
-Results will display after the search is done and to access the full recipe user is provided with a link to it.
+Results will be displayed after the search for food recipes is done. The result will display the link to access  the full recipe alongside image of the recipes if there is one. 
+
+This plugin is a really good to add on food related websites like food bloggers for example as it creates additional value for the visitors. 
 
 == Installation ==
 
-1. Upload `plugin-name.php` to the `/wp-content/plugins/` directory
+1. Upload `plugin-name.php` to the `/wp-content/plugins/` directory or install through the Plugins menu
 2. Activate the plugin through the 'Plugins' menu in WordPress
 3. Place the plugin in footer or sidebar.
@@ -27 +29 @@
 == Frequently asked questions ==
 
-= A question that someone might have =
+= What languages can I use when searchin recipes? =
+
+At the moment the plugins works in English. As it uses the API provided by recipepuppy, you can look if they are thinking of adding another language in the future. 
+
+= Do I have to use both ingredients and search fields? =
+
+No, you don't have to use both fields to search for food recipes as you can use just one as well. Even better, leave both empty and get random results!
+
+= Is Get Recipes free to use? =
+
+Yes, this plugin is free to use.  
+
+== Changelog ==
+
+= 1.0 =
 
 == Screenshots ==
 
-1. Adding Food Recipes widget to the sidebar
+1. Adding Food Recipes widget to the sidebar in Dashboard -> Appearance -> Widgets
+
+2. The plugin showing results after search.
 
 == Changelog ==

give-me-recipes/trunk/ts-give-me-recipes.js

@@ +1 @@
+/*
+* Give me recipes JS
+* Using ajax so there is no page refresh
+*/
 jQuery(document).ready(function(){
+
+// When the search button is pressed.
  jQuery( "#give-me-recipe" ).click(function( event ) {
+
+  // Prevent the default button action.
    event.preventDefault();
 
+  // Get information from the form we're submitting.
    var form = jQuery('#recipes-form');
         formsAction = form.attr( 'action' );
-   jQuery(form).fadeOut(300);
+   jQuery(form).fadeOut(300); 
+
+   // Add the nice .gif thingy so it looks like we're loading :) 
+    // Using timeout function here so it happens smoothly
      setTimeout(function(){  
       jQuery('#the-recipes').append('<li><img src="'+wp_urls.plugin_url+'/img/clock.gif"></li><li>Searching recipes ...</li>');
       }, 400);
 
+  // Get values from the form fields.
     var ingredients = jQuery('#ingredients').val();
     var query = jQuery('#query').val();
+
+    // Submit the information
     jQuery.ajax({
         type:"POST",
@@ -22 +37 @@
         },
         success:function(response){
-
+        // Getting the response AKA the recipes.
           var obj = response.results; 
+        // Set timeout funtion again here so the loading gif is displayed a bit longer. 
           setTimeout(function(){  
            jQuery('#the-recipes').empty();

give-me-recipes/trunk/ts-give-me-recipes.php

@@ -12 +12 @@
 
 if ( ! defined( 'ABSPATH' ) ) exit; 
-// Load Styles
+// Load Styles for the admin, not actually necessary.
 function foodrecipes_backend_styles() {
 
@@ -20 +20 @@
 add_action( 'admin_head', 'foodrecipes_backend_styles' );
 
-// Ajax function when sending the form
+// Ajax function when sending the form this and the js file are the ones that do the magic. 
 function recipe_ajax_request() {
  $i = $_REQUEST["ingredients"];
@@ -34 +34 @@
 
 
+// Loading the js file and the css file.
 function foodrecipes_frontend_scripts_and_styles() {
 
@@ -66 +67 @@
 
  /**
-  * Front-end display of widget.
+  * Front-end display of widget. What will be put to the sidebar. 
   *
   * @see WP_Widget::widget()