INTERNAL NOTES ABOUT NAVIGATOR USER GUIDE ( ) This page will only appear in the INTERNAL version of this file. DO NOT send this version to

Transcription

1 INTERNAL NOTES ABOUT NAVIGATOR USER GUIDE ( ) This page will only appear in the INTERNAL version of this file. DO NOT send this version to non-datango. Author: Created with a lot of help from a lot of datangos. Document created with Framemaker 6.0. There are 2 versions of this doc: RELEASE INTERNAL The text in this doc is color-coded. The color determines what type of doc the text will be in: Normal. RELEASE / DEVELOPER / INTERNAL. TOC entries. RELEASE / DEVELOPER / INTERNAL. Code. RELEASE / DEVELOPER / INTERNAL. Developer. DEVELOPER / INTERNAL. Internal. INTERNAL. Comment. INTERNAL. Error. INTERNAL.

2 (empty page)

3 Title page datango navigator v Page 1 of 38

4 Page2of38 datango Navigator

5 Table of contents 1. Documentation overview This document Other documentation Documents Websites / Servers Basic concepts Getting the info you need to use a website The difficulties for the first-time website visitor Websites are designed for repeat customers Websites are multifunctional An unrealistic solution: Personal assistance The datango tour solution The datango Navigator System requirements Tutorial Play a tour Pause, Play (resume), Stop Go to tourstop Restart current tourstop Go to a different tourstop Hyperlink to proxy pages in same browser during pause Hyperlink to non-proxy webpage in new browser Enter/submit form data during pause Unrecommended interaction with webpage/browser during tour Browser back / forward button Hyperlink to proxy pages in same browser without pause Hyperlink to non-proxy pages in same browser Enter URL (non-proxy) User Interface Release notes Version Version Version Version New features Enhancements Version Version Version Version Trouble-shooting xxx TS 1. xxx FAQ xx Table of contents Page 3 of 38

6 8.1. FAQ 1. xx Glossary List of figures Index Page 4 of 38 Table of contents

7 1. Documentation overview 1.1. This document This document describes how to use the datango Navigator to play tours. Contents of this document: Ch. 1. Documentation overview (pg. 5) This chapter. Ch. 2. Basic concepts (pg. 7). Gives an idea of what exactly a tour is. Ch. 3. System requirements (pg. 9). Ch. 4. Tutorial (pg. 11). Step-by-step instructions for controlling how a tour is played using the Navigator. Ch. 5. User Interface (pg. 25). Describes in detail the Navigator user interface. Ch. 6. Release notes (pg. 27) For each released version of the Navigator. Ch. 7. Trouble-shooting (pg. 29). Description of common problems and how to resolve them. Ch. 8. FAQ (pg. 31)Frequently-asked questions. Ch. 9. Glossary (pg. 33). Ch. 10. List of figures (pg. 35). Ch. 11. Index (pg. 37) Other documentation Documents If you are viewing this document in Acrobat Reader: Click on any of the bold text below to open the pdf document (the desired document must be present in the same directory as this document). 1 datango Tour Overview. Provides an overview of what a tour is and how a tour functions. 2 datango Tour Quick Start. Demonstrates how to create a very simple tour and make the tour available via internet. 3 (this doc) 4 datango Recorder. Describes in detail the functionality of the datango Recorder, which is used to create tours. 5 datango Tour Production Guide. Describes how to create professional-level tours. Assumes that the reader has read the Recorder and has user the Recorder. 6 datango Server. For the system administrator. Detailed technical information for maintaining the Server that actually delivers the tours Websites / Servers If you are viewing this document in Acrobat Reader: Click on any of the bold text below to view the website. Datango website. Documentation website. Model website for creating tours (referenced throughout this document). Website used to create advanced tours. Server that provides examples tour. (username / password required). Server. Chapter 1. Documentation overview Page 5 of 38

8 Page 6 of 38 Chapter 1. Documentation overview

