IEEE Standards Publishing Tutorial
1. Overview
This tutorial is intended to give working group technical editors an overview of the Adobe FrameMaker publishing environment, especially as used with the IEEE Standards FrameMaker templates.
1.1 Scope
This tutorial will cover rudimentary and advanced features of FrameMaker and the IEEE Standards FrameMaker templates.
1.2 Purpose
This tutorial is intended to expand working group knowledge of FrameMaker and its document authoring and publishing capabilities.
2. References
This document shall be used in conjunction with the following publications. When the following publications are superseded by an appropriate revision, the revision shall apply.
IEEE Standards Style Manual, 2000 Edition.
IEEE Standards Companion.
NOTES
1--There is no need to re-type the sort of information found in Footnote 1. Weve included that information in our master pages, which can be accessed via the View --> Master Pages option (see Annex B).
2--The sentences that introduce this clause are critical. The first sentence should be used in every standard, while the second sentence should be used as applicable.
3. Definitions
Definitions require a bit of manual intervention, as only the definition number is set as bold. The following definitions were taken from Websters New Collegiate Dictionary [Bx]. This tutorial does not use any definitions from The IEEE Standards Dictionary of Electrical and Electronics Terms [Bx].
3.1 fulham: A loaded die.
3.2 mazer: A large drinking bowl, usually of hard wood.
3.3 tarn: A small steep-banked mountain lake or pool.
3.4 treacle: Antidote against a poisonous bite.
NOTE--Document-specific information, if included in the definitions clause, must be placed in notes.
4. Common pitfalls
4.1 Lists
To add a dashed list wed choose the paragraph format DL,DashedList. The following is an example of a dashed list:
	San Diego
	San Francisco
	Oakland
Now well move on to ordered lists, which are a bit more complex:
a)	Use L1,LetteredList for the first item of a lettered list
b)	Use L,LetteredList for subsequent lettered list items
This is a list paragraph, which is set via the LP tag
c)	Lettered lists are first in our list hierarchy
1)	Use LI1,NumberedList2 for the first item of a numbered list
2)	Use LI,NumberedList2 for subsequent numbered list items
3)	Numbered lists are second in our list hierarchy
i)	Use LII1NumberedList3 for the first item of a third-level list
ii)	Use LII,NumberedList for subsequent third-level list items
iii)	Roman numerals come third in our list hierarchy
We have now created a properly nested ordered list. If this style is not followed, you can see that it could take some time for an IEEE editor to reformat.
NOTE--We manually added some extra space between list items. This augments readability, and is a good practice (though certainly not mandatory). List spacing can be set via the paragraph designer window (ctrl + m on the PC; Applekey + m on the Mac).
4.2 Equations
FrameMaker features a fairly powerful equation editor. Its admittedly a bit quirky, too, and can take some time and patience to learn. In this section well try a few sample equations to highlight some potential pitfalls.
Before we start, we should point out that equations use one of two paragraph tags: the Equation tag for numbered equations, and the EU,EquationUnnumbered tag for unnumbered equations.
To create a new equation, choose the equation palette from the right-hand menu bar. Then choose New Medium Equation from the Equations menu. Our first example is an unnumbered equation.

Notice how we Shrink Wrapped the table when we were done. If you needed to edit the equation, you would highlight its box and choose Unwrap Equation, and then Shrink Wrap it again when your edits were complete.
In the next equation, well mix variables and plain text. When in the equation editor, use shift + quote key to enter text mode. Italic is the default in FrameMaker equations.
(1)
It is highly recommended that you number all equations, as it makes it much easier for implementers of the standard to reference them. Now on to our last, most complex example:
(2)
4.3 Figures
One of the advantages of FrameMaker is that it features fairly robust, if understated, graphics capabilities. Unlike in Word or WordPerfect, artwork created in FrameMaker converts well (and, more importantly, easily) to TIF or GIF formats, formats widely used on the web. In this example were going to work with two figures: one well import from an existing file; the other well create from scratch.
The first step when adding a figure to your document is to create an anchored frame. This will ensure that your figure stays right where you placed it, even if text is added or deleted at a later date. Keep in mind that we try to place figures right after the paragraph in which theyre called out. To add an anchored frame, place your cursor where you want it, then choose Anchored Frame from the Special menu. Alignment should be centered, the frame should be positioned below current line, and set at Width = 432.0, Height = 144.0.
Once the anchored frame is added, heres the process for importing a figure:
	First use the graphics palette to add a text box at the bottom of the anchored frame. This is for your figure caption. Type the text of the caption, then apply the FigTitle tag.
	Now click on the border of the anchored frame to highlight it. Then go to File --> Import --> File, then use the browser to find the figure you want to import. Always, always import graphics by reference. Also, import at 500 dpi (our default).
	To size the figure, or rotate it, click on the figure itself, then use the tools under the Graphics menu.
Optimal file formats when working with Frame include TIF, EPS, GIF, JPEG. If possible, please avoid WMF format, which does not convert well to online format.
Next well try drawing our graphic using FrameMakers graphics tools. The figure that well draw, Figure 2, will rely on the following tools:
	Grouping and ungrouping graphic elements
	Aligning and distributing graphic elements
	Using various line types and sizes (including arrows)
	Using shading
	Adding text
We will now create Figure 2. Please refer to your handout for what well be attempting to draw.
4.4 Tables
In this subclause we will cover tables. The first table we will perform the following tasks:
a)	Convert a table from pre-existing text
a)	Create a table from scratch
Now we start with Table 1. Well use FrameMakers Covert to Table option to create a table from pre-existing text (such as tab-delimited ASCII). Using the text in the ASCII file on the disk, lets create our first table (Table 1):
Table 1Sample test score
Mike	Bob	Jim
90%	85%	87%
76%	89%	23%

That was easy enough. The key is always remember to use IEEE format for the tables.
Now well move on to Table 2, which well create from scratch. FrameMaker makes this exercise very simple, and everything you need is in the Table menu.
Table 2Sample test score analysis

The Table Designer option lets you specify how your table will look before you make it. Table straddling is very handy as well.
Annex A
(informative) 
Bibliography
[B1] The IEEE Standards Dictionary of Electrical and Electronics Terms, Sixth Edition.
[B2] Websters New Collegiate Dictionary.
Annex B
(informative) 
Other features and tools
B.1 Cross referencing
One key feature of FrameMaker and the document development process is cross referencing. We commonly cross reference the following items in text:
	References to clause and subclause numbers (including annexes)
	Table, figure, and equation numbers
	Bibliography items
If we did not cross reference these elements--and material was added or deleted--it would likely spell distaster. For instance, lets cross reference to 4.3. That being done, now lets go back to to Clause 2 and cross reference the bibliography items there. Be sure to use the Edit --> Update References feature.
B.2 TOCs, LOFs, LOTs
FrameMaker easily and accurately generates the following:
	Table of contents
	List of figures
	List of tables
To access these features, goto File --> Generate Book. Choose the list option, then go from there. Lets try doing each.
B.3 Master pages
If youll notice, the example draft that were working off has set running headers and footers. These can be adjusted via the View --> Master Pages option. Before we finish, lets go in and change our master pages.