Omni Systems, Inc.

  

Mif2Go User's Guide, Version 33u52

  

Valid HTML 4.01!

 

Made with Mif2Go

About this guide > New information


New information

The Mif2Go User's Guide is a perpetual work-in-progress, largely unreviewed. See history.txt in the Mif2Go distribution for updates to the software that are not mentioned in this guide or in the on-line Help.

This section identifies substantive additions and corrections since prior editions, extending back for one year. Corrections are shown in red.

2008 November 11, update 33u52

1. Log what happens during conversion. New configuration section [Logging]; see §4.3 Logging conversion events.

2. Specify absolute paths to conversion templates. See §4.6.5 Troubleshooting template import problems.

3. Fine-tune image scaling in Word output. New setting PicScale; see §5.12.7 Preserving graphics scale in Word.

4. Produce a list of CSH aliases and topic titles for HTML Help. New setting AliasTitle; see §8.11.6 Producing a list of aliases and associated topic titles.

5. Modify CSS to change OmniHelp display features. See §9.5.6 Modifying OmniHelp CSS classes.

6. Prevent Mif2Go from generating plugin.xml for Eclipse Help. New setting UsePlugin; see §11.2.3.3 Choosing whether to generate plugin.xml.

7. Allow Eclipse to generate a default opening page for Eclipse Help. Give TocTopic an empty value; see §11.4.4.2 Specifying a starting topic or.

8. Merge Eclipse Help modules without risking broken links. Anchor method deprecated for Eclipse version 3.4 and later versions; see §11.5 Merging Eclipse Help projects.

9. Apply attributes to table formats for DITA. Settings intended for HTML work for DITA XML also; see §14.6.3 Applying attributes to DITA tables.

10. Merge DITA stripped-table elements under a single parent. New setting CloseStrippedTables; see §14.6.6 Omitting table coding entirely.

11. Specify ancestry of image elements in DITA. New setting ImageParents; see §14.7.1 Designating ancestors for <image> and <fig> elements.

12. Specify how to wrap image elements in DITA. New settings CloseFigAfterImage and MultiImageFigures, and new format property NoFig; see §14.7.2 Specifying what to include in a <fig> wrapper.

13. Specify units for image attributes in DITA. Needed for round-tripping with FrameMaker 8. New setting UsePtSuffix; see:

§14.2.6 Ensuring FrameMaker 8 import compatibility

§14.7.4 Understanding why images might look incorrectly scaled.

14. Omit <xref> elements from DITA footnotes. For DITA-OT PDF2 output. New setting FootnoteXref; see §14.10.3 Omitting <xref> elements from footnotes.

15. Transfer format properties of FrameMaker user variables to DITA. Use macro variables; see §14.11.3 Retaining format properties of user variables in DITA.

16. Use first-topic navigation titles for DITA map titles. New setting UseAltMapTitle; see §15.2.1.4 Specifying a title for a chapter or book ditamap.

17. Prevent unwanted paragraphs from messing up HTML browse sequences. Use conditional text to make them go away; see §17.2.2.2 Preventing splits that create unwanted files.

18. Prevent a paragraph format from triggering HTML file splits. New format property NoSplit; see §17.2.2.4 Keeping headings together when other content intervenes.

19. Insert code at the very end of the HTML head section. New [Inserts] keywords HeadEnd, FirstHeadEnd, LastHeadEnd, SplitHeadEnd, and ExtrHeadEnd; see §17.5.2 Assigning code to [Inserts] keywords for splits and extracts.

20. Navigation systems for HTML are interfile, not intrafile. By design; see §19.1 Understanding how navigation links work.

21. Provide better browse sequences in HTML. Browse-sequence keyword building blocks expanded, behavior simplified; see §19.4 Creating a browse sequence.

22. Understand what format property Delete can and cannot do. See §20.3.13 Eliminating unwanted paragraphs.

23. Replace tabs in HTML or XML with code. New section [StyleTabReplace]; see §20.5.2 Understanding how Mif2Go treats tabs in HTML/XML.

24. Wildcards are an exception to special-character mapping for HTML; see §20.5.5 Mapping individual special characters.

25. Do not use special characters in URIs. Anything above 255 does not translate; see §20.5.7 Avoiding use of special characters in URIs.

26. DITA system ID needs a leading space if shorter than 16 characters. See §30.4.1 Content model [Topic] settings.

27. Override public and system IDs for specialized DITA maps. Same method as for topic types; see §30.6.3 Overriding declarations in a DITA map content model.

28. Omit DITA prefix from topic-type name in [DITAContentModels] entries (correction); see §30.6.4 Listing DITA topic type configuration files.

29. Preserve spaces and/or underscores in file names for automated systems. New settings KeepFileNameUnderscores, KeepFileNameSpaces, ChangeFileNameSpaces, and FileNameSpaceChar; see §32.7.4.1 Constructing file names based on paragraph content.

2008 May 11, update 33u51

1. Apply FrameMaker conditions and variables at run time. New section [ConditionsShown], new settings SetFrameConditions, ConditionName, and ReplaceFrameVars; see §4.7 Applying FrameMaker conditions and variables.

2. Emulate WWP drop-down hotspots with Mif2Go macros. See §6.9.8 Emulating Web Works Publisher drop-down hotspots.

3. List Eclipse Help plug-in attributes in plugin.xml. By default some are now in MANIFEST.MF instead. New setting UseManifest; see §11.3.1 Specifying a Java manifest file for Eclipse Help.

4. Specify the product version for your Eclipse Help plug-in. New setting PluginVer; see §11.3.2 Specifying Eclipse Help plug-in properties.

