Chapter 2. Bookbuild Tools

This chapter describes how to install the bookbuild tools and set up a workarea. You should be familiar with using Inst or Software Manager. The following sections are included:

Required Software Packages

In addition to the build and viewing tools described in “Tools”, you need FrameMaker 4.0 or 5.1 for IRIX or Frame 3.0 for Japanese for Solaris. FrameMaker 5.5 does not work with the build tools.

Compatibility

All of the tools assume that you are installing on a computer running the IRIX 6.2 operating system.

Tools

All of the tools described in this section should be installed in the standard default location of /.

If you have the previous 3.5 bookbuild tools installed, see the section “Removing ROOT and TOOLROOT” for instructions on how to remove them.

You need the following subsystems:

make

make is required by the bookbuild tools to run the make command as described in Chapter 5, “Building Online Books.”

The name of the Inst image is dev.

I  dev                  11/06/97  Development System, 6.2
I  dev.sw               11/06/97  Development Software, 6.2
I  dev.sw.make          11/06/97  Parallel Make Utilities

insight_dev

The name of the Inst image is insight_dev.

I  insight_dev          11/06/97  InSight Developer Book Building Tools, 3.6
I  insight_dev.books    11/06/97  Insight Developer Books, 3.6
I  insight_dev.books.IPTemplate  11/06/97  Insight Developer Template, 3.6
I  insight_dev.books.InProPub_UG  11/06/97  Insight Professional Publisher
                                  User's Guide, 3.6
I  insight_dev.man      11/06/97  InSight Book Building Development Release
                                  Notes, 3.6
I  insight_dev.man.relnotes  11/06/97  InSight Book Building Release Notes, 3.6
I  insight_dev.sw       11/06/97  InSight Book Building Development
                                  Environment, 3.6
I  insight_dev.sw.rules 11/06/97  InSight Book Building Rules, 3.6
I  insight_dev.sw.samples  11/06/97  InSight Book Building samples, 3.6
I  insight_dev.sw.tools 11/06/97  InSight Book Building Tools, 3.6

prod_toolroot

The prod_toolroot contains productivity tools and enhanced quality assurance for the build process. This is used by the SGI_QA variable in “Setting Workarea Environment Variables”.

The name of the Inst image is prod_toolroot.

I  prod_toolroot        01/20/98  prod_toolroot (no description)
I  prod_toolroot.sw     01/20/98  Technical Publications Production Toolroot
                                  Software
I  prod_toolroot.sw.IP_templates  01/20/98  Production Additions to IPTemplates
I  prod_toolroot.sw.frame_macros  01/20/98  Macros for FrameMaker
I  prod_toolroot.sw.prod_gizmo  01/20/98  ProdGizmo
I  prod_toolroot.sw.scripts_prod  01/20/98  Prod scripts
I  prod_toolroot.sw.scripts_pubs  01/20/98  Pubs-wide scripts
I  prod_toolroot.sw.special_templates  01/20/98  Special Templates

impr_rip

This subsystem is required for converting Adobe Illustrator files into gif images. You need a license for this product. See “Getting Licenses” for more information.

The name of the inst image is impr_base.

I  impr_rip             01/20/98  Impressario 2.2.3 PostScript Renderer
                                  (Requires Optional Impressario License)
I  impr_rip.man         01/20/98  Impressario 2.2.3 PostScript Renderer Manual
                                  Pages
I  impr_rip.man.impr    01/20/98  Impressario 2.2.3 PostScript Renderer Manual
                                  Pages
I  impr_rip.sw          01/20/98  Impressario 2.2.3 PostScript Renderer
                                  (Requires Optional Impressario License)
I  impr_rip.sw.impr     01/20/98  Impressario 2.2.3 PostScript Renderer
                                  (Requires Optional Impressario License)

impr_kanji (Japanese only)

This is necessary for building Japanese books that have Adobe Illustrator files containing Japanese characters. You need a license for this product. See “Getting Licenses” for more information.

The name of the Inst image is impr_kanji.

