User manual ADOBE FRAMEMAKER 6.0

Adobe FrameMaker 6.0 ® ® MIF Reference Online Manual Adobe, the Adobe logo, Acrobat, Acrobat Reader, Adobe Type Manager, ATM, Display PostScript, Distiller, Exchange, Frame, FrameMaker, FrameViewer, InstantView, and PostScript are trademarks of Adobe Systems Incorporated. Apple, PowerBook, QuickTime, Mac, Macintosh and Power Macintosh are trademarks of Apple Computer, Inc., registered in the United States and other countries. HP-UX is a registered trademark of Hewlett-Packard Company. Microsoft, MS-DOS, Windows, and Windows NT are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries.. Sun and Solaris are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and other countries. Unix is a registered trademark and X Window System is a trademark of The Open Group. All other trademarks are property of their respective owners. © 2000 Adobe Systems Incorporated. All rights reserved. 3 Contents Introduction Why use MIF? .................................................. 6 ............................................... 6 ...................................... 7 Using this manual Overview of MIF statements MIF statement syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Using MIF Statements Working with MIF files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 . . . . . . . . . . . . . . . . . . . . . . . . . 18 . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 Creating a simple MIF file for FrameMaker Creating and applying character formats Creating and formatting tables Specifying page layout Creating markers Creating variables Creating cross-references Creating conditional text Including template files Applications of MIF Debugging MIF files Other application tools Where to go from here . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 Setting View Only document options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 MIF Document Statements MIF file layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 MIFFile statement Control statements Macro statements Conditional text Paragraph formats Character formats Tables Color Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 Cross-references Global document properties 4 Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111 Graphic objects and graphic frames Text flows Publishers Text insets (text imported by reference) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132 . . . . . . . . . . . . . . . . . . . . . . . . . . . 140 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149 MIF Book File Statements MIF book file overview Book statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151 MIF book file identification line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151 MIF Statements for Structured Documents and Books Structural element definitions Attribute definitions Format rules Elements Format change lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178 . . . . . . . . . . . . . . . . . . . . . . 180 Preference settings for structured documents Text in structured documents Structured book statements MIF Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187 MIF Equation Statements Document statement Math statement MathFullForm statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195 MIF Asian Text Processing Statements Asian Character Encoding Combined Fonts Kumihan Tables Rubi text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228 Examples Text example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239 Bar chart example Pie chart example Custom dashed lines Table examples Database publishing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245 5 MIF Messages General form for MIF messages List of MIF messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253 MIF Compatibility Changes between version 5.5 and 6.0 Changes between version 5 and 5.5 Changes between versions 4 and 5 Changes between versions 3 and 4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264 Facet Formats for Graphics Facets for imported graphics Basic facet format Graphic insets (UNIX versions) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272 . . . . . . . . . . . . . . . . . . . . . . . 278 General rules for reading and writing facets EPSI Facet Format Specification of an EPSI facet Example of an EPSI facet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280 FrameImage Facet Format Specification of a FrameImage facet Specification of FrameImage data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282 . . . . . . . . . . . . . . . . . . . . . . . 285 Differences between monochrome and color Sample unencoded FrameImage facet Sample encoded FrameImage facet . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288 FrameVector Facet Format Specification of a FrameVector facet Specification of FrameVector data Sample FrameVector facet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308 6 Introduction MIF (Maker Interchange Format) is a group of ASCII statements that create an easily parsed, readable text file of all the text, graphics, formatting, and layout constructs that most FrameMaker® products (with the exception of FrameReader®) understand. Because MIF is an alternative representation of a FrameMaker document, it allows FrameMaker products and other applications to exchange information while preserving graphics, document content, and format. Why use MIF? You can use MIF files to allow FrameMaker products and other applications to exchange information. For example, you can write programs to convert graphics and text into MIF and then import the MIF file into a FrameMaker product with the graphics and text intact. You can also save a FrameMaker document or book file as a MIF file and then write a program to convert the MIF file to another format. These conversion programs are called filters; filters allow you to convert FrameMaker document files into foreign files (files in another word processing or desktop publishing format), and foreign files into FrameMaker document files. You can use MIF files with database publishing applications, which allow you to capture changing data from databases and format the data into high-quality documents containing both text and graphics information. You use the database to enter, manipulate, sort, and select data. You use a FrameMaker product to format the resulting data. You use MIF files as the data interchange format between the database and the FrameMaker product. You can also use MIF files to do the following: · Share documents with earlier versions of FrameMaker products · Perform custom document processing · Set options for online documents in View Only format These tasks are described in "Applications of MIF" on page 60. You can use other FrameMaker products to perform some of these tasks. See "Other application tools" on page 64. Using this manual This manual: · Describes the layout of MIF files. · Provides a complete description of each MIF statement and its syntax. · Provides examples of how to use MIF statements. · Includes MIF statements for version 5.5 of the following FrameMaker products: FrameMaker®, FrameViewer®, FrameMaker+SGMLTM. ADOBE FRAMEMAKER 6.0 7 Introduction Your FrameMaker product may not include all of the features described in this manual. For example, some statements appear in all MIF files but are only applicable for structured documents created with FrameMaker+SGML. Contact your FrameMaker local customer service representative for information about other FrameMaker products. To get the most from this manual you should be familiar with your FrameMaker product. For information about a FrameMaker product and its features, see the documentation for your product. In addition, if you are using MIF as an interchange format between a FrameMaker product and another application, you should be familiar with the tools needed to create and manipulate the other application, such as a programming language or database query language. This chapter provides basic information about working with MIF files, including opening and saving MIF files in your FrameMaker product. It goes on to provide detailed information about the MIF language and its syntax. For an introduction to writing MIF files, read , "Using MIF Statements." You can then use the statement index, subject index, and table of contents to locate more specific information about a particular MIF statement. For a description of a MIF statement, use the table of contents or statement index to locate the statement. For a description of the differences between the MIF statements for this version of your FrameMaker product and earlier versions, see , "MIF Compatibility."Style conventions This manual uses different fonts to represent different types of information. · What you type is shown in . · MIF statement names, pathnames, and filenames are also shown in . · Placeholders (such as MIF data) are shown in text like this. For example, the statement description for is shown as: You replace tagstring with the tag of a paragraph format. This manual also uses the term FrameMaker, (as in FrameMaker product, FrameMaker document, or FrameMaker session) to refer to any of the FrameMaker, FrameMaker+SGML, and FrameViewer products. Overview of MIF statements When you are learning about MIF statements, you may find it useful to understand how FrameMaker products represent documents. ADOBE FRAMEMAKER 6.0 8 Introduction How MIF statements represent documents FrameMaker products represent document components as objects. Different types of objects represent different components in a FrameMaker document. For example, a paragraph is considered an object; a paragraph format is considered a formatting object. The graphic objects that you create by using the Tools palette are yet another type of object. Each object has properties that represent its characteristics. For example, a paragraph has properties that represent its left indent, the space above it, and its default font. A rectangle has properties that represent its width, height, and position on the page. When a FrameMaker product creates a MIF file, it writes an ASCII statement for each object in the document or book. The statement includes substatements for the object's properties. For example, suppose a document (with no text frame) contains a rectangle that is 2 inches wide and 1 inch high. The rectangle is located 3 inches from the left side of the page and 1.5 inches from the top. MIF represents this rectangle with the following statement: # Position and size: left offset, # top offset, width, and height > A FrameMaker product also treats each document as an object and stores document preferences as properties of the document. For example, a document's page size and page numbering style are document properties. FrameMaker documents have default objects A FrameMaker document always has a certain set of default objects, formats, and preferences, even when you create a new document. When you create a MIF file, you usually provide the objects and properties that your document needs. However, if you don't provide all the objects and properties required in a FrameMaker document, the MIF interpreter fills in a set of default objects and document formats. The MIF interpreter normally provides the following default objects: · Predefined paragraph formats for body text, headers, and table cells · Predefined character formats · A right master page for single-sided documents and left and right master pages for double-sided documents · A reference page · Predefined table formats · Predefined cross-reference formats · Default pen and fill values and dash patterns for graphics · Default colors · Default document preferences, such as ruler settings · Default condition tags ADOBE FRAMEMAKER 6.0 9 Introduction Although you can rely on the MIF interpreter to provide defaults, the exact properties and objects provided may vary depending on your FrameMaker product's configuration. The MIF interpreter uses default objects and properties that are specified in setup files and in templates. In UNIX® versions, these templates are and . You can modify these default objects and document formats by creating your own version of or or by modifying your setup files. For more information about modifying the default templates and setup files, see the online manual Customizing FrameMaker Products for UNIX versions of FrameMaker products. For the Macintosh and Windows® versions, see the chapter on templates in your user manual. Current state and inheritance A FrameMaker product has a MIF interpreter that reads and parses MIF files. When you open or import a MIF file, the interpreter reads the MIF statements and creates a FrameMaker document that contains the objects described in the MIF file. When the interpreter reads a MIF file, it keeps track of the current state of certain objects. If the interpreter reads an object with properties that are not fully specified, it applies the current state to that object. When an object acquires the current state, it inherits the properties stored in that state. For example, if the line width is set to 1 point for a graphic object, the interpreter continues to use a 1-point line width for graphic objects until a new value is specified in the MIF file. Similarly, if the MIF file specifies a format for a paragraph, the interpreter uses the same format until a new format is specified in the file. The MIF interpreter keeps track of the following document objects and properties: · Units · Condition tag properties · Paragraph format properties · Character format properties · Page properties · Graphic frame properties · Text frame properties · Fill pattern · Pen pattern · Line width · Line cap · Line style (dash or solid) · Color · Text line alignment and character format Because the interpreter also provides default objects for a document, the current state of an object may be determined by a default object. For example, if a document does not provide any paragraph formats, the interpreter applies a set of default paragraph properties to the first paragraph. Subsequent paragraphs use the same properties unless otherwise specified. ADOBE FRAMEMAKER 6.0 10 Introduction How a FrameMaker product identifies MIF files A MIF file must be identified by a or statement at the beginning of the file; otherwise a FrameMaker product simply reads the file as a text file. All other statements are optional; that is, a valid MIF file can contain only the statement. Other document objects can be added as needed; a FrameMaker product provides a set of default objects if a MIF file does not supply them. MIF statement syntax The statement descriptions in this manual use the following conventions to describe syntax: tokendatawhere token represents one of the MIF statement names (such as ) listed in the MIF statement descriptions later in this manual, and data represents one or more numbers, a string, a token, or nested statements. Markup statements are always delimited by angle brackets (<>); macro statements are not. For the syntax of macro statements, see "Macro statements" on page 70. A token is an indivisible group of characters that identify a reserved word in a MIF statement. Tokens in MIF are case-sensitive. A token cannot contain white space characters, such as spaces, tabs, or newlines. For example, the following MIF statement is invalid because the token contains white space characters: When the MIF interpreter finds white space characters that aren't part of the text of the document (as in the example MIF statement, ), it interprets the white space as token delimiters. When parsing the example statement, the MIF interpreter ignores the white space characters between the left angle bracket (<) and the first character of the token, . After reading the token, the MIF interpreter checks its validity. If the token is valid, the interpreter reads and parses the data portion of the statement. If the token is not valid, the interpreter ignores all text up to the corresponding right angle bracket (>), including any nested substatements. The interpreter then scans the file for the next left angle bracket that marks the beginning of the next MIF statement. All statements, as well as all data portions of a statement, are optional. If you do not provide a data portion, the MIF interpreter assigns a default value to the statement. Statement hierarchy Some MIF statements can contain other statements. The contained statements are called substatements. In this manual, substatements are usually shown indented within the containing statements as follows: > The indentation is not required in a MIF file, although it may make the file easier for you to read. A MIF main statement appears at the top level of a file. A main statement cannot be nested within other statements. Some substatements can only appear within certain main statements. The statement descriptions in this manual indicate the valid locations for a substatement by including it in all of the valid main statements. Main statements are identified in the statement description; for the correct order of main statements, see "MIF file layout" on page 66. ADOBE FRAMEMAKER 6.0 11 Introduction MIF data items There are several general types of data items in a MIF statement. This manual uses the following terms and symbols to identify data items. This term or symbol Means Left quotation mark ( ` ), zero or more standard ASCII characters, and a straight quotation mark (' ). Example: . To include extended ASCII characters in a string, you must use a backslash sequence (see "Character set in strings" on page 13). A string that names a format tag, such as a paragraph format tag. A tagstring value must be unique; case is significant. A statement that refers to a tagstring must exactly match the tagstring value. A tagstring value can include any character from the FrameMaker character set. A string specifying a pathname (see "Device-independent pathnames" on page 13). A value of either or . Case is significant. Integer whose range depends on the associated statement name. Integer that specifies a unique ID. An ID can be any positive integer between 1 and 65535, inclusive. A statement that refers to an ID must exactly match the ID. Decimal number signifying a dimension. You can specify the units, such as , , and . If no units are specified, the default unit is used (see "Units statement" on page 68). A decimal number signifying an angle value in degrees. You cannot specify units; any number is interpreted as a degree value. A decimal number signifying a percentage value. You cannot specify units; any number is interpreted as a percentage value. A dimension specified in units that represent points, where one point is 1/72 inch (see "Math values" on page 12). Only used in statements. Pair of dimensions representing width and height. You can specify the units. Coordinates of a point. Coordinates originate at the upper-left corner of the page or graphic frame. You can specify the units. Coordinates representing left, top, right, and bottom indents. You can specify the units. Coordinates representing the left and top indents plus the dimensions representing the width and height of an object. You can specify the units. Coordinates of a point on the physical screen represented by X and Y plus dimensions describing the width and height. Used only by the and statements within the statement and the statement within the statement. The values are in pixels; you cannot specify the units. A token value. The allowed token values are listed for each statement; you can provide only one value. Ellipsis points in a statement indicate required substatements or arguments. The entire expanded statement occurs at this point. string tagstring pathname boolean integer ID dimension degrees percentage metric WH XY LTRB LTWH XYWH keyword ADOBE FRAMEMAKER 6.0 12 Introduction Unit values You can specify the unit of measurement for most dimension data items. The following table lists the units of measurement that a FrameMaker product supports and their notation in MIF.Dimension data types can Measurement unit point inch millimeter centimeter pica didot cicero Notation in MIF pt or point " or in mm or millimeter cm or centimeter pc or pica dd or didot cc or cicero Relationship to other units 1/72 inch 72 points 1 inch is 25.4 mm 1 inch is 2.54 cm 12 points 0.01483 inches 12 didots mix different units of measurement. For example, the statement L T R B can be written as either of the following: Math values The statement uses metric values in formatting codes. A metric unit represents one point (1/72 inch). The metric type is a 32-bit fixed-point number. The 16 most significant bits of a metric value represent the digits before the decimal; the 16 least significant bits represent the digits after the decimal. Therefore, 1 point is expressed as hexadecimal or decimal . The following table shows how to convert metric values into equivalent measurement units. To get this unit point inch millimeter centimeter pica didot cicero Divide the metric value by this number 65536 4718592 185771 1857713 786432 6997 839724 ADOBE FRAMEMAKER 6.0 13 Introduction Character set in strings MIF string data uses the FrameMaker character set (see the Quick Reference for your FrameMaker product). MIF strings must begin with a left quotation mark (ASCII character code ) and end with a straight quotation mark (ASCII character code ). Within a string, you can include any character in the FrameMaker character set. However, because a MIF file can contain only standard ASCII characters and because of MIF parsing requirements, you must represent certain characters with backslash (\) sequences. Character Tab > Representation \t \> \q ` \ nonstandard ASCII \Q \\ \xnn All FrameMaker characters with values above the standard ASCII range (greater than ) are represented in a string by using nn notation, where nn represents the hexadecimal code for the character. The hexadecimal digits must be followed by a space. The following example shows a FrameMaker document line and its representation in a MIF string. In a FrameMaker document Some `symbols': > \Ø¿! In MIF `Some \Qsymbols\q: \> \\\xaf \xc0 !' You can also use the statement to include certain predefined special characters in a statement (see "Char statement" on page 136). Device-independent pathnames Several MIF statements require pathnames as values. You should supply a device-independent pathname so that files can easily be transported across different system types. Because of MIF parsing requirements, you must use the following syntax to supply a pathname: `namenamename...' where name is the name of a component in the file's path and code identifies the role of the component in the path. The following table lists codes and their meanings. Code r v h c Meaning Root of UNIX file tree (UNIX only) Volume or drive (Macintosh and Windows) Host (Apollo only) Component ADOBE FRAMEMAKER 6.0 14 Introduction Code u Meaning Up one level in the file tree When you specify a device-independent pathname in a MIF string, you must precede any right angle brackets (>) with backslashes (\), as shown in the syntax above. Absolute pathnames An absolute pathname shows the location of a file beginning with the root directory, volume, or drive. The following table specifies device-independent, absolute pathnames for the different versions of FrameMaker products.Relative pathnames In this version UNIX Macintosh Windows The pathname appears as this MIF string `MyDirectoryMySubdirectoryFilename' `MyVolumeMyFolderMySubfolderFilename' `c:mydirsubdirfilename' A relative pathname shows the location of a file relative to the current directory. In all FrameMaker product versions, the device-independent, relative pathname for the same file is: `Filename' ADOBE FRAMEMAKER 6.0 15 Introduction 16 Using MIF Statements MIF statements can completely describe any FrameMaker document, no matter how complex. As a result, you often need many MIF statements to describe a document. To learn how to use MIF statements, it helps to begin with some simple examples. This chapter introduces you to MIF, beginning with a simple MIF example file with only a few lines of text. Additional examples show how to add common document objects, such as paragraph formats, a table, and a custom page layout, to this simple MIF file. The examples in this chapter are also provided in online sample files. You can open these examples in a FrameMaker product and experiment with them by adding additional MIF statements. Look for the sample files in the following location: In this version UNIX Look here $FMHOME/fminit/language/Samples/MIF, where language is the language in use, such as usenglish The MIF folder in the Samples folder The MIF directory under the samples directory Macintosh Windows Working with MIF files A MIF file is an alternate representation of a FrameMaker document in ASCII format. MIF files are usually generated by a FrameMaker product or by an application that writes out MIF statements. You can, however, create MIF files by using a text editor or by using a FrameMaker product as a text editor. This section provides some general information about working with MIF files regardless of the method you use to create them. Opening and saving MIF files When you save a FrameMaker document, you usually save it in Normal format, FrameMaker's binary format for document files. To save a document as a MIF file, choose Save As from the File menu. In the Save Document dialog box, choose Interchange (MIF) from the Format pop-up menu. You should give the saved file the suffix .mif to distinguish it from a file saved in binary format. When you open or import a MIF file, a FrameMaker product reads the file directly, translating it into a FrameMaker document or book. When you save the document in Normal format, a FrameMaker product creates a binary document file. To prevent overwriting the original MIF file, remove the .mif file suffix and replace it with a different suffix (or no suffix). ADOBE FRAMEMAKER 6.0 17 Using MIF Statements If you use a FrameMaker product to edit a MIF file, you must prevent it from interpreting MIF statements when you open the file by holding down a modifier key and clicking Open in the Open dialog box. In this version UNIX Macintosh Windows NeXT Use this modifier key Shift Option Control or Shift Alt Save the edited MIF file as a text file by using the Save As command and choosing Text Only from the Format pop-up menu. Give the saved file the suffix .mif. When you save a document as Text Only, a FrameMaker product asks you where to place carriage returns. For a MIF file, choose the Only between Paragraphs option. In UNIX versions, a FrameMaker product saves a document in text format in the ISO Latin-1 character encoding. You can change the character encoding to ASCII by changing the value of an X resource. See the description of character encoding in the online manual Customizing FrameMaker Products. In Macintosh and Windows versions, press Esc F t c to toggle between FrameMaker's character encoding and ANSI for Windows or ASCII for Macintosh. Importing MIF files You can use the File menu's Import>File command to import MIF files into an existing document, but you must make sure that the imported statements are valid at the location where you are importing them. A MIF file can describe both text and graphics; make sure that you have selected either a place in the text flow (if you are importing text or graphics) or an anchored frame (if you are importing graphics). For example, to import a MIF file that describes a graphic, first create an anchored frame in a document, select the frame, and then import the MIF file (see "Bar chart example" on page 235). When you import or include MIF files, make sure that object IDs are unique in the final document and that references to object IDs are correct (see "Generic object statements" on page 111). Editing MIF files You normally use a text editor to edit a MIF file. If you use a FrameMaker product to enter text into a MIF file, be sure to open the MIF file as a text file and turn off Smart Quotes. If you leave Smart Quotes on, you must use a key sequence to type the quotation marks that enclose a MIF string (`'). To enter a left quotation mark, type Control-`. To enter a straight quotation mark, type Control-'. Although MIF statements are usually generated by a program, while you learn MIF or test and debug an application that generates MIF, you may need to manually generate MIF statements. In either case, you can minimize the number of MIF statements that your application needs to generate or that you need to type in. ADOBE FRAMEMAKER 6.0 18 Using MIF Statements The following suggestions may be helpful when you are working with MIF statements: · Edit a MIF file generated by a FrameMaker product. You can edit a MIF file generated by a FrameMaker product or copy a group of statements from a MIF file into your file and then edit the statements. An easy way to use a FrameMaker product to generate a MIF file is to create an empty document by using the New command and then saving it as a MIF file. · Test one object at a time. While testing an object in a document or learning about the MIF statements that describe an object, work with just that object. For example, if you work with a document that contains both tables and anchored frames, start by creating the MIF statements that describe tables. Then add the statements that describe anchored frames. · Use the default properties provided by a FrameMaker product. If you are not concerned with testing certain document components, let a FrameMaker product provide a set of default document objects and formats. MIF file layout A FrameMaker product writes the objects in a MIF document file in the following order: This section File ID Units Catalogs Contains these objects MIF file identification line (MIFFile statement) Default units (Units statement) Color Condition Paragraph Format Element Font or Character Format Ruling Table Format Views Variable Cross-reference Document Dictionary Anchored frames Tables Pages Text flows Formats Objects A FrameMaker product provides all of these objects, even if the object is empty. To avoid unpredictable results in a document, you must follow this order when you create a MIF file. Creating a simple MIF file for FrameMaker The rest of this chapter explains how to create some simple MIF files for FrameMaker and FrameViewer by hand. These instructions do not apply to FrameMaker+SGML, which requires that you create elements first. ADOBE FRAMEMAKER 6.0 19 Using MIF Statements The most accurate source of information about MIF files is a MIF file generated by a FrameMaker product. MIF files generated by a FrameMaker product can be very lengthy because a FrameMaker product repeats information and provides default objects and formats for all documents. You may find it difficult to determine the minimum number of statements that are necessary to define your document by looking at a FrameMaker-generated MIF file. To better understand how a FrameMaker product reads MIF files, study the following example. This MIF file uses only four statements to describe a document that contains one line of text: >#end of Paraline >#end of Para # The only required statement # Begin a paragraph # Begin a line within the paragraph # The actual text of this document # End of ParaLine statement # End of Para statement The MIFFile statement is required in each MIF file. It identifies the FrameMaker product version and must appear on the first line of the file. All other statements are optional; that is, a FrameMaker product provides a set of default objects if you specify none. Comments in a MIF file are preceded by a number sign (#). By convention, the substatements in a MIF statement are indented to show their nesting level and to make the file easier to read. The MIF interpreter ignores spaces at the beginning of a line. This example is in the sample file hello.mif. To see how a FrameMaker product provides defaults for a document, open this file in a FrameMaker product. Even though the MIF file does not specify any formatting, a FrameMaker product provides a default Paragraph Catalog and Character Catalog. In addition, it provides a right master page, as well as many other default properties. Save this document as a MIF file and open the FrameMaker-generated MIF file in a text editor or in a FrameMaker product as a text file. (For information on how to save and open MIF files, see "Opening and saving MIF files" on page 16.) You'll see that the MIF interpreter has taken the original 6-line file and generated over 1,000 lines of MIF statements that describe all the default objects and their properties. To see the actual text of the document, go to the end of the file. This example demonstrates an important point about MIF files. Your MIF file can be very sparse; the MIF interpreter supplies missing information. Most documents are not this simple, however, and require some formatting. The following sections describe how to add additional document components, such as paragraph and character formats, a table, and custom page layouts, to this minimal MIF file. Creating and applying paragraph formats In a FrameMaker document, paragraphs have formatting properties that specify the appearance of the paragraph's text. A paragraph format includes the font family and size, indents, tab stops, the space between lines in a paragraph, and the space before and after a paragraph. In a FrameMaker document, the end of a paragraph is denoted by a single carriage return. You control the amount of space above and below the paragraph by modifying the paragraph's format, not by adding extra carriage returns. ADOBE FRAMEMAKER 6.0 20 Using MIF Statements In a FrameMaker document, you store paragraph formats in a Paragraph Catalog and assign a tag (name) to the format. You can then apply the same format to many paragraphs by assigning the format tag to the paragraphs. You can also format a paragraph individually, without storing the format in the Paragraph Catalog. Or, you can assign a format from the Paragraph Catalog and then override some of the properties within a particular paragraph. Formats that are not stored in the Paragraph Catalog are called local formats. Creating a paragraph In a MIF file, paragraphs are defined by a Para statement. A Para statement contains one or more ParaLine statements that contain the lines in a paragraph; the actual text of the line is enclosed in one or more String statements: > > # Begin a paragraph # Begin a line within the paragraph # The actual text of this document # End of ParaLine statement # End of Para statement The Para, ParaLine, and String statements are the only required statements to import text. You could use this example to import a simple document into a FrameMaker product by placing each paragraph in a Para statement. Break the paragraph text into a series of String statements contained in one ParaLine statement. It doesn't matter how you break up text lines within a Para statement; the MIF interpreter automatically wraps lines when it reads the MIF file. Some characters must be represented by backslash sequences in a MIF string. For more information, see "Character set in strings" on page 13. Creating a paragraph format Within a FrameMaker document, you define a paragraph format by using the Paragraph Designer to specify the paragraph's properties. In a MIF file, you define a paragraph format by using the Pgf statement. The Pgf statement contains a group of substatements that describe all of a paragraph's properties. It has the following syntax: ... A Pgf statement is quite long, so learning how to relate its substatements to the paragraph's properties may take some practice. Usually a MIF statement name is similar to the name of the setting within a dialog box. The following examples show the property dialog boxes from the Paragraph Designer with the related Pgf substatements.