[recipes] Add docs fixes with feedback from mclasen



commit 9671e15b514235d2547574a5586889828b14dd41
Author: Paul Cutler <paul r cutler gmail com>
Date:   Tue Mar 21 19:06:17 2017 -0500

    Add docs fixes with feedback from mclasen
    
    In details, clarify that name and servings are mandatory.  In
    add-recipe-images add steps for adding multiple images at the
    same time.  In recipe-directions give additional detail on adding
    timer tags and break into sections the tags for temperature, images
    and steps.

 help/C/add-recipe-details.page    |    5 ++-
 help/C/add-recipe-directions.page |   59 ++++++++++++++++++++++++------------
 help/C/add-recipe-images.page     |   46 +++++++++++++++++++++++++----
 3 files changed, 83 insertions(+), 27 deletions(-)
---
diff --git a/help/C/add-recipe-details.page b/help/C/add-recipe-details.page
index b30ed40..c079a5e 100644
--- a/help/C/add-recipe-details.page
+++ b/help/C/add-recipe-details.page
@@ -24,7 +24,10 @@
   <title>Add Recipe Details</title>
       <p>Press the <gui>New Recipe</gui> in the upper left corner of 
       <app>Recipes</app> and include the following information about your 
-      recipe in the <gui>Details</gui> section. Each field is optional.</p>
+      recipe in the <gui>Details</gui> section. The recipe name
+      and serving size is required and all other fields are optional. 
+      It is helpful to fill as many fields as possible to help when searching
+      <app>Recipes</app>.</p>
       <steps>
         <item><p><gui>Name Your Recipe</gui>: Enter the name of the recipe in
         the text box.</p>
diff --git a/help/C/add-recipe-directions.page b/help/C/add-recipe-directions.page
index 48355a4..45b9d14 100644
--- a/help/C/add-recipe-directions.page
+++ b/help/C/add-recipe-directions.page
@@ -21,32 +21,51 @@
   </info>
   
   <title>Add Cooking Directions</title>
+  
+  <section id="steps">
+  <title>Add steps</title>
   <p>Press the <gui>New Recipe</gui> in the upper left corner of 
     <app>Recipes</app>.  In the Directions text box, type the steps needed 
     to create the recipe.  To separate each step, press <key>Enter</key> twice 
-    to create a new paragraph for each step.  <app>Recipes</app>
-    will automatically create separate steps for your
+    to create a new paragraph for each step. <app>Recipes</app>
+    will automatically create a separate steps for each paragraph in your
     recipe.  These steps will be used when it is time to cook using
     full screen mode in <app>Recipes</app>.</p>
   <p>In each paragraph for each step, you can include the following tags
     for adding images, timers or temperature.  You can only use an image
-    or a timer, but not both in a given step.
-    The information in these tags will be available when viewing the recipe
+    or a timer, but not both in an individual step.
+    The information in the tags will be available when viewing the recipe
     or when in hands-free mode.  All tags are enclosed within brackets.</p>
-    <terms>
-      <item>
-        <title>Timers</title>        
+  </section>
+  
+  <section id="timers">
+  <title>Add timers</title>       
           <p>To create a timer, enter how long the timer should be within
-          brackets.  An example of a one minute and thirty second timer 
-          would be: <cmd>[01:30]</cmd>.
-          </p>
-          <p>You can add a description for the timer by adding a comma 
-          and the description. An example of a fifteen minute timer to 
-          preheat the oven would be: <cmd>[15:00,Preheat oven]</cmd>.
+          brackets.  The format is [timer:hour:minute:seconds, description]
           </p>
-      </item>
+            <p>Timer examples:
+            </p>
+              <list>
+                <item>
+                  <p><cmd>[timer:00:30, stir ingredients]</cmd> - 
+                  Stir ingredients for thirty seconds.
+                  </p>
+                </item>
+                <item>
+                  <p><cmd>[timer:01:30, stir ingredients]</cmd> - Stir 
+                  ingredients for one minute and thirty seconds.
+                  </p>
+                </item>
+                <item>
+                  <p><cmd>[timer:01:01:30, preheat oven]</cmd> - 
+                  Preheat oven for one hour, one minute and thirty seconds.
+                  </p>
+                </item>
+              </list>
+  </section>
         
-      <item>
+  <section id="image-steps">
+  <title>Add images to each step</title>    
         <title>Images</title>
           <p>You can add an image or photo of the finished recipe and also
           a photo of each each step of making a recipe.  See 
@@ -73,9 +92,10 @@
               </p>
             </item>
           </steps>
-        </item>
-        
-        <item>
+  </section>
+  
+  <section id="temp">        
+       
         <title>Temperature</title>
           <p>You can add the temperature a step needs to be cooked at by 
           adding a temperature tag. 
@@ -86,7 +106,6 @@
               following the temperature.
               </p></item>
             </steps>
-        </item>
-      </terms>
+  </section>    
   
 </page>
diff --git a/help/C/add-recipe-images.page b/help/C/add-recipe-images.page
index e6c1f1b..80a3493 100644
--- a/help/C/add-recipe-images.page
+++ b/help/C/add-recipe-images.page
@@ -22,12 +22,46 @@
   
   <title>Add Images and Photos</title>
     <p>Press the <gui>New Recipe</gui> in the upper left corner of 
-    <app>Recipes</app>. To add an image to your recipe, press the 
-    <gui style="button">+</gui> button below the camera icon or press <guiseq>
-    <gui>Add Image</gui> <gui style="button">+</gui></guiseq> at the bottom 
-    of the <app>Recipes</app> window. Select the image you would like to add 
-    and press <gui>Open</gui>. To add additional images, repeat the process.
-    </p>
+    <app>Recipes</app>. To add an image to your recipe:</p>
+    <steps>
+      <item>
+        <p>Press the <gui style="button">+</gui> button below the camera icon 
+        or press <guiseq> <gui>Add Image</gui> 
+        <gui style="button">+</gui></guiseq> at the bottom 
+        of the <app>Recipes</app> window. 
+        </p>
+      </item>
+      <item>
+        <p>Select the image you would like to add.
+        </p>
+      </item>
+      <item>
+        <p>Press <gui>Open</gui>
+        </p>
+      </item>
+    </steps>
+    
+    <p>You may want to add multiple images to the recipe.  When using 
+    hands-free mode, <app>Recipes</app> can display an image for each step
+    when cooking. To add multiple images:</p>
+    <steps>
+      <item>
+        <p>Press the <gui style="button">+</gui> button below the camera icon 
+        or press <guiseq> <gui>Add Image</gui> 
+        <gui style="button">+</gui></guiseq> at the bottom 
+        of the <app>Recipes</app> window. 
+        </p>
+      </item>
+      <item>
+        <p>Select multiple images by pressing <key>Control</key> and the 
+        images you would like to add. 
+        </p>
+      </item>
+      <item>
+        <p>Press <gui>Open</gui>
+        </p>
+      </item>
+    </steps>
     <p>After adding an image, you can rotate it, make it the default
     image for the recipe, or remove it from the recipe.
     </p>


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]