I  impr_kanji           01/20/98  Kanji Fonts 2.0 Execution Environment
I  impr_kanji.man       01/20/98  impr_kanji Manual Pages
I  impr_kanji.man.fonts 01/20/98  Kanji Fonts 2.0 Manual Pages
I  impr_kanji.man.relnotes  01/20/98  Kanji Fonts 2.0 Release Notes
I  impr_kanji.sw        01/20/98  Kanji Fonts 2.0 for Impressario, requires
                                  license
I  impr_kanji.sw.fonts  01/20/98  Kanji Fonts 2.0 for Impressario, requires 
                                  license

Getting Licenses

You need a license for impr_rip and impr_kanji, both of which are part of the Impressario product. You may find it necessary to get a license for the IRIS InSight Professional Publisher. In future releases of the IRIS InSight Professional Publisher, no licensing will be necessary.

To get a license for any Silicon Graphics product, follow the instructions given below. The system must be owned by Silicon Graphics, otherwise you will need to purchase your own software. You may be prompted for a SurfZone ID and password. The ID is free, but you do have to fill out the registration at http://www.sgi.com/zone-reg.html.

  1. Go to this URL and complete all relevant information:

    http://www.sgi.com/Products/license.html

  2. Go to the permanent license section.

  3. Select Impressario and IRIS InSight Professional Publisher for your license.

  4. Enter SGI LOANER in the subject header or sales order field.

The Silicon Graphics licensing department will verify that the system in question is owned by Silicon Graphics. After verification, you will receive the license in the mail.

Instructions for installing the licenses are included with the license information.

Installing Software Packages

The section gives you a quick overivew of Inst and step-by-step instructions using Inst for installing the tools needed for bookbuilidng.

Once you have received all the images, such as those for IRIS InSight Professional Publisher, prod_toolroot, and Impressario, you need to use inst or Software Manager. All of the software, starting with the 3.6 Bookbuild Tools, are installed into the default location of /. If there is not enough space on /, you may need to remove unneccessary software. See “Removing ROOT and TOOLROOT” for information on removing old bookbuild tools.

Product Descriptions

Before installing any software from Silicon Graphics, it is important to know what the filenames mean. This sections describes the naming conventions for installable software products.

Product Descriptions

The product description is a file that contains information about product requirements and the installation environment for the product. The name of the product description file is the shortname for the product. For example, the name of the product description file for the IRIS InSight Professional Publisher product is insight_dev.

Installation Database

The installation database is a file that contains installation information for every file in the product. The name of the installation database is the shortname with an .idb extension. For example, the name of the installation database for the IRIS InSight Professional Publisher product is insight_dev.idb.

Images

An image is a collection of installable files that perform a similar or complementary function. Typically, each software product contains at least two images. This modularity allows for tailoring installations. For example, it is possible to install the images that contain the executable programs of a product without installing the release notes image.

The name of an image is the product shortname followed by an extension that describes the image's function. For example, insight_dev.sw is the image in the IRIS InSight Professional Publisher product that contains files for program execution, and insight_dev.man is the image that contains manual pages.

Subsystems

Images are composed of one or more subsystems. In a software product release, a subsystem is the smallest installable unit of software; the files that make up a subsystem cannot be installed individually. Subsystems are assigned three-part names of the form product.image.subsystem. For example, insight_dev.sw.rules and insight_dev.sw.tools are subsystems in the IRIS InSight Professional Publisher product.

Checking the Installation Directory

Example 2-1 shows you what your installation directory should look like.

Example 2-1. Directory View of the Installation Images

%ls ~/bookbuildtools  
dev                dev.sw64           impr_rip.man       prod_toolroot
dev.books          impr_kanji         impr_rip.sw        prod_toolroot.idb
dev.hdr            impr_kanji.idb     insight_dev        prod_toolroot.sw
dev.idb            impr_kanji.man     insight_dev.books  
dev.man            impr_kanji.sw      insight_dev.idb
dev.sw             impr_rip           insight_dev.man
dev.sw32           impr_rip.idb       insight_dev.sw


Installing the Software

The next step is to install the software. Enter the following command:

% inst -f /pathname of dir where images are located 

If the images are located on another system, you should be able to use the following command:

% inst -f guest@name of server:/pathname of dir where images are located 

After using this command, you get a screen like the one shown in Example 2-2.

Example 2-2. Main Inst Screen

paranoia 1# inst -f guest@midas:~dvogt/bookbuildtools
 
Default distribution to install from: guest@midas:~dvogt/bookbuildtools
 
For help on inst commands, type "help overview".
 
 
Inst Main Menu
 
 1. from [source ...]            Specify location of software to be installed
 2. open [source ...]            Specify additional software locations
 3. close [source ...]           Close distributions
 4. list [keywords] [names]      Display information about software subsystems
 5. go                           Perform software installation and removal now
 6. install [keywords] [names]   Select subsystems to be installed
 7. remove [keywords] [names]    Select subsystems to be removed
 8. keep [keywords] [names]      Do not install or remove these subsystems
 9. step [keywords] [names]      Interactive mode for install/remove/keep
10. conflicts [choice ...]       List or resolve installation conflicts
11. help [topic]                 Get help in general or on a specific word
12. view ...                     Go to the View Commands Menu
13. admin ...                    Go to the Administrative Commands Menu
14. quit                         Terminate software installation
 
Inst> 

Type list to list the software products contained in the directory. Example 2-3 shows an example of typical output.

Example 2-3. Full Listing of Software Products

i N  dev.books.IRIX_NetPG [d]        1780+  IRIX Network Programming Guide
i N  dev.books.I_IRIX_Prog [d]        956+  Introduction to IRIX Programming
i N  dev.books.IndigoMagic_IG [d]    2700+  Indigo Magic Desktop Integration
                                            Guide
i N  dev.books.T_IRIX_Prog [d]       2628+  Topics in IRIX Programming
i N  dev.books.UI_Glines [d]         4736+  IndigoMagic UI Guidelines
i N  dev.man.irix_lib [d]            3536+  Development Environment IRIX Manual
                                            Pages
i N  dev.man.relnotes [d]              36+  IDO Release Notes
  N  dev.sw.abi                     11224+  ABI development environment
  N  dev.sw.irix_speclibs            4368+  IRIX NonShared Libraries for
                                            Benchmarks
i N  dev.sw.lib [d]                   980+  Development Libraries
i N  dev.sw.make [d]                  172+  Parallel Make Utilities
  N  dev.sw32.nonshared_lib          9488+  NonShared N32 Libraries
  N  dev.sw64.lib                     272+  N64 Development Libraries
  N  dev.sw64.nonshared_lib         12816+  NonShared N64 Libraries
 
i N  impr_kanji.man.fonts [d]           4+  Kanji Fonts 2.0 Manual Pages
i N  impr_kanji.man.relnotes [d]       44+  Kanji Fonts 2.0 Release Notes
i N  impr_kanji.sw.fonts [d]        26204+  Kanji Fonts 2.0 for Impressario,
                                            requires license
 
  N  impr_rip.man.impr                 32+  Impressario 2.2.2 PostScript
                                            Renderer Manual Pages
  N  impr_rip.sw.impr                4272+  Impressario 2.2.2 PostScript
                                            Renderer (Requires Optional
                                            Impressario License)
 
i N  insight_dev.books.IPTemplate [d]  564+  Insight Developer Template, 3.6
i N  insight_dev.books.InProPub_UG [d]  752+  Insight Professional Publisher
                                            User's Guide, 3.6
i N  insight_dev.man.relnotes [d]      36+  InSight Book Building Release
                                            Notes, 3.6
i N  insight_dev.sw.rules [d]          36+  InSight Book Building Rules, 3.6
  N  insight_dev.sw.samples          5728+  InSight Book Building samples, 3.6
i N  insight_dev.sw.tools [d]       62704+  InSight Book Building Tools, 3.6
 
  N  prod_toolroot.sw.IP_templates     92+  Production Additions to IPTemplates
  N  prod_toolroot.sw.frame_macros     36+  Macros for FrameMaker
  N  prod_toolroot.sw.prod_gizmo       32+  ProdGizmo
  N  prod_toolroot.sw.scripts_prod    100+  Prod scripts
  N  prod_toolroot.sw.scripts_pubs     48+  Pubs-wide scripts
  N  prod_toolroot.sw.special_templates  444+  Special Templates
 
