SJI6510_Authoring _With_Structured_FrameMaker

Authoring with Structured FrameMaker SJI6510
Objective of Doc: How to create CMMs using Structured FrameMaker SGML and ATA2200
Dept Name: Product Support Rev. Current as
of:
Created by: Ben Rhodes A 08-15-08
Change Comment Original release
1
1.0 AUTHORING WITH STRUCTURED FRAMEMAKER
1.1. Creating a Book
In this section, you will learn how to create a new book using the Structured
FrameMaker SGML in conjunction with the ATA Spec. 2200 Template. Books
are crucial to working in structured FrameMaker. Books provide a place for
storing and organizing all of the various files and folders you will need to create a
manual. Books also allow you to print your manual either to paper or to PDF with
a single click.
To create a book:
1.1.1. Navigate to L:TECH_PUBSFRAMEMAKER_TEMPLATES and select the
FrameTemplateStruct_05-07 folder within the directory.
NOTE: Do not copy, cut, move, delete or open the MASTER TEMPLATE
folder! This folder contains critical FrameMaker application files that
may only be accessed by authorized personnel.
1.1.2. Copy the FrameTemplateStruct_05-07 folder to the folder on the L: drive that
corresponds to the aircraft and/or project you will be working on.
1.1.3. Rename the copied folder with the 6-digit CMM number followed by the
revision number (e.g. in the title 50-50-50R0, 50-50-50 is the CMM number and
R0 indicates that this is the original version).
1.1.4. Open your new folder. You should see two folders and 20 files. There should
be two types of files: 19 .FM files, which are orange; and one .BOOK file, which
is white and gray (Figure 1). If there are any files named backup.fm, delete
these files.

of:
2
Figure 1. Windows Book Directory
1.1.5. Left-click 00-00-00R0.BOOK to highlight it, and change the name to match the
folder (e.g. 50-50-50R0.BOOK). This is your “.BOOK” file. When working in
Structured FrameMaker, you will always work within the .BOOK file.
1.1.6. Next, change the names of all 19 document files to match the book file (e.g.
change 00-00-00R0DESCRIP.FM to 50-50-50R0DESCRIP.FM and so on).
1.1.7. Finally, open the ILLUSTRATIONS file and delete any illustrations you find
there.
1.1.8. Close the directory and start FrameMaker.
1.1.9. Once FrameMaker starts, click File>Preferences>General. The Preferences
dialog box will appear (Figure 2).

of:
3
Figure 2. Preferences Dialog Box
1.1.10. Make sure that the Product Interface option at the bottom of the dialog box is
set to Structured FrameMaker.
1.1.10.1. If it is, click Cancel.
1.1.10.2. If it’s not, click the down arrow to open the pulldown menu and click
Structured FrameMaker. Click Set to save your changes and close
the dialog box, then restart FrameMaker.
1.1.11. When FrameMaker restarts, click File>Open, then double-click the *.BOOK
file in the Open dialog box to open your book. The >BOOK Directory appears
(Figure 3).
NOTE: An asterisk ( * ) before any group of letters or numbers is
computer-geek lingo for “whatever.” It basically means that whatever the
asterisk replaces is unimportant. I use it here because the part number
preceding the .BOOK suffix is not important.
NOTE: You will notice that the Automatic Save check box is not checked.
This is not an oversight. Frequently, when working in FrameMaker, you

of:
4
will be copying and pasting text and structure from other books. While
you are doing this, you do not want FrameMaker automatically saving
changes you might inadvertently be making to the completed books.
Therefore, this box should never be checked. LEARN TO SAVE
MANUALLY AND SAVE OFTEN.
Figure 3. .BOOK Directory
When the .BOOK directory opens, you will notice that your various book
chapters (the .FM files) are still not properly numbered. Notice too that your
chapter file icons all have big question marks inside of them. This is because
you renamed the chapter files in the Windows directory and FrameMaker can
no longer find them.
NOTE: Renaming the .FM files in a Windows directory does NOT rename
the .FM files within your book. You must now manually rename all of the