5. Include a processing instruction in Eclipse Help plugin.xml. New setting IncludeVersionPI; see §11.3.4.2 Including a processing instruction to validate plugin.xml.

6. Specify the Eclipse Help plug-in schema version. New setting PluginSchemaVersion; see §11.3.4.3 Specifying the plug-in schema version for plugin.xml.

7. Populate MANIFEST.MF for Eclipse Help. New settings WriteManifest, ManifestName, and UseSingleton; see §11.3.3 Configuring the Java manifest file for Eclipse Help.

8. Choose between mid-topic TOC jumps and breadcrumbs for Eclipse Help. New setting TocNamesFileOnly; see §11.4.4.3 Enabling mid-topic jumps from the TOC.

9. Name the Eclipse Help context file and plug-in attribute for secondary plug-ins. New settings ContextFileName and ContextPluginName; see §11.6.2 Naming context file and attribute for secondary plug-ins.

10. Convert FrameMaker conditions to HTML/XHTML/DITA attributes. New section [ConditionAttributes], new setting ConditionCharTag; see:

§12.10 Converting conditions to HTML attributes

§14.12 Converting conditions to DITA attributes.

11. Omit path from DITA DTD SYSTEM identifier. New setting UseDTDPath; see §14.2.5 Configuring the DITA DTD SYSTEM identifier.

12. Keep the first paragraph in a file from starting a new DITA topic. New setting ForceStartTopic; see §14.9.1.3 Preventing the first paragraph format from starting a topic.

13. Make DITA <xref scope="local"> attribute explicit. New setting UseLocalScope; see §14.10.4.1 Specifying the <xref> scope attribute.

14. Keep track of FrameMaker text insets in DITA output. New settings TextInsetMark and TextInsetNest; see §14.13 Marking FrameMaker text insets in DITA.

15. Property LinkSrc applies only to paragraph formats, not character formats (correction); see §18.2.4 Using a macro to specify link properties.

16. Improved Unicode support for HTML and for FrameMaker version 8. See:

§20.5.3 Understanding Mif2Go support for FrameMaker 8 Unicode

§20.5.6 Mapping characters in a special font.

17. Omit px suffix from image width and height attributes for HTML or XML. New setting UsePxSuffix; see §22.9.4 Specifying px units for graphics sized in pixels.

18. Assign table row attributes to paragraphs for HTML or XML. New [HTMLStyles] setting RowAttribute, new section [StyleRowAttribute]; see §23.4.5 Specifying attributes for table rows.

19. Add table row attributes via marker for HTML or XML. New custom marker type RowAttr; see:

§23.4.5 Specifying attributes for table rows

§28.2.4 Using attribute markers for HTML or XML.

20. How to get comments in macro definitions to appear in output. Put up with the backslash; see §27.1.1.4 Including comments in macro definitions.

21. Save FrameMaker 8 files as FrameMaker 8 MIF. New setting UseFrame8MIF; see §36.2.5 Saving FrameMaker 8 files as FrameMaker 8 MIF.

2007 December 31, update 33u50

1. Encode FrameMaker 8 Unicode characters for use in Word. New section [DefaultUnicodeFonts]; see §5.7.5 Specifying font encoding for FrameMaker 8 Unicode.

2. OmniHelp data and control files have changed. All generated JavaScript data files are now named myproj_oh?.js instead of myproj.oh?; check your setting for WrapCopyFiles to make sure it includes myproj_oh?.js files. See:

§9.2.4 Examining generated control and data files

§9.13 Assembling OmniHelp files for viewing.

3. Use Mif2Go to create working full-text search for Oracle Help. Revised operation of FTSCommand; see §10.4.3.1 Directing Mif2Go to create full-text search for Oracle Help.

4. Eclipse Help <contexts> name parameter changed to file. For Eclipse 3.3, use the latter; see §11.6.1 Understanding how Mif2Go generates context links.

5. JAR your Eclipse Help files instead of ZIPping them. As an alternative; see §11.7 Packaging Eclipse Help files.

6. Specify what to do with forced returns in XML. New settings XMLBreakPara, XMLBreak, and XMLNoBreak; see §13.4.5 Configuring forced returns for XML.

7. Omit tags for invalid default elements. New setting DropInvalidParaTag; see:

§14.4.3.4 Omitting invalid tags for default DITA block elements

§16.4.2.3 Omitting invalid tags for default DocBook block elements.

8. Insert processing instructions in DITA for line or page breaks. Use Code markers or macros; see §14.4.8 Including processing instructions for line or page breaks.

9. Avoid specifying ancestries for table components in DITA. Mif2Go uses FrameMaker table structure instead; see:

§14.5.2 Designating DITA ancestor elements

§14.6.4.1 Omitting ancestries of DITA table components.

10. Omit or include empty-paragraph tags in table cells without affecting text settings. New setting RemoveEmptyTableParagraphs; see:

§14.6.4.2 Retaining empty paragraph tags in DITA table cells

§16.3.5 Retaining empty paragraph tags in DocBook table cells

§23.4.10 Deciding what to do with empty paragraphs in table cells.

11. Omit table coding from DITA XML for "container" tables. New table type strip; see §14.6.6 Omitting table coding entirely.

12. Prefix DITA XML file names according to topic type. New section [DITATopicFileNamePrefix]; see §14.8.3 Prefixing split-file names to identify DITA topic type.

13. Tabs do not survive HTML/XHTML/XML conversions. They go away or become spaces; see §20.5.2 Understanding how Mif2Go treats tabs in HTML/XML.

14. Define a custom table type for DITA. An example; see §30.6.6.4 Deriving a new table type.



About this guide > New information


Availability Colophon