Disk space summary (Kbytes):            /
 
Current free space                 139632 
- Selections net change            108040+
- Temporary inst overhead             836+
= Minimum free during install       30756 
 
Final projected free space          31592 
 
Inst> 

Anything marked with [d] after the subsystem is marked for installation by default. Any subsystem with a i before it will be installed. For example:

i N  insight_dev.sw.tools [d]       62704+  InSight Book Building Tools, 3.6

It is not always necessary to install default images, and sometimes it may be neccessary to install images that are not marked as default.

To install a product that is not marked for installation, enter the character i followed by the subsystem name. For example:

Inst> i impr_rip.sw.impr 

To test if the subsystem will be installed, enter, for example:

Inst> l impr_rip.sw.impr 

A typical result looks like this:

Inst> l impr_rip.sw.impr
  View:      distribution
  Status:    N=new, U=upgrade, S=same, D=downgrade
  Selection: i=install, r=remove, k=keep
 
  Subsystem Types [bdrpc]:  b=reBoot needed, d=Default, r=Required, p=patch,
             c=Client only
 
i N  impr_rip.sw.impr                4272+  Impressario 2.2.2 PostScript
                                            Renderer (Requires Optional
                                            Impressario License)
 
Disk space summary (Kbytes):            /
 
Current free space                 139632 
- Selections net change             99484+
- Temporary inst overhead             804+
= Minimum free during install       39344 
 
Final projected free space          40148 

The N after the i indicates that the software is new. An S indicates the same version as what is already installed on a system, and a U means that you are installing an upgrade.

To prevent a subsystem from being installed, enter k followed by the subsystem name(s). The sample below will not install anything that starts with dev.books. For example:

Inst> k dev.books dev.sw64.lib 

Entering k * prevents anything from being installed.

Necessary Installation Files

Example 2-4 shows you what your installation should like before you use the go command.

Example 2-4. Necessary Installation Files

Inst> l
  View:      distribution
  Status:    N=new, U=upgrade, S=same, D=downgrade
  Selection: i=install, r=remove, k=keep
 
  Subsystem Types [bdrpc]:  b=reBoot needed, d=Default, r=Required, p=patch,
             c=Client only
 
  N  dev.books.IRIX_NetPG [d]        1780+  IRIX Network Programming Guide
  N  dev.books.I_IRIX_Prog [d]        956+  Introduction to IRIX Programming
  N  dev.books.IndigoMagic_IG [d]    2700+  Indigo Magic Desktop Integration
                                            Guide
  N  dev.books.T_IRIX_Prog [d]       2628+  Topics in IRIX Programming
  N  dev.books.UI_Glines [d]         4736+  IndigoMagic UI Guidelines
  N  dev.man.irix_lib [d]            3536+  Development Environment IRIX Manual
                                            Pages
i N  dev.man.relnotes [d]              36+  IDO Release Notes
  N  dev.sw.abi                     11224+  ABI development environment
  N  dev.sw.irix_speclibs            4368+  IRIX NonShared Libraries for
                                            Benchmarks
i N  dev.sw.lib [d]                   980+  Development Libraries
i N  dev.sw.make [d]                  172+  Parallel Make Utilities
  N  dev.sw32.nonshared_lib          9488+  NonShared N32 Libraries
  N  dev.sw64.lib                     272+  N64 Development Libraries
  N  dev.sw64.nonshared_lib         12816+  NonShared N64 Libraries
 
i N  impr_kanji.man.fonts [d]           4+  Kanji Fonts 2.0 Manual Pages
i N  impr_kanji.man.relnotes [d]       44+  Kanji Fonts 2.0 Release Notes
i N  impr_kanji.sw.fonts [d]        26204+  Kanji Fonts 2.0 for Impressario,
                                            requires license
 
