Omni Systems, Inc.

  

Mif2Go User's Guide, Version 33u51

  

Valid HTML 4.01!

 

Made with Mif2Go

> G DITA/DocBook configuration


G DITA/DocBook configuration

This section provides an annotated list of configuration sections, keywords, and acceptable values for settings you can specify in configuration file mif2htm.ini, for DITA XML output. Where indicated, sections with names of the form [DITA...] apply also to DocBook XML, except the sections are named [DocBook...] instead.

See also:

§14 Producing DITA XML

§15 Configuring DITA maps

§16 Producing DocBook XML

§F HTML/XML configuration

§H DITA <bookmeta> template

 

; m2dita.txt, description of DITA-specific settings for mif2htm.ini

; as they are supported in dwhtm.dll h284 and m2rbook.dll b108.

 

[Options]

; Output = DITA, the command line uses the "dcl -t htm -fD" switches.

Output=DITA

 

[FDK]

; XMLSuffix = .dita, on the command line requires the "-o .dita" switch.

XMLSuffix=.dita

; UseFrameTOC = Yes (default, except for Help formats and DITA), or

; No (default for Help formats and DITA)

UseFrameTOC=No

; UseFrameIX = Yes (default, except for Help formats and DITA), or

; No (default for Help formats and DITA)

UseFrameIX=No

; UseFrameGenFiles = Yes (default for all formats except DITA), or

; No (default for DITA)

UseFrameGenFiles=No

 