9 2. Basic concepts This chapter introduces basic concepts that will help you to understand: What is a datango tour. Why a datango tour is so effective. How to use the datango Navigator to effectively playback a tour. 1. i want to add pics of examples.datango.de sometime in the future. 2. the recorder user guide describes concepts from the viewpoint of someone trying to create content... concepts in the navigator user guide describe concepts for someone wanting to get the info Getting the info you need to use a website Imagine that you visit for the first time a really incredible website. What is the first thing you want? You want the info you need to start using the website now. What you don t want in any case is to have to: Read documentation. You dont want to have to download a document, and then try to either print it out or view both the document and the website simultaneously on your computer screen. Open a special dialog or go to a webpage that describes how to use the website of interest. Search for the required information on the website itself The difficulties for the first-time website visitor For the typical website, most of the visitors are regulars who already have a good deal of experience using the site. These visitors are very important customers for website, and they typically want a website that: Is very easy to use. Provides a great deal of functionality. Provides a lot of information. However, a multi-functional site designed for the experienced user can be very difficult for a firsttime visitor Websites are designed for repeat customers A repeat customer typically wants a website with the following characteristics: High-quality content. Regular updates. Minimal download time. Easy to use. Simple. Uncluttered and functional. This makes it much easier to find what you want immediately and much easier to notice any changes. As little text as possible. Reading text requires a relatively large amount of time, and its difficult to notice if the text has changed in some way. Everything on a webpage fits on the computer screen. Noone wants to have to scroll down to view the bottom of the page. As few elements as possible (for faster downloading). No audio that explains how to use the website. Listening to the same audio constantly can be not only annoying, but audio content is relatively large Websites are multifunctional A company will typically have a single URL that all customers visit. This homepage has to allow customers with very different requirements and backgrounds to determine quickly where to find the information they need. Chapter 2. Basic concepts Page 7 of 38 Section 2.1. Getting the info you need to use a website

10 This is made possible with hyperlinks. A single webpage can offer all of the links required for any customer to find what he needs quickly. However, a multifunctional page with many hyperlinks can be very complex for a new user. He needs someone to show him how to find the information he needs An unrealistic solution: Personal assistance Probably the best solution to this dilemma, assuming that cost was no issue, would be have a personal website instructor who would provide a website tour with the following characteristics: Step-by-step instructions. Actual webpages opened. Voice explanation. Visual cues (with finger or mouse). Enterering of data (in forms, etc.). However, cost is typically an issue, which makes this approach unrealistic. Also, the availability of a personal instructor cannot be guaranteed 24 hours a day around the globe. So what is the solution? 2.4. The datango tour solution The solution to the dilemmas mentioned above is the datango tour. The datango tour provides all the benefits of a personal instructor, without the cost or availability issues. Available directly from the website Playing a datango tour could not be easier. The visitor simply opens a URL (typically a hyperlink on the website that is being visited). The tour is immediately downloaded and played. Voice and visual cues The webtour contains visual cues ( events ) and audio. No installation necessary To play the tour, only the following is required: An internet connection A browser A multimedia (for audio) computer Automated / 24-hour availability The tour is always available, 24 hours a day around the globe. The webpages in a tour are always current The tour actually downloads the tour pages from a website. Since the tour actually uses the website, the webtourist knows that the info is up-to-date The datango Navigator The datango Navigator is always displayed at the bottom of the browser when a tour is being played. The Navigtor allows the web visitor to pause, start and stop tours. The Navigator is described in detail in this document. Page 8 of 38 Chapter 2. Basic concepts Section 2.3. An unrealistic solution: Personal assistance

11 3. System requirements Hardware Minimum: Intel Celeron 500, 64 MB RAM. Recommended: Intel Pentium III 500, 128 MB RAM. 10 MB memory. Sound card. Headphones and microphone. OS: Webbrowser Windows: Netscape >= 4.06, < 6. Explorer >= 4.0 MacOS: Netscape >= 4.75, < 6 Internet Access 56K modem at least, ISDN suggested. Chapter 3. System requirements Page 9 of 38

12 Page 10 of 38 Chapter 3. System requirements

