This is a dummy paragraph.

This is a dummy paragraph.

There are three tags for bulleted lists: Bullet, BulletInd and BulletInd4.

This is the Bullet tag:

BulletInd appears here within a numbered list.

BulletInd4 is used here within a hanging list.

Use a square bulleted list for for substeps within a numbered list.

Use a dashed list for lists that fall within a bulleted list.

For each required level of indentation, there are two variations of the List tag: ListX and ListX1st. Use the ListX1st variation for the first item in the list, and the ListX variation for subsequent items. In all, there are six ordered list tags: List, List1st, ListInd, ListInd.1st, ListInd4, and ListInd4.1st.

This is an example of the List tags.

This is an example of the ListInd tags

This example uses the ListInd4 paragraph tags:

There are two hanging list tags: HangingList and HangingListInd. If the options or commands you wish to document are longer than the space provided, use a tab and then a forced return (<tab><r-alt><enter>) to begin a new line, rather than customize the paragraph tag.

Here is a sample hanging list:

Here is another sample hanging list. This one uses HangingListInd and a forced return after the tab for each item because at least one of the items is too long.

Tabular lists are multi-column tables that do not use the explicit markings such as headings and titles that one normally associates with tables. From a content perspective, they are either multi-column lists, or hanging lists where the item in the first column wraps. They are created using FrameMaker 's table utility. Use one of the flavors of the table format called TabularList. For the text of the Tabular list, use the paragraph tag TabularListText. Anchor the table the preceding paragraph.

This is a table that thinks it's a multi-column list.

Here's a table that thinks it's an indented hanging list.

This is a tabular list inside a hanging list

When you need to embed a line or two of code in regular text, use an Example tag. There are five variations: Example, ExampleInd, ExampleInd2, ExampleInd4, and ExampleInd5.

When you need to embed a line or two of code in regular text, use the Example paragraph tag:

Example

This example uses ExampleInd.

The following example uses ExampleInd2.

The following example uses ExampleInd4 and ExampleInd5

ExampleInd4 

For sample programs—or simply for longer code examples—use a Code paragraph tag. It uses more compact vertical spacing than Example. Use the 1st paragraph tag for the first line of code to give your sample the correct vertical spacing. There is a total of ten basic Code tags: Code1st, Code, CodeInd1st, CodeInd, CodeInd2.1st, CodeInd2, CodeInd4.1st, CodeInd4, CodeInd5.1st and CodeInd5. In addition, there are four Code tags for displaying longer lines of Code that don't fit within the margins: CodeExt1st, CodeExt, CodeMargin1st and CodeMargin.

---

Note: If you find it necessary to break a line of code, use the proper syntax for the programming language you are documenting.

---

This example uses Code1st and Code

Code1st 
Code 

The following example uses CodeInd

The following example uses CodeInd2

The following example uses CodeInd4 and CodeInd5

CodeInd4.1st 
CodeInd4 

If you have long lines of code that require more characters per line, you can use CodeExt1st and CodeExt tags which reduce the letterspacing and produce an 80-column line within the text margin.

long line of code that wouldn't fit in the text column and uses CodeExt1st tag
another long line that uses the CodeExt tag to keep it from breaking
12345678902234567890323456789042345678905234567890623456789072345678908234567890

You may also use the CodeMargin1st and CodeMargin paragraph tags to display long lines of code.

For *real* long lines of code, you might need to use the CodeMargin1st paratag.
It's companion, for second and following lines, is the CodeMargin paratag

For code and example blocks that you want to be able to cross-reference and have appear in the List of Examples at the beginning of your book, precede your block with either the CodeTitle ExampleTitle paragraph tag, depending on the paragraphs that make up your block.

---

Note: Both tags produce the same automatic string preceding the title, and use the same numbering scheme. The differentiation is necessary for online conversion, since Code and Example are different constructs in our SGML DTD.

---

---

Caution: Once you begin a block with an Example, Code1st, CodeExt1st or CodeMargin1st paragraph, you must tag subsequent paragraphs in the block with the appropriate variation of that tag for second and following paragraphs. If you mix and match Code and Example tags, the online tools will become confused and may mis-tag or mis-format your block.

