═══ 1. First Edition, February 1995 ═══ U Note! AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA? 3 Before using this information and the product 3 3 it supports, be sure to read the general 3 3 information under notices. 3 AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAU This edition applies to: Version 2 Release 1 of Tutorial Manager for OS/2 (5696-896) and to all subsequent releases and modifications until otherwise indicated in new editions. Order publications through your IBM representative or the IBM branch office serving your locality. Publications are not stocked at the address below. IBM welcomes your comments. A form for readers' comments may be provided at the back of this publication, or you may address your comments to the following address: IBM Deutschland Entwicklung GmbH Information Development, Dept. 0446 Postfach 1380 71003 Boeblingen Germany When you send information to IBM, you grant IBM a nonexclusive right to use or distribute the information in any way it believes appropriate without incurring any obligation to you. (C) Copyright International Business Machines Corporation 1995. All rights reserved. Note to U.S. Government Users - Documentation related to restricted rights - Use, duplication or disclosure is subject to restrictions set forth in GSA ADP Schedule Contract with IBM Corp. (Double click) ═══ 2. Notices ═══ References in this publication to IBM products, programs, or services do not imply that IBM intends to make these available in all countries in which IBM operates. Any reference to an IBM product, program, or service is not intended to state or imply that only IBM's product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any of IBM's intellectual property rights may be used instead of the IBM product, program, or service. Evaluation and verification of operation in conjunction with other products, except those expressly designated by IBM, is the user's responsibility. IBM may have patents or pending patent applications covering subject matter in this document. The furnishing of this document does not give you any license to these patents . You can send license inquiries , in writing , to the IBM Director of Licensing , IBM Corporation , 500 Columbus Avenue , Thornwood NY 10594 , U . S . A . 500 A . ' Trademarks and service marks ═══ Trademarks and service marks ═══ The following terms are trademarks of the IBM Corporation in the United States or other countries or both: IBM Personal System/2 IBM Personal Computer The following terms are trademarks of other companies: Windows Microsoft Corporation PC Direct Ziff Communications Company UNIX X/Open Company Limited Other company, product, and service names, denoted by a double asterisk (**) in this publication, may be trademarks or service marks of others. (Double click) ═══ 3. About this book ═══ This book provides a complete reference of all commands, tags, variables, and programming supported by Tutorial Manager. You can also find tips and hints on how to use Tutorial Manager while developing your presentations. Select: Different ways of how to open this book How to use this book How to search for information NOTE TO REVIEWERS: OPEN ??? Which terminology should be used: o presentations instead of tutorials o user instead of student o run-time version instead of student mode? Note: If you have any comments or input (such as good examples or tips and hints, how to ...) to improve this book, please send me a note: BEILHARD at SDFVM1 Suggestion on how to supply input: Please specify the window title or copy the window using the clipboard function to an input file and add your comment (starting with CCCCCC.). (Double click) ═══ How to open this book ═══ You can open this book by double-clicking on the book icon or by entering the following: o Under OS/2: view efzr7mst To view a certain section in this book, such as the ACTIONBAR description, enter: view efzr7mst actionbar You can also enter this command in the Command dialog window of your editor. o Under Windows: xview efzr7mst To view a certain section in this book, such as the ACTIONBAR description, enter: xview efzr7mst actionbar ??? OPEN ?? WHAT ABOUT UNIX??? ═══ ... use this book ═══ This book is not designed to be read sequentially: o There are no Backward and Forward push buttons, however, if there are sections that are most probably read in a sequence, you can continue reading by deleting-button3 on instead of returning to the table of contents. o To select a section, such as a tag description, deleting click on the required tag in the contents list. To view the next tag description, select Contents from the Services menu or click on the Contents push button to DEFRM the contents list for a new selection. o When you have finished reading a section, you can By it by deleting-button3 on the icon in the upper left corner of this window or by choosing another section from the contents list. Note: If the section consists of several windows, deleting-click on the icon in the upper left corner of the leftmost window. o To reduce the amount of open windows when working with this book, a tag section, for efzr7mst, is automatically By when another tag section is opened. o If you select Previous (push button or Options menu), or press the ESC key, the section you've last viewed is DEFS. o This book contains EFZTMCMP that can be viewed in Tutorial Manager. This is indicated by the Tutorial Manager icon next to the efzr7mst number: deleting click on the Tutorial Manager icon to view the efzr7mst. o To By this book use the system menu icon in the upper-left corner of the window. ═══ How to search for information ═══ To search for information, select the Search push button to specify your search term in the Search window. Note: Use an asterisk (*) to substitute a portion of a word or phrase. If you want to search for an asterisk, type a backslash (\) before the asterisk. For more information select Search for on the help window of the Search window. ═══ 4. How to ... ═══ This chapter provides information on how to use Tutorial Manager to develop your presentations. Note: Before starting with Tutorial Manager you need to be familiar with the CUA terminology and the operating system you are using. You do not need to have any programming skills to learn Tutorial Manager. However, if you have experience with programming in BASIC, C, or a similar language, the logic behind conditional execution and controlling course flow may be familiar. (Double click) ═══ 4.1. ... get started ═══ With Tutorial Manager you can create interactive information for education material, presentations, online tutorials, kiosk systems, marketing information, multimedia shows, and so on. What is more, it supports rapid prototyping. Note: You can reduce development time by reusing code, importing and exporting dialog resources, or linking to the application's own Information Presentation Facility (IPF) help file. To get an idea of what you can do with Tutorial Manager, run the following demos: TMDEMO TMFUT Note: o If you have opened this book for the first time: You must have changed your CONFIG.SYS and rebooted your computer after you have installed Tutorial Manager. o If you changed the default settings used by the Tutorial Manager installation program, you must enter the above file names in a window or fullscreen session, or by selecting the corresponding item in the Tutorial Manager folder on the desktop. (Double click) ═══ 4.2. ... define presentations ═══ To develop Tutorial Manager presentations you must specify the GML-like control tags in ASCII files. You can use any text editor to create these ASCII files. You can then test these files with the author tool before compiling them for use by the presentation tool. It is recommended to create two directories to be used during tutorial development, such as: c:\mybuild This directory contains the source files of your tutorial as a build-time version. When you have finished writing your tutorial and checked it with the author tool, copy all files to another directory, such as: c:\myrun At the beginning, this directory contains copies of the source files of your tutorial. When you have compiled your information and created a package, delete all profile, startup, or tutorial files contained in this directory. Note: The graphics files, that is, the bitmaps, icons, and metafiles, and the IPF help files specified in the startup file are not included in the package. They must be distributed together with the package file. Then use the presentation tool to check your run-time version. (Double click) ═══ 4.3. ... structure your files ═══ This section introduces you to the files that are required or optional, and an example for a simple file structure of a tutorial. Note: The section Restrictions and dependencies shows a table that provides recommendations for your file structure.Thefollowingfilesaremandatorytocreateyourtutorial:startupfile,profilefile,andtutorialfile.Select:.mandatory)filesaclick(.AforSelect(and(file((an(Startup file Profile file Tutorial file Imbed file IPF help file Menu file Summary file Exit file Bitmap file Icon file Metafile A simple file structure (Double click) ═══ Startup file ═══ The startup file specifies all files of your tutorial using the appropriate tags. This file is mandatory. Your tutorial must have one startup file. In this book file extension SUP is used for the startup file. Note: Directory paths are not supported in the startup file. When you start your tutorial, the files are searched for in the directory specified for the startup file (unless you use the /DPATHONLY option on the command line), then in the current directory, and finally in the DPATH. IPF help files are searched for in the HELP directory defined in the HELP environment variable. ═══ Profile file ═══ The profile file contains the predefinitions of the tutorial. It is used to set or override system defaults and predefine windows. The profile is processed when the tutorial is loaded. This file is mandatory. Your tutorial must have one profile file. In this book file extension PRO is used for the profile file. Note: o If you do not want to specify predefinitions in the profile, you must specify at least a comment line in this file. o A profile file containing a lot of definitions might increase the amount of time required until the first tutorial screen appears, because the profile is read only once at the beginning when starting a tutorial. ═══ Tutorial file ═══ A tutorial file contains tags that define your tutorial. A tutorial must have at least one tutorial file and contain a PA tag. In this book file extension TUT is used for the tutorial file. ═══ Imbed file ═══ The imbed file is a tutorial file that contains information (such as text, window definitions, data, and so on) that is "imported" into the tutorial on an as-needed bases. A tutorial can have 0 to n imbed files. In this book file extension IMB is used for the imbed file. ═══ IPF help file ═══ The IPF help file contains help panels for the windows and controls. Your tutorial can have 0 to n IPF help files. ═══ Menu file ═══ A tutorial file that is activated by pressing the Menu button on the main tutorial window. Your tutorial can have none or one menu file. ═══ Summary file ═══ A tutorial file that is activated by pressing the Summary button on the main tutorial window. Your tutorial can have none or one summary file. ═══ Exit file ═══ The exit file is a regular tutorial file which is activated when a tutorial is left using the Tutorial Manager system icon, by pressing F3, or when an Exit tag is encountered within a tutorial. Your tutorial can have none or one exit file. ═══ Bitmap file ═══ A bitmap file contains screen image data. Your tutorial can have 0 to n bitmap files. ═══ Icon file ═══ The icon file contains icon data. Your tutorial can have 0 to n icon files. ═══ Metafile ═══ The metafile contains graphic orders to generate graphics. Your tutorial can have 0 to n metafiles. (Double click) ═══ A simple file structure ═══ To develop clearly structured presentation code, it is recommended to provide all general definitions (such as window definitions, variable sets, and load statements for metafiles) in the profile file. This is reflected in the table of the Restrictions and dependencies section provided for each tag. Here are the basic tags and files required for a simple tutorial called SIMPLE: AAAAAAA SIMPLE.SUP AAAAAAA :CONTENTS. :TUTFILES 'SIMPLE1.tut'. :TUTFILES 'SIMPLE2.tut'. :PROFILE 'SIMPLE.pro'. AAAAAAA SIMPLE.PRO AAAAAAA :* At least a comment statement is required. :DEFWINDOW id=windef1. :EDEFWINDOW. :DEFHP ... :DEFMACRO ... :EDEFMACRO. :SET ... AAAAAAA SIMPLE1.TUT AAAAAAA :PA SIMULATE. :H0 TEXT='Page 1'. :WINDOW ID=win1 REFID=windef1 ... :WINDOW ID=win2 REFID=windef1 ... :TEXT REFID=win1. This is window 1. :ETEXT. :* comment: new text. :TEXT REFID=win2. This is window 2. :ETEXT. :TEXT.. This is the first page. :ETEXT. :PA SIMULATE. :H0 TEXT='Page 2'. :TEXT. This is the last page. :ETEXT. AAAAAAA SIMPLE2.TUT AAAAAAA :PA SIMULATE. :TEXT. This is another page. :ETEXT. Related information: o Recommendations to improve your presentation performance. ═══ 4.4. ... handle several tutorial files ═══ From an organizational point of view it is sometimes desirable to have different parts of a tutorial in separate files, in particular when you want to reuse parts of one tutorial in another tutorial. In this case, specify the tutorial files in the desired sequence in the startup file (using the TUTFILES tag). When running such a tutorial in the build-time version (author mode) not all heading entries appear in the Contents pull-down. This is because in the build-time version Tutorial Manager processes only the first tutorial file after startup and all subsequent tutorial files only when they are needed (for example, when a BRANCH tag passes control to another part of the tutorial). In the run-time version (presentation or student mode) the tutorial is run through the Tutorial Manager's compiler. The compiler resolves all references to other tutorial files and the Contents pull-down shows all entries, no matter in which tutorial file they were defined. (Double click) ═══ 4.5. ... define and check user interaction ═══ With Tutorial Manager you can check and react to almost any user interaction. You do this with the ON tag. OPEN ???? The following text is an annotation This tag is also used for simulating applications. Normally, ON-handling is defined by coding SON,