of:
5
files again within the book. This is a quirk of FrameMaker and an
important point to remember – you cannot shortcut this process or you
will find your self unable to open any of your book’s chapters.
1.1.12. To rename the book’s chapters:
1.1.12.1. Left-click the first .FM file (usually 00-00-00R0TITLE.FM) to highlight it.
1.1.12.2. On your keyboard, type Alt, E, R.
1.1.12.3. Change the CMM number portion only of the chapter’s title.
1.1.12.4. Press Enter.
1.1.12.5. A FrameMaker dialog box appears telling you about all sorts of things
that are about to happen. Ignore it and press Enter.
1.1.12.6. A second dialog box appears telling you of more actions to be taken
and their dire consequences. Ignore this one too, and press Enter.
1.1.12.7. Yet a third dialog box appears telling of still more dire consequences to
your careless actions. You should also ignore this one and press
Enter.
1.1.12.8. A final dialog box appears stating that FrameMaker did not successfully
apply the command across all selected files in the book. This, too, is
meaningless and can be ignored. You may also ignore the error
message that appears. Press Enter to close the dialog box and ignore
the error messages.
1.1.12.9. Notice that the chapter file’s icon has changed from a question mark to
a document (see Figure 4). Now that you’ve renamed the chapter file,
FrameMaker once more knows where to look for it.

of:
6
Icon for
Renamed File
Changes
Figure 4. Renamed .FM File
1.1.12.10. Repeat this procedure until you have renamed all of the chapter files.
1.1.13. When you have finished renaming all of the chapter files, close any remaining
error messages.
1.1.14. Update the book by clicking the Update and Generate icon at the bottom
of the book directory window. The Update dialog box appears (Figure 5).

of:
7
Figure 5. Update Book Dialog Box
1.1.15. Make sure that all of the check boxes are selected EXCEPT Apply Master
Pages (you REALLY don’t want to go there), then click Update.
1.1.16. You will get error messages; that’s normal at this stage. Simply close them.
1.1.17. After you have updated the book, save it by clicking File>Save Book.
1.2. Working in the Structured FrameMaker Environment
1.2.1. Double-click the Title chapter icon to open the Title page block. The Title page
block appears in the document window (see Figure 6).

of:
8
Title Bar
Catalog
Icons
Info Bar Zoom Controls
Element
Boundary
Symbols
Figure 6. Document Window

of:
9
1.2.2. You will notice right away that the Document Window in Structured Frame
looks exactly like the Document Window in regular Frame. Working in
Structured FrameMaker, however, is a lot different than working in regular
Frame. The major difference between the two is the use of the Structured
View Window and the Element Catalog. The Structure View Window displays
the “structure” of the document on a hierarchical tree. The Element Catalog
replaces the Paragraph Catalog used in regular Frame. All three windows
must be open simultaneously when you are authoring in Structured
FrameMaker.
1.2.3. Click View>Element Boundaries. The Element Boundaries appear in the
Document Window as brackets surrounding the text (Figure 6). Element
Boundaries indicate the presence and hierarchy of elements in the Document
Window. These boundaries will allow you to use the arrow keys to navigate
through a structured document. Whenever you open a document, the first
thing you should always do is turn on the Element Boundaries.
1.2.4. To open the Structure View Window, click the Structured View icon . The
Structure View Window appears (Figure 7).
1.2.4.1. Figure 7 is the Structure View of the Title page shown in Figure 6. The
Structure View consists of elements arranged on a hierarchical tree.
The elements contain attributes and text snippets. The attributes tell
FrameMaker how to display the elements and do not usually appear in
the document window (the one exception to this rule being the headers
and footers); text snippets display the first few words of the text that
actually appears in the document window (notice that the text snippet
following the first Title element corresponds to the title of the document
in the previous example).
1.2.4.2. In the example in Figure 7, the Title page block consists of an element
called Ttlpage, which has a number of attributes assigned to it. The
line descending from the Ttlpage element indicates that everything to
follow is contained within the Ttlpage element. The Ttlpage element
contains a “container” called Title, which itself contains the actual text
of the title. Title is followed by another element called Partinfo, which
has an attribute called Model and which contains elements called Title
and Mfrpnr. Title contains the text for the part name; Mfrpnr contains
several elements called Pnr, each of which may contain the text of the
part numbers.
NOTE: Elements have attributes and contain other elements and
containers. Containers do not have attributes and do not contain
other elements or containers; they contain text. You cannot enter
text in an element, only in a container. You can tell an element
from a container, because elements have plus and/or minus signs
on either side of them.

of:
10
1.2.4.3. Notice the small minus symbols (–) on either side of the elements. The
– indicates that the descendants and/or attributes are displayed.
Conversely, a + on either side of an element indicates that the
element’s descendants and/or attributes are not displayed. Clicking the
– on the right-hand side of an element hides the element’s attributes
and turns the – into a +. Clicking the – on the left-hand side of an
element hides the element’s descendants and turns the – into a +.
Clicking a + displays the element’s descendants and/or attributes.
Closing up the attributes and descendants of those elements you are
not currently working in will greatly simplify the Structure View and
make it easier to navigate through the document.

of:
11
Elements
Attributes
Text
Snippets
Figure 7. Structure View Window