---

blah, blah, blah
blah, blah, blah
blah, blah, blah

% su
# rm -r /*
# <Ctrl>-D
%

Typing math equations requires you to work in a different way than you do when typing text. The FrameMaker math editor is also a math package that evaluates and solves equations. We don't currently use this equation solving capability, but you should enter equations with the proper syntax anyway, to give them a mathematically correct look and to enable use of the equation solver in the future.

Equation objects include variables, operators, relations, and functions. Each entry that you make from the keyboard or from the Equations menu has a mathematical meaning. For example, FrameMaker assumes that a single letter is a variable. When you type one letter after another, FrameMaker assumes the variables are to be multiplied, because in mathematical notation, multiplication is implicit when variables are combined together with no spaces in between them. If what you really intend is a single variable whose name contains two or more characters, you must select "String" from the Equation menu and type the variable name between the quotes. The quotes disappear when you enter the next object in the equation. Use the space bar to select equation objects for editing, as described in "Using FrameMath".

When you use a variable from an equation in a sentence, some engineers prefer that variable to be set off from the surrounding text with a numeric space before and after it. This prevents the variable-width spacing adjustment from being applied to the spaces surrounding the variable, thus making it stand out from the surrounding text.

Even if you don't use equations, you should also keep in mind that the typography of mathematical symbols is different than that of letters and text symbols. For example, a minus sign has a slightly different appearance and vertical alignment than a dash symbol. A multiplication symbol is different than the letter x.

You should enter a minus symbol from the symbols font rather than a dash when you intend to indicate a negative value or a subtraction. Similary, you should enter the multiply symbol rather than the letter x when you intend to represent multiplication. The most common case of this is when quoting dimensions, as in 3x5. Do not use the letter x to represent "3 by 5".

Figure 1-2. Sample Figure Using FigTitle-Margin Paratag

---

Caution: If you create additional figures using this method, be sure to delete all the text in the figure title, including any xref target marker.

---

To create a side-column figure, follow these steps:

Use one of the Hint paragraph tags to provide supplemental information related to the text. There are five Hint tags: Hint, HintInd1, HintInd2, HintInd4 and HintInd5

This example uses Hint.

---

Tip: Hint Hint Hint Hint Hint Hint Hint Hint Hint Hint Hint Hint Hint Hint Hint Hint Hint Hint Hint Hint Hint Hint Hint Hint Hint Hint

---

The example below uses HintInd.

The following example uses HintInd2.

The following example uses HintInd4 and HintInd5.

HangItem		HangBody Tip: Hintnd4 HintInd4 HintInd4 HintInd4 HintInd4 HintInd4 HintInd4 HintInd4 HintInd4 HintInd4
HangItem		HangBody BulletInd4 Tip: Hintnd5 HintInd5 HintInd5 HintInd5 HintInd5 HintInd5 HintInd5 HintInd5 HintInd5 HintInd5 BulletInd4

Use one of the Tip paragraph tags to provide supplemental information related to the text. There are five Tip tags: Tip, TipInd1, TipInd2, TipInd4 and Tipnd5

This example uses Tip.

---

Tip: Tip Tip Tip Tip Tip Tip Tip Tip Tip Tip Tip Tip Tip Tip Tip Tip Tip Tip Tip Tip Tip Tip Tip Tip Tip Tip Tip Tip Tip Tip Tip Tip Tip Tip Tip Tip

---

The example below uses TipInd.

The following example uses TipInd2.

The following example uses TipInd4 and TipInd5.

HangItem		HangBody Tip: Tipnd4 TipInd4 TipInd4 TipInd4 TipInd4 TipInd4 TipInd4 TipInd4 TipInd4 TipInd4 TipInd4 TipInd4
HangItem		HangBody BulletInd4 Tip: Tipnd5 TipInd5 TipInd5 TipInd5 TipInd5 TipInd5 TipInd5 TipInd5 TipInd5 TipInd5 TipInd5 TipInd5 BulletInd4

Use one of the Note paragraph tags to provide supplemental information related to the text. There are five Note tags: Note, NoteInd1, NoteInd2, NoteInd4 and NoteInd5

