XFTUTORIAL(1)

NAME
xftutorial - interactive Tk tutorial program

SYNOPSIS
xftutorial [xftutorial options]

xftutorial options:

    [-xfBindPath <filename>] [-xfColorFile <filename>] [-xfCursorFile <filename>] [-xfFontFile <filename>] [-xfLoading] [-xfLoadPath <pathname>] [-xfModelColor] [-xfModelMono] [-xfNoLoading] [-xfStartup <filename>] scriptPath targetInterpreter

DESCRIPTION

XFtutorial allows to interactively introduce a user to the usage of a Tcl/Tk program. The developer writes a tutorial script, leading the user through the functionality of the program. This program is part of the XF distribution, and is used to introduce the user into the handling of XF.

The menubutton (File) contains an item to print the current help page, and to quit the program. The menubutton ( Chapters) contains all chapters that are available. The text area displays the current help text. Below this area, there are three buttons that control the paging of the tutorial. Tutorial pages can have actions attached to them, which are performed when the next page is selected, or the Perform action button is pressed.

THE SCRIPT FILES
The script files must contain input following certain rules. One of the script files must define a global list named chapterList. This list contains a list of lists. The first element of the lists is the title of the chapter, followed by the underline position of the menu item, and the script name of this chapter. To insert a separator, an empty list is inserted.

Each script file must define two variables first. The first variable (<chapter>Last) specifies the last accessible page number. The second variable (<chapter>LastSectionDone) is an internal counter initialized with -1.

Each page is represented by three variables. The first variable (<chapter>Name<pagenumber>) contains the name of the page. The second variable (<chapter>Text<pagenumber>) contains the text to display. And the third variable (<chapter>Command<pagenumber>) contains the command to be executed. This command is sent to the application that uses the tutorial.

OPTIONS

The following options can be controlled from the command line.

-xfBindFile filename
    This option specifies a file containing class bindings that implement a default behavior of all widgets.

-xfColorFile filename
    This option specifies a file containing a list of all known colors. This file is automatically created when XF is installed, so please set this variable to the location of the Colors file of the installed XF (usually in the directory ./lib inside the XF distribution).

-xfCursorFile filename
    This option specifies a file containing a list of all known cursors. This file is automatically created when XF is installed, so please set this variable to the location of the Cursors file of the installed XF (usually in the directory ./lib inside the XF distribution).

-xfFontFile filename
    This option specifies a file containing a list of all known fonts. This file is automatically created when XF is installed, so please set this variable to the location of the Fonts file of the installed XF (usually in the directory ./lib inside the XF distribution).

-xfLoading
    This option specifies that the program reports the source filenames that it loads. This is useful when the program automatically accesses archives in the development phase.

-xfLoadPath pathname
    This option specifies a list of pathnames (separated by ":") where the Tcl source files can be found. In order to find the Tcl source files they must be stored in one of these directories.

-xfModelColor
    This option starts the application in color mode.

-xfModelMono
    This option starts the application in monochrome mode.

-xfNoLoading
    This option specifies that the program does not report the source filenames that it loads.

-xfStartup filename
    This option specifies a file containing additional Tcl/Tk code that is loaded at startup.

scriptPath
    This option specifies the directory where the script files are located.

targetInterpreter
    This option specifies the interpreter that is the target for the tutorial.

ENVIRONMENT

DISPLAY
    The default display to be used.

XF_LOAD_PATH
    This variable specifies a list of pathnames (separated by ":") where the Tcl source files can be found. In order to find the Tcl source files they must be stored in one of these directories.

BUGS

•   Surely there are many bugs.

SEE ALSO

Tcl(3), Tk-manuals(3), XF-documentation

AUTHOR

Sven Delmas
TU Berlin, Germany
garfield@cs.tu-berlin.de