Chapter 9. Preparing Files for Handoff to Silicon Graphics

This chapter describes the naming conventions of the files you prepare for hand-off to Silicon Graphics as well as what files need to be included with each hand-off. See your project schedule for the hand-off dates. If you're unable to make your hand-off date, please negotiate a new date with your L10N project manager.

Naming Conventions

The files you download from Silicon Graphics should include all the files necessary to produce an English version of a document. These files include

*.doc  

FrameMaker source files for the book.

bookfile 

FrameMaker bookfile.

*.sgm  

SGML files for the online version of the book.

Makefile  

Text file with instructions.

orig directory  

All the original artwork for the book:

  • .rgb files are RGB screen captures

  • .ai files are Encapsulated PostScript files authored in Adobe Illustrator.

  • .ps files are Encapsulated PostScript files authored in Adobe Illustrator.

  • .mv files are SGI movie format files.

print directory 

All print versions of the artwork for the book:

  • .bw files are the grayscale versions of the .rgb files after they have been put through the tobw tool.

  • .ai files are identical to those in the orig directory.

online directory 

All .gif files for the online version of the book.

help directory 

All the helpmaps necessary for the book to act as online help for an application or utility.

diff directory  

All the compare (CMP) and summary (SUM) files documenting the differences between this version and a previous version of the book.

PostScript Files

If a book project requires PostScript files as a deliverable, create a PostScript file for each Frame file that makes up a book. All PostScript files should be included in a directory named psfiles. Place the psfiles directory at the same level as the print and orig directories in a book directory. See Table 9-1 for the naming conventions to use for the files.

Table 9-1. PostScript File Naming Conventions

Name

Description

##front.ps

front is 'Title/Credits'

##TOC.ps

TOC is 'Table of Contents'

##LOE.ps

LOE is 'List of Examples'

##LOF.ps

LOF is 'List of Figures'

##LOT.ps

LOT is 'List of Tables'

##intro.ps

intro is 'About this Guide'

##ptab#.ps

ptab is 'Part Tab'

##tab#.ps

tab is 'Chapter Tab'

##chap#.ps

chap is 'Chapter'

##appX.ps

app is 'Appendix'; X is an uppercase letter

##gloss.ps

gloss is 'Glossary'

##IX.ps

IX is 'Index'



Note: The interactive script getps will create PostScript files from a book's FrameMaker bookfile, number them automatically, and place them in a directory named psfiles. Contact your Production Editor if you would like to use this tool (it is not included in the prod toolroot).


Tarring Files

Before you send files to Silicon Graphics, you must prepare them for downloading to an FTP site.

  1. Check files within the directory and ensure that the Makefile is present.


    Note: Files for Japanese books must contain the .mif files.


    % ls 007-1234-567JP 
    ch1.doc  ch1.mif  ch2.doc  ch2.mif  Makefile
    

  2. Make a tar file containing all files under the 007-1234-567JP directory and name it YY.MM.DD.007-1234-567JP.tar.

    % tar cvf YY.MM.DD.007-1234-567JP.tar 007-1234-567JP 
    a 007-1234-567JP/ch1.doc  2 blocks
    

  3. Confirm the file was created:

    % ls 
    007-1234-567JP     YY.MM.DD.007-1234-567JP.tar
    

  4. Confirm the contents of the tar file:

    % tar tvf YY.MM.DD.007-1234-567JP 
    rwxr-xr-x 11113/10  Feb 21 15:51 1997 007-1234-567JP/
    rw-r--r-- 11113/10           972 Feb 18 21:41 1997
    1007-1234-567JP/ch1.doc
    

Compressing Files

  1. Compress the tar file:

    % gzip YY.MM.DD.007-1234-567JP.tar 
    

  2. Confirm the gzipped file:

    % ls 
    007-1234-567JP YY.MM.DD.007-1234-567JP.tar.gz
    

First Handoff

Once the linguistic translation of a book is complete, post the FrameMaker or MIF files to Silicon Graphics' FTP site and notify L10n and Production that the files are ready for review. This first hand-off is intended for linguistic review by L10N and a quick functionality check by Production to ensure that all of the files are present and that the markers or cross-references have not been removed during the translation process. A hard-copy printout of the FrameMaker files for European books is supplied to L10N for their review. Nihon Silicon Graphics (NSG) provides linguistic review and feedback for Japanese books.

In the first hand-off, include all the *.doc files, *.book file, and, optimally, a Makefile and the orig, print, and help directories (if applicable) so a test build can be done. For Japanese books, the *.mif files must also be included.

Second Handoff

In the second hand-off, include all the *.doc, *.sgm, and *.book files, a Makefile, and the orig, print, online, and help directories (if applicable). For Japanese books, the *.mif files must also be included.

Final Handoff

Because this is the final hand-off, include all the *.doc, *.sgm, and *.book files, a Makefile, and the orig, print, online, and help directories (if applicable). For Japanese books, the *.mif files must also be included. The final hand-off files should result in a buildable, error-free book with the same functionality as its English equivalent.