Changes between Version 3 and Version 4 of BluePrint/InlineHelp

Timestamp:

06/02/13 03:15:08 (13 years ago)

Author:

graeme

Comment:

--

BluePrint/InlineHelp

@@ -77 +77 @@
 || || **place** //integer the place to resume within the tour, if not completed// ||
 
+==== Tour Input ====
+
+|| **__Configuration__** || **auto_start** //boolean// - does the tour start automatically, default '''''false''''' ||
+|| || **logged_in** //boolean// - does the tour require the person to be logged in, default '''''true''''' ||
+|| **__Details__** || **Tour_Name** //string// ||
+|| || **Tip_Title** //string// ||
+|| || **Tip_Details** //string// ||
+|| || **HTML_ID** //string// unique identifier for the location of the tip ||
+|| || **Button** //string// the name of the button, default 'Next' ||
+|| || **Tip_Location** //string// the side of the HTML_ID to which the tip points to, (top, bottom, left, right) default bottom ||
+|| || **DataTable_ID** //string// Name of dataTable for which some data will be extracted ||
+|| || **DataTable_row** //integer// The row of the table for which data is to be extracted ||
+|| || **DataTable_columns** //stringlist// The column headings from which data is to be extracted (from the row) '''''each column can be referred to in the text using the special combination %(dt_<heading>)s where heading is one of the dataTable headings and is used in the string list ||
+|| || **Redirect** //URL// page to which upon clicking the button the tour will redirect to ||
+
+Example
+{{{
+#!div style="font-size: 80%"
+Tour_Name, joyrideID_1
+auto_start, false
+logged_in, false
+
+Tip_Title, Situation
+Tip_Details, Each situation button will perform an action that will allow you to see the various resources that are available.
+HTML_ID, menu_div_sit
+Button, Next
+Tip_Location, Right
+
+Tip_Title, Decision
+Tip_Details, Each decision button will perform an action that is part of a decision based on the situation.
+HTML_ID, menu_div_dec
+
+Tip_Title, Response
+Tip_Details, Each response button will perform an action that is in response to an earlier decision.
+HTML_ID, menu_div_res
+Tip_Location, Left
+
+Tip_Title, Facilities
+Tip_Details, Here are a list of the different type of facilities that are registered on the system.
+HTML_ID, facility_box
+Tip_Location, Left
+
+Tip_Title, Feeds
+Tip_Details, Here are a number of media feeds which can be configured to listen for a variety of information.
+HTML_ID, feed-control
+Tip_Location, Top
+
+Tip_Title, Register for an account
+Tip_Details, Click the link to register for a free account. You will need to have an account to create data and explore Sahana Eden in depth
+HTML_ID, register-btn
+Button, Finish
+}}}
 
 === Workflows ===