22 May 1985 ========================== Document Development Tools ========================== by Don Amby Delco Systems Operations General Motors Corporation Post Office Box 471, M/S 1A21 Milwaukee, Wisconsin 53201 (414)768-2682 GM Network: 8/521-2682 logical name: DOC_TOOLS The logical name DOC_TOOLS is assumed to point to this directory, and is set by the SETLOGS.COM file. This directory contains several tools that can be used to aid in the development of (Runoff) documents. There are several template files that can be used to start off creation of a new document, along with numerous standard include (via Runoff .REQUIRE) files. Over time tools and automated utilities will be added that will make it easier to create standard format documents. Structured Documentation Development ------------------------------------ The purpose of a Runoff source file is the same as a source file in any programming language. These files are then run through a translation process that generates the desired output, from the input source files. The include (or require for *.RNO) files are set up to encapsulate common features of a document, be it a memo, a short report, or a large manual composed of many chapters and appendices. This is like the partitioning a large program into a set of reusable functions or procedures, that can be used by anyone to build new programs with them. They also function similar to the constants, types, and variable declarations of a programming language such as PASCAL. Important Files --------------- The following is a list of some of the important files that are to be found in this directory. BUILDKIT.COM Builds new HELP.HLB and SETUP.SET files. HELP.HLB Help library for tools. SETLOGS.COM Defines logical names for this directory. SETSYMBS.COM Defines global symbols for tools. SETUP.SET Toolkit startup file. Accessing Toolkit ----------------- There are three ways that you may access the tools and files that are in this Toolkit. The most important point to be kept in mind, is that the SETLOGS.COM procedure MUST BE RUN FROM THIS DIRECTORY ONLY! 1. Guaranteed Access Method The following method will always work, as the setup (SETLOGS.COM and SETSYMBS.COM) procedures are run from within this directory. $ SET DEF this-directory $ @SETLOGS $ @SETSYMBS $ SET DEF where-you-came-from 2. Access Using SETUP.SET File The second method is to use the SETUP.SET command procedure, for a Toolkit main directory. This can only be done after you are sure that the SETUP.SET file has the proper directory name within it. The SETUP.SET file must have been created with the BLDSETUP tool, that is part of the Toolkit Management Toolkit. This file will have the complete directory specification (including device) inside of it. 3. Access After Logical Names Defined The third, and best method, is to have the system manager use the SETLOGS.COM procedures to define the logical names in the system (or group) logical name tables. This can be accomplished easily as the SETLOGS.COM procedure allows a parameter of GROUP or SYSTEM to be passed, that will have it define system or group logical names. After the logical names are defined then all you need to do is the following. $ @DOC_TOOLS:SETSYMBS