Omni Systems, Inc.

  

Mif2Go User's Guide, Version 55

  

Valid HTML 4.01!

 

Made with Mif2Go

15 Converting to DITA XML > 15.3 Specifying general options for DITA


15.3 Specifying general options for DITA

This section summarizes DITA-specific default values and recommended options for configuration settings in the following areas:

Declaration

Standard XML options

Filtering options

Style options

Indexing

CSS

Context-sensitive help

Assembling files for distribution

Declaration

Mif2Go sets the following default values for the PUBLIC declaration, depending on the DITA version and on the topic type. For example, for DITA version 1.1 and topic type concept:

[HTMLOptions]

HTMLDocType="-//OASIS//DTD DITA 1.1 Concept//EN"

HTMLDTD="docs.oasis-open.org/dita/v1.1/CS01/dtd/concept.dtd"

If you need the declaration to comply with the requirements of third-party tools, you can override the default values. See §32.7.2 Overriding settings in a DITA content model and §32.7.4 Overriding declarations in a DITA map content model.

Standard XML options

The following XML settings cannot be overridden:

[HTMLOptions]

AllowOverrides = No

AlignAttributes = No

NoFonts = Yes

[Graphics]

GraphScale = Yes

[Tables]

TableAttributes = No

CellAlignAttributes = No

CellColorAttributes = No

Filtering options

These settings provide DITA-specific default values for assorted options; you do not have to include the following settings in your configuration file unless you change their values:

[HTMLOptions]

; The following are the DITA-specific defaults for each setting:

FileSuffix = .dita

RunInHeads = Normal

RemoveANames = Yes

ATagElement = xref

XMLEncoding = UTF-8

NumericCharRefs = No

FootInlineTag = fn

HardRetPara = No

RemoveEmptyParagraphs = Yes

RemoveEmptyTableParagraphs = Yes

If your document uses run-in headings only for presentational purposes, you might want to set RunInHeads=Runin; see §21.3.2 Converting sidehead and run-in paragraph formats.

See §13 Converting to HTML/XHTML.

Style options

Keep empty paragraphs empty (if not removed):

[HTMLOptions]

EmptyParaContent =

See §21.3.9 Providing content for empty paragraphs.

Footnotes are DITA-specific, but you can remove them:

[HTMLOptions]

Footnotes = None

A footnote that appears in a <title> element will be wrapped in a <ph> element. If you are using the DITA Open Toolkit, see §15.10.5 Omitting <xref> elements from footnotes.

By default, Mif2Go suppresses FrameMaker autonumbers for DITA:

[HTMLParaStyles]

* = NoAnum

Autonumbers violate DITA architecture. However, if you use FrameMaker numbering properties for purposes that have nothing to do with numbering, you can override the suppression for selected paragraph formats:

[HTMLParaStyles]

ParaFmt = Anum

If you want a graphic in DITA, you reference it, then add it when you render output from DITA. The graphic does not belong in the DITA itself, so if it is present in FrameMaker you need to mark it for deletion. How you do that depends on how the graphic was added in FrameMaker. For example, if the graphic is a Frame Above, set:

[HTMLOptions]

RemoveFramesAbove=Yes

This removes all such frames, which is probably what you want; see§21.3.7 Keeping or removing reference frames.

If the graphic is anchored in the text, apply a condition, and exclude that condition when converting to DITA.

By default, Mif2Go converts forced returns (FrameMaker Shift+Enter) to spaces for DITA. To simply close and reopen the paragraph tag (without attributes) instead:

[HTMLOptions]

XMLBreakPara = Yes

To do so selectively by paragraph format:

[HTMLParaStyles]

ParaFmt = XMLBreak

See §14.4.5 Configuring forced returns for XML.

To preserve line or page breaks in DITA, see §15.4.8 Including PIs for line, column, or page breaks.

Do not assign the [HTMLParaStyles] Split property to any FrameMaker format. For DITA, Mif2Go splits files according to topic starts; see §15.8.2 Splitting FrameMaker files into DITA topic files.

By default, for DITA XML output Mif2Go adds a px suffix to width and height attribute values for images sized in pixels. To omit the suffix:

[Graphics]

UsePxSuffix = No

See §23.9.5 Specifying px units for graphics sized in pixels, and §15.7.7 Understanding why images might look incorrectly scaled.

Indexing

For DITA version 1.1 Mif2Go uses FrameMaker sort strings to produce index-sort-as elements, so you might want to set the following Help option:

[Index]

UseSortString = Yes

See §7.5.9.4 Choosing whether to use FrameMaker index sort strings, and §15.4.10 Converting index markers to <indexterm> elements.

CSS

The CSS file Mif2Go generates for DITA specifies classes only, no tags, so that it can be used for HTML outputs generated from the DITA files. These options are in effect by default:

[CSS]

WriteClassAttributes = No

ClassIsTag = No

which results in [DITAOptions]UseOutputClass=No.

To include CSS class names, specify [DITAOptions]UseOutputClass=Yes, then convert @outputclass to class attributes in the HTML; see §15.4.6.6 Providing outputclass attributes for all elements. Setting [CSS]UseCSS=Yes also sets [DITAOptions]UseOutputClass=Yes; see §22.4.2 Specifying CSS options in a Mif2Go configuration file

Note:  To include CSS class names as outputclass attributes, make sure your configuration file does not specify [CSS]WriteClassAttributes=No.

By default, Mif2Go uses FrameMaker cross-reference format names and link character format names to set the @outputclass for cross references and hypertext links:

[CSS]

XrefFormatIsXrefClass = Yes

See §22.7.8 Using link format names as CSS class names.

Context-sensitive help

By default, DITA output includes all context-sensitive help targets provided in your source document via TopicAlias markers, in the following form:

<data name="topicalias" value="IDH_about" />

To exclude these targets from DITA output:

[DITAOptions]

; UseTopicAlias = Yes (default, include CSH targets in DITA output)

; or No

UseTopicAlias=No

See:

§7.10 Setting up Context Sensitive Help (CSH)

§15.14 Including CSH targets in DITA XML

The id attribute has no use in DITA maps, so is not essential.

Assembling files for distribution

These settings provide DITA-specific default values for gathering converted files for further processing; you do not have to include these settings in your configuration file if the following default values are satisfactory:

[Automation]

; The following are the DITA-specific defaults for each setting:

WrapCopyFiles = *.dita *.ditamap *.bookmap *.dtd *.mod *.ent *.xsd

CssCopyFiles = *.css *.xsl

GraphCopyFiles = *.gif *.jpg *.png *.svg

EmptyOutputFiles = *.dita *.ditamap *.bookmap *.ref *.grx

See §35 Producing deliverable results.



15 Converting to DITA XML > 15.3 Specifying general options for DITA