Omni Systems, Inc.

  

Mif2Go User's Guide, Version 55

  

Valid HTML 4.01!

 

Made with Mif2Go

16 Configuring DITA maps > 16.4 Mapping FrameMaker files to bookmap components > 16.4.1 Assigning bookmap roles to FrameMaker files


16.4.1 Assigning bookmap roles to FrameMaker files

To indicate the role and (if relevant) component that each file in your FrameMaker book should play in the <bookmap>:

[DITABookmapFiles]

; filename without .ext = role, optionally followed by a component

; or by Lists then a booklist component, optionally followed by

; ElementBefore or ElementAfter; or None (omit from bookmap).

Table 16-2 lists the roles you can assign to FrameMaker files. The role (and components, if any) assigned to a FrameMaker file determine which element or elements are included in the bookmap for the DITA topic or topics generated from that file. Entries appear in the <bookmap> element in the same order they appear in your FrameMaker book. If you need a different sequence, create a different FrameMaker .book file and populate it with files in the sequence you need; then construct the DITA <bookmap> from that alternate FrameMaker book.

Table 16-2 Roles of component files in a bookmap

Role

Book component

Ref.

Front

Frontmatter, including one or more components; place first after =

16.4.2

Back

Backmatter, including one or more components; place first after =

16.4.2

Lists

Generated file; must follow Front or Back.

16.4.2

Part

Divider for logical groups of chapters, either explicit or implicit

16.4.4

Chapter

Normal chapter files

 

Appendix

Normal appendix files

 

*Seg

Multiple-role chapters

16.4.5

Multiple-chapter roles

16.4.6

ElementBefore

Elements to be generated precede this file

16.4.7

ElementAfter

Elements to be generated follow this file

16.4.7

None

Omit from the bookmap

 

Front, Back, and Lists

For files that belong in frontmatter or backmatter, Front or Back must precede any other role or component. If you assign Front or Back to a file, that role applies to the following component, if any. Lists must follow Front or Back, and must be followed by a booklist component. See §16.4.2 Assigning frontmatter and backmatter roles and components.

Authored vs. generated files

Most of the non-generated files in your FrameMaker book should be assigned either the Chapter or Appendix role. Because Chapter is the default role, you do not have to list single-role chapter files in [DITABookmapFiles], except for chapters that begin implicit multi-chapter sections; see §16.4.4 Assigning a divider role to a section file or chapter.

Omitting a file from the list

If you do not list in [DITABookmapFiles] a particular file in your FrameMaker book, Mif2Go includes that file in the bookmap based on file type (authored vs. generated) and on the position of the file relative to files that are listed. A non-generated file that occurs after the TOC (if any) becomes a <chapter> element.

Omitting all files from the list

If you do not list any files, the bookmap contains one entry for each FrameMaker file, with a <frontmatter> element for the FrameMaker TOC and a <backmatter> element for the FrameMaker IX. References to any other generated files appear in <frontmatter> or <backmatter> as <booklist> elements, based on their location in the FrameMaker book. All non-generated files become <chapter> elements, except for any preceding the TOC (such as a cover page), which become <topicref> elements in <frontmatter>.

Omitting a file from the bookmap

When filename=None, the file listed is not included in the bookmap.



16 Configuring DITA maps > 16.4 Mapping FrameMaker files to bookmap components > 16.4.1 Assigning bookmap roles to FrameMaker files