$PTOLEMY/doc/samples, the following files can be found:
title.doc: A sample cover page.
documents.doc: A sample document (very similar to this chapter).
documentsTOC.doc: The table of contents for the document.
documents.book: A book file that unites the above three documents.
documents.docas a template for most applications. It defines the paragraph and character styles visible in this chapter.
By convention, except for the sample document, we do not distribute the FrameMaker files for the entire Almagest. Instead, we distribute the PostScript1 code produced by Frame. The makefiles used to print manual, therefore, simply assume that the PostScript files are up to date. It is up to you to ensure this. You must also ensure that the index files corresponding to the PostScript code are up to date. The section below explains how to generate these.
18.3.1 Index Entries
We use FrameMaker to generate the indexes for each manual. Different index markers are used to denote different uses of the term bein indexed. For example, the definition of a star gets a different FrameMaker marker than a simple reference to the star. In the index file the page number of the definition will be in bold, the page number of the reference will be in a regular font.
These resources cause the named index markers to appear in the list of markers.
Esc-s-m). Then choose one of the above six types of index entries, using the following guidelines:
IndexReference: Generic index entry
IndexExample: An example of the usage of a particular feature.
IndexDefinition: The definition of a term.
IndexStarRef: A generic reference to a star.
IndexStarEx: An example of the usage of a star. For example if the text that describes the SDF
butterflydemo would have a index entry that looks like:
butterfly (SDF demo).
IndexStarDef: The definition of a star. This entry is normally automatically generated when a star is compiled, so you will probably not encounter any occasion to use it directly. The text that defines the SDF
Rampstar would have the marker text:
Ramp (SDF block)
domain. Of course, if you are writing some explanation of these basic terms, then an index entry is appropriate. Before entering index entries for a star, look in the documentation for similar stars to get an idea of the subject terms that have already been used and might be related. Be sure to follow the same capitalization rules as the existing index entries (i.e.
Ramp (SDF block), not
Ramp (SDF Block)).
Currently we use Quadralay's WebWorks to convert Framemaker documents to html. You can use
HTMLStartto indicate text that should be present in the html output as a link. Use a
HTMLEndon the end of the text of the text that represents the link. The text of the first
HTMLStartcontains the filename or URL:
HTMLEndis placed at the end of the text you want underlined in the html version.Here is a sample link to
The markers are not printed when the FrameMaker document is printed. WebMaker converts the text delimited by the markers into HTML hypertext links.
When you print your document, you should generate the index file that will be used to print the overall index. To do this, select File/Generate, and within the ensuing dialog box, select List/List of Markers. In the dialog box that results from this, be sure all of the above index markers are included, and then accept the default filename suffix "LOM". The dialog box should look like this:
When you click OK, you will get a new file with a list of markers in a format acceptable to the Ptolemy index generation software. This file should be saved in "Text only" form. By convention, we name the index file using the document name with the suffix ".index".
For a display entirely set in this font,
use the "Commands" paragraph format, as shown here.
You can use "meta-Return" to force carriage returns where you want them without getting a new paragraph.
"to straight quotes
", by typing Control-Shift-
". In general, commands don't have slanted double quotes, hence the need to convert them to straight quotes.
ProgramCodecharacter format. An example would be that the default of the loopScheduler target parameter is
1. Strings such as
FALSE, that are used as values to parameters should also be in the
Commandsparagraph format. Each successive line should use the
CommandsContparagraph format. The text the computer would print should be in the
ProgramCodecharacter format, the text the user would type should be in the ProgramUser character format.
Copyright © 1990-1997, University of California. All rights reserved.