framemaker design guidea) open bookname-chapterscontinued.fm in framemaker, and then and then select...

FrameMaker

Design Guide for Manuals

Version 4.00February 7, 2005

Toshen Golias

© 2005 by Toshen GoliasAll rights reserved.

ProductName is a trademark of CompanyName.

Other product and company names may be the trademarks of their respective owners.

Contents

Chapter 1: Using this template...............................1Creating a new book....................................................................... 1Branching a book to create a new version ................................... 7

Chapter 2: Page setup .............................................9Basic design decisions for output ................................................. 9Left/right master pages................................................................ 10Other master pages ...................................................................... 12Printing to PDF .............................................................................. 13

Chapter 3: Front matter design ........................... 17Title page ....................................................................................... 17Copyright page.............................................................................. 19Table of contents........................................................................... 23

Chapter 4: Body (chapters) design ..................... 25Headings ........................................................................................ 25Displaying section-level procedures TOP ................................... 26Displaying section-level procedures........................................... 26Standard paragraph formats ....................................................... 28Special paragraph formats........................................................... 30Enumerated procedures............................................................... 31Bulleted lists .................................................................................. 32Character formats ......................................................................... 33Notes .............................................................................................. 36Cross-references ........................................................................... 39Graphics ......................................................................................... 42Tables ............................................................................................. 50

Chapter 5: Back matter design ............................ 53Appendices .................................................................................... 53Index............................................................................................... 54

Appendix A: Getting help..................................... 55About your support contract ....................................................... 55

Design Guide 4.00 for ManualsContents i

ii

Appendix B: What’s new? ..................................... 57Version 4.00 ................................................................................... 57

Index......................................................................... 59

Design Guide 4.00 for ManualsContents

Chapter 1: Using this template

Using this templateThe blank version of this template is called “PPM.” It consists of the following files:

Creating a new book

Carefully creating your new book files from the template files can give you a set of files that you can use to efficiently write your book, with all the necessary paragraph, char-acter, table, cross-reference, and graphic formats, as well as the necessary variables.

This book template is designed with lots of margin white space, to facilitate easily expanding the print area for translations.

Create the book

Before you start this process, you should have a draft outline of your book on hand, including chapter names.

Copy and rename the template files

1. Copy all of the template files into the folder you want to store your manual in.

Our current folder hierarchy is: Docs/Bookname/VersionNumber/, for example, Docs/ProductName User’s Guide/3.60/. The VersionNumber folder should contain the book files, as well as the subfolders: PDF, Source docs, Tiffs, and Tmp.

2. Except for the Book file, rename each file, replacing the “PPM” portion of each name with the name you want to give your book. Leave the rest of each name exactly as it is. For example, rename PPM-TOC to BookName-TOC.fm.

The names should be generic, so that the manuals can be easily branched for new revisions. For example, for the TOC section, use “BookName-TOC” rather than “BookName.40-TOC. For Appendix F: What’s New, use “BookName-XNew” rather than “BookName-XFNew. Branching is discussed later in this guide.

• PPM-.book • PPM-AdditionalChapters.fm

• PPM-Front.fm • PPM-XFirstAppendix.fm

• PPM-TOC.fm • PPM-XAdditionalAppendices.fm

• PPM-FirstChapter.fm • PPM-IX.fm

1Design Guide 4.00 for Manuals

Chapter 1: Using this template › Creating a new book

2

Build your book

1. Open book. From your current manual’s folder, open the PPM-.book file. The book should contain two files: PPM-TOC.fm and PPM-IX.fm. If it doesn’t, add them (Add › Table of Contents, and Standard Index).

2. Save book with new name. Select File › Save Book As, and then save the file in the new manual’s folder with the name of your manual, for example, “BookName-.book.” The TOC and IX files in the book are automatically renamed with the new book name.

3. Add front matter file. Add the front matter file (BookName-Front.fm) to the book:

a) Select Add › Files.

a) In the Add File to Book dialog box, browse to the folder for your current man-ual, and then select the BookName-Front.fm file.

b) If necessary, in the book window drag the file to its correct sort location at the top of the list of files in the book.

4. Add first chapter. In the same way, add the first chapter (BookName-FirstChap-ter.fm) to the book. If necessary, drag it to its correct sort location between the TOC and IX files.

5. Add first appendix. In the same way, add the first appendix (BookName-XFirstAppendix.fm) to the book. If necessary, drag it to its correct sort location after the first chapter.

6. Verify setup of your files. The template files have been configured with the correct numbering and PDF setup options; however, you should verify the settings.

a) Front. It is not necessary to check anything with this file. These pages aren’t numbered, don’t have a footer, contain no hypertext links, and don’t use vari-ables.

b) Table of Contents. In the book window, select the BookName-TOC.fm file, and then choose Format › Document › Numbering.

1) In the Numbering Properties dialog box, select the Page tab, and make sure the settings are: First page #: 1, Format: Roman (xiv).

2) Select Edit › Set Up Table of Contents, and make sure the following para-graph formats are included in the Include Paragraphs Tagged list:

• H1

• H2Anywhere

• H2BTopOfPage

• H3Anywhere (optional; not necessary for a well-indexed book)

Design Guide 4.00 for ManualsChapter 1: Using this template › Creating a new book

• H3BTopOfPage (optional; not necessary for a well-indexed book)

• TitleIXH1

• xAppendixH1

Also Make sure Create Hypertext Links is selected.

3) Open the document, select Special › Variable, and then edit the product name variables:

• Name. Full product name for use throughout the manual.

• Acronym. Product acronym, if any, for use throughout the manual.

• FooterName. Product name Version # Manual name, for use in the foot-ers of the manual, for example, “ProductName 3.60 User’s Guide.”

The page numbers and the second line of the footer should already be formatted: “Contents #.”

4) It is not necessary to update the book at this time, although it doesn’t hurt. You only need to update the book when you want your TOC, index, and links to reflect changes you have made in the rest of the book.

c) First chapter. In the book window, select your BookName-FirstChapter.fm file, and then choose Format › Document › Numbering.

1) In the Numbering Properties dialog box, select the Page tab, and make sure the settings are: First page #: 1, Format: Numeric (14).

2) Again in the Numbering Properties dialog box, select the Chapter tab, and make sure the settings are: Chapter #: 1, Format: Numeric (14).





Note: There is a quirk in FrameMaker 6.0 that causes the program to think that there are overrides in the body of the TOC whenever you add a special variable such as the FooterName to the TOC master

pages. When you toggle between the master pages and the body pages, a dialog box asks if you want to keep or remove those overrides. It does not matter what you answer, nothing is changed (at least nothing with any real-world impact).



4

The page numbers and the second line of the footer should already be formatted: “Chapter 1: Heading1 › Heading2 #.”

4) Select Edit › Rename File, and then change the name to its correct chapter name for the first chapter of the book, for example, BookName-Intro.fm.

d) First appendix. In the book window, select your BookName-XFirstAppen-dix.fm file, and then choose Format › Document › Numbering.

1) In the Numbering Properties dialog box, select the Page tab, and make sure the setting is: Continue Numbering from Previous Page in Book.

2) Again in the Numbering Properties dialog box, select the Chapter tab, and make sure the settings are: Chapter #: 1, Format: Alphabetic (N).





The page numbers and the second line of the footer should already be formatted: “Appendix A: Heading1 › Heading2 #.”

4) Select Edit › Rename File, and then change the name to its correct appendix name for the first appendix of the book, for example, “ProductName-XSup-port.fm.”

e) Index. In the book window, select your YourBookName-IX.fm file, and then choose Format › Document › Numbering.


2) Select Edit › Set Up Standard Index, and make sure the following paragraph formats are included in the Include Markers of Type list: Index.

Also, make sure Create Hypertext Links is selected.

3) Select Special › Variable, and then edit the product name variables:




The page numbers and the second line of the footer should already be formatted: “Index: GroupTitle #.”


4) It is not necessary to update the book at this time, although it doesn’t hurt. You only need to update the book when you want your TOC, index, and links to reflect changes you have made in the rest of the book.

7. Add additional chapters. Add as many additional chapter files as needed. Base each one on the BookName-AdditionalChapters.fm file.

a) Open BookName-ChaptersContinued.fm in FrameMaker, and then and then select Format › Document › Numbering, and verify that the numbering options are correct.


2) Also in the Numbering Properties dialog box, select the Chapter tab, and make sure the setting is: Continue Numbering from Previous File in Book.





The page numbers and the second line of the footer should already be formatted: “Chapter #: Heading1 › Heading2 #.”

4) Important: if you make any changes, save the BookName-AdditionalChapters.fm file.

b) Use the Save As command to save the file with the appropriate chapter name, for example, “BookName-Overview.”

c) Repeat step b as many times as is needed to create files for all of the book’s chapters.

d) Add all of the chapter files to the book file, and sort them in the actual order they should be printed, following Chapter 1.

You can also add additional chapters to the book at any time, and of course, re-order or rename them whenever needed. It is a good idea to always use the BookName-AdditionalChapters.fm file as the basis for any new chapters you add, as it is configured appropriately.

8. Add additional appendices. Add as many additional appendix files as needed. Base each one on the BookName-AdditionalAppendices.fm file.

a) Open BookName-AdditionalAppendices.fm in FrameMaker, and then and then select Format › Document › Numbering, and verify that the numbering options are correct.



6


2) Also in the Numbering Properties dialog box, select the Chapter tab, and make sure the setting is: Continue Numbering from Previous File in Book.

Note: Another FrameMaker 6.0 quirk? It might be necessary to change the setting to Chapter #: 1, Format: Alphabetic (N), and then change it back to Continue Numbering from Previous File in Book, so that the appendix lettering is alphabetic.





The page numbers and the second line of the footer should already be formatted: “Appendix #: Heading1 › Heading2 #.”

4) Important: if you make any changes, save the BookName-AdditionalAppendices.fm file.

b) Use the Save As command to save the file with the appropriate appendix name, for example, BookName-New.fm.

c) Repeat step b as many times as is needed to create files for all of the book’s appendi-ces.

d) Add all of the appendix files to the book file, and sort them in the actual order they should be printed, following Appendix A.

You can also add additional appendices to the book at any time, and of course, re-order or rename them whenever needed. It is a good idea to always use the BookName-AdditionalAppendices.fm file as the basis for any new appendices you add, as it is configured appropriately.


Branching a book to create a new version

When it is time to branch a book for a new version:

1. Simply copy the VersionNumber folder together with all subfolders, and then paste it into the Bookname folder.

2. Rename the VersionNumber folder with the new version number, for example, “3.60.”

• The cross reference links will not be broken. The logic FrameMaker uses is: “Look in the current folder for a link to a marker in a file named filename.”

• As long as the folder names of the VersionNumber folder’s subfolders do not change, graphics that were placed by reference will maintain their links. The logic FrameMaker uses is: “Look in the current folder’s subfolder named Tiffs for a graphic file named filename.”


Chapter 1: Using this template › Branching a book to create a new version

8
Design Guide 4.00 for ManualsChapter 1: Using this template › Branching a book to create a new version

Chapter 2: Page setup

Page setup This template is designed for full-length, user-friendly, procedure- and graphic-inten-sive user guides. It contains everything that is needed to create the main document, as well as generate a hypertext-linked table of contents and index.

Basic design decisions for output

We are outputting our files as PDFs for printing on a DocuTech. We are also creating PDF documents from this basic template document for online use. The formatting required to make reasonably smooth PDF conversions is designed into the template. However, we layout the 7” x 9” document on an 8.5” x 11” page.

Margin shift

If we require mirrored margins with different offsets in the finished documents, we need to specify to the printer the amount they need to shift the left/right margins. Cur-rently, for the English-language version of the manuals, we are not doing this, but if we produce translated versions with tighter margins, we might need to.

Blank even (verso) pages at end of section

Each template type (Front, TOC, Chapter, Additional Chapters, XAppendix, XAddi-tionalAppendices, and IX) has a master page titled “No header/footer,” which can be applied to blank verso (even) pages at end of any section. There will never be blank recto (odd) pages, because Heading1 headings are formatted to begin on recto pages.


Chapter 2: Page setup › Basic design decisions for output

10

Left/right master pages

The left and right master pages are set up the same, with one exception: the footer text is justified outer on both pages (left justified on left [verso] master page, right justified on right [recto] master page).

Specifications

Page size 8.500” x 11.000” (7.000” × 9.000” finished size after trimming)

Top margin 2.000” (1.000” finished size after trimming)

Bottom margin 2.000” (1.000” finished size after trimming)

Inner margin 2.625” (1.125” finished size after trimming)

Outer margin 2.625” (1.125” finished size after trimming)

Margin shift None

Main text frame Text flow A; 4.750”wide × 7.000” high

Header properties Not used

Footer properties Page number. Offset from. Top: 9.375” (8.375” after trimming); Left: (Verso) 1.500” (0.750” after trimming); (Recto) 6.750” (6.000” after trimming); Unrotated size. Width: 0.250”; Height: 0.250.”

Footer text. Offset from. Top: 9.375” (8.375” after trimming); Left: 2.625” (1.125” finished size after trimming); Unrotated size. Width: 4.750”; Height: 0.250.”

Format (Footer ¶ format). Basic. Indents: None; Alignment: Left; Space Above Pgf: 0.0 pt; Space Below Pgf: 0.0 pt; Line Spacing: 10.0 pt; Tab Stops: 4.750” R; Next Pgf Tag: None. Default Font. Family: MyriaMM; Size: 8 pt; Angle: Regular; Weight: Regular; Color: Deep blue.

Footer text Page number (justified outer): Number only, on second line.

First line footer (justified outer): ProductName Version# BookName (User’s Guide, Administrator’s Guide, or Reference Manual). Variable used: FooterName.

Design Guide 4.00 for ManualsChapter 2: Page setup › Left/right master pages

Second line footer (justified outer): Chapter (or Appendix) #: Header1 › Header2 (optionally) › Header 3.Plain text: “Chapter” (or “Appendix”), colon (:), guillemot single right (›).Variables: Chapter Number, Running H/F 2, Running H/F 3, and (optionally) Running H/F.

Variable definitions Chapter Number: <$chapnum>Running H/F 2: <$paratext[H1, xAppendixH1]>Running H/F 3: <$paratext[H2Anywhere, H2BTopOfPage]>Running H/F 4: <$paratext[GroupTitlesIX, H3Anywhere,

H3BTopOfPage]>

Running H/F 4 can be used when you want to provide additional navigational assistance in a chapter; however, when it used, each H2 must be followed by an H3 on the same page.

Page numbering Arabic numerals.


Chapter 2: Page setup › Left/right master pages

12

Other master pages

Front matter master pages

Based on the left/right master pages with these exceptions:

Footer text None.

TOC left/right master pages


Text frame Flow. Room for Side Heads: Selected; Width: 1.0”; Gap: 0.25”; Side: Left.

Footer text Second line footer (justified outer): TitleTOCH1.Variable: Running H/F 1.

Variable definitions Running H/F 1: <$paratext[Title, TitleTOCH1, TitleIXH1]>

Page numbering Roman numerals.

IX left/right master pages


Text frame Columns. Number: 2”; Gap: 0.25”; Balance Columns: No.

Footer text Second line footer (justified outer): TitleTOCH1.Variable: Running H/F 1 › Running H/F 4.

Variable definitions Running H/F 1: <$paratext[Title, TitleTOCH1, TitleIXH1]>Running H/F 4: <$paratext[GroupTitlesIX, H3Anywhere,

H3BTopOfPage]>

Design Guide 4.00 for ManualsChapter 2: Page setup › Other master pages

Printing to PDF

It is necessary to tweak FrameMaker and Acrobat in order to produce a decent PDF.

Tweak Acrobat settings

We need to produce two PDFs for each revision, both of which should be based on the same default settings in Distiller:

• One for the printed manual.

• One for the online manual.

1. Make sure that Distiller has the correct Job Options job selected. We are using the standard PrintOptimized job options:

General

• Compatibility: Acrobat 4.0

• Optimize PDF: selected

• Resolution: 1200 dpi

• Binding: Left

Compression

• Color Bitmap Images

• Resampling: selected: Bicubic Downsampling at 300 dpi

• Compression: selected: Automatic

• Quality: High

• Grayscale Bitmap Images


• Compression: selected: Automatic

• Quality: High

• Monochrome Bitmap Images


• Compression: selected: CCITT Group 4

• Compress Text and Line Art: selected


Chapter 2: Page setup › Printing to PDF

14

Fonts

• Embed All Fonts: selected

• Subset All Embedded Fonts Below 100%

• When Embedding Fails: Warn and Continue

Color

• Tag Everything for Color Mgmt (no conversion)

• Assumed Profiles:

• Gray: None

• RGB: sRGB IEC61966-2.1

• CMYK: Adobe CMYK

• Options:

• Preserve Overprint Settings: selected

• Preserve Under Color Removal and Black Generation Settings: selected

• Preserve Transfer Functions: selected

Advanced

• Options:

• Allow PostScript file to Override Job Options: selected

• Preserve Level 2 copypage Semantics: selected

• Save Portable Jobe Ticket inside PDF file: selected

• Document Structuring Conventions (DSC):

• Resize Page and Center Artwork for EPS Files: selected

• Preserve EPS Information from DSC: selected

• Preserve OPI Comments: selected

• Preserve Document Information from DSC: selected

• Default Page Size:

• Width: 612.0 points

• Height 792.0 points

Design Guide 4.00 for ManualsChapter 2: Page setup › Printing to PDF

Mozill

Tweak FrameMaker settings

In order to output color screen capture graphics to a PDF file, it is necessary to change the printer to “Acrobat Distiller” prior to generating the PDF file. Otherwise, for some reason, you will get monotone screen capture graphics.

1. Open the book file.

2. Update the TOC and index (Edit › Update Book).

Printed book

1. With the book file open, Generate the PDF:

a) File › Print Book.

b) Click Printer Setup, and then choose Acrobat Distiller.

c) Select Generate Acrobat Data and Print Only to File. Change the path name/file name, if necessary. Use the extension “.ps” and the structure: “Ver-sion#BookName(optionally, Rev&Rev#)-.ps,” e.g., “360BookNameRev4-.ps.”

d) Click PDF Setup, and edit the settings as follows:

Include these paragraphs Use this bookmark level

GroupTitlesIX 4

H1 3

H2Anywhere 4

H2BTopOfPage 4

H3Anywhere 5

H3BTopOfPage 5

H4 (optional) 6

Title 1

TitleByline 2

TitleIXH1 2

TitleTOCH1 2

xAppendixH1 3

xAppendixH1Preheader 2

xH1Preheader 2


Chapter 2: Page setup › Printing to PDF

16

2. Click Print to generate the postscript file.

3. In Windows Explore, navigate to the folder the postscript file was saved to, and then double-click it to distill it into a PDF (use the same file name, except add “Paper” after the dash.).

a) Pages should not be cropped.

b) Pages should not be renumbered.

Online book

1. Open the print-version PDF in Adobe Acrobat.

2. Save it with the same file name, except add “Online” instead of “Paper” after the dash.

3. Resize the pages. Once the online-version PDF file has been saved, select Docu-ment > Crop Pages, and then resize the margins to (in inches):

• Top and Bottom: 1.000”

• Left and Right: 0.750”

4. Renumber the pages. Select Document › Number Pages, and then change the num-bering to match the printed book:

• Front (title, copyright, and dedication pages): none

• TOC: Roman numerals, start at “1.”

• Rest of book (chapters, appendices, and index): Arabic numerals, start at “1.”

Remember to set Pages to All so that the whole document is cropped, and not just the current page.

Design Guide 4.00 for ManualsChapter 2: Page setup › Printing to PDF

Chapter 3: Front matter design

Front matter design

Title page

See next recto page for sample layout of title page. In actual use, no header or footer is used; first recto page (we aren’t using a half-title page).

TitleSuperTag. (Body ¶ format +) Empty paragraph, used for preceding Title only. Basic. Space Above Pgf: 0.0 pt; Space Below Pgf: 120.0 pt; Line Spacing: 24.0 pt; Next Pgf Tag: Title. Pagination. Start: Top of Right Page.

TitlePre. (¶ format) Used for suite title. Basic. First Indent: 0.375”; Left Indent: 0.375”; Alignment: Left; Space Above Pgf: 0.0 pt; Space Below Pgf: 0.0 pt; Line Spacing: 36.0 pt; Next Pgf Tag: Title2. Default Font. Family: MyriaMM_830 BL 600 NO; Size: 30.0 pt; Angle: Regular; Weight: Regular; Color: Deep blue (R 8%, G 4%, B 40%).

Title. (¶ format) Used for product title. Basic. First Indent: 0.375”; Left Indent: 0.375”; Alignment: Left; Space Above Pgf: 0.0 pt; Space Below Pgf: 0.0 pt; Line Spacing: 49.0 pt; Next Pgf Tag: Title2. Default Font. Family: MyriaMM_830 BL 600 NO; Size: 48.0 pt; Angle: Regular; Weight: Regular; Color: Deep blue (R 8%, G 4%, B 40%).

Title2. (Title ¶ format +) Used for type of book subtitle (User’s guide, Administrator’s guide, Reference manual). Basic. Alignment: Left; Space Below Pgf: 72.0 pt; Line Spac-ing: 36.0 pt; Next Pgf Tag: TitleByline. Default Font. Family: MyriaMM_830 BL 600 NO; Size: 30.0 pt; Angle: Regular; Weight: Regular; Color: Deep burgundy (R 40%, G 0%, B 30%).

TitleByline. (¶ format) Used for software version number and document revision. Basic. First Indent: 0.375”; Left Indent: 0.375”; Alignment: Right; Line Spacing: 15.0 pt; Next Pgf Tag: TitleByline. Default Font. Family: MyriaMM_700 BD 600 NO; Size: 12 pt; Angle: Regular; Weight: Regular; Color: Deep burgundy (R 40%, G 0%, B 30%).

TitleSuper. (¶ format) Used for company name. Basic. First Indent: 1.375”; Left Indent: 1.375”; Alignment: Right; Space Above Pgf: 90.0 pt; Space Below Pgf: 0.0 pt; Line Spac-ing: 15.0 pt; Next Pgf Tag: Body. Default Font. Family: MyriaMM_700 BD 600 NO;


Chapter 3: Front matter design › Title page

18

Size: 12 pt; Angle: Regular; Weight: Regular; Color: Deep blue (R 8%, G 4%, B 40%). (I know, I know, funny name! It used to be at the top, below the TitleSuperTag.)

Hint › When a paragraph is formatted with space above, it will still float to the top of a page when it is the first paragraph on the page.

If a paragraph style with space below is followed by a paragraph style with space above, the space between the two becomes the larger of the two (not the sum of the two).

Design Guide 4.00 for ManualsChapter 3: Front matter design › Title page

Copyright page

See next verso page for sample layout of copyright page. In actual use, no header or footer is used; verso of title page.

CopyrightSpacer. (¶ format) Empty paragraph, used for spacing purposes only. Basic. First Indent: 1.500”; Left Indent: 1.500”; Alignment: Left; Space Above Pgf: 0.0 pt; Space Below Pgf: 168.0 Line Spacing: 13.0 pt; Next Pgf Tag: Copyright. Default Font. Family: MinioMM; Size: 10 pt; Angle: Regular; Weight: Regular; Color: Black. Pagination. Start: Top of Left Page.

Copyright.(¶ format) Used for copyright notice. Basic. First Indent: 1.500”; Left Indent: 1.500”; Alignment: Left; Space Above Pgf: 0.0 pt; Space Below Pgf: Single Line; Line Spac-ing: 13.0 pt, Fixed; Next Pgf Tag: None. Default Font. Family: MinioMM; Size: 10 pt; Angle: Regular; Weight: Regular; Color: Black. Pagination. Start: Anywhere.


Chapter 3: Front matter design › Copyright page

20
Design Guide 4.00 for ManualsChapter 3: Front matter design › Copyright page

TitleSuperTag (regular position: top of first recto page). No text.

TitlePre: Suite

Title: ProductTitle2: Type of book

TitleByline: Software version 0.00TitleByline: Manual 0.00 (and, optionally: revision 0)

TitleSuper: CompanyName


Chapter 3: Front matter design › Copyright page

22

CopyrightSpacer.

Copyright. Copyright notice:© Year by Company.All rights reserved.

Trademark notice for our products: ProductName is a registered trademark of CompanyName.

Trademark notice for other companies: Other product and company names may be the trademarks of their respective owners.

Design Guide 4.00 for ManualsChapter 3: Front matter design › Copyright page

Table of contents

TOC Title (TitleTOCH1)

H1 TOC entry (H1TOC) ............................................. #H2Anywhere TOC entry (H2AnywhereTOC) ................................. #H2BTopOfPage TOC entry (H2BTopOfPageTOC)........................... #

H3Anywhere TOC entry (H3AnywhereTOC) .................................#H3BTopOfPage TOC entry (H3TopOfPageTOC) ............................#

AppendixH1 TOC entry (xAppendixH1TOC) ....... #

Index Title TOC entry (TitleIXH1TOC) ................... #

TitleTOCH1. (¶ format) Used for TOC title. Basic. Indents: None; Alignment: Left; Space Above Pgf: 27.0 pt; Space Below Pgf: 18.0 pt; Line Spacing: 27.0 pt; Tab Stops: None; Next Pgf Tag: Body. Default Font. Family: MyriaMM_565 SB 600 NO; Size: 24 pt; Angle: Regular; Weight: Regular; Color: Deep blue (R 8.2%, G 3.5%, B 40.4%); Pair Kern: Yes. Pagination. Start: Top of Right Page; Keep With: Next Pgf; Format: Across All Columns and Side Heads.

H1TOC. (¶ format) Used for Level 1 topic entries in TOC. Reference page variable: Chapter <$chapnum>: <$paratext>[TAB]<$pagenum>. Basic. Indents: None; Align-ment: Left; Space Above Pgf: 7.0 pt; Space Below Pgf: 0.0 pt; Line Spacing: 14.0 pt; Tab Stops: 3.5” (Alignment: Right; Leader: .....); Next Pgf Tag: None. Default Font. Family: MyriaMM_565 SB 600 NO; Size: 12 pt; Angle: Regular; Weight: Regular; Color: Deep blue (R 8%, G 4%, B 40%); Pair Kern: Yes. Pagination. Start: Anywhere; Keep With: None; Format: In Column.

H2AnywhereTOC. (¶ format) Used for Level 2 topic entries in TOC. Reference page variable: <$paratext>[TAB]<$pagenum>. Basic. First Indent: 0.250”; Left Indent: 0.250”; Right Indent: 0.000”; Alignment: Left; Space Above Pgf: 1.0 pt; Space Below Pgf:

Note: The TOC pages are set to leave Room for Side Heads; Width: 1.000”; Gap: 0.250”; Side: Left, which is artificially imitated using indents and a different tab stop in the preceding example.


Chapter 3: Front matter design › Table of contents

24

0.0 pt; Line Spacing: 12.0 pt; Tab Stops: None; Tab Stops: 3.5” (Alignment: Right; Leader: .....); Next Pgf Tag: None. Default Font. Family: MyriaMM_480 wt 450 wd (custom); Size: 10 pt; Angle: Regular; Weight: Regular; Color: Black; Pair Kern: Yes. Pagination. Start: Anywhere; Keep With: None; Format: In Column.

H2BTopOfPageTOC. (H2AnywhereTOC ¶ format).

H3AnwhereTOC. (H2AnywhereTOC ¶ format +) Used for Level 3 topic entries in TOC. Basic. First Indent: 0.375”; Left Indent: 0.375”.Weight: Regular; Pair Kern: Yes. Default Font. Family: MyriaMM_400 wt 450 wd (custom). Pagination. Start: Any-where; Keep With: None; Format: In Column.

H3BTopOfPageTOC. (H3AnywhereTOC ¶ format +).

xAppendixH1TOC. (H1TOC ¶ format +). Reference page variable: Appendix <$chapnum>: <$paratext>[TAB]<$pagenum>.

TitleIXH1TOC. (H1TOC ¶ format +). Reference page variable: <$para-text>[TAB]<$pagenum>.

Note: The custom Multiple Master fonts used for H2AnywhereTOC (MyriaMM_480 wt 450 wd) and H3AnywhereTOC (MyriaMM_400 wt 450 wd) are created in Adobe Type Manager. Both are variations of

the basic Myriad MM font, with adjustments to weight (wt) and width (wd).

Design Guide 4.00 for ManualsChapter 3: Front matter design › Table of contents

Chapter 4: Body (chapters) design

Body (chapters) design

Headings

Chapter 1

Chapter titlesxH1Preheader. (¶ format +). Basic. Indents: None; Alignment: Left; Space Above Pgf: 12.0 pt; Space Below Pgf: 2.0 pt; Line Spacing: 12.0 pt; Tab Stops: None; Next Pgf Tag: H1. Default Font. Family: MyriaMM_565 SB 600 NO; Size: 12 pt; Angle: Regular; Weight: Regular; Color: Deep blue (R 8%, G 4%, B 40%); Pair Kern: Yes. Pagination. Start: Top of Right Page; Keep With: Next Pgf. Numbering. Autonumber Format: Chapter <$chapnum>.

H1. (¶ format). Basic. Indents: None; Alignment: Left; Space Above Pgf: 6.0 pt; Space Below Pgf: 6.0 pt; Line Spacing: 24.0 pt; Tab Stops: None; Next Pgf Tag: Body. Default Font. Family: MyriaMM_565 SB 600 NO; Size: 24 pt; Angle: Regular; Weight: Regular; Color: Deep blue (R 8%, G 4%, B 40%); Pair Kern: Yes. Pagination. Start: Anywhere; Keep With: Next Pgf.


Chapter 4: Body (chapters) design › Headings

26

Displaying section-level procedures TOP

H2BTopOfPage. (H2Anywhere ¶ format +) Pagination. Start: Top of Page.

Displaying section-level procedures

H2Anywhere. (¶ format) Basic. Indents: None; Alignment: Left; Space Above Pgf: 22.0 pt; Space Below Pgf: 9.0 pt; Line Spacing: 22.0 pt; Tab Stops: None; Next Pgf Tag: Body. Default Font. Family: MyriaMM_565 SB 600 NO; Size: 18 pt; Angle: Regular; Weight: Regular; Color: Deep blue (R 8%, G 4%, B 40%); Pair Kern: Yes. Pagination. Start: Any-where; Keep With: Next Pgf.

Design Guide 4.00 for ManualsChapter 4: Body (chapters) design › Displaying section-level procedures TOP

To introduce individual procedures TOP

H3BTopOfPage. (H3Anwhere¶ format +) Pagination. Start: Top of Page.

To introduce individual procedures

H3Anywhere. (¶ format) Basic. Indents: None; Alignment: Left; Space Above Pgf: 17.0 pt; Space Below Pgf: 7.0 pt; Line Spacing: 17.0 pt; Tab Stops: None; Next Pgf Tag: Body. Default Font. Family: MyriaMM_565 SB 600 NO; Size: 14 pt; Angle: Regular; Weight: Regular; Color: Deep burgundy (R 40%, G 0%, B 30%); Pair Kern: Yes. Pagination. Start: Anywhere; Keep With: Next Pgf.

To introduce branches of individual procedures

H4. (¶ format) Basic. Indents: None; Alignment: Left; Space Above Pgf: 13.0 pt; Space Below Pgf: 7.0 pt; Line Spacing: 13.0 pt; Tab Stops: None; Next Pgf Tag: Body. Default Font. Family: MyriaMM_700 SB 600 NO; Size: 11 pt; Angle: Regular; Weight: Regular; Color: Deep burgundy (R 40%, G 0%, B 30%); Pair Kern: Yes. Pagination. Start: Any-where; Keep With: Next Pgf.

To introduce minor subdivisions

H5. (¶ format) Basic. Indents: None; Alignment: Left; Space Above Pgf: 7.0 pt; Space Below Pgf: 0.0 pt; Line Spacing: 12.0 pt; Tab Stops: None; Next Pgf Tag: Body. Default Font. Family: MyriaMM_565 SB 600 NO; Size: 10 pt; Angle: Regular; Weight: Regular; Color: Black; Pair Kern: Yes. Pagination. Start: Anywhere; Keep With: Next Pgf.


Chapter 4: Body (chapters) design › Displaying section-level procedures

28

Standard paragraph formats

Body. (¶ format) Basic. Indents: None; Alignment: Left; Space Above Pgf: 7.0 pt; Space Below Pgf: 0.0 pt; Line Spacing: Single, Fixed; Tab Stops: None; Next Pgf Tag: None. Default Font. Family: MinioMM; Size: 10 pt; Angle: Regular; Weight: Regular; Pair Kern: Yes. Pagination. Start: Anywhere; Keep With: None; Widow/Orphan Lines: 2.

BodyHalfSpace. (Body ¶ format +) Use to add a half-space line between two other lines. Basic. Line Spacing: 0.0 pt.

QuarterSpace. (Body ¶ format +) Use to add a quarter-space line between two other lines. Basic. Space Above Pgf: 3.5 pt; Line Spacing: 0.0 pt.

BodyKeepTogether. (Body ¶ format +) Use to keep lines of paragraph together on one page (max. 20 lines). Pagination. Widow/Orphan Lines: 20.

BodyKeepWithNext. (Body ¶ format +) Use to keep lines of paragraph together on one page (max. 20 lines). Pagination. Keep With: Next Pgf; Widow/Orphan Lines: 10.

Indented1. (Body ¶ format +) Basic. First Indent: 0.200”; Left Indent: 0.200”; Space Above Pgf: 4.0 pt; Space Below Pgf: 0.0 pt; Line Spacing, Fixed: Single; Tab Stops: None; Next Pgf Tag: None.

All indented styles have “KeepWithNext” variant, e.g., IndentedKeepWithNext1. Pagination. Widow/Orphan Lines: 7.

Indented2. (Indented1 ¶ format +) Basic. First Indent: 0.400”; Left Indent: 0.400”; Next Pgf Tag: None.



List1. (¶ format) Basic. Left indent: 1.200”; Alignment: Left; Space Above Pgf: 7.0 pt; Space Below Pgf: 0.0 pt; Line Spacing: Single, Fixed; Tab Stops: At 1.200”; Next Pgf Tag: None. Default Font. Family: MinioMM; Size: 10 pt; Angle: Regular; Weight: Regular; Pair Kern: Yes. Pagination. Start: Anywhere; Keep With: None.

List1Cont. (List ¶ format +) Basic. First indent: 1.200”

• List1Bulleted. (List ¶ format +) Basic. First indent: 1.210”; Left indent: 1.400”; Tab Stops: At 1.400”.

Design Guide 4.00 for ManualsChapter 4: Body (chapters) design › Standard paragraph formats

List2. (List ¶ format +) Basic. Left indent: 2.000”; Tab Stops: At 2.000”.

List2Cont. (List2 ¶ format +) Basic. First indent: 2.000”.


Chapter 4: Body (chapters) design › Standard paragraph formats

30

Special paragraph formats

xFormula (¶ format). Used for formulas, as in the following example:Previous Balance Forward (of accounts receivable)

+ Charges– Credits= Balance Forward (of accounts receivable)

Basic. First indent: 0.200”; Left indent: 0.375”; Alignment: Left; Space Above Pgf: 3.0 pt; Space Below Pgf: 0.0 pt; Line Spacing: 10.0 pt, Fixed; Tab Stops: 0.375” L; Next Pgf Tag: xFormula. Default Font. Family: MinioMM; Size: 10 pt; Angle: Regular; Weight: Regular; Pair Kern: Yes. Pagination. Start: Anywhere; Keep With: None.

LongListTitle (¶ format). Used for titles in long reference lists, as in the following example: LongListTitle

Basic. First indent: 0.000”; Left indent: 0.000”; Alignment: Left; Space Above Pgf: 0.0 pt; Space Below Pgf: 0.0 pt; Line Spacing: 8.0 pt, Fixed; Tab Stops: default; Next Pgf Tag: LongList. Default Font. Family: MyriaMM; Size: 8 pt; Angle: Regular; Weight: Regular; Color: Deep Burgundy; Pair Kern: Yes. Pagination. Start: Anywhere; Keep With: None.

LongListTitleIndented (LongListTitle ¶ format +). LongListTitleIndented

Basic. First indent: 0.200”; Left indent: 0.200”; Tab Stops: 0.200”; Next Pgf Tag: LongListIndented.

LongList (¶ format). Used for long reference lists, as in the following example: LongList

Basic. First indent: 0.000”; Left indent: 0.000”; Alignment: Left; Space Above Pgf: 0.0 pt; Space Below Pgf: 0.0 pt; Line Spacing: 8.0 pt, Fixed; Tab Stops: default; Next Pgf Tag: LongList. Default Font. Family: MinioMM; Size: 7 pt; Angle: Regular; Weight: Regular; Color: Black; Pair Kern: Yes. Pagination. Start: Anywhere; Keep With: None.

LongListIndented (LongList ¶ format +). Used for long reference lists, as in the follow-ing example:

LongListIndented

Basic. First indent: 0.200”; Left indent: 0.200”; Tab Stops: 0.200”; Next Pgf Tag: LongListIndented.

Design Guide 4.00 for ManualsChapter 4: Body (chapters) design › Special paragraph formats

Enumerated procedures

All enumerated styles have “KeepWithNext” variant, e.g., EnumeratedKeepWithNext1. Pagination. Widow/Orphan Lines: 7.

1. Enumerated1. (¶ format) Basic. First Indent: 0.000”; Left Indent: 0.200”; Space Above Pgf: 4.0 pt; Space Below Pgf: 0.0 pt; Line Spacing: 12.0 pt, Fixed; Tab Stops: 0.200” L; Next Pgf Tag: EnumeratedCont. Default Font. Family: MinioMM; Size: 10 pt; Angle: Regular; Weight: Regular; Pair Kern: Yes. Pagination. Start: Anywhere; Keep With: None. Numbering. Autonumber Format: S:<n=1>.\t.

2. Enumerated1Cont. (Enumerated1 ¶ format +) Numbering. Autonumber Format: S:<n+>.\t.

A. Enumerated1A. (Enumerated1 ¶ format +) Numbering. Autonumber Format: L:<A=1>.\t; Character Format: BodyTitle.

B. Enumerated1ContA. (Enumerated1A ¶ format +) Numbering. Autonumber For-mat: L:<A+>.\t.

Enumerated1Text. Use Indented.

a) Enumerated2. (Enumerated1 ¶ format +) Basic. First Indent: 0.200”; Left Indent: 0.400”; Tab Stops: 0.400” L; Next Pgf Tag: Enumerated2Cont. Number-ing. Autonumber Format: V:<a=1>)\t

b) Enumerated2Cont. (Enumerated2 ¶ format +) Numbering. Autonumber For-mat: V:<a+>)\t.

Enumerated2Text. Use Indented2.

1) Enumerated3. (Enumerated1 ¶ format +) Basic. First Indent: 0.400”; Left Indent: 0.600”; Tab Stops: 0.600” L; Next Pgf Tag: Enumerated3Cont. Num-bering. Autonumber Format: U:(<n=1>)\t.

2) Enumerated3Cont. (Enumerated3 ¶ format +) Numbering. Autonumber Format: U:(<n+>)\t.

Enumerated3Text. Use Indented3.

The Autonumber format series label

The Autonumber format series label (the first letter in the format code) should always be a unique letter for each format:

S = Enumerated1; L = Enumerated1A; V = Enumerated2; U = Enumerated3N = NoteEnumerated1; O = NoteEnumerated2; T = TableTitle


Chapter 4: Body (chapters) design › Enumerated procedures

32

Bulleted lists

All bulleted styles have “KeepWithNext” variant, e.g., BulletedKeepWithNext1. Pagination. Widow/Orphan Lines: 7.

• Bulleted1. (¶ format) Basic. First Indent: 0.010”; Left Indent: 0.200”; Space Above Pgf: 4.0 pt; Space Below Pgf: 0.0 pt; Line Spacing: 12.0 pt, Fixed; Tab Stops: 0.200” L; Next Pgf Tag: None. Default Font. Family: MinioMM; Size: 10 pt; Angle: Regular; Weight: Regular; Pair Kern: Yes. Pagination. Start: Anywhere; Keep With: None. Numbering. Autonumber Format: \b\t; Character Format: BodyBold.

Bulleted1Text. Use Indented1.

• Bulleted2. (Bulleted ¶ format +) Basic. First Indent: 0.210”; Left Indent: 0.400”; Tab Stops: 0.400” L; Next Pgf Tag: None.

Bulleted2Text. Use Indented2.


Bulleted3Text. Used Indented3


Bulleted4Text. Used Indented4

ZaphBoxed1. (Bulleted ¶ format +) Numbering. Autonumber Format: “o ”(o + one space); Character Format: ZaphDingbats.

ZaphBoxed2. (Bulleted2 ¶ format +) Numbering. Autonumber Format: “o ”(o + one space); Character Format: ZaphDingbats.

Design Guide 4.00 for ManualsChapter 4: Body (chapters) design › Bulleted lists

Character formats

There are two categories of character formats: general and documentation conventions.

General character formats

Appendix. (ƒ format) [SAMPLE] Font. Family: MyriaMM_565 SB 600 NO; Size: 14 pt; Angle: Regular; Weight: Regular; Color: Deep blue (R 8%, G 4%, B 40%); Small Caps: Yes; Pair Kern: Yes.

BodyBold. (ƒ format) [Sample] Font. Family: MinioMM_578 BD 585 NO 11 OP; Size: As Is; Angle: Italic; Weight: Regular; Pair Kern: Yes.

BodyBoldItalic. (ƒ format) [Sample] Font. Family: MinioMM_578 BD 585 NO 11 OP; Size: As Is; Angle: Regular; Weight: Regular; Pair Kern: Yes.

BodyTitle. (ƒ format) [Sample] Font. Family: MyriaMM_565 SB 600 NO; Size: As Is; Angle: Regular; Weight: Regular; Pair Kern: Yes.

Callout. (ƒ format) [Sample] Font. Family: MyriaMM; Size: 9.0 pt; Angle: Regular; Weight: Regular; Color: Deep blue (R 8%, G 4%, B 40%); Pair Kern: Yes.

CalloutBold. (ƒ format) [Sample] Font. Family: MyriaMM_565 SB 600 NO; Size: 9.0 pt; Angle: Regular; Weight: Regular; Color: Deep blue (R 8%, G 4%, B 40%); Pair Kern: Yes.

DeepBlue. (ƒ format) [Sample] Font. Family: As Is; Size: As Is; Angle: As Is; Weight: As Is; Variation: As Is; Color: Deep blue; Pair Kern: Yes.

Emphasis. (ƒ format) [Sample] Font. Family: As Is; Size: As Is; Angle: Italic; Weight: As Is; Variation: As Is; Color: As Is; Pair Kern: Yes.

EquationVariables. (ƒ format) [Sample] Font. Family: As Is; Size: As Is; Angle: Italic; Weight: As Is; Variation: As Is; Color: As Is; Pair Kern: Yes.

Footer. (ƒ format) [Sample] Font. Family: MyriaMM; Size: 8.0 pt; Angle: Regular; Weight: Regular; Color: Deep blue; Pair Kern: Yes.

Hypertext. (ƒ format) [Sample] Font. Family: MinioMM; Size: As Is; Angle: Regular; Weight: Regular; Color: Deep blue (R 8%, G 4%, B 40%); Underlined: Yes; Pair Kern: Yes.

IntroHint. (ƒ format) [Sample] Font. Family: MyriaMM_565 SB 600 NO; Size: 10.0 pt; Angle: Italic; Weight: Regular; Color: Deep burgundy (R 50%, G 0%, B 30%); Pair Kern: Yes.


Chapter 4: Body (chapters) design › Character formats

34

IntroImportant. (ƒ format) [Sample] Font. Family: MyriaMM_565 SB 600 NO; Size: 10.0 pt; Angle: Italic; Weight: Regular; Color: Deep red (R 55%, G 0%, B 0%); Pair Kern: Yes.

IntroNote. (ƒ format) [Sample] Font. Family: MyriaMM_565 SB 600 NO; Size: 10.0 pt; Angle: Italic; Weight: Regular; Color: Deep blue (R 8%, G 4%, B 40%); Pair Kern: Yes.

IntroSpeedHint. (ƒ format) [Sample] Font. Family: MyriaMM_565 SB 600 NO; Size: 10.0 pt; Angle: Italic; Weight: Regular; Color: Deep green (R 0%, G 20%, B 0%); Pair Kern: Yes.

LongList. (ƒ format) [Sample] Font. Family: MinioMM; Size: 8.0 pt; Angle: Regular; Weight: Regular; Color: Black; Pair Kern: Yes.

PageNumber. (ƒ format) [123] Font. Family: MyriaMM_565 SB 600 NO; Size: 9.0 pt; Angle: Regular; Weight: Regular; Color: Black; Pair Kern: Yes.

Squeezed[90, 92.5, 95, 97.5]. (ƒ format) [Sample90] Font. Family: As Is; Size: As Is; Angle: As Is; Weight: As Is; Color: As Is; Stretch: [90, 92.5, 95, 97.5]%; Pair Kern: Yes.

Superscript. (ƒ format) [Sample] Font. Family: As Is; Size: As Is; Angle: As Is; Weight: As Is; Color: As Is; Superscript: Yes; Pair Kern: Yes.

TypedEntry. (ƒ format) [Sample] Font. Family: Courier New; Size: 9.0 pt; Angle: Reg-ular; Weight: Regular; Pair Kern: No.

Underline. (ƒ format) [Sample] Font. Family: As Is; Size: As Is; Angle: As Is; Weight: As Is; Color: As Is; Underline: Yes; Pair Kern: Yes.

Whiteout. (ƒ format) [Sample] Font. Family: As Is; Size: As Is; Angle: As Is; Weight: As Is; Color: White; Pair Kern: Yes. Used to white out the colon and chapter or appendix name that follows the chapter number or appendix letter at the top of each chapter or appendix.

Wingdings. (ƒ format) [ ] Font. Family: Wingdings; Size: 10.0 pt; Angle: Regular; Weight: Regular; Pair Kern: No.

WingdingsBold. (ƒ format) [ ] Font. Family: Wingdings; Size: 10.0 pt; Angle: Regular; Weight: Bolded; Pair Kern: No.

ZaphDingbats. (ƒ format) [ ] Font. Family: Wingdings; Size: 8.0 pt; Angle: Regular; Weight: Regular; Stretch: 80.0%; Pair Kern: No. (I know, but I couldn’t get ZaphDingbats to work with the printer after I had applied the style all over the place.)

Design Guide 4.00 for ManualsChapter 4: Body (chapters) design › Character formats

Documentation convention character styles

For future use. Currently, all are the same as BodyBold.

CommandBtn. (ƒ format) [Sample] Font. Family: MinioMM_578 BD 585 NO 11 OP; Size: As Is; Angle: Regular; Weight: Regular; Pair Kern: Yes.

DialogBoxTitle. (ƒ format) [Sample] Font. Family: MinioMM_578 BD 585 NO 11 OP; Size: As Is; Angle: Regular; Weight: Regular; Pair Kern: Yes.

FieldLabel. (ƒ format) [Sample] Font. Family: MinioMM_578 BD 585 NO 11 OP; Size: As Is; Angle: Regular; Weight: Regular; Pair Kern: Yes.

FormName. (ƒ format) [Sample] Font. Family: MinioMM_578 BD 585 NO 11 OP; Size: As Is; Angle: Regular; Weight: Regular; Pair Kern: Yes.

HeadBullet. (ƒ format) [Sample] Font. Family: MinioMM_578 BD 585 NO 11 OP; Size: As Is; Angle: Regular; Weight: Regular; Pair Kern: Yes.

KeyName. (ƒ format) [Sample] Font. Family: MinioMM_578 BD 585 NO 11 OP; Size: As Is; Angle: Regular; Weight: Regular; Pair Kern: Yes.

MenuCommand. (ƒ format) [Sample] Font. Family: MinioMM_578 BD 585 NO 11 OP; Size: As Is; Angle: Regular; Weight: Regular; Pair Kern: Yes.

MenuName. (ƒ format) [Sample] Font. Family: MinioMM_578 BD 585 NO 11 OP; Size: As Is; Angle: Regular; Weight: Regular; Pair Kern: Yes.

MenuSubName. (ƒ format) [Sample] Font. Family: MinioMM_578 BD 585 NO 11 OP; Size: As Is; Angle: Regular; Weight: Regular; Pair Kern: Yes.

TabName. (ƒ format) [Sample] Font. Family: MinioMM_578 BD 585 NO 11 OP; Size: As Is; Angle: Regular; Weight: Regular; Pair Kern: Yes.

TreeFolderName. (ƒ format) [Sample] Font. Family: MinioMM_578 BD 585 NO 11 OP; Size: As Is; Angle: Regular; Weight: Regular; Pair Kern: Yes.

TreeFolderSubName. (ƒ format) [Sample] Font. Family: MinioMM_578 BD 585 NO 11 OP; Size: As Is; Angle: Regular; Weight: Regular; Pair Kern: Yes.

TreeItemName. (ƒ format) [Sample] Font. Family: MinioMM_578 BD 585 NO 11 OP; Size: As Is; Angle: Regular; Weight: Regular; Pair Kern: Yes.

WindowName. (ƒ format) [Sample] Font. Family: MinioMM; Size: As Is; Angle: Regular; Weight: Regular; Pair Kern: Yes.

WizardName. (ƒ format) [Sample] Font. Family: MinioMM; Size: As Is; Angle: Regular; Weight: Regular; Pair Kern: Yes.


Chapter 4: Body (chapters) design › Character formats

36

Notes

To introduce a note into the document, you must first insert a Note table. The table opens with the introductory term “Note:” pre-filled. The cursor is pre-positioned to the beginning of the note text.

There are several special note paragraph formats available, as described in the following notes. Once you have inserted a Note table, you can covert it to a note of type Impor-tant, Hint, or Speed hint by choosing the appropriate paragraph format (“Note2 Impor-tant,” “Note3 Hint,” or “Note4 Speed hint”).

Notes are tagged to the preceding paragraph. The tag will inserted wherever your cur-sor is positioned when you choose Table > Insert Table, so it is best to insert a table with your cursor positioned after the final period of a paragraph.

Note. (Table format). Basic. Indents: None; Space Above: 12.0 pt; Space Below: 12.0 pt; Top Cell Margin: 12.0 pt; Bottom Cell Margin: 9.0 pt; Alignment: Left; Start: Anywhere; Numbering: Row First; Title Position: No Title; Orphan Rows: 1. Ruling. Column Ruling: None; Body Row Ruling: None; Heading and Footing Ruling: None; Outside Top Ruling: Very Thin; Outside Bottom Ruling: Very Thin; Outside Left and Right Ruling: None. Shading. Heading and Footing Shading: None; Body Shading Shade By: Body Row; Body Shading First: 1, Fill: 100%, Color: 05% Gray. Next: None.

NoteNoAbove. (Note Table format +). Basic. Space Above: 0.0 pt

IntroNote. (ƒ format) [Sample] Font. Family: MyriaMM_565 SB 600 NO; Size: As Is; Angle: Italic; Weight: Regular; Color: Deep blue (R 8%, G 4%, B 40%); Pair Kern: Yes.

IntroImportant. (ƒ format) [Sample] Font. Family: MyriaMM_565 SB 600 NO; Size: As Is; Angle: Italic; Weight: Regular; Color: Deep red (R 55%, G 0%, B 0%); Pair Kern: Yes.

IntroHint. (ƒ format) [Sample] Font. Family: MyriaMM_565 SB 600 NO; Size: As Is; Angle: Italic; Weight: Regular; Color: Deep burgundy (R 50%, G 0%, B 30%); Pair Kern: Yes.

IntroSpeedHint. (ƒ format) [Sample] Font. Family: MyriaMM_565 SB 600 NO; Size: As Is; Angle: Italic; Weight: Regular; Color: Deep green (R 0%, G 20%, B 0%); Pair Kern: Yes.

Important! The note tables are formatted as one-row tables, so notes cannot be larger than one page in length, which anyway is a good design guideline.

Design Guide 4.00 for ManualsChapter 4: Body (chapters) design › Notes

Tag paragraph. This is the paragraph that the following four tables are tagged to. The icons are stored on the first Reference page (ESC v R), in preformatted anchored frames. Make sure you click on the frame (not on the tiff inside the frame), and then copy it. Return to the body pages (ESC v B), place your insertion point after the note introduction phrase, and then paste the anchored frame. It will be positioned correctly.

The “Notex” titles make cross-referencing much easier, because you can search on that specific paragraph style, rather than looking through all notes and try-ing to pick out the correct starting text.

NotexTitle. (Note1Note ¶ format +) Default Font. Family: MyriaMM_565 SB 600 NO; Size: 10.0 pt; Angle: Italic; Weight: Regular; Color: Deep Blue (R 8%, G

Note: Note1Note. (¶ format) Basic. First indent: 0.200”; Left indent: 0.200”; Fight indent: 0.200”; Alignment: Left; Space Above Pgf: 7.0 pt; Space Below Pgf: 0.0 pt; Line Spacing: 13.0 pt, Fixed; Tab Stops: None;

Next Pgf Tag: NoteCont. Default Font. Family: MinioMM; Size: 10 pt; Angle: Regular; Weight: Regular; Pair Kern: Yes. Pagination. Start: Anywhere; Keep With: None. Numbering. Autonumber Format: Note:\sn; Character Format: NoteIntro; Position: Start of Paragraph.

NotexTitle: Notes with custom titles.

Important! Note2Important. (Note1Note ¶ format +) Numbering. Autonumber Format: Important!\sn.

NotexTitleImportant: Important notes with custom titles

Hint › Note3Hint. (Note1Note ¶ format +) Numbering. Autonum-ber Format: Hint \)\sn.

NotexTitleHint: Hint notes with custom titles

Speed hint ››› Note4Speed hint. (Note1Note ¶ format +) Number-ing. Autonumber Format: Speed hint \)\)\)\sn.

NotexTitleSpeed: Speed hint notes with custom titles


Chapter 4: Body (chapters) design › Notes

38

4%, B 40%); Pair Kern: Yes.

NotexTitleImportant. (NotexTitle ¶ format +) Default Font. Color: Deep Red (R 55%, G 0%, B 0%).

NotexTitleHint. (NotexTitle ¶ format +) Default Font. Color: Deep Burgundy (R 50%, G 0%, B 30%).

NotexTitleSpeed. (NotexTitle ¶ format +) Default Font. Color: Deep Green (R 0%, G 20%, B 0%).

Note: Other note body styles:

NoteCont. (Note1Note ¶ format +) Basic. Space Above Pgf: 4.0 pt. Pagination. Keep With: Previous Pgf. Numbering. Autonumber For-

mat: None.

1. NoteEnumerated1. (Enumerated1 ¶ format +) Basic. First Indent: 0.200”; Left Indent: 0.400”; Right Indent: 0.200”; Tab Stops: 0.400” L; Next Pgf Tag: NoteEnumberated1Cont. Pagination. Keep With: Previous Pgf. Number-ing. Autonumber Format: N:<n=1>.\t.

2. NoteEnumerated1Cont. (NoteEnumerated1 ¶ format +) Numbering. Autonumber Format: N:<n+>.\t.

a. NoteEnumerated2. (Enumerated2 ¶ format +) Basic. First Indent: 0.400”; Left Indent: 0.600”; Tab Stops: 0.400” L; Next Pgf Tag: NoteEnumberated2Cont. Pagination. Keep With: Previous Pgf. Num-bering. Autonumber Format: O:<a=1>.\t.

b. NoteEnumerated2Cont. (NoteEnumerated1 ¶ format +) Numbering. Autonumber Format: O:<a+>.\t.

• NoteBulleted. (Bulleted2 ¶ format +) Basic. First Indent: 0.210”; Right Indent: 0.200”; Next Pgf Tag: None. Pagination. Keep With: Previous Pgf.

NoteTxt. (Indent2 ¶ format +) Basic. Right Indent: 0.200”; Next Pgf Tag: None. Pagination. Keep With: Previous Pgf.

• NoteBulleted2. (Bulleted3 ¶ format +) Basic. First Indent: 0.410”; Right Indent: 0.200”; Next Pgf Tag: None. Pagination. Keep With: Previous Pgf.

NoteTxt2. (Indent3 ¶ format +) Basic. Right Indent: 0.200”; Next Pgf Tag: None. Pagination. Keep With: Previous Pgf.

Design Guide 4.00 for ManualsChapter 4: Body (chapters) design › Notes

Cross-references

Which format should you use?

Always choose the cross-reference format that gives you the most link text possible.

ABC (x-ref format) [A B C ] Format: <BodyTitle><$paratext><Default ¶ Font>. Note: Three spaces follow term. Use for glossaries.

Adv. (x-ref format) [Cross-references. Page 39. ] Format: <BodyTitle><$paratext><Default ¶ Font>. Page <$pagenum[paratag]>. Note: Space follows final period.

Adv? (x-ref format) [Which format should you use? Page 39. ] Format: <BodyTitle><$paratext><Default ¶ Font> Page <$pagenum[paratag]>. Note: Space follows final period.

Appendix heading & np. (x-ref format) [Appendix A: Getting help on page 55]Format: <Emphasis>Appendix <$chapnum>: <$paratext><Default ¶ Font> on page\ <$pagenum>.

Bullet. (x-ref format) [Cross-references (page 39)]Format: <Default ¶ Font><$paratext> (page\ <$pagenum>)

BulletBold. (x-ref format) [Cross-references (page 39)]Format: <BodyBold><$paratext> <Default ¶ Font>(page\ <$pagenum>)

BulletEmphasis. (x-ref format) [Cross-references (page 39)]Format: <BodyEmphasis><$paratext> <Default ¶ Font>(page\ <$pagenum>)

BulletTitled. (x-ref format) [Cross-references (page 39)]Format: <BodyTitle><$paratext> <Default ¶ Font>(page\ <$pagenum>)

Fmi, see [heading] on [page]. (x-ref format) [For more information, see Cross-refer-ences on page 39.]Format: For more information, see <Emphasis><$paratext><Default ¶ Font> on page\ <$pagenum>.

Fmi, see Appendix [heading] on [page]. (x-ref format) [For more information, see Appendix A: Getting help on page 55.]Format: For more information, see <Emphasis>Appendix <$chapnum>: <$para-text><Default ¶ Font> on page\ <$pagenum>.


Chapter 4: Body (chapters) design › Cross-references

40

Fmi, see the note [NoteTitle] on [page]. (x-ref format) [For more information, see the note Cross references to notes with custom titles on page 41.]Format: For more information, see the note <Emphasis><$paratext><Default ¶ Font> on page\ <$pagenum>.

Heading. (x-ref format) [Cross-references]Format: <Emphasis><$paratext><Default ¶ Font>

Heading & Page np (x-ref format) [Cross-references on page 39]Format: <Emphasis><$paratext><Default ¶ Font> on page\ <$pagenum>

Heading (page) np (x-ref format) [Cross-references (page 39)]Format: <Emphasis><$paratext><Default ¶ Font> (page\ <$pagenum>)

Page. (x-ref format) [page 39]Format: page\ <$pagenum>

PenUsers: see heading & page. (x-ref format) [Pen users › see Cross-references on page 39]Format: <IntroNote>Pen users \)<Default ¶ Font> see <Emphasis><$para-text><Default ¶ Font> on page\ <$pagenum>

Preheading. (x-ref format) [Cross-references]Format: <$paratext>. Designed for hidden chapter and appendix heading that follow the chapter number or appendix letter at the top of each chapter or appendix. This is necessary to integrate chapter numbers and appendix letters in both the TOC and the bookmarks of the PDF-version of the book.

See also Heading & Page np. (x-ref format) [See also Cross-references on page 39] Format: See also <Emphasis><$paratext><Default ¶ Font> on page\ <$pagenum>

see also Heading & Page np. (x-ref format) [see also Cross-references on page 39] Format: see also <Emphasis><$paratext><Default ¶ Font> on page\ <$pagenum>

See Heading & Page np. (x-ref format) [See Cross-references on page 39]Format: See <Emphasis><$paratext><Default ¶ Font> on page\ <$pagenum>

see Heading & Page np. (x-ref format) [see Cross-references on page 39]Format: see <Emphasis><$paratext><Default ¶ Font> on page\ <$pagenum>.

Table All. (x-ref format) [Table : Generic table on page 50]Format: <Emphasis>Table\ <$paranumonly>: <$paratext><Default ¶ Font> on page\ <$pagenum>. Designed for use with numbered tables only.

Design Guide 4.00 for ManualsChapter 4: Body (chapters) design › Cross-references

Table Number & Page. (x-ref format) [Table on page 50] Format: <Emphasis>Table\ <$paranumonly>: <$paratext><Default ¶ Font> on page\ <$pagenum>. Designed for use with numbered tables only.

Cross references to notes with custom titles

This note has a custom title, which makes it a perfect candidate for cross references.


Chapter 4: Body (chapters) design › Cross-references

42

Graphics

Graphics are primarily formatted using:

1. The screen capture software settings.

Graphics are positioned using:

1. Special › Anchored Frame settings.

2. Paragraph formats applied to the paragraph to which the graphic is attached.

3. If they are attached to a paragraph in a table, the table formats.

To set a screen capture’s dpi

This procedure presumes the use of SnagIt:

1. On the Filters menu, choose Image Resolution.

2. Clear the Auto Configuration check box.

3. Set the resolution to a dpi (dots per inch) level that will produce the size graphic you need. Samples of graphic sizes at various dpi settings follow.

Note: All of the graphics in this document have a 0.5 pt black border (except the note icons, which have a 1.0 pt border). This can be set using the Tools palette (Pen pattern: Solid; Line width: 0.5 pt; Line

ends: No arrows; Line style: Solid line; Color: Black; Tint: 100%.), or through the Graphics > Object Properties dialog (Color: Black; Tint: 100%, Overprint: From Color; Angle: 0.0; Border Width: 0.5 pt.).

Design Guide 4.00 for ManualsChapter 4: Body (chapters) design › Graphics

Graphic paragraphs

Graphic1. Applies to following paragraph, to which the graphic is attached. (Graphic format) Captured as an uncompressed RBG tiff at 96 dpi; imported at 96 dpi (100% original size). (Frame format) Anchored Frame. Anchoring Position: At Insertion Point; Shrink-wrapped (ESC m p). (¶ format) Basic. Indents: None; Alignment: Left; Space Above Pgf: 7.0 pt; Space Below Pgf: 0.0 pt; Line Spacing: Single; Tab Stops: None; Next Pgf Tag: Body. Pagination. Start: Anywhere; Keep With: Previous Pgf.

Graphic2. Applies to following paragraph, to which the graphic is attached. (Graphic format) Captured as an uncompressed RBG tiff at 150 dpi; imported at 150 dpi (40% original size). (Frame format) Anchored Frame. Anchoring Position: At Insertion Point; Shrink-wrapped (ESC m p). (Body ¶ format+) Basic. First indents: 0.200”; Left indents: 0.200”; Next Pgf Tag: Body. Pagination. Start: Anywhere; Keep With: Previous Pgf.


Chapter 4: Body (chapters) design › Graphics

44

Graphic3. Applies to this paragraph, to which the graphic is attached. The text will runaround the right side and then wrap to the left margin, once a sentence is more than 12.0 points below the graphic. (Graphic format) Captured as an uncompressed RBG tiff at 225 dpi. Imported at 225 dpi (18% original). (Frame format) Anchored Frame. Anchoring Position: Run into

Paragraph; Alignment: Left; Gap: 12.0 pt; Shrink-wrapped (ESC m p). (Body ¶ for-mat+) Basic. Next Pgf Tag: Body. Pagination. Start: Anywhere; Keep With: None.

Graphic4. Applies to this paragraph, to which the graphic is attached. The text will runaround the right side and then wrap to the left margin, once a sentence is more than 12.0 points below the graphic. (Graphic format) Captured as an uncompressed RBG tiff at 300 dpi. Imported at 300 dpi (10% original size). (Frame

format) Anchored Frame. Anchoring Position: Run into Paragraph; Alignment: Left; Gap: 12.0 pt; Shrink-wrapped (ESC m p). (Body ¶ format+) Basic. First indents: 0.200”; Left indents: 0.200”; Next Pgf Tag: Body. Pagination. Start: Any-where; Keep With: None.

Graphic5. Applies to this paragraph, to which the graphic is attached. The text will runaround the right side and then wrap to the left margin, once a sentence is more than 12.0 points below the graphic. (Body ¶ format+) Basic. First indents: 0.400”; Left indents: 0.400”; Next Pgf Tag: Body.

Pagination. Start: Anywhere; Keep With: None.

Graphic6. Applies to this paragraph, to which the graphic is attached. The text will run-around the right side and then wrap to the left margin, once a sentence is more than 12.0 points below the graphic. (Body ¶ format+) Basic. First indents: 0.600”; Left indents: 0.600”;

Next Pgf Tag: Body. Pagination. Start: Anywhere; Keep With: None.


Graphic tables

Callout1. (Table format) Size: 2 columns, 1 row. ¶ format. Left cell: CellGraphic. Right cell: Callout. Basic. Space above: 7.0 pt; Space below: 12.0 pt; Alignment: Left; Start: Any-where; Title Position: No title. No ruling, no shading.

Callout1. (¶ format) Basic. First indent: 0.020”; Left indent: 0.020”; Right indent: 0.010”; Alignment: Left; Space Above Pgf: 3.0 pt; Space Below Pgf: 0.0 pt; Line Spacing: Single; Tab Stops: None; Next Pgf Tag: None. Default Font. Family: MyriaMM; Size: 8 pt; Angle: Regular; Weight: Regular; Pair Kern: Yes. Pagination. Start: Anywhere; Keep With: None. Table Cell. Cell Vertical Alignment: Middle.

Callout1. (Table format) Use to attach short callout text to a graphic. This graphic is attached to the paragraph in the left cell, which is formatted CellGraphic. This para-graph, containing the actual callout text, is formatted

Callout1. (¶ format) This paragraph, containing the actual callout text.

Hint › Initially, the Callout table splits the page in half; CTRL+click to select the left cell, then use SHFT+drag to change the width of the left cell without changing the overall width of the table.

When the graphic is placed in the cell, shrinkwrap it (ESC m p), The default Anchoring Position is “At Insertion Point.” This leaves a couple of points between the bottom of the graphic and the bottom of the table. If you want no space below the graphic, CTRL+click on the cell, and then set the Anchoring Position (Special > Anchored Frame) to “Run into Paragraph.”

To fine tune table spacing, use the Table Designer (CTRL+t), and change Default Cell Margins, Space Above/Below, or Indents, and then Apply to selec-tion. Do NOT Update All.

Hint › Callout text is vertically aligned “Middle” in the cell. It can be as long as needed (the table will grow in height). The graphic is verti-cally aligned “Top” in its cell. When the callout text grows longer than

the graphic’s height, visually it becomes vertically top aligned.



46

CellGraphic. (¶ format) Use for the paragraph in the table cell to which the graphic is attached. Basic. No indents, no spacing. Table Cell. Cell Vertical Alignment: Top

Callout2. (Table format) Size: 3 cols, 1 row. ¶ format. Left &middle cell: CellGraphic. Right cell: Callout. Left cell leaves the same amount of space as a single indent. Basic. Space above: 7.0 pt; Space below: 12.0 pt; Left Cell Margin: 15.0 pt; Alignment: Left; Start: Anywhere; Title Position: No title. No ruling, no shading.

Callout2. (¶ format) Basic. Indent: None; Space Above Pgf: 3.0 pt; Space Below Pgf: 0.0 pt; Line Spacing: Single; Tab Stops: None; Next Pgf Tag: None. Default Font. Family: MyriaMM; Size: 8 pt; Angle: Regular; Weight: Regular; Pair Kern: Yes. Pagination. Start: Anywhere; Keep With: None. Table Cell. Cell Vertical Alignment: Middle.

Graphic callouts

To create a graphic with callouts (the sample was captured as an uncompressed RBG tiff at 150 dpi, and imported at 125 dpi):

Callout2. (Table format) Use to attach short callout text to an indented graphic. This graphic is attached to the paragraph in the middle cell, which is format-ted CellGraphic.

Callout2. (¶ format) This paragraph, containing the actual callout text.

E

C

D

BA


1. Import the graphic at a resolution that leaves room for the callout lines and lettering or text.

2. Shrinkwrap it (ESC m p).

3. Adjust the text frame outward to create space for the callout elements.

4. Place the callout elements. There are sample elements that you can copy on the Reference pages (ESC v R). (One of the lettered callouts has a frame around it, and is designed for placement on top of the screen capture. It has a white background to help distinguish it from the underlining graphic.)

5. The callout elements—and the graphic itself—can be grouped together (ESC g g), but it is not necessary, because the entire text frame moves with the paragraph it is attached to.

6. When you are finished creating the callouts, shrinkwrap the text frame again.

Callout line. (Manually set line format). Pen pattern: Black; Line width: 0.5 pt; Line ends: No arrows; Line style: Solid line; Color: Deep burgundy; Tint: 100%. When the callout line travels across the screen capture, the color helps distinguish it from inter-face element lines in the PDF version of the manual.

CalloutBoxed. (¶ format) [Sample] Use for callout text that is floating over the screen capture. Basic. Indent: None; Space Above Pgf: 6.0 pt; Space Below Pgf: 0.0 pt; Line Spac-ing: Single; Alignment: Center; Tab Stops: None; Next Pgf Tag: None. Default Font. Family: MyriaMM; Size: 9 pt; Angle: Regular; Weight: Regular; Color: Deep blue; Pair Kern: Yes. Pagination. Start: Anywhere; Keep With: None.

CalloutEnumerated. (¶ format) [Sample] Use for callout text that is set next to the screen capture. Basic. Indent: None; Space Above Pgf: 6.0 pt; Space Below Pgf: 0.0 pt; Line Spacing: Single; Alignment: Left; Tab Stops: None; Next Pgf Tag: None. Default Font. Family: MyriaMM; Size: 9 pt; Angle: Regular; Weight: Regular; Color: Deep blue; Pair Kern: Yes. Pagination. Start: Anywhere; Keep With: None.

CalloutEnumeratedIndented. (CalloutEnumerated ¶ format +) [Sample] Basic. Indent: “0.12”; Tab Stops: “0.12.”

CalloutEnumeratedRight. (CalloutEnumerated ¶ format +) [Sample] Basic. Align-ment: Right.

CalloutEnumeratedHeading. (CalloutEnumerated ¶ format +) [Sample] Font. Fam-ily: MyriaMM_565 SB 600 NO.



48

Additional graphic samples

The following sample was captured as an uncompressed RBG tiff at 150 dpi, and imported at 125 dpi. This is the maximum size at which a module can be captured, and still leave room for callouts. (Just as an example, there is a boxed callout floating over this screen capture).

F


The following sample was captured as an uncompressed RBG tiff at 150 dpi, and imported at 175 dpi. This is the maximum size at which a full window can be captured, and still fit within our page margins.



50

Tables

In addition to the special tables for notes and graphics that have already been described, there is one additional generic table already formatted. It is meant as a template from which you can quickly build any needed tables.

Generic. (Table format) Size: 3 columns, 2 rows. Table title: TableTitle; Top row & Left column: CellHeading; Data cells: CellBody. Basic. Space above: 12.0 pt; Top & Bottom Cell Margins: 3.0 pt; Left Cell Margin: 0.0 pt; Right Cell Margin: 3.0 pt; Alignment: Left; Start: Anywhere; Title Position: Above Table; Title Gap: 6.0 pts. No ruling, no shading.

Generic bullet. (Generic table format +) Size: 2 columns, 1 row. Basic. Space above: 0.0 pt; Top Cell Margins: 6.0 pt; Bottom Cell Margin: 0.0 pt; Right Cell Margin: 3.0 pt; Title Position: No title.

GenericNT. (Generic table format +) Size: 1 col, 1 row. Basic. Space above: 7.0 pt.; Title Position: No title.

Note. (Table format) For more information, see Notes on page 36.

NoteNoAbove. (Table format) For more information, see Notes on page 36.

Callout1. (Table format) For more information, see Graphic tables on page 45.

Callout2. (Table format) For more information, see Graphic tables on page 45.

Generic table

CellHeading CellHeading CellHeading

CellHeading CellBody CellBody

Hint › Use the Table Designer to make any basic changes to the Table Title, ruling, and shading: Click in the table, open the Table Designer (CTRL+t), make changes, and then Apply changes to the table you

are working on. Do NOT Update All.

• Bulleted1 • Bulleted1

CellHeading CellBody

CellHeadingEP CellBodyEP

Design Guide 4.00 for ManualsChapter 4: Body (chapters) design › Tables

TableTitle. (¶ format) Basic. Indent: None; Space Above Pgf: 0.0 pt; Space Below Pgf: 0.0 pt; Line Spacing: Single; Tab Stops: None; Next Pgf Tag: None. Default Font. Family: MyriaMM_565 SB 600 NO; Size: 12 pt; Angle: Regular; Weight: Regular; Color: Deep blue; Pair Kern: Yes. Pagination. Start: Anywhere; Keep With: None. Table Cell. Cell Vertical Alignment: Middle.

CellHeading (¶ format) Basic. Indent: None; Space Above Pgf: 0.0 pt; Space Below Pgf: 0.0 pt; Line Spacing: Single; Tab Stops: None; Next Pgf Tag: None. Default Font. Family: MyriaMM_565 SB 600 NO; Size: 10 pt; Angle: Regular; Weight: Regular; Color: Black; Pair Kern: Yes. Pagination. Start: Anywhere; Keep With: None. Table Cell. Cell Vertical Alignment: Top.

CellBody (¶ format) Basic. Indent: None; Space Above Pgf: 4.0 pt; Space Below Pgf: 0.0 pt; Line Spacing: Single; Tab Stops: None; Next Pgf Tag: None. Default Font. Family: MinioMM; Size: 10 pt; Angle: Regular; Weight: Regular; Color: Black; Pair Kern: Yes. Pagination. Start: Anywhere; Keep With: None. Table Cell. Cell Vertical Alignment: Top.

CellHeadingEP (¶ format) Basic. Indent: None; Space Above Pgf: 0.0 pt; Space Below Pgf: 0.0 pt; Line Spacing: Single; Tab Stops: None; Next Pgf Tag: None. Default Font. Family: MyriaMM_565 SB 600 NO; Size: 8.0 pt; Angle: Regular; Weight: Regular; Color: DeepBlue; Pair Kern: Yes. Pagination. Start: Anywhere; Keep With: None. Table Cell. Cell Vertical Alignment: Top; Cell Margins: Top and Bottom: From Table Format, Plus: 2.0 pt; Left and Right: From Table Format, Plus: 3.0 pt.