This example uses Note.

---

Note: Note Note Note Note Note Note Note Note Note Note Note Note Note Note Note Note Note Note Note Note Note Note Note Note Note

---

The example below uses NoteInd.

The following example uses NoteInd2.

The following example uses NoteInd4 and NoteInd5.

HangItem		HangBody Note: NoteInd4 NoteInd4 NoteInd4 NoteInd4 NoteInd4 NoteInd4 NoteInd4 NoteInd4 NoteInd4 NoteInd4
HangItem		HangBody BulletInd4 Note: NoteInd5 NoteInd5 NoteInd5 NoteInd5 NoteInd5 NoteInd5 NoteInd5 NoteInd5 NoteInd5 BulletInd4

Use one of the Caution paragraph tags to point out actions that may cause damage to your system. There are five Caution paragraph tags: Caution, CautionInd1, CautionInd2, CautionInd4 and CautionInd5.

This example uses Caution.

---

Caution: Caution Caution Caution Caution Caution Caution Caution Caution Caution Caution Caution Caution Caution Caution Caution

---

The next example uses CautionInd.

The following example uses CautionInd2.

The following example uses CautionInd4 and CautionInd5.

HangItem		HangBody Caution: CautionInd4 CautionInd4 CautionInd4 CautionInd4 CautionInd4 CautionInd4 CautionInd4
HangItem		HangBody BulletInd4 Caution: CautionInd5 CautionInd5 CautionInd5 CautionInd5 CautionInd5 CautionInd5 CautionInd5 BulletInd4

Use one of the Warning paragraph tags to call attention actions or practices that may cause physical harm to the user. There are three Warning paragraph tags: Warning, WarningInd and WarningInd2

This example uses Warning

---

Warning: warning warning warning warning warning warning warning warning warning warning warning warning warning warning warning warning warning

---

The next example uses WarningInd

The following example uses WarningInd2

Each of the three warning paratags has an icon to the left of it. Unfortunately, this icon must be added manually. Here is the procedure:

---

Note: This procedure is not nearly as complicated as it looks and it appears to work in all cases but one. This is when the Warning paragraph is the first paragraph on the page. In this case FrameMaker bumps the anchored frame down so it doesn't run above the top of the upper margin. So, what you have to do is add an empty Text tag above the Warning tag, then set the Space Above for the Warning paragraph to 0.0". I would advise against using this workaround until you are absolutely sure that a Warning tag will fall at the top of a page.

---

These are the shortcut tags.

---

Tip: Shortcut Shortcut Shortcut Shortcut Shortcut Shortcut Shortcut Shortcut Shortcut Shortcut Shortcut Shortcut Shortcut Shortcut

---

Text paragraph

The four “flag tags” in this section have been created for writers to use in internal drafts They are based on the Warning paragraph tag from the standard IPChap.doc template.

Writers are encouraged to use these tags to communicate with their editors and reviewers, rather than inserting comments in brackets or in different fonts. The advantages of using these tags are as follows:

Each of the four flag tags has an icon to the left of it. If you copy an existing flag paragraph from your document or from this template, you will copy the icon with it. Otherwise you must add the icon manually. Here is the procedure:

Flag paragraphs are not supported in the translator, so they will not appear in the InSight versions of your documents. However, your document will build properly with flag paratags in it if you mark them as conditional text. This must be done manually.

When it's time to remove the flag paragraphs from your document, you can find them quickly by using FrameMaker's Search function:

---

Note: The steps outlined below will not work unless you have already read in the IPMacros file.

---

To insert an index marker:

That's all it takes. You'll notice that a marker now appears at the beginning of the paragraph, and the index entry has turned underlined blue. The index entry text is conditional. To hide it, hide IndexEntry conditional text. <Esc> I is a keyboard macro that's been defined in the macros template.

shortcuts. See keyboard shortcuts

shortcuts. Alt-iSeeAlt-d keyboard shortcutsAlt-n 

shortcuts. <Italics>See<Default Para Font> keyboard shortcuts<$nopage>

For an explanation of the standard rules for index entry syntax, see Using FrameMaker, pp. 11-4 to 11-8. In addition, by utilizing a feature described the manual New Features in FrameMaker (p. A-6), the templates have defined the following characters as “ignored” for index sorting purposes:

$
/
.
<
"
"

So, for instance, the entry

/etc/hosts

is sorted as though the /'s were absent. The full entry (under E) appears as

E
/etc/hosts

Be aware that because all instances of an ignored character will be ignored, sequences like the following are possible:

/etc/ghosts
/etchosts
/etc/root

This is mainly a problem with the / character, since the other ignored characters rarely appear anywhere but the beginning of an index entry. In the case of the / character, it was decided that the advantage of having the leading / ignored outweighed the disadvantage of having to put up with a few cases where an ignored / in the midst of an entry caused an unusual sort order.

The following rules apply to ignored characters in index entry syntax. They are not explained anywhere in the FrameMaker manuals and were arrived at by investigation. If you find that any of them are incorrect, please notify the template keeper.

“add” and “generate” are two separate procedures in FrameMaker. “add” means add a file pointer to a book file. “generate” refers to the actual process of searching constituent files for designated para- graph tags and creating a “generated” file. Please note that the book file itself is also considered a “generated” file.

To add names of files created through standard text entry (chaps, appendices, etc), select “Add File” from the file menu. The window that comes up has three main areas. The top portion allows you to choose the type of file you wish to add. Choose “Document File”. The left portion allows you to chose where you would like the file to go in you book file. You can highlight any file in the list and chose “Before...” or “After Current File” from the drop-down menu directly above the list. The right portion lists the files you can add. Choose the one you want and click “Add”. The name of the file should appear in the book file.

After the name of the new file appears, highlight it by clicking on it and go to Set Up File in the File menu. The window that appears allows you to set the specifications necessary for your file to have the correct page and paragraph numbering. The following lists describe the specifications that should be set for text files you add to your book depending on the combination of part tabs and tabs in your book.

Table 1-7 shows the specifications that should be set for text files that you add to your book when there are no part tabs or tabs:

Table 1-7 shows the specifications that should be set for text files that you add to your book when there are tabs

Table 1-7 describes the specifications that should be set for text files that you add to your book when there are part tabs

Table 1-7 describes the specifications that should be set for text files that you add to your book when there are part tabs and tabs

To add names of files to be created through FrameMaker's file generation utility (Contents, Figures, Tables, Index):

At this point, the file itself does not actually exist. What you have done is add the name of a file that FrameMaker will create when you choose Generate/Update from the File menu. See the section “Generating TOC, LOE, LOF, LOT and Index” for instructions on how to generate these files.

FrameMaker assumes that when you finally generate your generated files (as opposed to just adding their names to the book file) all the appropriate files are in your book file in the correct order, and have been set up with the correct specifications in Set Up File.

To rearrange files so they are in the proper order, use Rearrange Files. The window that appears is self-explanitory. This window is the only place where files can be deleted from your book.

After rearranging your files, use the Set Up File option (book file must be open and filename must be highlighted) to check for the proper specs, or fix any files that weren't set up when they were originally added to te book file. See Table 1-7 and Table 1-10 for the proper specs.

The FrameMaker documentation says to generate your files, Use Formats From, and regenerate to allow FrameMaker to incorporate the new styles. This will not work for you.

This best way to create your generated files is to set up your book file as explained in “Adding Generated Files to Your Book”. Then, before you actually generate the files, make copies of the generated sections of the template, stick them in the directory with your document files, give them the same names that these sections have in the book file, and then generate. This way, FrameMaker assumes that it is overwriting existing files and simply dumps the generated text into a pre-formatted template section. You should then be able to open up your generated file and see it already fully formatted.

If you try this strategy, one way to tell if it hasn't worked is at the end of the generation process when you open the generated FrameMaker file it contains unformatted files. This indicates that FrameMaker did not recognize the renamed template copies you put in with your document files, probably because you misnamed them.

The template uses an single autonumbering scheme to run Chap/AppNum, the “#-” in the footer, Headings, Tables and Figures, Examples and Equations. The scheme relies upon your having built a book, set up your files, and used Generate/Update to repaginate the files.

If your autonumbering doesn't work, here are some possible causes: