updated template

documentation/source/running_WAFL.rst

@@ -5,7 +5,8 @@ There are four modes in which to run the system
 
 $ wafl run
 ----------
-Starts all the available interfaces of the chatbot at the same time.
+Starts the available interfaces of the chatbot at the same time.
+This is equivalent to running run-audio and run-server in parallel (see below).
 
 
 $ wafl run-audio

wafl/templates/rules.yaml

@@ -24,33 +24,42 @@ rules:
   - the user wants to know the weather tomorrow:
     - output "<execute>check_tomorrow_weather()</execute>".
 
+  - the user wants the news from the guardian website:
+    - output exactly "<remember> The guardian headlines are <execute>get_guardian_headlines()</execute></remember>".
+    - use the headlines to create a list of bullet points separated by new lines "\n"
+    - output the bullet points to the user in a summarised form
+
   - the user wants to summarise a website:
-      - you'll need the website url to summarise
-      - output exactly "<remember> The website content is <execute>get_website('WEBSITE_URL')</execute> </remember>".
-      - summarise the website content given what you remember
-      - output the summary
+    - Ask the website url to summarise
+    - output exactly "<remember> The website content is <execute>get_website('WEBSITE_URL')</execute> </remember>"
+    - output a summary of the website content
 
   - the user wants to know what is in the shopping list:
     - output "<execute>get_shopping_list()</execute>".
 
   - the user wants to add something to the shopping list:
-      - The task here is to add the item to the shopping list using a python function
-      - example "add milk to the shopping list" should output "<execute>add_to_shopping_list(['milk'])</execute>"
-      - output "<execute>add_to_shopping_list(ITEMS_TO_ADD)</execute>".
+    - The task here is to add the item to the shopping list using a python function
+    - example "add milk to the shopping list" should output "<execute>add_to_shopping_list(['milk'])</execute>"
+    - output "<execute>add_to_shopping_list(ITEMS_TO_ADD)</execute>".
 
   - the user wants to remove something to the shopping list:
-      - The task here is to remove the item from the shopping list using a python function
-      - example "remove milk from the shopping list" should output "<execute>remove_from_shopping_list(['milk'])</execute>"
-      - output "<execute>remove_from_shopping_list(ITEMS_TO_REMOVE)</execute>".
+    - The task here is to remove the item from the shopping list using a python function
+    - example "remove milk from the shopping list" should output "<execute>remove_from_shopping_list(['milk'])</execute>"
+    - output "<execute>remove_from_shopping_list(ITEMS_TO_REMOVE)</execute>".
+
+  - the user asks to write something in a file:
+    - unless specified, the file is called "file.txt"
+    - The text to write can contain new lines. They can be added to the function using "\n"
+    - output exactly "<execute>write_to_file('file.txt', 'TEXT_TO_WRITE')</execute>".
 
   - the user asks something about cities, capitals, countries, buildings, famous people, bars, restaurants, rivers, mountains, lakes, seas, oceans, planets, stars, galaxies:
-      - say that you are just improvising the answer
-      - say what you think answer the question
+    - say that you are just improvising the answer
+    - say what you think answer the question
 
   - the user thanks the bot:
     - The intention of the user is to close the conversation
     - You must answer the user by writing "<execute>close_conversation()</execute>"
 
   - the user says "end this conversation":
     - The intention of the user is to close the conversation
-    - You must answer the user by writing "<execute>close_conversation()</execute>"
+    - You must answer the user by writing "<execute>close_conversation()</execute>"