CellBodyEP (¶ format) Basic. Indent: None; Space Above Pgf: 4.0 pt; Space Below Pgf: 0.0 pt; Line Spacing: Single; Tab Stops: None; Next Pgf Tag: None. Default Font. Family: MinioMM; Size: 8.0 pt; Angle: Regular; Weight: Regular; Color: Black; Pair Kern: Yes. Pagination. Start: Anywhere; Keep With: None. Table Cell. Cell Vertical Alignment: Top; Cell Margins: Top and Bottom: From Table Format, Plus: 2.0 pt; Left and Right: From Table Format, Plus: 3.0 pt.


Chapter 4: Body (chapters) design › Tables

52
Design Guide 4.00 for ManualsChapter 4: Body (chapters) design › Tables

Chapter 5: Back matter design

Back matter design

Appendices

Appendix A

Appendix titlesXAppendixH1Preheader. (xH1Preheader ¶ format +). Numbering. Autonumber Format: Appendix <$chapnum>.

xAppendixH1. (H1 ¶ format).


Chapter 5: Back matter design › Appendices

54

Index

Index heading (TitleIXH1)

Index group titles [A, B, C, etc.] (GroupTitlesIX)Level 1 index entries (Level1IX)

Level 2 index entries (Level2IX)

TitleIXH1. (H1 ¶ format)

GroupTitlesIX. (¶ format) Basic. Indents: None; Alignment: Left; Space Above Pgf: 7.0 pt; Space Below Pgf: 0.0 pt; Line Spacing: Single line, Fixed; Tab Stops: None; Next Pgf Tag: None. Default Font. Family: MyriaMM_700 BD 600 NO; Size: 12 pt; Angle: Regu-lar; Weight: Regular; Color: Deep burgundy (R 40%, G 0%, B 30%); Pair Kern: Yes. Pag-ination. Start: Anywhere; Keep With: Next Pgf.

Level1IX. (¶ format) Basic. Indents: None; Alignment: Left; Space Above Pgf: 7.0 pt; Space Below Pgf: 0.0 pt; Line Spacing: Single line, Fixed; Tab Stops: None; Next Pgf Tag: None. Default Font. Family: MinioMM; Size: 10 pt; Angle: Regular; Weight: Regular; Color: Black; Pair Kern: Yes. Pagination. Start: Anywhere; Keep With: Next Pgf.

Level2IX. (¶ format) Basic. First indent: 0.200”; Left indent: 0.400”;None; Alignment: Left; Space Above Pgf: 7.0 pt; Space Below Pgf: 0.0 pt; Line Spacing: Single line, Fixed; Tab Stops: None; Next Pgf Tag: None. Default Font. Family: MinioMM; Size: 10 pt; Angle: Regular; Weight: Regular; Color: Black; Pair Kern: Yes. Pagination. Start: Any-where; Keep With: Next Pgf.

Design Guide 4.00 for ManualsChapter 5: Back matter design › Index

Appendix A: Getting help

Getting helpIn User’s Guides, the first appendix should address how the customer can get support.

In Administrator’s Guides, the first appendix should address how they can take charge of maintaining their system.

About your support contract

This appendix has been placed in the Design Guide simply to preserve FirstAppendix formatting.


Appendix A: Getting help › About your support contract

56
Design Guide 4.00 for ManualsAppendix A: Getting help › About your support contract

Appendix B: What’s new?

What’s new?(This appendix should always be the last one.)

This appendix outlines many of the new or changed sections in this version of the man-ual. While many of the features that are discussed are new, some of the sections are sim-ply new or revised descriptions of existing features.

Version 4.00

Optional H3: Revision 2 for service pack 2

Optional text: This revision includes new material addressing service pack 2 changes, as well as corrections to the original 3.00 manual.

Creating a new book (page 1). This section has been updated and expanded. We are now using four template files for chapters and appendices: FirstChapter, Additional-Chapters, XFirstAppendix, and XAdditionalAppendices. This makes it easier to create books with the correct (new) chapter numbering and appendix lettering.

Left/right master pages (page 10) and Other master pages (page 12). These sec-tions have been updated to reflect the standalone page numbers and new, expanded footers, which now include:

• Line 1: ProductName Version# GuideName

• Line 2 (table of contents): Contents

• Line 2 (chapters and appendices): Chapter or Appendix number: Heading 1 › Head-ing 2

• Line 2 (index): Index: Group Title

Printed book (page 15). This section has an updated table of the paragraphs that should be included in the PDF as bookmarks, as well as their new bookmark levels.

Online book (page 16). For maximum usability, we should now add the chapter or appendix heading text to the chapter or appendix number bookmarks.

Title page (page 17). The title page has been redesigned.

Body (chapters) design (page 25). A chapter number preheader paragraph format has been added.


Appendix B: What’s new? › Version 4.00

58

Character formats (page 33). Three new character formats have been added: Equa-tionVariables, Wingdings, WingdingsBold.

Cross-references (page 39). Several new cross-reference formats have been added, including two for referring to appendices, and one specifically for pen-users.

Design Guide 4.00 for ManualsAppendix B: What’s new? › Version 4.00

Index

Aaardvarks

hidden behind sentences 7, 9appendices

properties and samples 53xAppendixH1 53xAppendixH1Preheader 53

Autonumber format series label 31

Bback matter 53

appendices 53index 54

blank even (verso) pages at end of section 9body (chapters) design 25book

branching to create a new version 7creating new 1

branching a book to create a new version 7bulleted lists

Bulleted1 32Bulleted1Text, see Indented1Bulleted2 32Bulleted2Text, see Indented2Bulleted3 32Bulleted3Text, see Indented3Bulleted4 32Bulleted4Text, see Indented4properties and samples 32ZaphBoxed1 32ZaphBoxed2 32

Ccharacter formats 33

Appendix 33BodyBold 33BodyBoldItalic 33BodyTitle 33Callout 33CalloutBold 33CummandBtn 35Deep blue 33DialogBoxTitle 35document convention styles 35Emphasis 33

EquationVariables 33FieldLabel 35Footer 33FormName 35general 33HeadBullet 35Hypertext 33IntroHint 33, 36IntroImportant 34, 36IntroNote 34, 36IntroSpeedHint 34, 36KeyName 35LongList 34MenuCommand 35MenuName 35MenuSubName 35PageNumber 34Squeezed 34Superscript 34TabName 35TreeFolderName 35TreeFolderSubName 35TreeItemName 35TypedEntry 34Underline 34WindowName 35Wingdings 34WingdingsBold 34WizardName 35ZaphDingbats 34

copyright pageCopyright

properties 19sample 22

CopyrightSpacerproperties 19sample 22

creating a new book 1cross-references 39

Ddocument body 25

bulleted lists 32character formats 33cross-references 39

Design Guide 4.00 for ManualsIndex: A 59

60

enumerated procedures 31headings 25notes 36special paragraph formats 30standard paragraph formats 28

DocuTech printer constraints 9

Eenumerated procedures

Enumerated1 31Enumerated1Cont 31Enumerated1Text, see IndentedEnumerated2 31Enumerated2Cont 31Enumerated2Text, see Indented2Enumerated3 31Enumerated3Cont 31Enumerated3Text, see Indented3properties and samples 31

Ffooter

format 10properties 10text 10

front matter 17master pages 12table of contents 23title page 17

Ggraphics

additional graphic samples 48callouts 46

Callout line 47CalloutBoxed para format 47CalloutEnumerated para format 47CalloutEnumeratedHeading para format 47CalloutEnumeratedIndented para format 47CalloutEnumeratedRight para format 47

paragraphs 43Callout para format 45Callout2 para format 46CellGraphic para format 46Graphic1 para format 43Graphic2 para format 43Graphic3 para format 44Graphic4 para format 44Graphic5 para format 44Graphic6 para format 44

properties and samples 42–49tables 45

Callout table format 45Callout2 table format 46

Hheadings

H1 25H2Anywhere 26H2BTopOfPage 26H3Anywhere 27H3BTopOfPage 27H4 27H5 27properties and samples 25xH1Preheader 25

Iindex

GroupTitlesIX 54Level1IX 54Level2IX 54properties and samples 54TitleIX 54

IX master pages 12

Lleft/right master pages 10

Mmargin

shift 9, 10master pages

front matter 12IX 12left/right 10other 12TOC 12

NNote table format


NoteNoAbove table formatproperties 36

notesproperties and samples 36–38IntroHint


Design Guide 4.00 for ManualsIndex: E

IntroImportantproperties 36sample 37

IntroNoteproperties 36sample 37

IntroSpeedHintproperties 36sample 37

Note1Note 37Note2Important 37Note3Hint 37Note4Speed hint 37NoteBulleted 38NoteBulleted2 38NoteCont 38NoteEnumerated1 38NoteEnumerated1Cont 38NoteEnumerated2 38NoteEnumerated2Cont 38NoteTxt 38NoteTxt2 38NotexTitle 37NotexTitleHint 38NotexTitleImportant 38NotexTitleSpeed 38

Ppage numbering 11page setup 9

blank even (verso) pages at end of section 9margin shift 9

paragraph formats. Seebulleted listsenumerated proceduresgraphic calloutsgraphic paragraphsgraphic tablesheadingsnotesspecial paragraph formatsstandard paragraph formatstables

PDF, outputting totweaking Acrobat 13tweaking FrameMaker 13, 15

PDF, printing to 13

Sseries label for Autonumber format 31

special paragraph formatsLongList 30LongListIndented 30LongListTitle 30LongListTitleIndented 30properties and samples 30xFormula 30

standard paragraph formatsBody 28BodyHalfSpace 28BodyKeepTogether 28BodyKeepWithNext 28Indented1 28Indented2 28Indented3 28Indented4 28List1 28List1Cont 28List2 28, 29List2Cont 29properties and samples 28QuarterSpace 28

Ttable of contents

H1TOC 23H2AnywhereTOC 23H2BTopOfPageTOC 23H3AnywhereTOC 23H3BTopOfPageTOC 23properties and sample 23TitleIXH1TOC 23TitleTOC 23xAppendixH1TOC 23

table paragraph formatsCellBody 51CellBodyEP 51CellHeading 51CellHeadingEP 51TableTitle 51

tables 50Callout1 45Callout2 46Generic 50Generic bullet 50GenericNT 50Note 36NoteNoAbove 36

title pageproperties 17

Design Guide 4.00 for ManualsIndex: P 61

62

sample 21Title properties 17Title sample 21TitleByline properties 17TitleByline sample 21TitlePre properties 17TitleSuper properties 17TitleSuper sample 21TitleSuperTag properties 17TitleSuperTag sample 21

TOC master pages 12

Uusing this template

branching a book 7creating a new book 1

Zzebras

hidden between the lines 54

Design Guide 4.00 for ManualsIndex: U

framemaker design guidea) open bookname-chapterscontinued.fm in framemaker, and then and then select...

Documents