of:
12
1.2.4.4. As you move about in the Structure View, the cursor changes
depending on where it is located:
indicates that the cursor is at the beginning of a text string
indicates that the cursor is at the end of a text string (see Figure 7)
indicates that the cursor is in the middle of a text string
indicates that the cursor is at a point on the structure tree where an
element can be inserted (see Figure 8)
An Element Can Be Inserted at This Point
Figure 8. Element Insertion Point
1.2.4.5. The Structure View shows the relationship of the various elements to
each other. Elements that contain other elements are called parents or
ancestors. Elements that are contained within other elements are
called children or descendants. Elements that are on the same level
are called siblings. So, in the previous example, the Pnr elements are
siblings to each other and descendants of Mfrpnr; Mfrpnr is the
ancestor of the Pnr elements, but it is also the sibling of the Title
element and the descendant of the Prtinfo element.
1.2.4.6. In the Structure View, elements can be added, deleted, cut, copied,
pasted, or moved from one position to another simply by highlighting
the element and performing the desired function. You can select a
single element (Figure 9) or you can select an element and all of its
descendants simply by clicking on the parent element Figure 10).

of:
13
Figure 9. Selecting a Single Element
Figure 10. Selecting an Element and Its Descendants
1.2.4.7. If you insert, paste or move an element to a place in the structure
where it cannot go, Frame indicates the error. If an element is in the
wrong place, the structure tree changes to a red, dotted line below the
illegal element (see Figure 11). Also, if you remove a required element,
or forget to insert a required element, a red box will appear on the
structure tree.

of:
14
A red, dotted line on the
structure tree indicates
that an element is in the
wrong place.
A red square indicates that
a required element is missing.
Figure 11. Elements Inserted In the Wrong Place
1.2.5. Next, open the Element Catalog by clicking the Element Catalog icon .
The Element Catalog appears.

of:
15
Figure 12. Element Catalog
1.2.5.1. The element catalog lists those elements that are available for use at
any given time. Unlike paragraphs in regular Frame, elements can only
be placed in a specific order, and only where they are allowed.
Elements that are allowed appear in the Element Catalog with a dark
check mark next to them. If an element is not allowed, it doesn’t
appear at all, or it appears with a light check mark next to it, depending
on how the Options are set. Elements appearing with a check and a
plus sign next to them are called inclusions. Inclusions are elements
than can be placed just about anywhere within the structure. As you
move the cursor around in the element catalog, you will notice that
different elements become available depending on where the cursor is.
The rules for where an element is or is not allowed have been preset by
ATA and written into the template you are now using.
1.2.5.2. The appearance of <TEXT> in the element catalog indicates that –
obviously – text can be entered. If <TEXT> does not appear in the
element catalog, you cannot type a text string in the document. This
may sound absurdly obvious, but trying to enter text strings when the
<TEXT> element is absent is a common mistake.

of:
16
1.2.5.3. The element catalog also contains four buttons near the bottom. These
are used to insert, wrap (more on this later) and change elements, as
well as set the element catalog display options.
1.2.6. Once you have all three windows open, you will need to organize them so that
you can see all three at the same time. The two standard methods are side-
by-side and over-and-under. It is, however, completely up to you how you
arrange your desktop. Figure 13 for an example of an Over-and-Under setup.

of:
17
Document Window Book Directory
Structured View Window Element Catalog
Figure 13. Arranging Structured Frame Windows

of:
18
1.3. Setting Book Attributes
1.3.1. In the Book Directory, left click the top-level icon to highlight it (the top-level
icon is the BOOK itself).
1.3.2. Notice that the Structure View window has changed. Now the top-level
element is called CMM. What you are looking at is the structure for the entire
book. Notice also that the CMM element has a number of attributes associated
with it. Since the majority of the CMMs and ACMMs consist of boiler plate
material (i.e. material that has been pre-structured and, in some cases, pre-
written for you), the majority of your work as a writer will consist of setting the
values on these attributes (and many others throughout the book). Once the
attribute values are correctly set, things like page block numbers, book
numbers and internal reference links will be set automatically. What is left after
that is merely “plugging in” data. We will now begin to set the attribute values,
beginning here with the book itself.
1.3.3. Double click on any of the attribute names associated with CMM. The Attribute
Editor dialog box appears; the name of the element appears just below the
editor’s title bar (see Figure 14).
Figure 14. Attribute Editor Dialog Box
1.3.4. Highlight Chapnbr in the Attribute Name window. In the Attribute Value
window, change 00 to the first two digits of your CMM number, and click Set
Value.
1.3.5. Highlight Oidate, change 20050000 to the issue date of your manual (i.e.
March 15th
, 2006, would be 20060315), then click Set Value.
1.3.6. Highlight Revdate, change 20050000 to the issue date of your manual, then
click Set Value.
1.3.7. Highlight Sectnbr, change 00 to the second two digits of your CMM number,

of:
19
then click Set Value.
1.3.8. Highlight Subjnbr, change 00 to the last two digits of your CMM number, then
click Set Value.
1.3.9. Click Done to save your changes and close the dialog box (none of the other
values need to be set).
1.3.10. Update and save your book.

of:
20
1.4. Completing the Title Page
1.4.1. In the Document Window, place your cursor somewhere in the Component
Title line. The Structure View changes once again; now the top-level element
is Ttlpage.
1.4.2. Double-click on the Chapnbr attribute to open the Attribute Editor dialog box
(see Figure 15).
Figure 15. Attribute Editor for the Ttlpage Element
1.4.3. Set the attribute values the same way you did for the BOOK. Chapref,
Pgblknbr, Confnbr and Key have no values at this level and should be left as
they are. When you are finished, the attributes for the Ttlpage element should
look something like those in Figure 16.

of:
21
Figure 16. Sample Ttlpage Attributes
1.4.4. In the Structured View, scroll down to the second Title element and double-
click the text snippet COMPONENT TITLE. Notice that the text is highlighted
in both the Structure View and the Document Window.
1.4.5. In the Document Window, place your cursor anywhere in the COMPONENT
TITLE line.
1.4.6. Delete the text string COMPONENT TITLE and type in the title of the CMM you
are working on.
1.4.7. Position the cursor anywhere in the PN: line.
1.4.8. Delete XXXXXXX-X and type in the part number(s) for the LRU in the CMM.
1.4.9. Make sure the year in the copyright paragraph is correct. If it isn’t, delete the
year and type in the correct one.
1.4.10. Save the Title Page. Page numbers, CMM numbers, and issue and revision
dates should all update when you save.
1.5. Completing the Front Matter
1.5.1. After the Title Page, there are several more pages of “front matter” that must
be completed. These include:
1.5.1.1. Letter of Transmittal
• Open *TRANSLTR (NEW RELEASE).FM.
• Set the attribute values for the Transltr element.
• Edit the date in the text string of the first Para element.
• Save and close *TRANSLTR (NEW RELEASE).FM.
1.5.1.2. Record of Revisions
• Open *RR.FM.

of:
22
• Set the attribute values for the Rrlist element.
• In the first cell under ISSUE DATE, change Month 01/05 to the
correct date.
• Save and close *RR.FM.
1.5.1.3. Record of Temporary Revisions
• Open *RTR.FM.
• Set the attribute values for the Trlist element.
• Save and close *RTR.FM.
1.5.1.4. Service Bulletin List
• Open *SBL.FM.
• Set the attribute values for Sblist.
• Save and close *SBL.FM.
1.5.1.5. List of Effective Pages
• Open *LEP.FM.
• Set the attribute values for Leplist. The rest of the LEP will not be
filled in until the entire document has been completed.
• Save and close *LEP.FM.
1.5.1.6. Table of Contents
• Open *TOC.FM. Notice that there is no Structure View for the
TOC. The TOC is an unstructured document that we fill in
manually. All you have to do now is set the headers and footers.
• Press ALT+V+M on the keyboard. The Document changes to
show the Master Pages.

of:
23
Figure 17. Master Pages

of:
24
• Double-click the XXXXXXX-X at the top of the page. The Variable
dialog box appears.
Figure 18. Variable Dialog Box
• Highlight Part Number and click Edit Definition. The Edit User
Variable dialog box appears.
Figure 19. Edit User Variable Dialog Box
• Change the XXXXXXX-X variable in the Definition: window to the
correct part number, then click Change.

of:
25
• Click Done to close the Edit User Variable dialog box.
• On the Variable dialog box, click Replace to set the variables and
close the dialog box. All of the variables should have updated to their
correct attributes.
• Repeat this process for the CMM Number and Initial Date.
• Press Alt+V+D on the keyboard to return to the Document View.
1.5.1.7. You are done with the TOC for now. Save and close the TOC.

