═══ 1. Cover Page ═══ Graphical User Interface Editor and Application Generator for Personal Computers using OS/2 Version 2.1 or higher. This document provides instructions on installing Guidelines 3.20a. Copyright (c) 1994, 1995 JBA International plc. All rights reserved. ═══ 1.1. Document Change Control ═══ Document Change Control This page provides details of changes made to this document. With each release of this document, the Document Release Number is incremented, and the details of the changes made are outlined on this page. It not only provides a means of tracking a history of changes made, but enables customers to compare their on-line documents with the currently available documents. Current Document Release Number: 1.03 Document Change History ┌───────────────┬─────────────────────────────────────────────┬───────────────┐ │Release No. │Details │Date │ ├───────────────┼─────────────────────────────────────────────┼───────────────┤ │ 1.00 │Initial release. │ 27th May 1995 │ ├───────────────┼─────────────────────────────────────────────┼───────────────┤ │ 1.01 │Updated for new Directory Structure │ 7th Sep 1995 │ ├───────────────┼─────────────────────────────────────────────┼───────────────┤ │ 1.02 │Updated WorkPlace Shell option panel and │ 5th Oct 1995 │ │ │added new pictures │ │ ├───────────────┼─────────────────────────────────────────────┼───────────────┤ │ 1.03 │Updated Options Dialog for new rules on │ 17th Oct 1995 │ │ │possible combinations │ │ ├───────────────┼─────────────────────────────────────────────┼───────────────┤ │  │  │  │ ├───────────────┼─────────────────────────────────────────────┼───────────────┤ │  │  │  │ └───────────────┴─────────────────────────────────────────────┴───────────────┘ ═══ 2. Guidelines Installation ═══ Guidelines Installation Welcome to the Guidelines Installation program! This program will perform the installation of Guidelines and any optional extension packs. Press the Ok button to start the installation. ═══ 2.1. Installation Help ═══ Installation Help This program will perform the installation of Guidelines and any optional extension packs. Help is available at each step of the installation process, so if you are in doubt, either press the Help button or press F1. Please select Options Contents (using Ctrl+C) to find the help you require. ═══ 2.2. Directories Menu Item ═══ "Directories" Menu Item Selecting this menu item will invoke the Directories dialog, which allows you to specify Source and Target directories for the installation of Guidelines. ═══ 2.3. 'Install Guidelines...' Menu Item ═══ "Install Guidelines" Menu Item Selecting this menu item will begin the installation of the base Guidelines product, using the settings you have selected within the directories dialog. ═══ 2.4. 'Install Extensions...' Menu Item ═══ "Install Extensions" Menu Item Selecting this menu item will invoke the Install Extensions Selection dialog, allowing you to choose a Guidelines Extension Pack to install. ═══ 2.5. 'Exit' Menu Item ═══ "Exit" Menu Item Select this menu item to leave the installation program. ═══ 2.6. 'Installation Options' Dialog ═══ "Installation Options" Dialog This dialog allows you to modify the behaviour of the installation program. As you check or uncheck components, the Statistics section provides a guide showing the amount of space required for the selected options. The following settings may be modified:  Install Designtime Support  Install Runtime Support  Install Documentation  Install Sample Applications  Update CONFIG.SYS  Update Workplace Shell ═══ 2.6.1. Install Designtime Support ═══ Install Designtime Support This checkbox will install all necessary files to design Guidelines applications, but not to run them. When selected, the Runtime support is automatically selected as well - it is pointless to be able to design programs but not run them. ═══ 2.6.2. Install Runtime Support ═══ Install Runtime Support This checkbox will install all necessary files to run Guidelines applications, not to create new ones. If you do not want to design or run Guidelines applications, the only possibel option is to install the Guidelines Documentation, with or without the WorkPlace Shell icons. (in this latter case you will not be asked for a Registration Number). ═══ 2.6.3. Install Documentation ═══ Install Documentation If you check this item, the installation program will copy documentation files into the Guidelines documentation folder. These documents provide on-line information about Guidelines and its components. Once installed, they may be viewed by selecting the 'Documentation' folder and double-clicking on the desired item. The documents are not essential for the operation of Guidelines, and you may choose not to install them if disk space is at a premium. However, we recommend that you install them as even experienced programmers can learn much from them. ═══ 2.6.4. Install Sample Applications ═══ Install Sample Applications If this option is checked, a series of Guidelines applications will be installed into the GUIDE\SAMPLES\GUI directory. There is a wide range of sample GUI files which illustrate important techniques for creating Guidelines applications. Some applications are small and illustrate key concepts or demonstrate specific features of a control, while others are more complex and illustrate design principles and coding examples used by the creators of Guidelines. It is recommended that all users install these samples, as even experienced programmers may learn from them. Other sample programs will be installed within the GUIDE\BIN directory which demonstrate some of the capabilities available in optional Guidelines extension packs. GUI files for these programs have not been provided as they require the extension packs to support them. ═══ 2.6.5. Update CONFIG.SYS ═══ Update CONFIG.SYS Guidelines needs to modify several environment variables within your CONFIG.SYS file in order to operate correctly. It will modify the following settings: LIBPATH This setting tells OS/2 where to look for Dynamic Link Libraries (.DLL). So that Guidelines may find its own DLLs when it has not been started from its installed directory, the GUIDE\DLL directory is added to this setting. PATH The PATH variable is used to find executable (.EXE) programs. To allow you to run GUIDE from the command line from any directory, the Installation program will add the GUIDE\BIN directory to the PATH environment variable. HELP This variable tells the Help Manager where to find online help files (.HLP). Guidelines itself, and all the custom controls have help files, so the Installation program will add GUIDE\HELP to the HELP path to find them. INCLUDE The INCLUDE path tells the compiler where C/C++ header files (.H/.HPP) are to be found. The Guidelines runtime and all the controls have their own header files which are needed to compile applications, so the Installation program will add GUIDE\INCLUDE to the INCLUDE path. LIB The LIB path tells the linker where to find libraries (.LIB) to link as a final step of building an application. As with the INCLUDE path, Guidelines and its controls need to know where to find their libraries, so the LIB path will have GUIDE\LIB added to it. GUE This setting is specific to Guidelines, as it tells Guidelines where to find the GUE extensions which support the custom controls. This will be set to GUIDE\GUE. It is recommended that you allow the Installation program to modify CONFIG.SYS for you, otherwise you will need to manually edit the file to ensure correct operation. If you opt not to have the changes done automatically, the required changes will be written to a file called CONFIG.GL within the target directory. These changes can then be applied manually before running Guidelines. Note that it is not possible to update the LIBPATH environment variable manually. This variable must be set when your OS/2 system boots to take effect - you cannot set it dynamically. ═══ 2.6.6. Update Workplace Shell ═══ Update Workplace Shell If this option is selected, the installation program will create a Guidelines folder on your Workplace Shell Desktop as the following example shows: It is possible for this checkbox to be disabled. When this occurs (only when installing one or more Extension Packs) it means that it isn't possible for the installer to locate the main Guidelines folder. This could have occurred due to technical difficulties with a particular installation of you operating system, but more likely because the folder was never installed in the first place. To quickly create this folder, cancel the installation of the current pack, go back to the main screen and Select 'Install Guidelines' from the menu. Enter all details as normal, but when the option dialog appears de-select all options except for 'Update WPS' and click on OK. This will create the required WorkPlace Shell folders. ═══ 2.6.7. Optional Libraries ═══ Optional Libraries Guidelines requires the availability of a compiler for your chosen environment. The 'Optional Libraries' list shows the compilers supported by Guidelines. Check the compiler(s) you wish to use with Guidelines. By default, all of the compiler libraries are checked. The installer will not allow you to de-select every compiler - if you try it will select all of them for you. At least one compiler must be selected. Furthermore, the compiler support for a particular platform requires that the latest compiler be installed, so that if you required CSet++ support several files compiled in Visual Age must be installed also for Guidelines to function. The installer will automatically select the correct compiler support boxes dependent upon your selection. ═══ 2.7. Installation Directories ═══ Installation Directories This dialog allows you to specify the source and target directories to be used during the installation of Guidelines. The following fields can be set:  Install From  Install Guidelines  Install Extensions ═══ 2.7.1. "Install from" Directory ═══ Install From This is the directory from which you are installing Guidelines. It would normally be A:\ or B:\ if you are installing from a floppy drive. If you are installing from an AS/400 shared folder, the directory will be I:\GUI_INST.ALL for a full installation, or I:\GUI_INST.PIP for a improvement pack. If you are installing from a directory on a hard drive, the Installation program will display the directory from which it was run, which should specify the location of the installation files. This field should not normally be changed. ═══ 2.7.2. Installation Directories - Guidelines ═══ Installation Directories - Guidelines This panel enables you to specify the directory into which Guidelines will be installed. The default drive for installation is the OS/2 boot drive (usually C:), and the default directory is GUIDE. If the target directory does not exist, it will be created. If the target directory already exists and contains an existing copy of Guidelines, then the system files will be overwritten with the version being installed. Other user files within the target directory will not be affected. The Installation program will automatically check that there is sufficient space to install all the options selected. ═══ 2.7.3. Installation Directories - Extensions ═══ Installation Directories - Extensions This panel enables you to specify the directory into which Extension packs will be installed. The default drive for installation is the OS/2 boot drive (usually C:), and the default directory is GUIDE. If the target directory does not exist, it will be created. If the target directory already exists and contains an existing copy of any pack, then the system files will be overwritten with the version being installed. Other user files within the target directory will not be affected. The install program offers C:\GUIDE as the directory to install all extension packs into. We recommend that you use this name to perform the installation, though the target drive may be any drive which has sufficient space to contain all the files. If you find it necessary to change the 'Install to' location, ensure that it is not the same as the 'Install from' location. It is sufficient to install extension packs to the same directory as Guidelines, this will keep all appropriate files in a single directory. This (the default) is the recommended option. All extension packs will be installed to this directory, should you want to install different packs to different directories, you will have to change this field to the desired directory and install only that pack from the Install.. Extensions menu option. The Installation program will automatically check that there is sufficient space to install all the options selected. ═══ 2.8. Registration Dialog ═══ Registration Dialog This dialog allows you to personalize your Guidelines package. You should enter the following information before proceeding:  Registration Number  Name  Company ═══ 2.8.1. Registration Number ═══ Registration Number Enter your Registration Number in this field. Your unique Registration Number is supplied with your Guidelines package. If you have not purchased a registered copy of Guidelines, a blank Registration Number will be accepted which will provide full functionaility within the base product, but will prevent the use of any Guidelines extension packs. ═══ 2.8.2. Name ═══ Name Enter your name in this field to customize your Guidelines package. This name will appear in the Product Information dialog from within Guidelines. If no Company is specified, this Name will appear in your applications' Copyright notices. ═══ 2.8.3. Company ═══ Company Enter your Company name (if any) in this field. This Company name will appear in your applications' Copyright notices. If the Company name is not specified, the Name will appear in the Copyright notices instead. ═══ 2.9. Installation Status ═══ Installation Status This dialog shows the progress of the installation. It displays the actions it is performing and shows a graphical bar representing the completion percentage of the installation as it progresses. Pressing the Abort button will stop the installation. ═══ 2.10. Install Extensions Dialog ═══ Install Extensions Dialog This dialog displays a list of the Extension Packs which are available for installation. Select an Extension Pack to install from the Extension Pack list and press the Install button. You can select the All button if you wish to highlight automatically all of the available extensions (this is the default). Or you can select the None button to deselect all extensions. This enables you to manually select an individual component to install. ═══ 2.10.1. Extension Pack List ═══ Extension Pack List This list shows all of the Extension Packs which were located on the specified source directory. Select an Extension Pack to install, and press the Install button to proceed.