i N  impr_rip.man.impr                 32+  Impressario 2.2.2 PostScript
                                            Renderer Manual Pages
i N  impr_rip.sw.impr                4272+  Impressario 2.2.2 PostScript
                                            Renderer (Requires Optional
                                            Impressario License)
 
i N  insight_dev.books.IPTemplate [d]  564+  Insight Developer Template, 3.6
i N  insight_dev.books.InProPub_UG [d]  752+  Insight Professional Publisher
                                            User's Guide, 3.6
i N  insight_dev.man.relnotes [d]      36+  InSight Book Building Release
                                            Notes, 3.6
i N  insight_dev.sw.rules [d]          36+  InSight Book Building Rules, 3.6
i N  insight_dev.sw.samples          5728+  InSight Book Building samples, 3.6
i N  insight_dev.sw.tools [d]       62704+  InSight Book Building Tools, 3.6
 
i N  prod_toolroot.sw.IP_templates     92+  Production Additions to IPTemplates
i N  prod_toolroot.sw.frame_macros     36+  Macros for FrameMaker
i N  prod_toolroot.sw.prod_gizmo       32+  ProdGizmo
i N  prod_toolroot.sw.scripts_prod    100+  Prod scripts
i N  prod_toolroot.sw.scripts_pubs     48+  Pubs-wide scripts
i N  prod_toolroot.sw.special_templates  444+  Special Templates
 
Disk space summary (Kbytes):            /
 
Current free space                 139632 
- Selections net change            102388+
- Temporary inst overhead             728+
= Minimum free during install       36516 
 
Final projected free space          37244 

It is generally all right to install more susbsytems than you might actually use as long as you have enough disk space.

Once all the appropriate subsystems are selected, you can enter the go command, which installs all of the software with i's in the left column.

Inst> go 
Pre-installation check ..   8% 
Checking space requirements ..  16% 
Installing/removing files ..  16% 
Installing new versions of selected dev.sw subsystems
Installing/removing files ..  19% 
Installing new versions of selected dev.man subsystems
Installing new versions of selected prod_toolroot.sw subsystems
Installing/removing files ..  21% 
Installing new versions of selected impr_rip.sw subsystems
Installing/removing files ..  24% 
Installing new versions of selected impr_rip.man subsystems
Installing new versions of selected impr_kanji.man subsystems
Installing/removing files ..  25% 
Installing new versions of selected impr_kanji.sw subsystems
Installing/removing files ..  58% 
Installing new versions of selected insight_dev.books subsystems
Installing/removing files ..  62% 
Installing new versions of selected insight_dev.man subsystems
Installing/removing files ..  63% 
Installing new versions of selected insight_dev.sw subsystems
Installing/removing files ..  94% 
Running exit-commands ..  99% 
Checking dependencies .. 100% Done.
Installations and removals were successful.
You may continue with installations or quit now.

Enter list to see what is installed. Anything that is installed should have an S in the second column. For example:

  S  insight_dev.books.IPTemplate [d]   0   Insight Developer Template, 3.6
  S  insight_dev.books.InProPub_UG [d]  0   Insight Professional Publisher
                                            User's Guide, 3.6
  S  insight_dev.man.relnotes [d]       0   InSight Book Building Release
                                            Notes, 3.6
  S  insight_dev.sw.rules [d]           0   InSight Book Building Rules, 3.6
  S  insight_dev.sw.samples             0   InSight Book Building samples, 3.6
  S  insight_dev.sw.tools [d]           0   InSight Book Building Tools, 3.6

If you are satisfied with the installation, enter quit:

Inst> quit 
Requickstarting ELF files (see rqsall(1)) .. 100% Done.

You are now ready to work.

Additional Information on Inst and Software Manager

For more information on Inst or Software Manager, see the manual IRIX Admin: Software Installation and Licensing. This can be accessed online from
http://techpubs.sgi.com/library/dynaweb_bin/0620/bin/nph-dynaweb.cgi/
dynaweb/SGI_Admin.

You can also download PDF files from
http://techpubs.sgi.com/library/lib/makepspage.cgi?007-1364-060,pdf,@Version[0].