of:
26
1.6. Authoring Body Chapters
1.6.1. Body chapters include all of the *.FM files between the TOC and the IPL.
Some of these, like *INTRO.FM, *3001.FM (Cleaning) and *15001.FM
(Storage), are boiler plate sections. They only need to have their element
attributes set throughout and their cross references established. Other
sections, like *1001.FM (Testing and Fault Isolation) or *6001.FM (Repair),
may require an extensive amount of text and data input on your part.
Individual treatment of each section is beyond the scope of this manual;
instead, the following procedures will cover general information that applies
across all of the body chapters. For more detailed information, consult either
Adobe FrameMaker Help or the Authoring Structured Documents Workbook.
1.6.2. Open *DESCRIP.FM and turn on the element boundaries.
NOTE: Many of the chapters contain cross references to other chapters
within the book. As you open these chapters, a dialog box will appear
telling you that unresolved cross references exist in the document. This
is normal and will be discussed in Section 5.8. For now, click OK to close
the dialog box.
1.6.3. Set the attribute values for the Pgblk element.
Figure 20. Pgblk Attributes
1.6.3.1. Pgblknbr, Chg, EDDVersion and Pgblkname have already been
preset.
1.6.3.2. Chappref and Confnbr receive no assigned values.
1.6.3.3. Chapnbr, Sectnbr, Subjnbr, CMMRevDate, Revdate and
PartNumber receive the same values as before.

of:
27
1.6.3.4. Key is a unique identifier that FrameMaker uses to establish internal
references. It consists of:
o An alpha code
• the 2-digit Chapnbr
• the 2-digit Sectnbr
• the 2-digit Subjnbr
• the 3-digit Func code
• the 3-digit Seq code
Fill in only the 6-digit CMM number; the rest is preset.
1.6.3.5. Author is you, the writer, even if you’re simply retyping the book.
1.6.4. Next, set the values for the Chapnbr, Sectnbr, Subjnbr, Revdate and Key
attributes for the first Task element.
Figure 21. Task Attributes
NOTE: For an explanation of MTOS task numbers, refer to the
*INTRO.FM section of the manual you are currently working on.
1.6.5. In the Structure View, scroll down to the text snippet (1) (Write out a physical
descriptio and highlight it by double-clicking it.

of:
28
Figure 22. Physical Description Text Snippet
1.6.5.1. Press Delete, then type in the physical description of the LRU. The
physical description should be detailed enough to allow a qualified
mechanic to identify the part without referring to the illustration. Notice
that as you type, the text appears in the Document Window, even
though the Structure View is the active window.
1.6.6. Use the down arrow key to move down to the text snippet (1) (Write out usage
and operation o and highlight it by double-clicking it.
Figure 23. Usage & Operation Text Snippet
1.6.6.1. Press Delete, then type in a brief explanation of what the LRU is used
for and how it operates (if it does).
1.6.7. Tables
1.6.7.1. Tables are handled differently in Structured FrameMaker than they are
in regular Frame. In regular Frame, tables are created using the Table
Designer dialog box; in Structured Frame, tables are created in the
Structure View using table elements. Figure 21 shows the Technical
Properties table used in the *DESCRIP.FM section. Although this is a
very simple table, it is created using the same elements as all of the

of:
29
other tables in the body chapters.
Figure 24. Simple Table
Figure 25 shows the Structure View of the Table shown in Figure 24.
Notice that the Table element is the descendant of the Prcitem element,
which is in turn the descendant of Prcitem1. Tables can only be placed
in certain locations on the structure tree. To find out where a table can be
positioned, move the cursor around in the Structure View and notice
when the Table element appears in the Element catalog.
Tables also contain elements. In Figure 25, you can see that Table
contains an element called Title and an element called Tgroup. Title
contains <TEXT>; Tgroup contains Thead and Tbody. Thead contains
the header row for the table; Tbody contains all of the body rows for the
table. Thead and Tbody are essentially the same; however, since the
text in the Thead is preset, we will focus on the Tbody.

of:
30
Figure 25. Simple Table Structure

of:
31
Figure 26 shows the Structure View of a simple Tbody. A Tbody must
contain at least one Row, which in turn must contain at least one Entry.
An Entry contains at least one (but sometimes more) Para. Para is the
only element in the Tbody that can contain <TEXT>. This particular
Tbody contains ten Row elements with two Entry elements each.
Figure 26. Simple Table Body Structure
1.6.7.2. To fill in the table, begin by setting the attribute values in the Table
element.
• As usual, Chappref, Confltr and Confnbr have no values.
• Pgblknbr receives no value because *INTRO.FM has no numeric
value to input. All of the subsequent page blocks are numbered
(1001, 5001, 15001, etc), and this attribute receives that number.
• Tblno is 1. If you need additional tables, they are number 2, 3, 4,
and so on. In a numbered page block, like 3001, the Tblno of the
first table is 3001, and additional tables are numbered 3002, 3003,
etc.

of:
32
1.6.7.3. Next, expand the Tbody (if it’s not already) and enter the LRU data in
the appropriate Para elements.
NOTE: It is not necessary to insert values for the Entry elements’
attributes.
Figure 27. Copying Tables
1.6.7.4. If you need additional tables, in the Structure View:
• collapse the Table element
• click on the Prcitem1 element to highlight it (Figure 27, top)
• copy the entire Prcitem1 element (press Ctrl+C)
• place the cursor on the structure tree below the first Prcitem1
(Figure 27, bottom)
• paste the table you just copied onto the structure tree (press
Ctrl+V)
• expand the new table and edit the attributes and data
1.6.8. Graphics
1.6.8.1. In regular FrameMaker, graphics are inserted simply by inserting an

of:
33
anchored frame, then importing or pasting the graphic into the frame.
In Structured FrameMaker, you must once again insert and define
elements within the Structure View.
In Structured Frame, a graphic consists of an element called Graphic,
which contains another element called Frameset. Frameset contains
two elements: Frame and Sheet. Sheet contains an element called
Title, which contains the <TEXT> element for Title.
When inserting a graphic, the element attributes in the Structure View
should resemble Figure 28. Once the attributes for the elements are
set, you can import the actual graphic file.

of:
34
Figure 28. Graphics Structure
1.6.8.2. There are two ways to place a graphic into a book: 1) copy the graphic

of:
35
and paste it into the frame; and 2) import the graphic by reference. The
first is the easiest and most effective method; therefore, the latter is –
naturally – the preferred method. In order to import graphics, they must
be saved into a separate Illustrations folder in the BOOK file. Graphics
are then “imported by reference” into the Frame element from the
Illustrations folder.
• In the Document Window, select the graphic frame by right-clicking
on it.
• With the frame selected, click File>Import>File. The Import dialog
box appears (see Figure 29).
Figure 29. Import Dialog Box
• Navigate to the Illustrations folder in your .BOOK file, then right-
click the file you want to import.
• Make sure that the Import By Reference radio button is selected.
• Click Import to close the dialog box and import the graphic. The
selected graphic appears in the frame.
• Size the graphic to fit the frame, if necessary.
NOTE: When graphics are imported by reference, the image on the
computer screen looks terrible. This is due to the fact that what