[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

 

[HTMLOptions]

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

StartingSplit=No

RunInHeads=Normal

RemoveANames=Yes

ATagElement=xref

XMLEncoding=UTF-8

NumericCharRefs=No

RemoveEmptyParagraphs=Yes

 

; Keep empty paragraphs empty if not removed.

EmptyParaContent=

; Footnotes are DITA-specific, but can still be removed with:

Footnotes=None

 

; The following standard XML settings cannot be overridden:

AllowOverrides=No

AlignAttributes=No

NoFonts=Yes

 

 

[Graphics]

; The following standard XML settings cannot be overridden:

GraphScale=No

 

[Table]

; Keep empty table cells empty.

EmptyTbCellContent=

; The following standard XML settings cannot be overridden:

TableAttributes=No

CellAlignAttributes=No

CellColorAttributes=No

 

[ConditionAttributes]

; Condition name = attributes for elements, where the DITA attribute

; name is usually one of props, platform, product, audience, or

; otherprops. For HTML, the attribute name is usually class.

;ProductA= product="A"

;ProductB= product="B"

 

[CSS]

; The CSS file generated for DITA specifies classes only, no tags,

; so that it can be used for HTML outputs generated from the DITA

; files (when [DITAOptions]UseOutputClass=Yes, and outputclass is

; converted to class attributes in the HTML). By default:

WriteClassAttributes=No

ClassIsTag=No

; which results in [DITAOptions]UseOutputClass=No. Note that setting

UseCSS=Yes

; sets UseOutputClass=Yes, if WriteClassAttributes is not set to No.

 

[Index]

; Frame sort strings produce index-sort-as elements.

UseSortString=Yes

 

[HTMLStyles]

; For DITA, Frame autonumbers are all suppressed by default.

*=NoAnum

; They can be restored for individual formats for special (non-numbering)

; purposes by setting the Anum property.

; Split is automatic for topic starts, and should not be used elsewhre.

 

 

; The rest of the sections here are specific to DITA. Most, but

; not all, include example settings.

 

[DITAOptions]

; DITAVer = DITA version point number, 1 (default, for 1.1) or 0 (for 1.0)

DITAVer=1

; UseDTDPath = Yes (default, use full URL to DTD at OASIS) or No (just

; use the DTD name with no path, required for XMetaL and some CMSs).

UseDTDPath=Yes

; DefTopic = name of topic type to use, default "concept", overridden by

; DITATopic marker and via [DITATopics] settings. If specialized, a

; DITAspecialname.ini must exist, such as DITAglossary.ini. The built-in

; data may also be overridden by such an ini, such as DITAconcept.ini.

DefTopic=concept

; TopicID = id for first topic in Frame file, default is base file name;

; may be set in a specific filename.ini, or in a DITATopicID marker.

; In addition, FileName markers can be used to set split file names and

; hence their topic IDs.

TopicID=YourTopicID

;

; These are used only when generating a TopicID from the file name:

; DITATopicIDSpaceChar = char to replace spaces, default none (remove space)

DITATopicIDSpaceChar=_

; DITATopicIDUnderscore = Yes (default, keep underscores) or No (remove)

DITATopicIDUnderscore=Yes

; DITATopicIDLowerCase = Yes (default, make all lower) or No (retain original)

DITATopicIDLowerCase=Yes

;

; FM8Import = No (default) or Yes (restrict output for compatibility

; with FrameMaker Version 8 DITA import and map usage). When Yes,

; changes defaults to DITAVer=0, MapTopicmeta=No, MapTopicID=No, and

; WrapTopicFiles=Yes. If the Leximation DITA-FMx plugin is used, this

; setting is *not* required for Frame 8.

FM8Import=No

;

; ForceStartTopic = Yes (default, make the format of the first para a

; topic start with tag "title" at level 1 and parent "topic"), or No

; (let the para produce invalid DITA if it doesn't have those settings).

ForceStartTopic=Yes

; SplitTopicFiles = Yes (default, each topic is a file, recommended as

; best practice) or No (all topics in the chapter are in a single file,

; either nested if NestTopicFiles=Yes or wrapped with <dita> tags or both).

; Topics are identified by frame formats mapped to the starting element

; (default "title") at DITA level 1.

SplitTopicFiles=Yes

; NestTopicFiles = No (default, recommended), or Yes (if SplitTopicFiles=No,

; nest the topics in the <dita> file per their [DITAMapLevels]). If a

; topic is nested in a glossary topic (which is invalid), the DITAMapLevel

; of the nested topic is decremented to make it a sibling. If a topic is

; set to a level more than one higher than the previous topic, its level

; is decreased so that no levels are skipped. If a topic is nested in a

; topic of a different basic type (topic, concept, task, or reference),

; WrapTopicFiles is set to make that nesting valid using DITA Composite.

; Any adjustments made to DITAMapLevel also affect the chapter ditamap.

NestTopicFiles=No

; WrapTopicFiles = No (default, wrap in <dita> tags only if required by a

; mixed-type nesting condition, or if SplitTopicFiles=No and the first topic

; does not nest all the rest), or Yes (always wrap in <dita> tags, needed

; to allow TopicIDs for Frame 8 import unless DITA-FMx is installed).

WrapTopicFiles=No

;

; UseFormatAsTag = No (default, if tag unmapped use default elem below),

; or Yes (if unmapped, use Frame format name if valid in content model).

; Unless the Frame template is specifically designed for DITA, this is a

; dangerous setting to make.

UseFormatAsTag=No

; DropInvalidParaTag = No (default) or Yes (if the para tag is the default

; DefParaElem <p> and is invalid, but #PCDATA is valid, drop the tag)

DropInvalidParaTag=No

; DefParaElem = element to use for Frame para formats that are not mapped

; in [DITAParaTags], default is "p".

DefParaElem=p

; DefCharElem = element for unmapped Frame char formats, default is "ph".

DefCharElem=ph

; DefTableElem = element for tables not listed in [DITATables], default

; is "table" which is the full, complex DITA table type.

DefTableElem=table

;

; UseOutputClass = No (default) or Yes (write [Classes] or Frame format

; name as the outputclass attribute on elements where that is legal).

; If you set UseOutputClass=Yes, don't set [CSS]WriteClassAttributes=No.

UseOutputClass=No

;

; KeepXrefText = No (default) or Yes (retain content of xref in DITA as

; is done for hyperlinks; prevents updating of xref text during later

; processing by the DITA Open Toolkit).

KeepXrefText=No

;

; UseLocalScope = No (default, omit scope attr from xref if not specified

; and href is not to a URL) or Yes (set scope="local" in those cases to

; satisfy applications (XMetaL) that do not respect #IMPLIED in the DTD).

UseLocalScope=No

;

; WriteDitamaps = Yes (default, overwrite existing maps if any, best

; if not editing by hand), or No (when using hand-edited chapter and

; book-level maps)

WriteDitamaps=Yes

; MapName = name to use (without extension) for the chapter ditamap.

; It overrides the default use of the chapter's base name for its map,

; and may also be set in a DITAMapName marker.

MapName=ChapterMapName

;MapID = id for Frame chapter file ditamap, default is base file name;

; may be set in a specific filename.ini, or in a DITAMapID marker.

MapID=ChapterMapID

;MapTitle sets a <title> element at the start of the chapter ditamap

; (effectively at map level 0); the content of the setting is the title.

; It can be overridden by a DITAMapTitle marker, and is best set in a

; filename.ini so that the same title is not used for all chapter maps.

; If [FileSequence]filename is set, that title is the MapTitle default.

MapTitle=Chapter Map Title

;MapHead sets a <topichead> element at the start of the chapter ditamap

; (effectively at map level 0) that contains the rest of the map entries;

; the content of the setting is the navtitle attribute. It can be

; overridden by a DITAMapHead marker, and is best set in a filename.ini.

; Unlike the MapTitle, the MapHead is included in the book .ditamap.

MapHead=Navigation Title for Chapter

;

; MapTopicmeta = Yes (default, include topicmeta with searchtitle and

; shortdesc, if any, in map topicrefs) or No (omit topicmeta, required

; for Frame 8 import without DITA-FMx).

MapTopicmeta=Yes

; MapTopicID = Yes (default, include topic ID with filename in maps) or

; No (use filename without ID, for Frame 8 import without DITA-FMx).

MapTopicID=Yes

;

; MapBookTopics = Yes (default, include <topicref> for each topic in the

; book .ditamap, and merge chapter reltables into the book map reltable),

; or No (include hrefs to chapter maps instead, better practice if it is

; supported by other tools used downstream). If a Frame file is in a book,

; the book is open, and WriteDitamaps=Yes, Mif2Go rebuilds the book map.

;

; If your book-level ditamap references other ditamaps that reference DITA

; files, and you ask Frame 8 to make your book-level map into a Frame book,

; you will get an error message (processing instruction ignored) for each

; file, but the resulting book, and all its chapters, will be correct. If

; instead your book-level ditamap references the DITA files directly, each

; DITA file (or each nested set of topicrefs) will become a chapter, which

; may be desirable for such purposes as creating a library of DITA topics

; to be referenced elsewhere as insets. The DITA-FMx plugin permits both.

MapBookTopics=Yes

;

; UseRelNameColumn = Yes (default, make first col of reltable with ALink

; name in <data> element) or No (use only the usual topic-type columns).

UseRelNameColumn=Yes

; BookMapName is the same as MapName, but for the book ditamap file,

; except that it has no corresponding marker to override it.

BookMapName=BookMapFileName

; BookMapID is the same as MapID, but for the book ditamap file,

; except that it has no corresponding marker to override it.

BookMapID=BookNapID

; BookMapTitle is the same as MapTitle, but for the book ditamap file,

; except that it has no corresponding marker to override it.

BookMapTitle=Book Map Title

; BookMapHead is the same as MapHead, but for the book ditamap file,

; except that it has no corresponding marker to override it.

BookMapHead=Navigation Title for Book

;

; SpecIniDir = path to add to names of specialized .inis, default "./".

SpecIniDir= ./

;

; VariableType = Text (default), Entity (for compatibility with DITA-FMx

; import), or Conref (referring to a variable library file). For Entity,

; the entity name is the name of a Frame variable with spaces and any

; punctuation removed, and the entity definition is plain text only.

; Each topic contains only entity declarations for the entities actually

; used in it. This method allows DITA-FMx, from Leximation, which is the

; successor to the Frame 7.2 DITA AppPack withdrawn by Adobe, to recognize

; Frame variables on re-import of the generated DITA files.

VariableType=Text

;

; The following four settings are effective only if VariableType=Conref:

;

; VariableFile = file for referencing variables, containing a single

; topic with a single Definition List in its body. Each Definition Term

; is the name of a variable with spaces and punctuation removed, and the

; corresponding Description has an ID identical to the name, and content

; in plain text only identical to the Frame variable definition.

VariableFile=ditavars.dita

; VariableTopicID = topic ID for the single topic in the VariableFile

VariableTopicID=varset

; VariableElement = wrapper element for variables, valid in a dd element.

VariableElement=ph

; WriteVariableFile = No (default) or Yes (write a file containing all

; variables defined in the Frame file after processing that file).

WriteVariableFile=No

;

; TextInsetMark = No (default) or Yes (mark text inset start and end,

; using <data> elements to specify the FrameMaker source for the inset)

TextInsetMark=No

; TextInsetNest = No (default, ignore nested insets) or Yes (mark them)

TextInsetNest=No

 

 

[Markers]

; Two attribute marker types are added for DITA, but work in all formats:

; Para* for attributes meant for the current block element.

; Char* for attributes meant for the current inline element.

; As with the other attribute markers, the rest of the type name is the

; attribute name, and the content is the attribute value. A sequence of

; identically-named markers is combined so that the contents form a single

; attribute, to get around Frame's 250-char size limit for markers.

 

[MarkerTypes]

; The following special MarkerTypes are recognized only when the output

; is to DITA. All the type names begin with "DITA":

;

; DITATopic specifies the type name for the current topic (overriding

; the [DITAOptions]DefTopic setting). It can be anywhere in the topic.

;

; DITATopicID specifies the ID attribute for the current topic.

; DITAElemID specifies the ID attribute for the current block element.

; (At the start of the topic, it specifies the <title> id.)

; DITAParentID specifies the ID for a parent of the current block

; element, when that parent is interpolated by Mif2Go and therefore

; cannot be set by DITAElemID; the content is "parentname=parentid"

; (with *no* spaces around the =).

;

; DITAAttribute specifies attributes other than ID to use for the

; current block element or for one of its interpolated parents.

; Content is: 'tag: attr1="val1" attr2="val2" ...' To apply attrs

; to more than one parent, use a separate marker for each parent.

; You can use Mif2Go macros for everything after the colon. Do not

; use this marker in place of the Link attribute markers below.

; It overrides DITAParaAttributes and DITAParentAttributes, but

; not DITACharAttributes or DITATableAttributes.

;

; DITAAlias specifies a Frame format name to be used in place of

; the paragraph format of the current block for DITA purposes,

; including lookup in the [DITA*] mif2htm.ini sections, overriding

; any [DITAAlias] mapping.

;

; DITATag specifies the element name mapping for the current block

; (not inline) element, overriding [DITAParaTags] mapping.

; DITALevel specifies the level at which the current block element

; should appear in the DITA file, overriding [DITALevels].

; DITAParent specifies the required parents for the current block

; element where that is ambiguous, overriding [DITAParents].

; DITAFirst specifies the parents under which the current block element

; must be first, overriding [DITAFirst].

;

; DITAOpenBefore causes the named elements to be opened, with any other

; elements nested under them, just before the current block element,

; overriding [DITAOpenBefore].

; DITAOpenAfter causes the named elements to be opened, with any other

; elements nested under them, just after the current block element,

; overriding [DITAOpenAfter].

;

; DITACloseBefore causes the named elements to be closed, with any other

; elements nested under them, just before the current block element,

; overriding [DITACloseBefore].

; DITACloseAfter causes the named elements to be closed, with any other

; elements nested under them, just after the current block element,

; overriding [DITACloseAfter].

;

; DITANavTitle is included in the Frame para that will be the <title>

; element, and specifies the alternate title for navigation use.

; It also appears in the map's <topicref> as the navtitle attribute,

; as does any navtitle para in the topic.

; DITASearchTitle is included in the Frame para that will be the <title>

; element, and specifies the alternate title for search-result use.

; It also appears in the <topicmeta> in the map's <topicref> as the

; <searchtitle> element, as does any searchtitle para in the topic.

;

; DITACode contains the XML code to be inserted at the marker location.

;

; DITAStartElem contains the tag name for the start of an inline element.

; DITAEndElem contains the tag name for the end of an inline element.

; These are only for inline (char) elements. When block (para) elements

; must be inserted this way, use DITAParent and DITACloseBefore/After.

;

; DITALinkScope sets the scope attribute for the next <xref> element,

; usually to set scope=peer. Otherwise scope=external if the link is

; set using a message URL hypertext marker, or omitted for the default

; scope=local.

; DITALinkFormat sets the format attribute for the next <xref> element,

; needed only if the built-in format-determining rules get it wrong.

; DITALinkType sets the type attribute for the next <xref> element,

; which is currently set to the DITA type (root element) of the linked

; topic, and omitted if the link is set using a message URL hypertext

; marker. Other valid values include li, fn, fig, table, and section.

; DITALinkElemID sets the element ID to use after the topic ID in the

; link href, for links below topic level, for use when the built-in

; rules used to determine the element ID provide the wrong one or none.

;

; DITAMapName sets the base name (without extension) to use for the

; Frame chapter file's ditamap.

; DITAMapID sets the id attribute for the root element of the Frame

; chapter file's ditamap.

; DITAAnchor sets an <anchor> element in the ditamap after its topic's

; <topicref>; the content of the marker is the id attribute.

; DITANavRef sets a <navref> element in the ditamap after its topic's

; <topicref>; the content of the marker is the mapref attribute.

; DITAMapRef sets a <topicref> element in the ditamap after its topic's

; <topicref>; the content of the marker (a map file name) is the href

; attribute, and the format attribute is set to "ditamap".

; DITALinkText appears in the <topicmeta> in the map's <topicref> as the

; <linktext> element.

; DITAShortDesc appears in the <topicmeta> in the map's <topicref> as the

; <shortdesc> element, as does any shortdesc para in the topic.

; DITAMapTitle sets a <title> element at the start of the chapter ditamap

; (effectively at map level 0); the content of the marker is the title.

; DITAMapHead sets a <topichead> element at the start of the chapter ditamap

; (effectively at map level 0) that contains the rest of the map entries;

; the content of the marker is the navtitle attribute.

;

; DITARelRow adds a <topicref> to the current topic to the <reltable> in

; the chapter map; the content of the marker is the row name. This is

; equivalent to the ALink marker in other Help systems, so if such ALink

; markers already exist, set [MarkerTypes]ALink=DITARelRow.

; DITARelLinking applies to the current topic's <topicref> in the chapter

; map <reltable>; it sets the linking attribute to its content, which

; may be "targetonly" or "sourceonly".

 

 

[DITAAlias]

; Frame paragraph format = Frame format name to use in place of that

; paragraph format for DITA purposes, including lookup in other [DITA*]

; mif2htm.ini sections; can be overridden by a [DITAAlias] marker.

x2Title=Heading1

 

 

[DITAParaTags]

; Frame paragraph format (wildcards OK) = DITA element, can be

; overridden by a DITATag marker. The element name "No" means that

; the tags for the format should be omitted, leaving the text inside

; the enclosing element. If the Frame format must set typographic

; elements (b, i, u, tt, sup, or sub) in addition to the element to

; which it is mapped here, use [DITATypographics] to add the rest.

Heading*=title

Meta=keyword

Body=p

Example=p

List=sli

Numbered1=p

Numbered=p

Bulleted=p

DefTerm=dt

DefDescription=dd

ParamTerm=pt

ParamDescription=pd

CellHeading=p

CellBody=p

Figure Title=title

Step=cmd

Syntax=p

CellContent=No

GlossItem=glossterm

 

 

[DITACharTags]

; Frame character format (wildcards OK) = DITA element, *cannot* be

; overridden by a DITATag marker. The element name "No" means that

; the tags for the format should be omitted, leaving the text inside

; the enclosing element. If the Frame format must set typographic

; elements (b, i, u, tt, sup, or sub) in addition to the element to

; which it is mapped here, use [DITATypographics] to add the rest.

Strong=b

Emphasis=i

BoldItalic=b

Subscript=sub

Superscript=sup

Mono=tt

Link=No

 

 

[DITAParaAttributes]

; Frame para format (wildcards OK) = attributes, which may contain

; Mif2Go macros. Can be overridden by a DITAAttributes marker.

 

[DITACharAttributes]

; Frame char format (wildcards OK) = attributes, which may contain

; Mif2Go macros. Cannot be overridden by a DITAAttributes marker.

 

 

[DITAParaTypographics]

; Frame para format (wildcards OK) = DITA typographic elements

; (any or all of b, i, u, tt, sup, or sub) to use in addition to

; the element to which the Frame format is mapped in [DITAParaTags].

; We advise minimal use of this feature; any such typographic

; presentation markup is best left to later processing, as with

; a CSS rule based on the outputclass attribute of the DITA

; semantic element. But it is available when unavoidable.

ShortDesc=b

 

 

[DITACharTypographics]

; Frame char format (wildcards OK) = DITA typographic elements

; (any or all of b, i, u, tt, sup, or sub) to use in addition to

; the element to which the Frame format is mapped in [DITACharTags].

; We advise minimal use of this feature; any such typographic

; presentation markup is best left to later processing, as with

; a CSS rule based on the outputclass attribute of the DITA

; semantic element. But it is available when unavoidable.

BoldItalic=i

 

 

[DITALevels]

; Frame para format (wildcards OK) = level in DITA (not Frame) file

; required for the DITAParaTag specified for this element. The top

; heading in the topic body is at level 3 (a title below topic, body,

; and section). This can be overridden by a DITALevel marker. It is

; best used to specify level 1 for formats that start topics.

Title=1

Heading*=1

GlossItem=1

 

 

[DITAParents]

; Frame para format (wildcards OK) = required parents, used for such

; formats as lists, where <li> elements under <ul> and <ol> are

; needed in addition to the <p> mapped in [DITAParaTags]. Not needed

; for elements that can have only a single parent, or if Mif2Go can

; determine hueristically which of the possible parents fits the

; context best. Can be overridden by a DITAParent marker. Element

; sequence is significant, and must be top-down.

Title=topic

Heading*=topic

Numbered1=ol li

Numbered=ol li

Bulleted=ul li

Example=example

Figure Title=fig

Syntax=refsyn

 

[DITAParentAttributes]

; Frame para format (wildcards OK) = parentname: attributes for

; any one parent newly interpolated for that format. The attibutes

; may contain Mif2Go macros. Can be overridden by a DITAAttributes

; marker; if more than one parent requires attributes, markers must

; be used for all but one of them.

 

[DITAFirst]

; Frame para format = parents under which the current block element

; (or one of its parents) must be the first child. Used mainly for

; lists, to ensure that the para starts a new list item or a new

; list. Can be overridden by a DITAFirst marker. Element sequence

; is significant, and must be top-down. The "first" rule applies to

; the bottommost instance of each element in [DITAParents] or in

; the current set of ancestors in the document.

Numbered1=ol li

Numbered=li

Bulleted=li

 

 

[DITAElementSets]

; $setname = DITA elements in the set. The set can be used in place

; of an element name in [DITAParents], [DITAFirst], or the corresponding

; markers. It means that any element in the set is acceptable at that

; point in the hierarchical sequence. There is no equivalent marker.

; These are predefined in the starting .ini for DITA:

$top=body section step

$text=body conbody taskbody refbody section example step refsyn entry

$list=ol ul

 

 

[DITAOpenBefore]

; Frame para format = elements to be opened, with any other elements

; nested under them, before the current block element starts. Used

; to force opening of elements when [DITAParents] does not suffice.

; Can be overridden by a DITAOpenBefore marker.

 

 

[DITAOpenAfter]

; Frame para format = elements to be opened, with any other elements

; nested under them, after the end of the current block element. Used

; to force opening of elements when [DITAParents] does not suffice.

; Can be overridden by a DITAOpenAfter marker.

 

 

[DITACloseBefore]

; Frame para format = elements to be closed, with any other elements

; nested under them, before the current block element starts. Used

; to force closure of elements that were opened using [DITAParents].

; Can be overridden by a DITACloseBefore marker.

Body=ul ol

 

 

[DITACloseAfter]

; Frame para format = elements to be closed, with any other elements

; nested under them, after the end of the current block element. Used

; to force closure of elements that were opened using [DITAParents].

; Can be overridden by a DITACloseAfter marker.

FigAnchor=fig

 

 

[DITATopics]

; Frame para format = suggested topic type to use, if no DITATopic

; marker found. Include only formats specific to topic types other

; than the DefTopic; be sure to include the format that starts any

; topics for which the starting element is not "title".

Step=task

Syntax=reference

GlossItem=glossary

 

 

[DITATopicFileNamePrefix]

; DITA topic type = prefix to use on DITA topic file name

concept=c_

task=t_

reference=r_

glossary=g_

 

 

[DITATables]

; Frame table format (wildcards OK) = base table type, one of table,

; simple, choice (in task), or property (in reference). Note that

; these names are *not* the DITA table tags, but are purely Mif2Go

; identifiers; more can be defined in the specialization .inis.

; Another type, figure, is an alias for simple, intended for use

; when a document contains images in tables that are followed by

; table titles (where the DITAParent is fig). The simpletable is

; then placed after the title element, wrapped in the fig with it.

Format A=table

Format B=simple

Choices=choice

Properties=property

 

[DITATableAttributes]

; table type = attributes to be used for every instance

 

 

[DITAMapLevels]

; Frame para format = level of topics it starts in chapter ditamap,

; default is 1. If missing, [HelpContentsLevels] are used instead.

; If NestTopicFiles=Yes, these levels may be adjusted by Mif2Go to

; achieve a valid result.

 

 

[DITAMapUsage]

; Frame para format that starts topic = Topic, Head, or None.

; Topic (default) to include in ditamap normally.

; Head to use head only, no href, in map.

; None to exclude from map entirely.

; The map file is named for the Frame file with extension .ditamap.

 

 

[DITARelGroups]

; DITA type name = collection-type attribute to use in the <colspec> for

; the chapter map <reltable> column for that DITA type. Default is no

; collection-type, so that topics in that column do not link to each other

; but only to topics in other columns in the same row. Possible values are:

; "family" (equivalent to usual ALink behavior), "sequence" (links are in

; order of appearance in the chapter), or "choice" (processor dependent).

;

; For example, "concept=family" and "task=sequence" would cause concept

; topics to link to other concepts and to task and reference topics in the

; same row (same DITARelRow setting), task topics would link to each other

; as an ordered set and to concept and reference topics normally, and the

; reference topics would link with task and concept but not with each other.

concept=family

task=sequence

 

 

[DITARelBookGroups]

; Does the same as [DITARelGroups], but for the book ditamap instead.

; If not found, [DITARelGroups] is used for the book reltable too.

 

 

[DITABookmapOptions]

; BookmapType = ditamap (default) or bookmap (1.1 only, uses the

; [DITABookmapFiles] section to categorize bookmap components)

BookmapType=ditamap

;

; These three settings comprise the bookmap booktitle element:

; BookTitle = mainbooktitle for bookmap; if missing, BookMapTitle is

; used in a title element instead.

BookTitle=Your Book Title

; BookSubtitle = optional booktitlealt for bookmap.

BookSubtitle=Your Subtitle for the Book

; BookLibrary = optional library catalog information text, can be a

; macro file or [section] reference.

BookLibrary=<$./yourdescription.txt>

;

; BookMeta = DITA content, can be macro file or [section]; if omitted,

; no bookmeta element is included. A bookmeta.xml file is imcluded in

; the distribution to use as a starting template; it is annotated and

; must be edited, or will cause validation of the bookmap to fail.

BookMeta=<$.\yourmetadata.xml>

 

[DITABookmapFiles]

; filename without .ext = role, one of Chapter (default), Part, Appendix,

; Front, Back, None (omit from map), or a *Seg directive (below).

; When a *Seg directive is used, it must be the first item in the list.

; If Front, follow with one of Lists (default), Notice, Dedication,

; Colophon, Abstract, Draftintro, or Preface.

; If Back, follow with one of Lists (default), Notice, Dedication,

; Colophon, or Amendment.

; If Lists (or just Front or Back), follow with one of TOC (default for

; Front), LOF, LOT, Abbr, Trademark, Biblio, Glossary, IX (default for

; Back), or Booklist (used for other types of Frame-generated files

; such as LOM/IOM).

; Part (which may be followed by Chapter if it is not a file of its own)

; logically contains all Chapters until the next Part, or the first

; Appendix, or the first Back item.

;

; Entries appear in the bookmap in the Frame .book sequence. Note

; that if a different sequence is needed in the bookmap, another

; Frame .book must be created which has the bookmap sequence. If

; MapBookTopics=No, the href is to the ditamap generated for the

; Frame chapter file. If MapBookTopics=Yes, and the chapter file

; has one top-level topic in its map, that topicref is renamed as

; the chapter (or other appropriate) element. If the chapter file

; has more than one top-level topicref, its topicrefs are instead

; wrapped in the chapter element, which has no href in that case

; unless one is supplied in [DITABookmapHrefs].

;

; If a Frame file contains more than one bookmap item, that usage

; is shown by:

; filename=MultiSeg #topicid1 #topicid2 ... #topicidN

; #topicid1=(roles as above)

; ...

; #topicidN=(roles as above)

; In this case, each topicref for the specified topic ID includes

; any topicrefs nested within it. Each topicref cited above may

; be nested at any level in its chapter ditamap, or not nested.

; The topics are listed in the sequence used in the bookmap; the

; original sequence in the chapter ditamap is ignored. If any

; topicref is not mentioned after MultiSeg (and is not nested in

; one that is mentioned), it is excluded from the bookmap.

;

; If multiple Frame files comprise a single bookmap item, use this

; segment syntax instead:

; filename1=StartSeg (roles as above, for full item)

; filename2=ContinueSeg (*no* roles)

; ...

; filenameN=EndSeg (*no* roles)

; In this case, all topicrefs from all the segment chapter ditamaps

; are wrapped withon one new chapter-level element with no href.

; The filenames should be consecutive in order in the Frame book.

;

; If any file in the Frame .book is omitted from this section, it

; is included in the bookmap based on its own type and its position

; relative to other files that are in this section. An omitted non-

; generated file that is after the TOC (if any) becomes a chapter.

;

; If this section is omitted, the bookmap contains one entry for each

; Frame file, with a Front containing the Frame TOC and a Back

; containing the Frame IX. Any other generated files appear in the

; Front or Back as a Booklist, based on their location in the Frame

; book. All non-generated files are Chapters, except for any

; preceding the TOC, which become topicrefs in Front.

 

[DITABookmapTitles]

; filename without .ext = navtitle attribute for its wrapper element,

; used only when such wrappers are produced for the bookmap. For a

; file mapped to Part as well as Chapter, the navtitle applies to the

; part tag. If the file is MultiSeg, and a wrapper is needed for one

; segment, the #topicID is used as the filename. For a StartSeg/EndSeg

; group, the StartSeg filename is used to specify the title for the

; full wrapper.

 

[DITABookmapHrefs]

; filename without .ext = href attribute for its wrapper element,

; using the same rules as for Titles above. The href is to a topic

; that is not already in the .book, provided as an introduction to

; the wrapped topics.

 

[DITABookmapHrefTypes]

; filename without .ext = type attribute for its wrapper element,

; for the specified href, using the same rules as for Titles above.

 

[DITABookmapHrefFormats]

; filename without .ext = format attribute for its wrapper element,

; for the specified href, using the same rules as for Titles above.

 

[DITABookmapHrefScopes]

; filename without .ext = scope attribute for its wrapper element,

; for the specified href, using the same rules as for Titles above.

 

 

[DITAContentModels]

; Topic specialization type name = any text (not used), causes Mif2Go

; to load the corresponding filename, such as DITAspecial.ini, located

; in the [DITAOptions]SpecIniDir, at startup. It is not needed if the

; topic type is explicitly requested by [DITAOptions]DefTopic or in a

; DITATopic marker, in which case it loads on demand. If the topic

; type info replaces one or more of the built-in types (topic, concept,

; task, reference, glossary, map, and bookmap) this is the way to load

; it. See ContentModel.txt (in the content model configuration appendix)

; for the contents of DITAspecial.ini files.

 

 

[End]

 

 



> G DITA/DocBook configuration