Differences

This shows you the differences between two versions of the page.

Link to this comparison view

integration [2013/01/07 10:55]
admin Added tour trigger patterns link
integration [2014/06/12 02:41] (current)
admin Added section on tour preloading
Line 50: Line 50:
  
 This way, the test mode will be disabled on production server and enabled otherwise This way, the test mode will be disabled on production server and enabled otherwise
 +
 +===== Preloading tours =====
 +
 +Normally, when a tour is run, the tour data is downloaded from the server and then displayed on the screen. This process may lead to a short delay (usually less than a second) while the tour data is downloaded. When we know that the user is likely to trigger a particular tour on a page, we can preload the tour data so that the tour can be displayed immediately. Here is an example:
 +
 +  - The page contains a help button
 +  - When the user clicks help, a tour is triggered to walk the user through the page
 +  - If we preload the tour, the required data will be downloaded in the background immediately after the page loads
 +  - So when the user clicks the help button, the tour is displayed immediately without needing to download the data
 +
 +The way to preload a tour is to add this line just after the ''tour.start()'' line in the integration:
 +
 +    tour.preload("<tour_id>");
 +
 +Use the preloading feature only for cases which require a user interaction to run a tour. It is not needed for tours that are run automatically when a user visits a page. ([[patterns|Click here]] for more on different ways to trigger a tour)
  
 ===== Using a readable user ID for the activity stream report ===== ===== Using a readable user ID for the activity stream report =====
Line 66: Line 81:
  
     tour.setUserReference("<your reference here>");     tour.setUserReference("<your reference here>");
-