of:
36
you are seeing is merely a “place holder” for the image – which
still resides in the Illustrations folder – and not the actual image
itself. Supposedly, the image will look fine once the book is
completed and printed; however, this is often not the case. The
only way to ensure “clean” looking graphics is to paste them
directly into the frame. (But you didn’t read that here.)

of:
37
1.6.8.3. There are two ways to add additional graphics to a document: adding
extra Frameset elements or adding extra Graphic elements. When
extra Frameset elements are added, the figure number remains the
same and sheet numbers are added (i.e. Figure 5001 Sheet 1 of 2,
Figure 5001 Sheet 2 of 2). When additional Graphic elements are
added, the figure numbers change (i.e. Figure 5001, Figure 5002). The
first method is used when the graphics are closely related to one
another, such as a detail of a larger assembly. The second method is
used when the graphics are not closely related to each other.
1.6.8.4. To add additional Frameset elements, copy the existing Frameset
along with all of its contents and paste the copy directly beneath the
first Frameset (see Figure 30).

of:
38
Figure 30. Adding Additional Frameset Elements
In the Sheet element, change the attributes as follows:
• change the Gnbr attribute to read XXXXXXFIG1(SHEET2OF2)R0
(with Xs being the CMM number)
• change the Sheetnbr attribute to read 2
• change the Key attribute to read shXX-XX-XX-99B-002 (with Xs
being the CMM number)
• In the Document Window, delete the graphic from the frame and
import a new graphic from the Illustrations folder

of:
39
1.6.8.5. To add additional Graphic elements, copy the existing Prcitem1
element that contains the Graphic element and paste the copied
elements directly beneath the existing Prcitem1 element (see Figure
31).
Figure 31. Adding Additional Graphic Elements
Change all of the attribute values to reflect that this is a new graphic,
then import your graphic by reference.

of:
40
1.7. Completing the IPL
1.7.1. The first five pages of the IPL are simply boiler plate. They require no data to
be input. Simply set all of the attribute values.
1.7.2. The IPL Figure is done the same as all of other graphics; only the title is
different. The first Figure has been put into the template; follow the previous
instructions to insert additional figures.

of:
41
Figure 32. IPL Structure
1.7.3. The Detailed Parts List is a specialized table. As you can see from Figure 32,