13 4. Tutorial This chapter presents a step-by-step tutorial that shows how to use (and how not to use) the Navigator to play tours. Contents of this tutorial: 4.1. Play a tour (pg. 12). Demonstrates how to start playing a tour Pause, Play (resume), Stop (pg. 16) Go to tourstop (pg. 17). Shows how to play the tour starting at a specific tourstop (tours consist of 1 or more tourstops) Hyperlink to proxy pages in same browser during pause (pg. 18). When a tour has been paused, you can follow hyperlinks whose destination URL resides on the same server that is playing the tour (tours are typically served from special servers). This section demonstrates this Hyperlink to non-proxy webpage in new browser (pg. 19). You can follow any hyperlink on a tour page to any page on any server, as long as the webpage is opened in a separate browser. This section demonstrates this Enter/submit form data during pause (pg. 20). Demonstrates how to enter and submit form data on a tour webpage while the tour has been paused Unrecommended interaction with webpage/browser during tour (pg. 22). There are several things that you should not do while playing a tour. In particular, the use of the browser navigation buttons is not recommended. This section demonstrates some of the problems that can occur. Chapter 4. Tutorial Page 11 of 38

14 4.1. Play a tour datango Navigator Playing a tour could not be simpler. You simply open the tour URL in a browser. 1. In a browser: Open (if you are viewing this document in Acrobat Reader, simply click on the URL above to open the URL in a browser). Note the tour link for the datango guided tour. Tour link Figure 1. Guided tour link on (617) 2. Click on the tour link. The starts loadind the tour from play.cfm?webride_id=12661: Tour URL Tour is loading xxx Navigator controls Figure 2. Tour is loading (602) is a link to a datango Server. The datango Server replies by sending all files required to play the tour. Page 12 of 38 Chapter 4. Tutorial Section 4.1. Play a tour

15 3. After the tour has loaded (several seconds), the tour starts to play.. xxx Remaining time Tourstop 1 Figure 3. Tour starts to play (603) At this point you will hear a voice describing the website. After a few seconds you will see a green mouse pointer and a flashing green box (a highlight). Figure 4. Green mouse point and flashing box (highlight) (604) After that the green mouse starts moving from right to left.. Green mouse moving from right to left Figure 5. Mouse movement from right to left (605) Then a red square (highlight) is drawn around Company. Then a red square around Products. Figure 6. Red square (highlight) (606) Chapter 4. Tutorial Page 13 of 38 Section 4.1. Play a tour

16 Then you hear a click and the tour goes to the Products webpage. URL has not changed Webpage has changed Figure 7. Tourstop 2: datango products (607) Note that this webpage is in a different tourstop. The audio and effects for tourstop 2 datango products play. Then tourstop 3 datango partners is opened.. Tourstop 2 Figure 8. Tourstop 3: datango partners (608,609) During tourstop 3 the page scrolls down automatically.. Tourstop 3 Scrolling Figure 9. Scrolling (610) Page 14 of 38 Chapter 4. Tutorial Section 4.1. Play a tour

17 Tourstop 4 contact datango is the last tourstop.. Figure 10. Tourstop 4: contact datango (611,612) At the end of tourstop 4, the Navigator scrolls slowly away.. Navigator slowly scrolls away Figure 11. Navigator scrolls away (613) Finally the end page of the tour is shown (datango website main page) Figure 12. datango website main page shown at end of tour (614) Chapter 4. Tutorial Page 15 of 38 Section 4.1. Play a tour

18 4.2. Pause, Play (resume), Stop datango Navigator This section describes how pause, play (resume) and stop a tour. 4. Open 5. After the tour is loaded: Click pause. The tour is paused and the pause button becomes a play button. Tour paused; Pause button becomes Play button Figure 13. Tour paused (615) 6. Click on play. The tour play is resumed. 7. Click on stop. The tour is stopped (the navigator scrolls away and the stop page of the tour is displayed). Page 16 of 38 Chapter 4. Tutorial Section 4.2. Pause, Play (resume), Stop