Setting Up the Workarea

If you have been assigned to localize an English book for more than one language, create separate directories for each language according to the naming conventions discussed in “Document and Directory Part Numbers”. Silicon Graphics manuals typically refer to books by part number when building online books.

Directory Tree

Figure 2-1 shows an example of a typical directory tree set up for bookbuilding several French and German documents.

Figure 2-1. Typical Silicon Graphics Working Directory


Workarea Environment Variables

Your workstation can provide information about the location of files and tools required by the bookbuild tools. You can obtain this information by using environment variables that you set yourself. This section covers

Configuring Workarea Environment Variables

The workarea environment variables you must set are listed in Table 2-1.

Table 2-1. Workarea Environment Variables

Variable

File

Description

ROOT

~/.set_workarea

Specifies the location of the rules to be used when you build books for IRIS InSight.

TOOLROOT

~/.set_workarea

Specifies the location of the tools to be used when you build books for IRIS InSight.

SGI_QA

~/.set_workarea

Set to null (no setting). Silicon Graphics specific QA tools. Prints values of TITLE, FULL_TITLE, VERSION, BOOKSHELF, BOOK_ICON, BOOK_LANG, DTD, SORT_ORDER, and HIDDEN in the Makefile and checks for values of VERSION and SORT_ORDER.


Setting Workarea Environment Variables

The procedure that follows explains how to create the ~/.set_workarea file and set environment variables in .set_workarea and .cshrc. The procedure includes instructions for defining how the commands pushd and popd will work in your workarea. (pushd and popd are alternatives to the cd command; they queue working directories so you can alternate current directories without specifying a directory name.)


Note: These instructions are adapted from Building Manual Pages and Release Notes. Please refer to that document for more information.


  1. Go to your home directory:

    % cd 
    

  2. Use your favorite editor (like vi or jot) to create a new file called .set_workarea.

  3. Edit your .set_workarea file. Set the ROOT and TOOLROOT variable within the if/endif statement to the correct version of the tools, for example, /. Otherwise, type these lines into the file exactly as they appear:

    set curdir=`pwd` 
    unsetenv WORKAREA 
    setenv ROOT     / 
    setenv TOOLROOT / 
    if ("$curdir" =~ workarea*) then 
      setenv ROOT / 
      setenv TOOLROOT / 
      setenv SGI_QA 
    endif 
    


    Note: If a .set_workarea file exists, append the if/endif statement to your existing .set_workarea file.


  4. Save the file and quit the editor.

  5. Add the cd, pushd, and popd aliases to your .cshrc file:

    alias cd    'cd    \!* && source ~/.set_workarea' 
    alias pushd 'pushd \!* && source ~/.set_workarea' 
    alias popd  'popd  \!* && source ~/.set_workarea' 
    

    These aliases call the .set_workarea file to set the appropriate environment variables. So, when you cd/popd/pushd to a directory specified in the .set_workarea, your environment variables are set correctly.

  6. Enter the following command in all open windows so your changes will take effect:

    % source .cshrc 
    

  7. Verify that the environment variables are set:

    % cd ~/books 
    % env 
    

    Check the output of env for ROOT and TOOLROOT. Both variables should be set to the correct version of tools.

Prod toolroot Contents

The prod_toolroot file includes scripts that are useful for production on books.

All of the following scripts are installed in the /usr/local/bin and /usr/local/bin/prod directories. You should add these paths to the path information in your environment settings (usually found in your .cshrc file). The following scripts are covered in this section:

helpcheck Script

This script checks the helpmaps in the help directory against the SGML file for a book to ensure that the helpmaps are actually pointing to a target in the documents. To get the full SGML file mentioned in Example 2-5, build a book using the bookbuild tools. An artifact of the bookbuilding process is the SGML file, which is used to create the final online book.

Example 2-5 shows the syntax for helpcheck along with the results. The results listed in the Desktop_UG.hc file show which help topics exist in the document and which ones do not.

Example 2-5. Results From helpcheck Script