of:
42
it is constructed differently than other tables in the book. Instead of Row
elements, the IPL uses Itemdata elements, which contain attributes that must
be set. Where regular tables use generic Entry and Para elements for the
cells, the IPL uses elements that are specific for each cell. Therefore, the first
cell – the item number – consists of an element called FigItemCell, which
contains a FigItem element, which itself contains both a Fig and an Item
element. Notice, however that the actual item number does not exist as a text
string anywhere within the FigItemCell element; instead, the item number
exists within the Itemdata parent element as an attribute value called Itemnbr.
1.7.4. The attributes for the Itemdata element are:
• Itemnbr lets you set the item number
• Attach indicates whether or not a part has attaching parts. A “0” indicates
that there are none; a “1” indicates that there are attaching parts.
• Illusind indicates whether or not a part is illustrated in the IPL Figure. A
“1” indicates that the part is illustrated; a “0” indicates that the part is not
illustrated.
• Indent sets the indenture in the Nomenclature column (for information on
the indenture, refer to the Explanation of Detail Parts List Entries on page
10002 of the CMM).
• Delitem indicates whether or not a part has been deleted (ATA does not
allow for parts to be removed from CMMs; instead, they are listed as
deleted parts).
1.7.5. Fill out the Detailed Parts List with the appropriate data.
1.7.6. When you are finished, save and close the IPL, then generate and save the
book.

of:
43
1.8. Setting Internal Cross Reference Links
1.8.1. Structured FrameMaker allows you to insert links that become active in Frame,
in PDF documents, and in web applications.
1.8.2. Open all of the chapters in your .BOOK Directory that contain cross
references – these include everything from *DESCRIP.FM to *10001.FM
inclusive. As you open the chapters, you will get a dialog box (you’ve actually
been getting it all along) telling you that you have unresolved cross references
(see Figure 33).
Figure 33. Cross Reference Dialog Box
1.8.3. Click OK to close the dialog boxes and open the documents.
1.8.4. Go to *DESCRIP.FM (pressing Ctrl+Tab toggles through the chapters).
1.8.5. Locate the first cross reference and right click to highlight it (see Figure 34).
Figure 34. Cross Reference in Document Window
1.8.6. Now look down in the Structure View and notice what the cross reference is a
container called Grphcref containing a text string and attributes (see Figure
35).

of:
44
Figure 35. Cross Reference in Structure View
1.8.7. Go back to the Document Window and double click on the cross reference.
The Cross Reference dialog box appears (see Figure 36).
NOTE: Cross reference attributes are the ONLY attributes whose values
are set from the Document Window. All other attribute values are set by
double-clicking on the attributes in the Structure View.
Figure 36. Cross Reference Editor Dialog Box
1.8.8. Use the Cross Reference editor dialog box to set cross references in your
document.
• Source: lets you select the target document for the cross reference. It
includes:
o Document: available documents appear in a pull-down menu
(documents must be open to be available)
o Element Tag: all element tags appear in a scrolling menu. Selecting an
element tag helps narrow the possible elements available.
o Elements (in Document Order): all available elements (i.e. elements of
a certain type within a certain document) appear in this window. You
must select one of the choices in this window to set the cross reference.
• Reference: lets you set up the cross reference. It includes:

of:
45
o Element Tag: available reference tags appear in a pull-down menu.
This is the name of the actual element container (see Figure 35).
o Format: available formats appear in a pull-down menu. This is the text
that appears in the document (see Figure 34).
• Click Replace to set the cross reference and close the dialog box.
NOTE: This is example shows the editor for replacing an existing cross
reference. If you are inserting a new cross reference, the editor looks
exactly the same except that the Replace button is an Insert button.
1.8.9. When you have finished setting all of the cross references in all of the
chapters, save and close all of the chapters.
1.8.10. Update your .BOOK and save it.
NOTE: You may get error messages at this point telling you that there are
still unresolved cross references. If this occurs, fix the problem before
continuing.

of:
46
1.9. TOC and LEP Completion
1.9.1. Once the chapters are complete, it’s time to go back and finish the Table of
Contents and the List of Effective Pages.
1.9.2. Click *TOC.FM to open the Table of Contents. Carefully go through the TOC
and make sure that all of the chapter and section heads, table captions, figure
captions and page numbers correspond to the finished chapters. Make any
necessary changes. When you are sure that the TOC is correct, save and
close the TOC.
1.9.3. Click *LEP.FM to open the List of Effective Pages. Again, carefully check the
List of Effective Pages against the actual book. Make sure that every single
page in the book is represented in the List of Effective Pages. If a page
contains even one word of text, include it in the LEP along with the issue date.
If a page contains the text “This Page Intentionally Left Blank,” include the
page number in the LEP along with the word BLANK (see Figure 37). When
you are sure that the LEP is correct, save and close the LEP.

of:
47
Figure 37. List of Effective Pages