19 4.3. Go to tourstop Restart current tourstop This section describes how to restart the current tourstop that is playing. 8. Open 9. After the tourstop 1 has played for several seconds. Click back. The tour restarts at the beginning of tourstop After tourstop 2 has played for several seconds. Click back. The tour restarts at the beginning of tourstop Go to a different tourstop 11. Open After the tourstop 1 has played for several seconds. Click next. The tour starts playing at the beginning of tourstop Click on the tourstop drop-down list. Figure 14. Tourstop drop-down list (616) 14. Select any tourstop. The selected tourstop starts playing. Chapter 4. Tutorial Page 17 of 38 Section 4.3. Go to tourstop

20 4.4. Hyperlink to proxy pages in same browser during pause A tour is normally delivered by a proxy server (this is necessary due to a security restriction in the browser). What that means is that the website pages in the tour of website might actually be sent from proxy server tours.anycompany.com. A tour can be paused and then a link to a different webpage on the proxy server can be followed. The tour can then be restarted with no problem. This is demonstrated below. 15. Start the datango tour. Tour link Figure 15. Guided tour link on (617) 16. After tourstop 1 has started. Click pause. Figure 16. Tour is paused (618) 17. Click on hyperlink Company. The company page is shown. Figure 17. The company page (619) 18. Place the cursor over the play button. Note the comment: Figure 18. Hint Continue the tour (620) 19. Click play. Note that the Welcome page is reloaded and the tour is started where it left off. Figure 19. Welcome page is restarted where it left off (621) Page 18 of 38 Chapter 4. Tutorial Section 4.4. Hyperlink to proxy pages in same browser during pause

21 4.5. Hyperlink to non-proxy webpage in new browser A webpage on a server other than the proxy server should be opened only in a new browser. If such a webpage is opened in the same browser, then the tour will be ended. This is demonstrated below. 20. Start the tourstop datango partners: Figure 20. Tourstop datango partners (626) 21. Click on the ebay.de hyperlink. The URL is opened in a new browser. The tour continues to play in the other browser. Chapter 4. Tutorial Page 19 of 38 Section 4.5. Hyperlink to non-proxy webpage in new browser

22 4.6. Enter/submit form data during pause datango Navigator You can pause a tour that contains a webpage with a form and then fill in and submit the form. When the play button is pressed, the tour starts from where it was paused (the URL is also reloaded). This is demonstrated below. 22. Open the tourstop contact datango. Figure 21. Tourstop contact datango (622) 23. Click pause. 24. Enter the data as shown: Figure 22. Entered contact info data (623) Page 20 of 38 Chapter 4. Tutorial Section 4.6. Enter/submit form data during pause

23 25. Click Submit. A reply is sent from the proxy. Figure 23. Reply from proxy (624) 26. Click play. Note that the tour continues at the point where it was paused (the URL is reloaded). Figure 24. Tour continues at the point where it was paused (625) Chapter 4. Tutorial Page 21 of 38 Section 4.6. Enter/submit form data during pause

24 4.7. Unrecommended interaction with webpage/browser during tour The tours are played in a webbrowser. That is very convenient, since every computer probably has a browser installed. That can cause problems, however, because the URL being displayed can be changed using the browser (such as clicking the browser Back button) rather than using the Navigator. This section demonstrates some of these problems. This section is not exhaustive, but provides a good idea of what you should not do and why Browser back / forward button In general you should never use the browser Back or Forward buttons while a tour is playing. The possible problems that can occur is demonstrated below. 27. Start the datango tour. Tour link Figure 25. Guided tour link on (617) 28. After tourstop1 has started. Click the Browser Back button. Note that you go back to the loading page: Figure 26. Loading page displayed while tourstop 1 is played (627) Note, however, that tourstop1 is still playing. Only when tourstop 2 starts playing is the proper page displayed. Figure 27. Tourstop 2 shown correctly (628) Page 22 of 38 Chapter 4. Tutorial Section 4.7. Unrecommended interaction with webpage/browser during tour

25 Hyperlink to proxy pages in same browser without pause Following a hyperlink to a proxy webpage when the tour is pause is allowed. However, if the tour is not paused, then typically you will hear the audio but not see the effects (seeing the effects would not be beneficial in any case, since the wrong webpage is shown). This is demonstrated below. 29. Start tourstop 4 contact datango.. Figure 28. Tourstop 4 contact datango (629) Note the effects being shown. 30. Go back to beginning of tourstop 4 (click the navigator back button). 31. Click on the tab . Do not click pause. Note that now when the tour plays, the audio is heard, but the effects are not seen. Figure 29. Tourstop 4 with wrong webpage and no effects (630) However, this problem can be fixed by simply pausing and playing the tour (this causes the URL to be reloaded). 32. Click pause. 33. Click play. Note that now when the tour plays, the effects are seen. Figure 30. Tourstop 4 with effects (after pause and play) (631) Hyperlink to non-proxy pages in same browser COULD NOT FIND A WAY TO DEMO THIS WITH Effects will not be shown. Next tourstop will be ok Enter URL (non-proxy) You should never enter a URL in the browser while a tour is being played. This is demonstrated below. 34. Restart the tour. 35. Enter URL Chapter 4. Tutorial Page 23 of 38 Section 4.7. Unrecommended interaction with webpage/browser during tour

26 36. Click Return. A warning message appears: Figure 31. Warning message about leaving tour (632) 37. Click OK (leave the tour). The site opens. 38. Click the browser Back button. The previous tour restarts at the beginning. Figure 32. The tour restarts at the beginning (633) Page 24 of 38 Chapter 4. Tutorial Section 4.7. Unrecommended interaction with webpage/browser during tour

27 5. User Interface The following diagram shows the Navigator user interface. Navigator Logo Playback control Figure 33. User interface (601) Elapsed time Synopsis (tourstop selection) Chapter 5. User Interface Page 25 of 38

28 Page 26 of 38 Chapter 5. User Interface

