This document contains information important to localization vendors who translate existing Silicon Graphics documentation into different languages. Most of the information in this document can be found in other Silicon Graphics manuals that describe how to create a documentation. Where appropriate, this guide points the vendor to those locations for further information.
Although this book's primary focus is online documentation, some hard copy issues will be discussed as well. Hard-copy production is occasionally required for a translated document; some procedures that are irrelevant for online books must be followed in order to accommodate these situations.
This document includes the following chapters:
Chapter 1, “Overview,” provides an overview of the book building process used to produce localized books for Silicon Graphics as well as specific notes that may be useful to you.
Chapter 2, “Bookbuild Tools,” describes how to install bookbuild tools and set up a workarea for bookbuilding.
Chapter 3, “Using FrameMaker Files and IPTemplate Features,” describes how to apply templates that implement the Silicon Graphics document structure.
Chapter 4, “External Cross References and Multiple Link Targets,” describes how to create and test external book links and how to find and fix multiple link targets.
Chapter 5, “Building Online Books,” describes how to prepare source files for the online version of a manual. It also explains how to view an online book that was created using the bookbuild process.
Chapter 6, “Debugging Bookbuild Errors,” describes how to debug bookbuild errors.
Chapter 7, “Testing Online Books,” describes how to test online books.
Chapter 8, “Testing Help Books,” describes how to test help books.
Chapter 9, “Preparing Files for Handoff to Silicon Graphics,” provides instructions on how to prepare files for the first, second, and final handoffs to Silicon Graphics.
Chapter 10, “Transferring Files Using FTP,” provides instructions on how to use FTP to transfer files.
Chapter 11, “Reporting Bugs,” provides instructions on how to report bugs found in books.
Appendix A, “Rules to Follow When Using the Templates,” is a quick reference list of rules to follow when using the IPTemplates.
Appendix B, “Building and Testing HTML Books,”provides instructions on how to build, install, and test HTML books.
Please call your Silicon Graphics contact if you have questions or need additional information on the procedures described in this book. Any errors, omissions, clarifications and requests for enhancements can be directed to [email protected].
These type conventions and symbols are used in this guide:
| Helvetica Bold | Hardware labels | |
| Italics | Command monitor commands, filenames, IRIX commands, manual/book titles, onscreen button names, program variables, tools, utilities, variable command-line arguments, and variables to be supplied by the user in examples | |
| nnn | (Lowercase italic ns) Placeholders for the version number in the part number: 007-1234-nnn. | |
| Fixed-width type |
| |
| Bold fixed-width type |
| |
| > | (Right angle bracket) Cascading menu(s); indicates a path of menu, submenu, and menu item | |
| # | IRIX shell prompt for the superuser (root) | |
| % | IRIX shell prompt for users other than superuser |