% /usr/local/bin/helpcheck help Desktop_UG.sgml > Desktop_UG.hc 

% more Desktop_UG.hc 
 
Checking help/Accessworkstation.helpmap...
access_other_user exists in Desktop_UG.sgml
Checking help/Background.helpmap...
background exists in Desktop_UG.sgml
schemes_browser exists in Desktop_UG.sgml
Checking help/SearchBook.helpmap...
srch_selectedmenu does not exist in Desktop_UG.sgml

helpdiff Script

This script checks the new localized helpmap directory against the original English version to make sure that only the text string that was supposed to be localized has changed. In some cases, during the localization process the semicolons in the helpmaps are accidentally removed. This script checks to make sure that hasn't happened. It is similar to running the diff command, but it ignores the third field.

Example 2-6 shows the syntax for helpdiff along with the results. The results listed in the Desktop_UG.hd file show which helpmaps are different in the document and which ones are the same. In the example, you find that files such as Background.helpmap and Desktop.helpmap are correct from a structural standpoint. However, FileManager.helpmap has what looks like three problems. These three lines should be looked at to make sure that everything is correct. It could be that the localized version is correct and the English version is not. If the English version is not correct, a bug should be filed against the helpmap file. If the localized version is the problem, make any necessary corrections.

Example 2-6. Results From helpdiff Script

% /usr/local/bin/helpdiff 007-1342-130FR/help 007-1342-130/help > \ 
    007-1342-130FR/Desktop_UG.hd 
 
% more 007-1342-130FR/Desktop_UG.hd 
 
007-1342-130FR/help <-> 007-1342-130/help
13a14
> Launch.helpmap
007-1342-130FR/help/Background.helpmap <-> 007-1342-130/help/Background.helpmap
007-1342-130FR/help/Desktop.helpmap <-> 007-1342-130/help/Desktop.helpmap
007-1342-130FR/help/DtSounds.helpmap <-> 007-1342-130/help/DtSounds.helpmap
007-1342-130FR/help/DtUtilities.helpmap <-> 007-1342-130/help/DtUtilities.helpmap
007-1342-130FR/help/FAXManager.helpmap <-> 007-1342-130/help/FAXManager.helpmap
007-1342-130FR/help/FileManager.helpmap <-> 007-1342-130/help/FileManager.helpmap
3d2
< 2;Desktop_UG;0;fm2;FileManager.FileManager
9c8
< 2;Desktop_UG;1;access_remote_login;FileManager.FileManager
---
> 2;Desktop_UG;1;newdir.Newdir.Help;FileManager.FileManager
13d11
< 2;Desktop_UG;0;fm5;FileManager.FileManager
30,31d27
< #0;Desktop_UG;0;file_browser;
<


installtestbooks Script

This script installs a book from a workarea into a test directory. This is not a real installation of the book (use Inst for that). This script must be run from the same directory in which the book was built. The instructions are listed as comments in the script. See “Installing a Localized Book for Testing” for more information.

gethelp Script

This script extracts the help topics out of the individual SGML files and replaces the third field in the helpmap with the corresponding string (or heading title). The helpmaps still need to be viewed to ensure that the third field of each line was converted correctly. This script can also be used to update the localized helpmaps.


Note: This script is located in /usr/local/bin/prod.

You must invoke the gethelp command from the part number directory of the book (the same directory as the SGML files). The help directory (containing the helpmaps) must be present. Example 2-7 shows an example of a typical English helpmap.

Example 2-7. English helpmap After Using gethelp

% more help/Background.helpmap 
0;Desktop_UG;Changing the Desktop Background;0;background;Background.Background
0;Desktop_UG;Using the Color Browser;0;schemes_browser;Background.ColorCDialog.Help

Example 2-8 shows the same Background.helpmap file after running the gethelp script on the French version of the document. Notice that only the third field has changed. This is the field that shows up in the pulldown Help menu of the application.

Example 2-8. Helpmap After Using gethelp on a French Document

% more help/Background.helpmap 
0;Desktop_UG;Modifier le fond d'&eacute;cran;0;background;Background.Background
0;Desktop_UG;Utiliser le visualisateur de couleurs;0;schemes_browser;Background.ColorCDialog.Help