29 6. Release notes 6.1. Version On MacOS, navigator wors from Netscape version 4.7 up (PR #2422) Fixed lost status message (PR #2416) Fixed "sytax error in regular expression" (PR #2372, PR #2189, #2426) Added logging of marker hit events (PR #2405) Added logging of invocation ID (PR #2402) 6.2. Version Fixed offline missing GSM decoder (PR #2418) Fixed select1 event handler (PR #2410) Fixed form element resolution (PR #2408) Fixed autoscroll for linear mouse, again (PR #2378) Fixed javascript initialization instability (PR #2309) Fixed audio buffering kick at tour start (PR #2294) Added still more diagnostics for license verification (PR #2146) 6.3. Version Fixed a problem with mouse event synthetization in IE 5.5 (PR #2395) Fixed text window / text bubble interaction (PR #2389) Fixed roundoff error oin linear scroll events (PR #2378) Fixed size calculation of flash highlights (PR #2376, PR #2317) Fixed: obfuscation breaks old webride player (PR #2364) Added more diagnostics for license verification (PR #2146) Added loading bar for use in start page (PR #2383) 6.4. Version New features Text annotations in bubbles, a window, or a panel (PR #2170, PR#2171, PR#2172) Linear scroll and mouse events (PR #2165, PR #2292) Combo box simulation for changes of SELECT elements (PR #2167) High quality audio for offline tours (PR #2164) Prefetching of HTML pages and images during the tour (PR #943) Late loading of audio codec classes (PR #2169) Deployment of obfuscated javascript code (PR #2152) Enhancements Highlights can have arbitrary color (PR #2174) Browser close confirmation simplified (PR #2298) Java class loader tricks removed (PR #2278) 6.5. Version Fixed mouse event handling (PR #2245) Fixed file locking in webridelog handler (PR #2280) HTML pages are prefetched (3.2 pre release) (PR #943) IE retrieves compressed js file (3.2 pre release) (PR #2238, PR #923) Chapter 6. Release notes Page 27 of 38 Section 6.1. Version 3.2.3

30 Audio codecs are dynamically loaded (3.2 pre release) (PR #2169) Fixed javascript errors that led to browser crash or player freeze in some instances (PR #1968, PR #2268) 6.6. Version Improved logging (PR #1768, PR #2179) Improved handling of subframe URL events (PR #1866, PR #2195) Fixed handling of javascript redirects in the proxy (PR #1087) Fixed mouse positioning in TD elements (PR #1955, PR #2103) Improved javascript event dispatch (PR #2216) Fixed handling of disabled javascript in the user's browser (PR #1922) 6.7. Version Improved proxy interaction (PR #2098) Improved recognition of configuration errors (PR #2081) Improved offline webrides (PR #2071, PR #2070) Fixed rendering error (PR #2025) Improved behavior of back button in GUI (PR #1961) Consistent float window layout for webride player (PR #1960) 6.8. Version Logging (PR #1768, PR #2003, PR #2039) Offline webrides (PR #1996) Simplify URL of deployed player (PR #2063) Play unencoded ulaw audio (PR #2036) Improve robustness of network interactions (PR #2026) Page 28 of 38 Chapter 6. Release notes Section 6.6. Version 3.1.3

31 7. Trouble-shooting 7.1. xxx TS 1. xxx Problem xxx Cause xxx Chapter 7. Trouble-shooting Page 29 of 38 Section 7.1. xxx

32 Page 30 of 38 Chapter 7. Trouble-shooting Section 7.1. xxx

33 8. FAQ 8.1. xx FAQ 1. xx Chapter 8. FAQ Page 31 of 38 Section 8.1. xx

34 Page 32 of 38 Chapter 8. FAQ Section 8.1. xx

35 9. Glossary the contents of this glossary will be created from a separate glossary file (the separate file will contain all glossary terminology for recorder and server, all docs, and german and english). Chapter 9. Glossary Page 33 of 38

36 Page 34 of 38 Chapter 9. Glossary

37 10.Listoffigures Figure 1.Guided tour link on (617) Figure 2.Tour is loading (602) Figure 3.Tour starts to play (603) Figure 4.Green mouse point and flashing box (highlight) (604) Figure 5.Mouse movement from right to left (605) Figure 6.Red square (highlight) (606) Figure 7.Tourstop 2: datango products (607) Figure 8.Tourstop 3: datango partners (608,609) Figure 9.Scrolling (610) Figure 10.Tourstop 4: contact datango (611,612) Figure 11.Navigator scrolls away (613) Figure 12.datango website main page shown at end of tour (614) Figure 13.Tour paused (615) Figure 14.Tourstop drop-down list (616) Figure 15.Guided tour link on (617) Figure 16.Tour is paused (618) Figure 17.The company page (619) Figure 18.Hint Continue the tour (620) Figure 19.Welcome page is restarted where it left off (621) Figure 20.Tourstop datango partners (626) Figure 21.Tourstop contact datango (622) Figure 22.Entered contact info data (623) Figure 23.Reply from proxy (624) Figure 24.Tour continues at the point where it was paused (625) Figure 25.Guided tour link on (617) Figure 26.Loading page displayed while tourstop 1 is played (627) Figure 27.Tourstop 2 shown correctly (628) Figure 28.Tourstop 4 contact datango (629) Figure 29.Tourstop 4 with wrong webpage and no effects (630) Figure 30.Tourstop 4 with effects (after pause and play) (631) Figure 31.Warning message about leaving tour (632) Figure 32.The tour restarts at the beginning (633) Figure 33.User interface (601) Chapter 10. List of figures Page 35 of 38

38 Page 36 of 38 Chapter 10. List of figures

39 11. Index B Back Browsers... 9 C Concepts... 7 D docs.datango.de... 5 Documentation... 5 E examples.datango.de... 5 F FAQ G Glossary H Highlight M Mouse pointer myserver.datango.de... 5 myserver.datango.de/serveradmin... 5 N Next O Operating systems... 9 P Pause Play... 12, 16 R Release notes S Scrolling Server Servers (list of)... 5 System requirements... 9 T Tour link Troubleshooting Tutorial tutorial.datango.de... 5 U User interface W Websites (list of) Chapter 11. Index Page 37 of 38

40 Page 38 of 38 Chapter 11. Index