of:
48
1.10. Finishing Up
1.10.1. With the .BOOK directory still open, navigate back to the Structured Frame
Template file on the P: drive and open the .BOOK directory in the Template
file.
1.10.2. Click File>Import> Element Definitions…. The Import Element Definitions
dialog box appears.
Figure 38. Import Element Definitions Dialog Box
1.10.3. Select 00-00-00r0.BOOK from the Import from Document pull-down menu.
1.10.4. Leave Format Rule Overrides blank.
1.10.5. Click Import.
1.10.6. Save the book.
1.10.7. Next click File>Save Book As…. The Save Book dialog box appears.
1.10.8. Leave the Save in field the same, change the file extension in the File name
field to .pdf, and change Save as type to PDF.
1.10.9. Click Save. The PDF Setup dialog box appears.

of:
49
Figure 39. PDF Setup Dialog Box
1.10.10. Leave all of the settings as they are and click Set.
1.10.11. The book is saved as a PDF.

of:
50
2.0 ELEMENT ATTRIBUTE VALUES
CMM
Attribute Name Definition Example
Spl Supplier Code (Goodrich Cargo
Systems)
31645
Oidate Original Issue Date 20050301
Tsn Transmission Date 20050301
Docnbr Document Number 50-20-02R0
Lang Language (EN=English) EN
Chapnbr ATA Chapter Number 50
Sectnbr ATA Section Number 20
Subjnbr ATA Subject Number 01
Type Manual Type Cmm
Prelim Preliminary Status 0
Chg Change Status
N=New
D=Deleted
R=Revised
U=Unchanged
N
Revdate Revision Date 20050301
Pgblk
Pgblknbr ATA Page Block Number 1001
Chg Change Status
N=New
D=Deleted
R=Revised
U=Unchanged
N
Key Unique number used to specifically
identify this page block; defined as
cmmch-se-su-func-seq
Cmm50-20-02-300-801
CMMRevDate CMM Revision Date at lower right of Mar 01/05

of:
51
page
Author Author of the CMM, presented as Last
Name, First Name
Doe, Jane
EDDVersion Element Document Definition Version 7.0
Pgblkname Page Block Name, entered with the
desired capitalization for cross-
references
Repair
PartNumber LRU Part Number A800160-1
Task
Func ATA MTOSS function code. 950
Seq Sequence Number 801, 802, 803, etc.
Confltr Configuration Letter A
Varnbr Variant Number 1
Confnmbr Configuration Number 01
Chg Change Status
N=New
D=Deleted
R=Revised
U=Unchanged
N
identify this page block; defined as tkch-
se-su-func-seq
tk50-20-02-940-803
Subtask
Func ATA MTOSS function code. 700

of:
52
Chg Change Status
N=New
D=Deleted
R=Revised
U=Unchanged
N
identify this page block; defined as skch-
se-su-func-seq
sk50-20-02-700-001
Figure
Func ATA MTOSS function code for graphics 99B
Chg Change Status
N=New
D=Deleted
R=Revised
U=Unchanged
N
identify this page block; defined as fgch-
se-su-func-seq
fg50-20-02-99B-001
Graphic

of:
53
Func ATA MTOSS function code for graphics 99B
Chg Change Status
N=New
D=Deleted
R=Revised
U=Unchanged
N
identify this page block; defined as grch-
se-su-func-seq
gr50-20-02-99B-001
Frame
Figno Figure Number 1
Xrefid Cross Reference Identification Automatically entered by the
system (i.e. CEBDFEEE)
FrameType Frame Type Imported Graphic
Sheet
Gnbr Graphic Number 502002IPL1(SHEET1OF2)R
0
Sheetnbr Sheet Number (sheet 1 of 2) 1
Chg Change Status
N=New
D=Deleted
R=Revised
U=Unchanged
N
Key Unique number used to specifically sh50-20-02-99B-001

of:
54
identify this page block; defined as shch-
se-su-func-seq
Grphref
Refid Reference Identification Automatically entered by the
system (i.e. sh50-20-02-
99B-001)
Sheetnbr Sheet Number (sheet 1 of 2) 1
Refint
Reftype Reference Type, (i.e. Table, Task,
Pgblk)
Table
Refid Reference Identification Automatically entered by the
system (i.e. CEBGCBBF)
Table
Func ATA MTOSS function code for Tables 99A
ID Identification Number Automatically entered by the
system (i.e. BEGHJCAC)
Prtlist
Chg Change Status
N=New
D=Deleted
R=Revised
U=Unchanged
N
identify this page block; defined as tch-
t50-20-02-99B-001

of:
55
se-su-func-seq

SJI6510_Authoring _With_Structured_FrameMaker

More Related Content

What's hot (20)

Similar to SJI6510_Authoring _With_Structured_FrameMaker (6)

SJI6510_Authoring _With_Structured_FrameMaker