Overview of the properties supported and how to maintain multiple property maps.
Property Mapper has two commands, Generate Property Map and Apply Property Map. Use Generate Property Map to create a property map file from an existing template and Apply Property Map to update the properties in a FM file based on the properties defined in the selected map.
The property map file uses the DITA XML model for storing the property definition data. Only a specific subset of DITA is supported for this mapping; anything else in the file is ignored. The properties are stored in the dl element structure. You can use one or more dl groups to store the properties. The dlentry element stores each property definition, which is made up of an object type (such as paragraph format or character format), a property of that object, the name of the object, and the property definition.
After generating a property map file with the Generate Property Map command, you may want to delete property definitions that don’t need to be changed. The intent is that you’d set up a property map for one language (perhaps named “propmap-enu.xml”), then copy that file to a new name (such as “propmap-fra.xml”), then edit the property definitions in each language-specific map.
You can edit the PropertyMapper.ini file to control the default objects or properties that are written to the property map file. This INI file is created in the Pubs-Tools folder (use the Open Pubs-Tools Folder command to locate). The OKWrite section contains entries for each object and property (as OBJ:PROPERTY). By default these are set to “1”, but you can disable each by setting it to “0”. Disabling an object disables all properties of that object.
When using the Apply Property Map command, the properties defined in that map file are applied to the current file or book.
There are two ways this data can be stored in the XML. One option is to group all properties of a specific object type in a dl list:
...
<dl>
<dlhead><dthd>OBJECT</dthd></dlhead>
<dlentry>
<dt>PROPERTY:OBJECT-NAME</dt>
<dd>PROPERTY-DEFINITION</dd>
</dlentry>
...
</dl>
...
The other option is to embed the object name in the dt as follows:
...
<dl>
<dlentry>
<dt>OBJECT:PROPERTY:OBJECT-NAME</dt>
<dd>PROPERTY-DEFINITION</dd>
</dlentry>
...
</dl>
...
The dt element contains the OBJECT, PROPERTY, and OBJECT-NAME values separated by a colon (“:”) delimiter. If you need to use an alternate delimiter, you can specify that in an othermeta element in the prolog of the DITA file as follows:
<othermeta name='delimchar' content='#'/>
This “delimchar” value can also be defined in the PropertyMapper.ini file through the PropDelimChar parameter in the General section. A value set via the othermeta element will override that set in the INI file.
The valid values for OBJECT are:
Doc - the document object
PgfFmt - paragraph format objects
CharFmt - character format objects
XRefFmt - cross-reference format objects
VarFmt - variable format objects
The dd element contains the definition or value of the property. Do not use any child elements in the dd (unless you’re setting the Tabs property).
The OBJECT-NAME value can make use of the asterisk (*) as a wildcard to assign the same property value to multiple named objects of the same type. For example, if you want to assign the same property value to all paragraph tags, just use “*” as the OBJECT-NAME value. Or if you want to assign a property value to all paragraph tags that start with “list-”, use “list-*” as the OBJECT-NAME value.
If you are applying the property map to a structured book, and some of the book components require different values for the same property, you can assign a value to the otherprops attribute on the dd element to use for selecting from multiple dd values. For more information see Multiple Property Values.
The properties and valid values for each object type are described below. The FDK property set by each property is the same name with an “FP_” prefix.
Sets the document display units ( : Display Units). The units set here should match those used for indents and tabs. Because the “Doc” object is not a named object, there is no “OBJECT-NAME” to specify in the dt element.
Valid values are: cm mm in inch pc pica pt point dd didot cc cicero
Sets the Autonumber Format (Numbering tab) for the specified paragraph format name. This value must contain valid building blocks and escape characters for use in that field in the FrameMaker UI.
Sets the Font Family (Default Font tab) for the specified paragraph format name. This value must be a valid font family name. To specify the “As Is” setting, use [AsIs].
Sets the Combined Font Family (Default Font tab) for the specified paragraph format name. This value must be a valid combined font family name (only available on systems that support Asian character sets). To specify the “As Is” setting, use [AsIs].
Sets the Language (Default Font tab) for the specified paragraph format name. Valid language values are listed below (as of FM12), to specify the “As Is” setting, use [AsIs].
usenglish ukenglish deutsch swissgerman francais canadianfrench espanol catalan italiano portuguese brasil danish dutch norwegian nynorsk finnish svenska japanese traditionalchinese simplifiedchinese korean
It appears that other language strings are valid as well, such as newgerman.
Sets the Color for the specified paragraph format name. This value must be a valid color name. To specify the “As Is” setting, use [AsIs].
Sets a new name for the specified paragraph format. Both the catalog name and all instances of this tag in the document will be renamed. Obviously, this will not work if the specified paragraph format name makes use of a wildcard.
Sets the Hyphenate option (Advanced tab) for the specified paragraph format name. Valid values are: 1, 0, true, or false (case-insensitive).
Sets the Max # Adjacent option (Advanced tab) for the specified paragraph format name. Valid value is a positive integer.
Sets the Shortest Word option (Advanced tab) for the specified paragraph format name. Valid value is a positive integer.
Sets the Shortest Prefix option (Advanced tab) for the specified paragraph format name. Valid value is a positive integer.
Sets the Shortest Suffix option (Advanced tab) for the specified paragraph format name. Valid value is a positive integer.
Sets the First Indent option (Basic tab) for the specified paragraph format name. Valid value is a units value (1.5", 1.5in, 1.5cm, etc.).
Sets the Left Indent option (Basic tab) for the specified paragraph format name. Valid value is a units value (1.5", 1.5in, 1.5cm, etc.).
Sets the Right Indent option (Basic tab) for the specified paragraph format name. Valid value is a units value (1.5", 1.5in, 1.5cm, etc.).
Sets the Frame Above Pgf. option (Advanced tab) for the specified paragraph format name. Valid value is a valid frame name.
Sets the Frame Below Pgf. option (Advanced tab) for the specified paragraph format name. Valid value is a valid frame name.
Sets the Direction option (Direction tab) for the specified format name. Valid values are RTL, LTR, or Inherit. To specify the “As Is” setting, use [AsIs].
Sets the Tab Stops (Basic tab) for the specified paragraph format name. This feature just modifies existing tab stops, it cannot be used to add or remove tab stop definitions. If you’re changing the units, be sure to set the Doc:ViewDisplayUnits value to a matching units before setting the tab values.
Requires the use of a 4-column simpletable within the dd element. See Tab structure, below, for details.
Note that the tab structure is not written by the Generate Property Map command. If you want to use this you have to create it manually.
Sets the Font Family for the specified character format name. This value must be a valid font family name. To specify the “As Is” setting, use [AsIs].
Sets the Combined Font Family for the specified character format name. This value must be a valid combined font family name (only available on systems that support Asian character sets). To specify the “As Is” setting, use [AsIs].
Sets the Language for the specified character format name. Valid language values are listed below (as of FM12), to specify the “As Is” setting, use [AsIs].
usenglish ukenglish deutsch swissgerman francais canadianfrench espanol catalan italiano portuguese brasil danish dutch norwegian nynorsk finnish svenska japanese traditionalchinese simplifiedchinese korean
It appears that other language strings are valid as well, such as newgerman.
Sets the Color for the specified character format name. This value must be a valid color name. To specify the “As Is” setting, use [AsIs].
Sets a new name for the specified character format. Obviously, this will not work if the specified character format name makes use of a wildcard.
Unlike other named objects, use of this property will not result in existing instances of the specified character format being renamed as well; only the name in the catalog will change.
Sets the cross-reference format definition for the specified cross-ref name. This value must contain valid building blocks for use in that field in the FrameMaker UI.
Sets a new name for the specified cross-reference format. Both the catalog name and all instances of this format in the document will be renamed. Obviously, this will not work if the specified cross-reference format name makes use of a wildcard.
Sets the variable format definition for the specified variable name. This value must contain valid building blocks for use in that field in the FrameMaker UI.
Sets a new name for the specified variable format definition. Both the catalog name and all instances of this variable in the document will be renamed. Obviously, this will not work if the specified variable format name makes use of a wildcard.
If you need to specify the PgfFmt:Tabs property in your map, you enter that data as a 4-column simpletable element within the dd element. Each row of the table specifies the properties of each tab stop. The types of data in each column are as follows:
Offset from left margin (1.5", 1.5in, 1.5cm, etc.)
Type of tab.
FV_TAB_LEFT - Left tab
FV_TAB_CENTER - Center tab
FV_TAB_RIGHT - Right tab
FV_TAB_DECIMAL - Decimal tab
Leader value (string that appears before the tab).
Decimal alignment character.