See “Helpmaps” for more information.

Removing ROOT and TOOLROOT

If you have old build tools installed under a different ROOT and TOOLROOT, you must remove them. They have been replaced by insight_dev and prod_root. To find out if you have old build tools installed, enter

% versions -r /dirpath 

For example, if a special bookbuild tools directory, such as /3.5tools, contained your old bookbuild tools, and you typed versions -r /3.5tools, you would see output similar to Example 2-9.

Example 2-9. Versions Output

midas 6% versions -r /d/3.5.tools
Target: /d/3.5.tools/
I = Installed, R = Removed
 
   Name                 Date      Description
 
I  build_root           11/19/96  Build Tools Development Environment
I  build_root.sw        11/19/96  Build Tools Development Environment
I  build_root.sw.dev    11/19/96  Build Tools Development Environment
I  build_root.sw.friend 11/19/96  Build Tools Ism Development Environment
 
I  build_toolroot       11/19/96  Build Tools TOOLROOT
I  build_toolroot.sw    11/19/96  Build Tools TOOLROOT
I  build_toolroot.sw.tools  11/19/96  Build Tools TOOLROOT
 
I  insight_root         11/19/96  InSight Development Environment, 3.5
I  insight_root.dev     11/19/96  InSight Book Building Development
                                  Environment, 3.5
I  insight_root.dev.books  11/19/96  InSight Book Building Dev, 3.5
I  insight_root.sw      11/19/96  InSight Viewer Development Environment, 3.5
I  insight_root.sw.dev  11/19/96  InSight Viewer Dev Environment, 3.5
I  insight_root.sw.sgihelp  11/19/96  SGIHelp Header & Library Files, 2.0.3
I  insight_root.sw.xhelp  11/19/96  SGIHelp XHelp Files, 2.0.3
 
I  insight_toolroot     11/19/96  InSight TOOLROOT, 3.5
I  insight_toolroot.books  11/19/96  InSight Book Building TOOLROOT, 3.5
I  insight_toolroot.books.Carberry_minimum  11/19/96  Carberry minimum, 4.3
I  insight_toolroot.books.EBT  11/19/96  EBT full, 3.0b7c
I  insight_toolroot.books.EBT_minimum  11/19/96  EBT minimum, 3.0b7c
I  insight_toolroot.books.PBMPlus  11/19/96  PBMPlus - partial collection
I  insight_toolroot.sw  11/19/96  InSight Viewer TOOLROOT, 3.5
I  insight_toolroot.sw.tools  11/19/96  InSight Viewer TOOLROOT, 3.5
 
I  prod_toolroot        12/03/97  prod_toolroot (no description)
I  prod_toolroot.sw     12/03/97  Technical Publications Production Toolroot
                                  Software
I  prod_toolroot.sw.IP_templates  12/03/97  Production Additions to IPTemplates
 
I  prod_toolroot        05/08/97  prod_toolroot (no description)
I  prod_toolroot.sw     05/08/97  Technical Publications Production Toolroot
                                  Software
I  prod_toolroot.sw.frame_macros  05/08/97  Macros for FrameMaker
 
I  prod_toolroot        08/05/97  prod_toolroot (no description)
I  prod_toolroot.sw     08/05/97  Technical Publications Production Toolroot
                                  Software
I  prod_toolroot.sw.scripts_prod  08/05/97  Prod scripts
I  prod_toolroot.sw.scripts_pubs  08/05/97  Pubs-wide scripts
I  prod_toolroot.sw.special_templates  08/05/97  Special Templates
 
I  prod_toolroot        11/25/97  prod_toolroot (no description)
I  prod_toolroot.sw     11/25/97  Technical Publications Production Toolroot
                                  Software
I  prod_toolroot.sw.prod_gizmo  11/25/97  ProdGizmo

The actual directory on your system may be different. To remove these old bookbuild tools, enter the following command:

% versions -r /dirpath remove “*” 

This should liberate considerable space on your disk drive.