TED - TEKI File Editor

(c) Cornell University, 1998

Brian Smith, Sumit Kapoor

Welcome to TED!  As the name suggests, TED is an editor that will help
you create TEKI files. Although TEKI files can be edited manually, TED
makes it easier to create and modify these files.  This note will help
you through the creation of your first TEKI file using TED.

Before you create your first .tek file, you should read
tek-file-format.txt, which describes the TEKI file format.  It will
help you understand what you need to know to create your first .tek
file.  This file can be viewed by selecting the appropriate item in the
TED Help menu.

Briefly, to create a TEKI file for a package, you should:

#0 Create a "bundle" that will contain the package.  A bundle is a
group of one or more packages.  TEKI allows you to distribute multiple
packages with one TEKI file.  When TED starts up, it creates a
new, empty bundle called "NewProject.tek" for you

#1 Create the directory structure for each package in the bundle.  For
example, Tcl-DP 4.0 has the following structure:

  dp4.0/  -- the root directory for the package
  dp4.0/readme.txt
  dp4.0/copyright
  dp4.0/doc/  -- package documention
  dp4.0/examples/  -- Examples that use Tcl-DP
  dp4.0/library/   -- Platform independent files (e.g., tcl files)
  dp4.0/win/       -- Files for Windows-NT and Windows-95
  dp4.0/solaris/   -- Files for Solaris

The root directory for this tree (dp4.0) is called the Base
Directory.

#2 Make sure that the system architectures for which you want to
provide an installation are defined. For example, you might
provide precompiled binaries for Windows NT and Solaris. 
Make sure these names appear in the "Bundle Information" window.
We provide a predefined list of common names; you can add a
new one by using the "System Names" command in the Bundle menu.

#3 Add a package to your bundle by selecting the Add Package button.
You need to define a unique package identifier which can be a
combination of English alphabets and numbers which usually specify the
version number, without spacing.  For example, TCL-DP version 4.0 uses
dp4.0 for its package identifier.

#4 Click on the newly added package and select "Base Directory" from
the "Package" menu.  The Base Directory is just the directory that you
created in step 2 above.

#5 Select the Wizard option in the Package menu.  The Package Wizard
leads you through a series of windows where you can specify the package
parameters. An online help is accessible by pressing the Help button on
any of the wizard windows. Also note that all the wizard windows are
available from the Package menu option directly.

#6 Repeat steps 3-5 for each package in the bundle.

#7 Set the Default installation parameters.  These default parameters
are used by TEKI when the user selects the "Typical install" option.
Defaults are needed for the following parameters: Architecture, Package
in the Bundle, and whter to Install Documents, Examples, and Data.  The
"Defaults Wizard" in the Bundle menu will guide you through the
selection of these parameters.  Again all the wizard windows are
accessible from the Bundle menu option.

#8 You now have collected all the parameters for the TEKI file and just
need to save the TEKI file and you are all set to go.


NOTE: Before you ship your application don't forget to include TEKI
(teki.tcl and the tekilib directory) with your archive.

