Edd Formatting

Customising
FrameMaker 12/13
Overview
Introduction ......................................................................... 2
Terminology.................................................................... 3
General procedure for customisation............................... 5
UI properties ........................................................................ 7
Workspaces..................................................................... 7
Toolbars ......................................................................... 8
Files for the UI................................................................. 9
Relationship between the UI files................................... 10
Menus ................................................................................ 11
Customising menus ...................................................... 12
Example menu customisation........................................ 13
Toolbars............................................................................. 14
Customising Toolbars ................................................... 14
Example toolbar............................................................ 14
Configuration files.............................................................. 17
Statements in configuration files ................................... 18
Debugging customisation files ...................................... 19
Tags in toolbar files............................................................ 20
Tool tags....................................................................... 21
Detail tag ...................................................................... 22
Toolbar commands ....................................................... 23
Toolbar icons ................................................................ 24
Extract icons ................................................................. 26
Commands......................................................................... 27
Command examples ..................................................... 27
Command statements ................................................... 28
Modify statement .......................................................... 29
Command details .......................................................... 30
Some particularities of commands................................. 34
Command names from plugins and scripts ................... 38
Menu statements .......................................................... 41
Workspace definition .......................................................... 44
Initialisation files maker.ini and others ............................... 46
Customising FrameMaker 12/13
Introduction
From the beginning FrameMaker could be customised.
 Menus can be switched from complete to quick. This is a
standard feature.
 Menus can be modified.
 Commands can be created and referenced in menus and
toolbars.
Until the arrival of the new user interface with FM-9 the pro-
cess was described in an Adobe file, which was lastly issued
for FM-7. The text provided by this file was grosso modo still
valid for FM 11. However, the new interface requires signifi-
cantly more information, which is not available from Adobe
until now.
Document history
This document is not 2013-02 Use FM-11 version of document as a base.
sacrosanct. In particular it FM-12-M1 introduces two button sizes and colours.
has not been verified by Image reference in toolbar.xml files can use a base-
Adobe and hence may name. The additional product interface XML-Author
contain errors or has no influence on this document.
misinterpretations.
2014-05 Clarify the situation with non-existing toolbar-
Readers are requested to
icons.
communicate errors or
enhancements to the author 2014-09 Check the situation with FM-13-M1. It seems that
klaus(daube.ch) nothing related to the customisation has changed.
2015-03 Reworking the structure of the document in some
places to get a ‘more logical’ sequence.
2015-12 Add text concerning scripts as commands. Amend
the example toolbar with this.
2016.01 Change the document title to reflect scope of docu-
ment; rework structure; add scheme and examples.
2016-02 Clarifications concerning command names from
scripts and plugins, clean up the example files.
2016-03 Clarifications with the help of an Irishman.
Sources  Experiments and beta testing activities.

 Communication in FrameMaker related forums as well as
personal communication with members of these forums.
 (Very sparse) communication with Adobe developers.
 User guides for FrameMaker.
 Adobe blogs
 Video: Getting started with the new FM-9 UI
 Video: Workspace overview
 Video: Customize and manage the Workspace
Explanation of fonts and Menus and names from the user interface are in > this > font.
highlights Variables (place holders) use italic script.
Keywords and the like are in fixed pitch font.
This is sample code
24 – 2
Introduction
Terminology
Note: IMHO the terminology of FM has not yet settled. The term pod
should be eliminated - but is used since FM-9 and confuses
more than it clarifies. Panel, palette and dialogue are some-
what synonymous. Terminology is not coherent between the
workspace files, the tool tips and context menus.
For better understanding of some terms look at the picture
Elements of the workspace on page 5
2016-03-29
$HOME The FM installation directory. In my case this is

H:\Adobe\FrameMaker.12en\AdobeFrameMaker12 - and
H:\Adobe\FrameMaker.13en\AdobeFrameMaker20151).
Access character An access character 2) in a menu item is preceded by the ‘&’
symbol (e.g. E&xit).
In Windows 7 and beyond these access characters are visible
at the menu items only when pressing the left ALT key. To
E:\_DDDprojects\FM-toolbar00\AllETB\etb-customising-fm12.fm
use the short cut for Exit, you type left ALT f x.
Dialogue Prior to FM-9 a dialogue was either modal or non modal. Some
of these have been replaced by dockable panels which can be
grouped into panel groups and minimised to icons.
Even in FM-12 there are still many of the old dialogues active.
Dock A dock is an area on the application window to which UI ele-
ments can be docked (anchored) and aligned.
Dock content What can be in
palatte toolbar Iconised or expanded dialogs/pds, the graphics palette
multi-controlbar Horizontal groups of toolbars on top of the application
window
palette Special tab panes such as the bottom pod (palette-kit data)
FCode The function code is the connection between the command

(as defined in a configuration file such as cmd.cfg) and the
routine in the application which performs the function.
Menus and commands The UI information basically is split into 2 groups:
 Command sets assembled according to views.
 Menus and tool bars assemble according to views.
modal vs. non-modal  A modal dialogue must be closed before work can continue
on the document.
 A non-modal dialogue could stay open like a palette.
Panel A docked or undocked dialogue, which need not be closed to
D
work on the document. The automatic behaviour depends on

Preferences > General > Interface > Pods.
Panel group A collection of panels which can be handled as a whole.
Pod A dockable panel. This seem to be a synonym for panel. The
term was first used in RoboHelp.
1 The installation program does not allow to modify the last level. This is
due to new mechanism (introduced with FM-10) using a data base for in-
stallation/de-installation.
2 The Adobe document calls this a mnemonic shortcut. The access character
must be carefully chosen to avoid duplicates within a menu.
24 – 3
UI User interface. The elements of user interaction: windows,

panes, menus and dialogues. Also keyboard shortcuts belong
into this category.
Palette This term was first used in FM for the read-only FM-docu-
ments which behave as non modal dialogues (Equation pal-
ette, Vertical toolbar, Template browser, Element catalogue
…). This term is still used in the workspace files.
Product interface FM≥12 contains three product interfaces (also known as
modes): Structured, UnStructured and XMLAuthor. XMLAuthor
is a stripped down version of the structured interface and
also available as own product.
Toolbars Toolbars are an alternative to menus for a desired function.
User-area In Windows 7 this is
C:\Users\user\AppData\Roaming\Adobe\FrameMaker\11\
View Views were introduced with FM-11. A view groups elements of
a workspace. Hence there are more menus and toolbar groups
than before FM-11.
In Structured mode there are three views: XMLView, AuthorView,
and WYSIWYGView. See Relationship between the UI files on
page 10. These are represented as icons in the top right hand
corner before the Workspace selection:
Unstructured mode knows only the WYSIWYGView. In the above

picture this is the rightmost icon (active).
This has consequences for the customisation: it is no more
sufficient to have a $HOME\fminit\configui\cstomui.cfg file.
The contents of such a file must also be appended to a menu
file.
Workspace A workspace is a saved set of frequently used panels/toolbars
in a desired arrangement for repeated use.
24 – 4
Introduction
Elements of the The workspace contains various elements, which are demon-
workspace strated on the following screen shot:
1 2
4
3
5 7
2016-03-29
9
1 Menu bar
2 Arrangement panel. A chosen arrangement (e.g. 2 docu-
ment panes side by side) is not saved in the workspace file.
3 Multi control bar (dock) spanning multiple rows of tool
bars. In the workspace file a row of this is a Control Bar
Pane.
4 Toolbar, docked. In the workspace file this is a Control Bar.
5 Toolbar, undocked = floating
6 Graphic toolbar (undocked, horizontal arrangement)
7 Tab group (docked ) with minimised panels.
8 Tab group (undocked)
9 Bottom pod - a special palette.
If used, work space information (workspace, tool bars,
menus), are copied from $HOME to the user area. Any modifica-
tions are only kept there.
For details see Relationship between the UI files on page 10.
D
General procedure for customisation

If a requirement can not be satisfied with entries in the
Initialisation files maker.ini and others on page 46, consider set-
ting up a custom workspace:
1 For special menu entries set up a custom menu file by
means of customui.cfg and append it to the relevant
menus.
24 – 5
2 A custom toolbar requires creation of a custom-toolbar.xml

file and a modification of the toolbar set file fmtoolbar.xml.
It may require the creation of button images.
3 For both cases it may be necessary to define new com-
mands in customui.cfg (which must be appended to the rel-
evant menus).
4 To define a custom workspace copy an existing workspace
file (xxx.fws) to a custom named file and modify the refer-
ences to menu and toolbar set.
Download example You can download the example customisation files from my
customisation website.
24 – 6
UI properties
UI properties
Workspaces
A workspace is a saved set of frequently used panels/toolbars
in a desired arrangement for repeated use. It also offers flexi-
bility of screen usage, by allowing a user to place panels in
numerous possible forms/arrangements: default, iconic, mini-
2016-03-29
mized, docked (left, right, bottom, top), floating, grouped.

The workspace remembers the dialogues that were open at
the previous session and also their positions, size, state etc.
FrameMaker ships with a set of standard Workspaces tailored
for different tasks. They can be modified and then saved with
a new name. FM also provides an empty workspace to start
with.
} Custom workspaces
} Initial workspaces
Modifications to a workspace are temporary (until saved) and

can be reversed by Reset.
The last used workspace is noted in maker.ini. The workspace
is loaded with the first document to open. This open may be
considered slow. No workspace is loaded with a book file.
The workspace does not contain the arrangement of docu-
ments (available with the drop down menu of located
to the right of the menu area).
D
Workspaces are saved in the user-area. The current workspace

is in xxx.cfws, while the last saved is in xxx.fws. See
Relationship between the UI files on page 10.
At the first use of workspaces the necessary files (workspace
definition, toolbars, menus) are taken from $HOME and copied
to the user-area.
To design a new workspace for a specific task, open all the
required panels and save the Workspace using Save
Workspace. The names are case sensitive.
24 – 7
Toolbars
Tool-set The toolbars available for the UI are listed in an xml file which
is referenced in the workspace file (see Relationship between
the UI files on page 10). The standard name is fmtoolbar.xml3).
There may be more toolbar files, but only those listed in this
file are visible in the menu.
fmtoolbar.xml
<?xml version="1.0" encoding="UTF-8"?>
<FMTOOLBARLIST version="1">
<TOOLBAR file="graphics.xml"/>
<SEPARATOR sep_id="0"/>
<TOOLBAR file="quick_access.xml"/>
<TOOLBAR file="structured.xml"/>
<TOOLBAR file="text_format.xml"/>
<TOOLBAR file="table_format.xml"/>
<TOOLBAR file="para_format.xml"/>
<TOOLBAR file="align_object.xml"/>
<TOOLBAR file="object_properties.xml"/>
<TOOLBAR file="trackchanges.xml"/>
</FMTOOLBARLIST>
Toolbar The toolbars themselves are defined in xml files The only tool-
bar which can not be customised is the graphics tool palette.
Toolbars can be docked in the top toolbar pane, to the right
or left of the application window or undocked (floating).
Note: Toolbars containing a drop-down list can not be docked to the
left or right!
3 A much clearer term would be toolbar-set.xml
24 – 8
UI properties
Files for the UI

If used, work spaces are copied to the user area. Any modifi-
cations are kept only there.
FM-12 and later contains three interfaces: Structured,
UnStructured and XMLAuthor. XMLAuthor is a stripped down ver-
sion of the structured interface and also available as own
product. It is not elaborated further here.
2016-03-29
The UI information basically is split into 2 groups:

 Command sets assembled according to views
 Menus and tool bars assembles according to views.
Product interface Structured Unstructured

View AuthorView CodeView (XML) WYSIWYG WYSIWYG
Standard commands Commands independet of views are located in $HOME\fminit\configui: cmds.cfg
a
Commands mathcmds.cfg wincmds.cfg mathcmds.cfg mathcmds.cfg
wincmds.cfg wincmds.cfg wincmds.cfg
b
Work spaces Authoring.fws Authoring.fws Authoring.fws Authoring.fws
none.fws c none.fws Blank.fws Blank.fws
Design.fws Design.fws
Manage Graphics.fws Manage Graphics.fws
none.fws none.fwsReview.fws
Review.fws
Structured Authoring…
Menus menus.cfg menus.cfg menus.cfg menus.cfg
menus_review.cfg menus_review.cfg
menus_structured_au- menus_ts.cfg
thoring.cfg
menus_ts.cfg d
Tool bars fmtoolbar.xml e fmtoolbar.xml align_object.xml align_object.xml
graphics.xml quick_access.xml fmtoolbar.xml fmtoolbar.xml
quick_access.xml xpathtoolbar.xml fmtoolbar_review.xml fmtoolbar_review.xml
quick_element.xml xslttoolbar.xml graphics.xml graphics.xml
structured.xml object_properties.xml object_properties.xml
trackchanges.xml para_format.xml para_format.xml
quick_access.xml quick_access.xml
quick_access_review. quick_access_review.
xml xml
structured.xml structured.xml
table_format.xml table_format.xml
tag-description.xml tag-description.xml
text_format.xml text_format.xml
trackchanges.xml trackchanges.xml
Customisation $HOME\ fminit\configue\cusomui.cfg
D
This file contains both menu defintions and (hypertext) command defintions.
a. Commands are located in fminit\configui\interface\view\
b. Work spaces are located in fminit\WorkSpaces\interface\view\
c. none.fws is an empty workspace used if no document or book is open. It can be used to build a custom work
space from scratch. It can refer to a custom menu, but does not honour the definition of a custom toolbar
set — IMHO this is an error.
d. The purpose of menus named menus_ts.cfg is IMHO unclear.
e. fmtoolbar.xml does not define commands and icons for a tool bar, but lists all the tool bars available in this
work space.
24 – 9
Relationship between the UI files

%appdata%\Adobe\FrameMaker\13
SkinGallery
SkinGallery Structured AuthorView menus menus.cfg
Startup
Startup UnStructured CodeView toolbars align_object.xml custom_menus.cfg
WorkSpace custom_toolset.xml menus_review.cfg
WorkSpaces
…
XMLAuthor FormView Authoring.fws
menus_struc-
Blank.fws direction.xml
…
tb-icon_C_L.png WYSIWYGView example-tb.xml tured_authoring.cfg
tb-icon_C_L.png Custom.fws
tb-icon_C_S.png fmtoolbar.xml menus_ts.cfg
tb-icon_C_S.png Design.fws
tb-icon_M_L.png fmtoolbar_review…
tb-icon_M_L.png Manage Graphics.fws
tb-icon_M_S.png none.fws graphics.xml
tb-icon_M_S.png
tb-icon_R_C_L.png
tb-icon_R_C_L.png Review.fws object_properties…
tb-icon_R_C_S.png para_format.xml
tb-icon_R_C_S.png Structured Auth.fws
tb-icon_R_M_L.png quick_access.xml
tb-icon_R_M_L.png
tb-icon_R_M_S.png Custom.fws quick_access_rev…
24
tb-icon_R_M_S.png
… <FrameUI version="1"> quick_element.xml
…
maker.ini
–10
<data type="all" menuFile="custom_menu.cfg" toolbarFile="custom_toolset.xml"/> structured.xml

maker.ini
…
… <fm-workspace> table_format.xml
<workspace version="1"> tag-description.xml
<dock anchor="top" content="multi-control-bar" is-closed="false"> text_format.xml
… trackchanges.xml
</dock>
<control-bar id="00070CEA" origin="-16 -2" size="558 26" is-closed="true" custom_menus.cfg
app-data="#lt;control-bar cb-data=#quot;custom_tb#quot; For documentation on this file, see "Customizing Frame Products" Online Manual
minimum-size=#quot;454 26#quot; maximum-size=#quot;1868 26#quot;
preferred-size=#quot;558 26#quot;/>"/> MS Windows FrameMaker Menu Configurations
</workspace>
</fm-workspace> *** Document Window Main Menu ***
original menu contents
</FrameUI>
<ReservedMenu !MakerMainMenu<Label Adobe FrameMaker>>
<Menu FileMenu <Label File>>
<Menu EditMenu <Label Edit>>
example_tb.xml custom_toolset.xml …
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?> [etb Addenda]====================================================
[Customisation] ==================================================
<FMTOOLBARLIST version="1"> <FMTOOLBARLIST version="1"> *** The
Example
[label]
menu
constructs
customisation
provide file navigation in EditPad
<TOOLBAR id="custom_tb" name="Custom Toolbar" kbd-shortcut="\!Vzz" <TOOLBAR file="graphics.xml"/> ***File
KLDis2016-01-18
harmonised with all the other etb-customui.cfg files
orientation="horizontal" readOnDocChange="true"> <SEPARATOR sep_id="0"/> *** Remarks
 <TOOLBAR file="quick_access.xml"/> ***- Place
This file (customui.cfg)
a new can not
menu item after the be UTF-8,
first one init the
must be in
Help Windows CP 1252
menu
<ACTION command="RepeatLastParaCommand" tooltip="Repeat…]"> <TOOLBAR file="structured.xml"/> using FrameRoman coding for Label statements.
<images base="tb-icon" /> <SEPARATOR sep_id="1"/> … Define a new command with a name not yet kwnown to FM
***
</ACTION> … [etb Documentation]
<Command CustomOfflinePDF <Label Local User guide (PDF)>
... <TOOLBAR file="example-tb.xml"/> <Command
<HypertextETBfmConsole <Label
message openfile Console Log File>
H:/Adobe/AdobeFrameMaker12/fminit/configui/
<DROPDOWN command="!RulerParaMenu" tooltip="Paragraph …"/> </FMTOOLBARLIST> <Hypertext message openfile H:/Adobe/…/fminit/configui/etb-GetLogFile.exe>>
FM12-help.pdf>>
same as customui.cfg
<FLYOUT command="!RulerAlignMenu" tooltip="Text alignment"> …
<images base="P_TextAlignLeft_Md" /> [etb Menu] menu entry with the command
*** Define
</FLYOUT> <Add CustomOfflinePDF
ETBmenu <Menu !HelpMenu>> <Menu !HelpMenu>>
... <Order !HelpMenu.ETBmenu <Before !HelpMenu.AdobeOnlineSupport>>
</TOOLBAR> <Add ETBfmConsole
*** Place <Menu
the menu item to the desired ETBmenu>>
place
</FMTOOLBARLIST> …
<Order !HelpMenu.CustomOfflinePDF <After !HelpMenu.Help>>
Menus
Menus
customui.cfg For FM versions prior to FM-11 all customisation was estab-
lished in the file fminit\configui\customui.cfg.
The possibilities in this file are explained extensively in the
Adobe document Customisation of Frame Products (FM-7).
This file is still required if the menu modifications are to be
visible from the beginning.4)
2016-03-29
However, the contents of this file must also be appended to

the relevant menu file. It is good practice to copy a menu file
to a new file, e.g. custom-menu.cfg and then append the con-
tents of customui.cfg to it.
Views Since FM-11 the contents of menus depend on a view. Hence
there are several menu files. See Files for the UI on page 9. As
an example the WYSIWYG view of the unstructured interface
of FM-12/13 is listed:
$HOME\fminit\configui\
cmds.cfg
sample.cfg
UnStructured\
WYSIWYGView
mathcmds.cfg
wincmds.cfg
$HOME\fminit\WorkSpaces
UnStructured
WYSIWYGView\
Authoring.fws
Blank.fws
Design.fws
Manage Graphics.fws
Review.fws
menus\
menus.cfg
menus_review.cfg
toolbars\
align_object.xml
fmtoolbar.xml
fmtoolbar_review.xml
graphics.xml
object_properties.xml
para_format.xml
quick_access.xml
quick_access_review.xml
D
structured.xml
table_format.xml
tag-description.xml
text_format.xml
trackchanges.xml
4 customui.cfg in FM-12 and later is only relevant before a workspace is se-

lected - that is, before any book or documents have been opened. AFter
closing all documents or books no customisation is active.
none.fws is an empty workspace. It can be used to build a custom work
space from scratch. It can refer to a custom menu, but does not honour
the definition of a custom toolbar set — IMHO this is an error.
24 – 11
Customising menus
Customisation To create your custom menu, take the appropriate standard
menu and copy it to a new file. Name this file with a prefix of
your customisation project. For example custom-menus.cfg.
You develop the customisation in a file customui.cfg which is
located in $HOME\fminit\configui\. As long as you have not a
customised menu assigned to a workspace, the menu custo-
misation is only visible during the display of the splash
screen (before you have opened a document or book).
To be available regularly the contents of customui.cfg must
also be appended to a menu file, which is referenced in the
workspace (see Relationship between the UI files on page 10).
To be available also with no document or book open, work-
space $HOME\fminit\WorkSpaces\UnStructured\none.cws must
point to the modified menu file (see table footnote c on page
9):
<FrameUI version="1">
<data type="all" menuFile="custom-menus.cfg" toolbarFile="fmtoolbar.xml"/>
<fm-workspace>
Testing menus You do not need to restart FM to test a modified menu. With
View > Menus > Modify… it can be read into the current
workspace.
Errors in the customisation file are reported in the FM console
window. Even if an error is found, reading and interpreting
the file continues.
Commands in menus In the various existing menus you can find a desired com-
mand for your special menu entry. You may however need to
set up a new command:
 Open a file. For example the offline user guide pdf.
 Execute a program.
 Execute a FrameScript
 Execute an ExtendScript
The first two tasks are performed by hypertext commands:
Open a file Hypertext message openfile H:/Adobe/AdobeFrameMaker12/fminit/
configui/FM12-help.pdf
Execute a program <Command ETBfmConsole <Label Console Log File>
<Hypertext message openfile H:/Adobe/AdobeFrameMaker12/
fminit/configui/GetLogFile.exe>>
Hyper-links with relative paths always point to files in the
same directory as the parent file. While for documents this
can be interpreted, it is not clear what it means for menus.
Relative paths do not start in $HOME as in pre-FM9. They start
in the current document folder:
$path[initdir]/fminit does not work (neither upper/lower/
mixed case, nor with path in quotes or double quotes).
For addressing scripts see Note concerning scripts on page 23.
Execute a FrameScript <Add iFrameMultiCatalog <Menu FormatMenu>>
Execute an ExtendScript <Add ImportFormatsSpecial <Menu FormatMenu>>
24 – 12
Menus
Example menu customisation

Let’s assume that you want to modify the Help menu.
You are tired of searching for the offline user guide (pdf).
Once you have downloaded it via Help > Help Topics >
Getting Started > General Resources. You placed it in
$HOME\fminit\configui\ with the name FM-12-help.pdf.
You want this in the menu as Help > User Guide PDF.
2016-03-29
We will establish this only for the unstructured interface in

the WYSIWYGView.
Note: This example is part of the download of FM-customisation-
example.zip.
customui.cfg In a plain vanilla FM installation this file does not exist (or it
is empty). Hence you need to create it. This file must be in
Windows code page (cp 1252), not in UTF-85)!
*** Example menu customisation

*** KLD 2016-01-18
*** Define a new command with a name not yet kwnown to FM

<Command CustomOfflinePDF <Label Local User guide (PDF)>
<Hypertext message openfile H:/Adobe/AdobeFrameMaker12/fminit/configui/FM12-help.pdf>>
*** Define menu entry with the command
<Add CustomOfflinePDF <Menu !HelpMenu>>
*** Place the menu item to the desired place
<Order !HelpMenu.CustomOfflinePDF <After !HelpMenu.Help>>
Note: For test purposes you may reference any pdf file in the com-
mand. Adjust the file location - use forward slash (/) in place of
backslash (\). Only absolute paths work!
Modify the relevant menu The customisation by customui.cfg is only active when no
document or book is open 6).
In our case the menu to be modified is menus.cfg. The file
contents of customui.cfg must be appended to the relevant
menu of the workspace to be available for open documents or
books.
Since it is not a good idea to just modify a standard menu, we
copy it to menus_custom.cfg and then add the contents of
customui.cfg to this file.
Define a new workspace Our modified menus_custom.cfg must be referenced in a work-

space. Hence Create a copy of Authoring.fws in the directory
D
Unstructured\WYSIWYGView and name it Custom.fws Edit line 2

according to the following (modification highlighted):
<data type="all" menuFile="menus_custom.cfg" toolbarFile="fmtoolbar.xml"/>
After starting FM and selecting the Custom Workspace drop-
down list, the menu modification is active.
5 The file coding is not at all consistent:

cp 1252: *.cfg (customui.cfg, cmd.cfg, mathcmd.cfg, menu.cfg etc.)
UTF_8: *.xml (toolbars), *.fws, *.cfws (work space), maker.ini.
6 Since FM-12 the rôle of customui.cfg is unclear. See footnote 4
24 – 13
Toolbars
Customising Toolbars
Customising toolbars or creating new toolbars is more elabo-
rate then customising menus, because more files are involved
(See Relationship between the UI files on page 10):
 The toolbar file itself (e.g. custom-tb.xml).
 The list of toolbars in fmtoolbars.xml.
 The icons needed for the toolbar.
 Probably a workspace file Custom.fws to refer to the cus-
tomised tool bar (and probably also customised menu).
Note: Toolbars containing a drop-down list can not be docked at left
or at right to become oriented vertically!
Example toolbar
example.zip.
The following is an example toolbar with all types of widgets.
We want to integrate it into the workspace Custom.fws already
used for the menu customisation.
Invoke ExtendScript
Invoke FrameScript
Command
Drop-down list
Command
This tool bar shall be available in the unstructured interface,

in the WYSIWYGView of the Custom workspace.
Note: If not specially noted, the file locations start with
%appdata%\Adobe\FrameMaker\vv\ with vv being 12 or 13.
Establish an example tool bar The following ingredients are required:
 File example-toolbar.xml defining the buttons and their
commands as well as keyboard-short cuts. This file must
be put into all the relevant view folders, in our case into
…WorkSapces\UnStructured\WYSIWYGView\toolbars\
 A copy of fmtoolbar.xml with modifications giving file
custom_toolset.xml for all the relevant view folders (in our
case, same as mentioned before).
 An appropriate set of icons. Either you reference existing
icons in the dll-files or you provide them in the user area.
After start of FrameMaker select the Authoring View, for
which you have set up the two files custom_toolset.xml and
example_tb.xml.
In menu View > Toolbars you will find the toolbar and can
activate it.
Move the tool bar to any location or dock it. You may save the
current workspace with a new name.
24 – 14
Toolbars
You may also update the workspace Custom containing already

the menu customisation.
File example-tb.xml This file describes the contents of the toolbar. This example
references standard commands as well as a FrameScript and
an ExtendScript.
These files are available in the already mentioned download.

2016-03-29
<ACTION command="msgJS" tooltip="Message via JavaScript">

2 <FMTOOLBARLIST version="1">
3 <images
<TOOLBAR id="custom_tb" />
base="tst-estk" name="Custom Toolbar" kbd-shortcut="\!Vzz"
4 </ACTION> orientation="horizontal">
</TOOLBAR>
5 
</FMTOOLBARLIST>
6 <ACTION command="RepeatLastParaCommand" tooltip="Repeat last ¶ command [Esc j j]">
7 <images base="etb-para-repeat" />
8 </ACTION>
9 
10 <DROPDOWN command="!RulerParaMenu" tooltip="Paragraph formats"/>
11 

12 <FLYOUT command="!RulerAlignMenu" tooltip="Text alignment">
13 <images base="P_TextAlignLeft_Md" />
14 </FLYOUT>
15 
16 <ACTION command="MyCommand1" tooltip="Just an alert">
17 <images base="tst-fs" />
18 </ACTION>
19 
20 <ACTION command="msgJS" tooltip="Message via JavaScript">
21 <images base="tst-estk" />
22 </ACTION>
23 </TOOLBAR>
24 </FMTOOLBARLIST>
The ID of the toolbar need not be the same as the file name. I
choose custom_tb for the ID, although the file names is
example_tb.xml. The ID is used in the workspace files only.
For each tool button a type is defined:
ACTION Button for standard command.
DROPDOWN Open a drop down list of commands.
FLYOUT Open a sub menu of commands.
See Tags in toolbar files on page 20 for more details.
Toolbar commands When setting up a toolbar you need to have an idea which
commands to use. Get the exact names from the appropriate
menus (see Configuration files on page 17) or from a command
D
list. See for example www.daube.ch.

Note: Hypertext commands can only be used in menus, not for tool-
bars.
For more details see Commands on page 27.
Note on drop-down lists More than one drop-down list can appear in a tool bar 7):
7 Example provided by Shmuel Wolfson.
24 – 15
Toolbar icons The button images use a base name to avoid listing all 8 vari-
ants (large/small, colour/monochrome, normal/rollover).
Standard icons These (e.g. P_TextAlignLeft_Md) are located in fmres.dll or
owlres.dll of FrameMaker. Names of these can be deducted
from existing tool bars or from my web site (look for “tool bar
resources”).
Custom icons Those named etb-xxx and tst-xxx are custom icons which
must reside in the user area (no subdirectory possible).
File custom_toolset.xml 1 Make a copy of fmtoolbar.xml and name it custom-

toolset.xml
2 Modify this file as shown hereafter.
1 <?xml version="1.0" encoding="UTF-8"?>

2 <FMTOOLBARLIST version="1">
3 <TOOLBAR file="graphics.xml"/>
4 <SEPARATOR sep_id="0"/>
5 <TOOLBAR file="quick_access.xml"/>
6 <TOOLBAR file="structured.xml"/>
8 <TOOLBAR file="text_format.xml"/>
9 <TOOLBAR file="table_format.xml"/>
10 <TOOLBAR file="para_format.xml"/>
12 <TOOLBAR file="align_object.xml"/>
13 <TOOLBAR file="object_properties.xml"/>
15 <TOOLBAR file="trackchanges.xml"/>
17 <TOOLBAR file="direction.xml"/>
19 <TOOLBAR file="example_tb.xml"/>
20 </FMTOOLBARLIST>
Integrating toolbar into The toolbar will appear in menu View > Toolbars. There you
workspace activate it and it will initially float around.
The workspace mechanism has assumed a certain width of
the toolbar which can be adjusted with the lower resize han-
dle:
Docking handle
Resize handle
As usual the toolbar is docked to the other toolbars with the

docking handle.
You can now save the current workspace, with or without a
different name.
Custom workspace You may also update the Custom workspace as defined in
Customising menus on page 12 and modify it to directly use
the custom tool set:
<data type="all" menuFile="menus_custom.cfg" toolbarFile="Custom_toolset.xml"/>
24 – 16
Configuration files
Configuration files
Configuration files define both commands and menus. These
files still have the format as in previous FM versions. That is,
they are named xxx.cfg and use the well-known MIF syntax
(not xml).
The names of these configuration files are specified in the ini-
tialisation file for FrameMaker (see [Files] in maker.ini).
2016-03-29
customui.cfg The file fminit\configui\customui.cfg is a special configura-

tion file called customisation file, because with this file com-
mands and menus are customised.
If this file does not exist or does not have the name defined in
maker.ini (see [Files] in maker.ini) then no customisation is
performed.
Commands The commands are defined in three files located in
$HOME\fminit\configui:
File Contents
cmds.cfg General commands, Escape sequences
mathcmds.cfg Commands for the Equation Editor
wincmds.cfg Platform dependent commands, definition of shortcuts
With the introduction of views, multiple files cmds and

wincmds. exist.
Menus Until FM-10 menus were located in $HOME\fminit\maker. FM-11
introduced the concept of views which requires a multitude
of menus. See Relationship between the UI files on page 10.
Note: While standard menus are in their own files (separated from
commands) the customisation file customui.cfg may contain
both commands and menus. Also a custom menu may contain
both kinds of definitions.
Configuration file A configuration file consists of a series of statements that

statements define menus, menu items, and the order of those items.
Commands are also defined in configuration files and may
contain definitions for details which may also be present in
menu files.
Properties of statements  Statements are case-sensitive.
 Each statement is enclosed in angle brackets (< and >).
 Statements must appear in a particular order.
 A statement begins with a keyword defining its function.
D
 A statement may span several lines.

 Text outside angle bracket-pairs is treated as comment.
Don’t include angle brackets in comments. Hence if you
want to comment out statements, you need to replace the <
> symbols, for example, by { }.
comment examples [etb --- ETB addenda] ======================================
*** The [label] supports file navigation in EditPad
- This file (customui.cfg) can not be UTF-8, it must
use Windows encoding and FrameRoman coding for Labels
- Defaulit path ($HOME) is named here + fm-root+
(no blank after first +). This is exchanged by the
installation pgm with the real $HOME directory.
24 – 17
Initialisation sequence When FrameMaker starts, it first reads the standard menu and
command configuration files and then a customisation file 8).
The information in each file overrides the information in files
read previously. Hence the following order is necessary:
1 Definition of the commands.
2 Modification of labels, shortcuts.
3 Definition of a menu item referring to a command.
4 Order of the menu item or sub menu within parent menu.
Statements in configuration files

Purpose Statement, statement detail
Define a command Command on page 28
Define a command for a menu item that ShiftCommand on page 28
is chosen while the Shift key is held down
Define a new label for a command or Modify on page 29
menu item
Define the function to be called when a Definition on page 30
command is chosen
Define a label for a menu or command Label on page 30
that is visible in the user interface
Define a context-sensitive label for a ReservedLabel on page 30
menu or menu item.
Define a keyboard shortcut for a com- KeySequence on page 31
mand
Define a label for the shortcut which ap- KeySequenceLabel on page 32
pears next to the command name on the
menu
Define whether a command is a general Mode on page 33
command, a FrameMath command (for
the Equation Editor), or both
Define an Asian typography command AsianFonts on page 33
Define a new menu Menu on page 41
Define a new reserved menu Reserved menu on page 41
Add a menu item to a menu Add on page 42
Define a particular place for a menu item Order on page 43
on a menu.
Remove a menu or menu item Remove on page 28
8 This process is called Localisation in the progress indication during the

start. This is due to the fact that the menu files are different for each UI
language. In FM the UI language is defined at installation - it can not be
changed afterwards.
24 – 18
Configuration files
Debugging customisation files

If you’re writing a lengthy menu customisation file, consider
writing and testing the customisations a few at a time. This
will make it much easier to locate problems in the statements
you write. As you create the file, you can save the file and
then read it into FrameMaker to test your statements.
With View > Menu > Modify… the modified menu can be
read.
2016-03-29
To display error messages when you load a menu customisa-

tion file, set ShowErrors in maker.ini to On. You can also turn
On the keyboard shortcut alerts (ConfigWarnKbdOverride,
ConfigWarnKbdOverride) to see error messages in the console
window 9). If you find errors, you can fix them immediately
and continue writing.
When you read the same menu customisation file again 10),
you’ll see error messages about redefining a command

(because the same statements are being read again). Ignore
these messages. Use comments throughout the menu custo-
misation file to document your work. Others may need to edit
the file later.
D
9 Please note that even a plain vanilla FrameMaker installation will create
a huge number of such messages, because definitions are ‘overloaded’. It
may be difficult to find real errors this way …
10 I’m not certain whether this method with View > Menus > Modify…
works reliably in FM-11 and beyond. We have now at least two modifica-
tion files…
24 – 19
Tags in toolbar files

Note: Be aware that in strings (e.g. defining the tool tip) no & must
be used. Character entities (e.g. #amp;) are not resolved. Use
the word ‘and’ or the ‘+’ sign in place of the ‘&’.
First line of toolbar file <?xml version="1.0" encoding="UTF-8"?>
Comments Comments are in the standard XML/HTML format:


Note: XML comments must not appear before the FMTOOLBARLIST
statement!
Example See File example-tb.xml on page 15. It displays most of the fol-
lowing tags.
FMTOOLBARLIST This is the root tag in a toolbar file.

Syntax <FMTOOLBARLIST attributes />
TOOLBAR statement with details
</FMTOOLBARLIST>
Attributes version="1" Parser version for which this toolbar file was
written. Value needs to be compatible with the cur-
rent parser version.
TOOLBAR This tag defines the toolbar and is a wrapper for the items on
the toolbar.
Syntax <TOOLBAR attributes />
tool tags (ACTION, DROPDOWN, …)
</TOOLBAR>
Attributes file File name of the toolbar, if the description is to be
picked from somewhere else. If this attribute exists
no other attributes are parsed here.
This attribute is not present in any of the Adobe
toolbars up to FM-13.
id Unique identifier for the toolbar, for workspace
identification, FDK access and API notifications
name Name of the toolbar as visible in the menu.
This may contain character entities, for example
name = "Paragraphs #amp; Characters"
orientation Keyword defining the default orientation of the
toolbar:
horizontal: Default orientation is horizontal.
vertical-narrow: Default orientation is vertical and
the items are arranged in a single col-
umn.
vertical-wide: Default orientation is vertical and
the items are arranged in two col-
umns.
dock Keyword defining the preferred/default dock (cur-
rently horizontal toolbars can be docked only at
the top):
24 – 20
left: Toolbar will be docked at the left

anchor
right: Toolbar will be docked at the left
anchor
top: Toolbar will be docked at the top
anchor
none: Toolbar will be floating
kbd-shortcut Key-sequence to activate the toolbar (default =
2016-03-29
none)
readOnDocChange I have no idea, what this is good for. Found
only in quick_element.xm.
Tool tags
ACTION The action tag defines the command assigned to an UI button.

Syntax <ACTION attribute/>
<IMAGES ...>
</ACTION>
Attributes command Identifier of an already defined FM action - a
required attribute.
name Name of the action (default is the tag defined for
the command)
tooltip Tool tip displayed on mouse hover (default is the
name of the action)
help Help String for the action command (default= none)
image An image-name for the action (default= None) 11).
TOGGLE A toggle tag is used to define two (logically alternating)

actions to be performed from a single widget.
Note: I have not managed to get this working. I have also not seen
this tag in any Adobe tool bar yet.
Syntax <TOGGLE attributes1 />
<command attributes2 />
</TOGGLE>
Attributes1 name Name of the toggle (default= None)
tooltip Tool-tip that is displayed on mouse hover (default=
name of the toggle)
D
help Help String for the toggle command (default=

None)
image An image-name for the toggle (default= None) 11).
Attributes2 on Required identifier of an already defined FM action
(non-toggle type).
off Required identifier of an already defined FM action
(non-toggle type).
11 This tag attribute may be replaced by images = list of images (see

IMAGES on page 22)
24 – 21
FLYOUT This is used to define a popup menu.

Syntax <FLYOUT attributes />
Attributes command Identifier of an already defined FM Menu - a
required attribute.
name=" Name of the flyout (default= the tag defined for the
command)
tooltip Tool tip that is displayed on mouse hover (default=
name of the flyout)
help Help string for the flyout command (default= none)
image An image-name for the flyout (default= none) 11).
DROPDOWN This is used to (generally) define a menu whose sub items are
a list of options that can be chosen one at a time, for example,
fonts.
Syntax <DROPDOWN attributes />
Attributes command Identifier of an already defined FM Menu - required
field"
tooltip Tool tip that is displayed on mouse hover (default=
name of the drop-down)
help Help String for the drop-down command (default=
none)
Note: There is no width indication for this widget. The width is
assumed by the workspace mechanism. If more than one drop-
down list appears in a tool bar then resizing ins applied to all
proportionally.
SEPARATOR This tag places a separator between two items

<SEPARATOR/>
Detail tag
Detail tags are optional. Currently only the IMAGE tag is in this
category.
IMAGES This tag describes the images displayed on an ACTION, FLY-

OUT and TOGGLE. Alternatively only one image can be
defined (see ACTION on page 21).
Syntax <images attributes />
Attributes normal Default image displayed when the UI is
bright (default= none)
rollover Image displayed on mouse hover when the
UI is bright (default= normal image)
dark_normal Default image displayed when the UI is
dark (default= normal image)
dark_rollover Image displayed on mouse hover when the
UI is dark (default= dark_normal image)
Example See Using icon-images on page 24.
24 – 22
Toolbar commands
See also section Commands on page 27.
All the menu items/commands that end up executing an FCode
can be used here. Hence hypertext commands can not be
used. However, scripts (FrameScript, ExtendScript) can be ref-
erenced. See Example toolbar on page 14.
Note concerning scripts

2016-03-29
 Scripts must be loaded during the start of FrameMaker.

This action generates a command name and an FCode for
the script.
 The FCode assigned to a script may differ from FM session
to FM session. Hence it is useless.
 ExtendScripts are located in
%appdata%\Adobe\FrameMaker\vv\Startup\
The name of the script name (without the file extension)
provides the command name. Installed ExtendScripts get

command names from their internal command definitions.
 FramExtendScripts may be located anywhere. However it
must be assured that they are loaded at start of
FrameMaker. See FrameScript options.
 The name for the command may not be identical to the
script file name (excluding the file extension) due to an ini-
tial script. You may get the proper command name by the
free FrameScript Report FM Commands from itl.
File name of script Command name

ImportFormatsSpecial.jsx ImportFormatsSpecial
MultiCatalog.fso iFrameMultiCatalog
RemoveUnusedFormats.fsl ESLSSRUN305 a
a. This is an automatically generated command name.
For details see Command names from plugins and scripts on

page 38.
D
24 – 23
Toolbar icons
Standard icons Icons for toolbars and for the dialogues are located in
resource files: fmcustom.dll, fmres.dll, owlres.dll. fmdlg.dll
and are not relevant in this context.
Names of such icons can be deducted from existing tool bars
or from my web site (look for “tool bar resources”).
Custom icons If images are needed, which are not in these resources, they
must be of type png (Portable Network Graphic) and be
located in the user-area (in the same directory as maker.ini).
Hovered (roll over) icons are framed. When clicked the icon it
gets a darker background. Hence the icons must be transpar-
ent.
Large and coloured icons Since FM-12 both large and/or coloured icons are supported.
Regular sized icons are 18×18 pixels, large icons are 26×26
pixels. Hence the maximum number of icon images is 8.
You can have 8 image files for the following possible combi-
nations of preferences with base name e.g. xyz:
Preferences Icon names
Size Colour Normal Rollover
Size Colour Normal Roll over
Large (L) Coloured (C) xyz_C_L.png xyz_R_C_L.png
Greyscale (M) xyz_M_L.png xyz_R_M_L.png
Regular (S) Coloured xyz_C_S.png xyz_R_C_S.png
Greyscale (M) xyz_M_S.png xyz_R_M_S.png
In most cases the R_X_X forms are copies of the _X_X forms.
Using icon-images 1 Add the base name of the icon in the base attribute of the
image element.
<ACTION command="RepeatLastParaCommand"
tooltip="Repeat last ¶ command [F4]">
<images base="etb-para-repeat" />
</ACTION>
2 Create at least 2 icon images for normal and rollover state
of the icon. For example if the icon name is xyz the image
names will be xyz_C_S.png and xyz_R_C_S.png. (Here, C= col-
our, S=regular, and R=rollover.) If, however, your icon pref-
erences are set to have large or greyscale icons instead of
regular and colour, you will use M and L in the icon names.
3 You can further add more icon files for icon states, such as
dark_normal and dark_rollover by specifying attributes
with data in the relevant element. For example:
<ACTION command="CenterPara">
<images base="P_TextAlignCenter_Md"
dark_normal=”<icon_name>.png” 
dark_rollover=”<icon_name>.png”
dark_normal_l=”<icon_name>.png”
dark_rollover_l=”<icon_name>.png”
/>
/>
24 – 24
Example icons These are all from fmcustom.dll, base name = P_AddRows
S - Regular (18 × 18) L - Large (26 × 26)
C - Coloured M - Grey C - Coloured M - Grey
Normal Roll over Normal Roll over Normal Roll over Normal Roll over
_C_S _R_C_S _M_S _R_M_S _C_L _R_C_L _M_L _R_M_L
2016-03-29
 Although there are special images for the roll-over situa-

tion, the pictures are the same (_C_S = R_C_S).
 In roll-over state the buttons are surrounded by a border
and the background becomes lighter than in normal state.
Hence there is no need for special images.
Default icons The result of missing images depend on the ‘severity’ of the
problem:
If size does not fit, the defaults are boxes with text in them:
If set to regular size, standard icons not found are depicted

with a default icon:
Tool bar icons and  A workspace defines the toolbars to be active in it.
workspaces
 References to all sorts of icons (small/large, grey/coloured)
exist in the tool bar.
 The size and colour of icon to be displayed is only defined
in Preferences > Global > Interface > Icons.
If you do not see coloured icons after switching to a work-
space which should have them, check your settings in
Preferences. After changing these preferences a restart of
FrameMaker is required.
Contents of the resource With the new UI two additional resource files were intro-
files in fminit duced: owlres.dll and owlres.res. These contain png images
which are not handled by (to me) known resource editors.
Also fmcustom.dll now contains png images, no more bit maps
(bmp).
File Icons, pictures Dialogues Other
D
fmcustom.dll Images for toolbar also icons for the panels none version info
and graphic toolbar. 2 to 8 variants per image.
fmdlg.dll Rubi-bit maps [bmp]. Many new items (panels) classic dialogues, panels, Icongroup (icons for the dia-
panel-lists logues) version info; 500 (?)
fmres.dll Button images for dialogues, palettes and pan- none Cursor group (32x32 cursors);
els (16x16), [bmp]. Some items no more used Icongroup (icons in panels etc.)
owlres.dll Images for the new toolbars [png]. 2 to 4 vari- C-like definitions for appli- Xstr (strings with all text in xml
ants per image. This file is new with FM-9 cation bar a , grafix bar, UI notation); version info (correct)
preference dialogue etc.
a. This relate to functions to the right of the menu bar (UI visibility, Arrange documents, Screen mode)
24 – 25
Extract icons
To get the icons out of the DLLs – to have individual files to
work on for the tool bar buttons – my procedure is the follow-
ing:
Extract and rename 1 Open the dll in ResHacker.

- Select the appropriate resource type (e.g. bitmap).
- Save the resources with Action > Save [...] resources.
- Use an rc name such as fmres-bmp.rc .
2 Open the rc file in EditPad.
- Convert double to single line spacing
- Use the REGEX to exchange the 'columns':
fmcustom binaries (.+) png "(.+)" \2\t\1
fmres bitmaps (.+) bitmap "(.+)" \2\t\1
cursors (.+) cursor "(.+)" \2\t\1
icons (.+) icon "(.+)" \2\t\1
owlres binaries (.+) png "(.+)" \2\t\1
- Remove blanks at start of line
- Save the table as fmres-rename-table-bmp.txt
3 Start RenameByTable.ahk
- Fill in all fields, including the target file extension.
PDF of all icons 1 Open the directory (e.g. E:\FM-specials\FM-12-

tests\Resources-owlres\renamed-png) in Thumbs+.
2 In Image > Print Catalog set up a layout (or use icon-
overview) with the following properties:
- Printer = Adobe PDF
- Print Thumbnail borders OFF
- Colour output
- Margins all: 0.5cm
- Thumbs width 4.5cm, height 2.2cm
- Header: Resource icons xxx
- Header font 12 pt, Caption font 8pt
- Items for caption: only File name
- Files to process: Current folder
- Print Heading for each folder: OFF
- FINISH: provide file path for PDF file
Be aware that some file names are to long for complete dis-
play. In the tabular arrangement of the icons the names may
overlap.
24 – 26
Commands
Commands
There are three command files in $HOME\fminit\configui:
cmds.cfg
mathcmds.cfg
wincmds.cfg
In the various views there are different versions of these files,
since not all commands are relevant in a particular view.
2016-03-29
For customisation it is not necessary to modify any of the

standard command files. All customisation of commands is
done in customui.cfg. and one or more menu files.
Note: A complete list of FM-13 commands can be found on
www.daube.ch. These command lists are created with the free
FrameScript Report FM Commands from itl.
Command examples
For explanation of the keywords see Command statements on
page 28.
Normal command <Command NewDocument Name of the command
<Label Document...> What you see in the menu
<KeySequence \!fn> Shortcut (ESC sequence)
<Definition \x300> FCODE, the command definition
<Mode All>> Valid contexts for this command
Command with restricted <Command SelectAll
context <ReservedLabel Flow Select All in Flow>
<ReservedLabel Frame Select All in Frame>
<ReservedLabel Page Select All on Page>
<KeySequence \!ea>
<Definition \x327>
<Mode All>>
Modify the shortcut <Modify SelectAll
<KeySequence ^a> >
… and indicate it in the menu <Modify SelectAll
<KeySequenceLabel CTRL+A> >
Combine these two <Modify SelectAll
modifications <KeySequence ^a>
<KeySequenceLabel CTRL+A >>
D
24 – 27
Command statements
Command The command statement is the wrapper definition for the
command:
Syntax <Command cmd-name <detail1> <detail2> <detailn>>
Details may be added to a command also by the Modify
statement on page 29.
Cmd-name A unique name of the command. This serves as a reference
between the various statement types.
Details For the detail specifications see Command details on page 30.
Examples See also Command examples on page 27.
<Command PrintingDisplay
<ReservedLabel Document &Printing Display>
<KeySequence \!qqp >
<KeySeqLabel Esc q q p>
<Definition \x4F1 \x4F2 \x4F3 \x3F8>
<Mode All>>
Note: This command is defined by 4 function codes which imposes
some problems. See the remark at Multi-code commands on
page 35.
Custom command A custom command must not use an already existing name.
Hence it is good practice to prefix the name with an indicator,
for example:
<Command ETBVertToolBar …> Enhanced Toolbar
<Command _MTCharSet …> Microtype’s Customisation
ShiftCommand This statement defines a command for a menu item that is
chosen while the Shift key is held down. This statement nor-
mally appears in a menu file (not a command file).
Syntax <ShiftCommand cmd-unshifted cmd-shifted>>
Cmd-unshifted This is the identifier of the command as it normally appears.
Cmd-shifted This is the identifier of the command you want to appear
when you hold down the Shift key.
Examples <ShiftCommand Save SaveAll>
<ShiftCommand FindNext FindPrevious>
Note: 12)Commands defined by ShiftCommand can not be placed in
context menus. The insertion of the command (by Add) does not
create an error, although the command is not inserted. A fur-
ther Order command will not find the (not) inserted command
and create an error. Example creating the error:
<ShiftCommand GraphicsObjProps GraphicsPickObjProps> ...
<Add GraphicsPickObjProps <Menu !GraphicsContextMenu>>
<Order !GraphicsContextMenu.GraphicsPickObjProps
<After !GraphicsContextMenu.GraphicsObjProps>>
Remove You can not remove commands. Only the menu entry is
removed.
Syntax <Remove cmd-name <Menu menu-id>>
Examples <Remove GraphicsReshape <Menu GraphicsMenu>>
<Remove GraphicsReshape <Menu QuickGraphicsMenu>>
12 I have reported this as bug # 3494702 as of 2013-02-01.
24 – 28
Commands
Modify statement
Modify The Modify statement is used to change details of a com-
mand. This command must be defined already. The change
may affect:
 the label(s)
 the key sequence aka shortcut(s)
 the key sequence label(s)
2016-03-29
Syntax <Modify cmd-name <new-detail1> … <new-detailn>>

<Modify cmd-name [context-id] <new detail>>
Cmd name This is the name (ID) of the command whose properties shall
be modified
Details In the Modify statement the same details can be defined as in
a Command statement. See Command details on page 30.
Modifications are cumulative for key sequences (shortcuts)13).
The other details are overwritten by the newest one.

Examples <Modify NewDocument
<KeySeqLabel Ctrl+N>>
<Modify TerminateMaker
<Label E&xit>> Define Label with access character
Renaming a context sensitive To rename the label of a context sensitive command, both the
command command-name and the context-identifier (here: Frame) must
be given:
<Modify SelectAll <ReservedLabel Frame Select Everything in
Frame>>
Various labels for same To get a different label for a command in only one place,
command define a new command that duplicates the function of the old
one (using the same key sequence, definition, and mode), but
use a different label. Then put the new command on the menu
in place of the old one.
D
13 If a customisation file contains shortcut definitions for commands that

already have shortcuts defined for them, warning messages may be writ-
ten to he console log file. This happens with ConfigWarnKbdRedundant = On
in maker.ini (see [Preferences] in maker.ini) .
24 – 29
Command details
Definition This defines the function of the command.
Syntax <Definition Fcode1 [Fcode2 … Fcoden]>
Fcode The function code is the connection between the command
and the routine in the application which performs the func-
tion. A command may issue several functions, although most
commands have only one Fcode associated.
The Fcode is noted as \xnnn with nnn being a hexadecimal
number. You can find relevant Fcodes in the FDK 14) documen-
tation or in the command files or in special lists derived from
these files.
Examples <Definition \x300> Create new document
<Definition \x302> Command Help
<Definition \x3F1 \x3F2 > Borders and Text symbols On
Label The label defines the entry in a menu. It also provides a
default for tool tips on buttons using this command.
Access character definition

}
}
Label KeySequenceLabel
Syntax <Label label-string defining the menu entry>

Label string If an ampersand character (&) is needed in the label-string,
it must be doubled. This is due to the fact that the & precedes
an access character. This will be underlined in the menu.
Example <Label P&rint Setup…>
This will display in a menu as Print Setup…
ReservedLabel Some commands have a different label, and a different effect,
depending on the context – where the insertion point is, what
is selected, and so on. In these cases, the command gets a
context-id defining the condition in which it can be chosen.
Each of the conditions has a ReservedLabel statement.
Syntax <ReservedLabel context-id label-string>
Context-id The following context-ids are used in commands15):
Context-id Condition
Body Body pages are displayed
Book Book window is active
14 In the FrameMaker Developer Kit (FDK) see include\fcodes.h

15 This table is deducted from the various cmdxxx.cfg files of FM-13. See
also FP_EnabledWhen value in the FDK reference.
24 – 30
Commands
Context-id Condition
Ditamap Ditamap is active
Document Document is active
Flow Flow is selected
Frame Frame is selected
Generic Set up any generated file
History History window
2016-03-29
Long, Long2 Complete (Long) menus is active

LongMultiple Multiple book components are selected
LongSingle Single book component is selected
MacEdition… Depreciated, since Macintosh is no more supported.
Master Master pages are displayed
NoDelete This page can not be deleted (e.g. Left/Right master page)
NoName This page has no name (not yet saved)
NotRegistered Product not yet registered

Other Other than body pages are displayed
Page A document page is active
Redo Undo command list
Reference Reference pages are displayed
Registered Product is registered
Repeat Repeat xxx
Scratch Probably a left-over from program development
Search AFAIK only used to search references.
Short, Short2 Short (Quick) menus is active
Straddle Selected cells are not straddled
Table Table is selected
TextInset Text inset is active
TOC, LOF, … Set up the respective generated file TOC, LOF, LOT, LOP,
LOE, APL, AEL, LOM, AML, LOR, IX, AIX, SIX, IOM, IOR)
ToTable Selection is paragraph(s)
ToText Selection is a table
Undo Redo command list
Unstraddle Selected cells are straddled
Label string The same rules as with the Label detail apply. See Label on
page 30
Example <Command SelectAll
D
<ReservedLabel Flow Select All in Flow>

<ReservedLabel Frame Select All in Frame>
<ReservedLabel Page Select All on Page>
... >>
The SelectAll command acts as a place holder on the menu
for the group of commands: Flow, Frame, and Page, all of which
have the same command definition.
KeySequence The key sequence defines a keyboard shortcut for the com-
mand.
Syntax <KeySequence sequence>
24 – 31
Sequence This defines the sequence of keystrokes. Two cases must be

distinguished: Keys to be pressed together (key group) and
keys to be pressed one after the other (key sequence).
If you need the modifier key symbols literally in a sequence,
the symbol must be preceded by a solidus (/). For example to
use the ‘+’ in a key sequence literally, you provide ‘/+’.
Key group A base key is pressed together with modi-
fier keys. These modifier keys are defined
with special symbols:
Escape key: \!
Shift key: +
Control key: ^
Alt key 16): ~
A key group should not use more than two
modifier keys, because humans have only
two hands …
Key Sequence These sequences mostly start with the
Escape key. Non-alphanumeric keys need a
special notation 17):
Escape key: \!
Function keys: /F1 … /F12
Insert key: /Insert
Note: Defining a key sequence must consider existing key sequences.
If a key sequence ESC,q,q is already defined, ESC,q can no
more be defied, because the input process waits for the next q.
If You then enter just any other character (e.g. z), nothing will
happen.
Existing key sequences mostly mimic the menu entries they
support. They depend on the UI language. For example the
sequence for Repeat last character modification is Esc,c,c in
the English, and Esc,z,w in the German FrameMaker.
Examples <KeySequence +^b > Shift+CTRL+B (one key stroke)
<KeySequence \!/+c > Escape, Plus, c (three distinct key
strokes)
Shortcuts on the Equations The shortcuts that appear on the Equations palette can not be
palette customised. This palette is actually a special view-only docu-
ment containing hypertext commands. The same is true for
the Vertical Toolbar.
KeySequenceLabel The key sequence label is added to the right side of a menu
entry.
Syntax <KeySeqLabel descriptive-string>
16 On European keyboards the right Alt key is engraved AltGr (Alternate

Graphic). Pressing this key together with another key types the special
graphic engraved at lower right of the symbol key. AltGr is equivalent
to Alt+Ctrl .
17 Since Windows 95 the following keys available only on Windows Key-
boards can no more be used for short cuts in FrameMaker:
Application Key – also called Menu Key (/Apps) right of the space bar. Its
standard function is to open the context menu of an application.
The Windows logo key (/Win) left of the space bar is used for various Win-
dows functions, for example, to open the Start Menu. See Wikipedia.
24 – 32
Commands
Descriptive string This echoes the key sequence of the command. You should
distinguish the two cases of key sequences by different nota-
tion:
Key group Key names concatenated with a ‘+’ sign.
Key sequence A list of key-names (separated by blank or
comma).
Examples <KeySeqLabel CTRL+A> Key group
<KeySeqLabel Escape, q, q, e> Key sequence
2016-03-29
<KeySeqLabel Esc q q p> Key sequence

<KeySeqLabel ALT+Shift+F9> Key group
Note: If a command does not have a KeySeqLabel detail, the com-
mand will be displayed on the menu with no shortcut. This
does not mean the shortcut does not exist; it just means the
shortcut is not displayed on the menu.
Mode The Mode defines the validity of a command for a particular
environment.
Syntax <Mode mode >

Mode Defined modes (used in commands) are:
Mode
All The default
Math During Equation editor
NonMath Anything but Math
Example <Mode NonMath >

AsianFonts To define a command that appears in menus only if your sys-
tem supports typing Asian text in documents and dialogue
boxes, use this detail:
Syntax <AsianFonts Yes>
Note: AsianFonts No has the same effect as omitting the statement.
In this case the command applies to all configurations.
D
24 – 33
Some particularities of commands

Hypertext commands See a synopsis of the hypertext commands at www.daube.ch.
 Hypertext commands can only be used in menus, not for
toolbars.
 It is not possible to define shortcuts for hypertext com-
mands. For example, the shortcut defined in the Modify
statement is not executed:
<Command Test1 <Label Using FrameMaker 11>
<Hypertext message openfile H:/…/etbfm11-help.pdf>>
<Modify Test1 <KeySequence \!qqq>
<KeySeqLabel Escape q q q>>
 Hypertext commands do not work in books, neither do
shortcuts to hypertext commands in a book window.
Although it is possible to define an entry in a book menu
for such commands , they are inactive (greyed out).
 It is possible to define FM read only documents containing
buttons with hypertext commands. Examples are the Equa-
tions palette and the Vertical tool bar. See more on this
method on www.daube.ch.
Keyboard shortcuts For ordinary commands (not hypertext commands) keyboard

shortcuts can be redefined. However, this will provoke a log
message if ConfigWarnKbdOverride = On is set in maker.ini.
Even an unmodified FM-UI will issue such messages 18).
If the same short cut is given more than once to a command,
another message is issued if ConfigWarnKbdRedundant = On is
set in maker.ini 19). This happens in particular for settings
both in configui\customui.cfg and in the menu file in
%appdata% – which is common for many UI modifications.
Command overloading A command (name) can be redefined20).

Initiall definition <Command Test2
<Label Using FrameMaker 11>
<Hypertext message URL
http://help.adobe.com/en_US/.../11.0/Using/index.html>>
<Modify Test2
<KeySequence \!qqq>
<KeySeqLabel Escape q q q>>
Later definition <Command Test2
<Hypertext alert Test2 is testing hypertext> >
<Add Test2 <Menu ViewMenu>>
Result The shortcut ESCqqq brings up an alert that says “Test2 is test-
ing hypertext”.
18 For example: The shortcut !ph in file FMPublisher overrides one or more
previous shortcuts.
19 For example The shortcut !SFL in file
$HOME\fminit\configui\structured\wysiwygview\wincmds.cfg is a dupli-
cate of an existing shortcut.
20 Lynne Price, 2014-10-23
24 – 34
Commands
Multi-code commands For multi-code commands only two of the three UI elements
may be defined: button, menu item, shortcut. If all three are
defined, then only the first code will be executed.21)
For the following no menu item will be defined:
<Command EditingDisplay
<ReservedLabel Document &Editing Display>
<KeySequence \!qqe >
<KeySeqLabel Esc q q e>
<Definition \x3F1 \x3F2 >
2016-03-29
<Mode All>>
And for the following only a menu item (and no shortcut or
button) will be defined:
<Command ETBGoToMasterPage
<Definition \x343 \x345 >
<Label Go to a Specific Master Page... >>
<Add ETBGoToMasterPage <Menu ViewMenu>>
<Order ViewMenu.ETBGoToMasterPage
<Before ViewMenu.ViewMasterPages>>
OWL commands The new interface requires special commands:

Show next tab in panel group <Command ShowNextKit
<Label Show Next>
<KeySequence ^ /F6>
<Definition \x971>
<Mode All>>
Show previous tab in panel <Command ShowPrevKit
group <Label Show Previous>
<KeySequence ^ +/F6>
<Definition \x972>
<Mode All>>
??? <Command ThemeLoad
<Label LoadTheme...>
<KeySequence \!LT>
<Definition \x974>
<Mode All>>
??? <Command ThemeSave
<Label SaveTheme...>
<KeySequence \!ST>
<Definition \x975>
<Mode All>>
Toggle between the <Command ToggleScreenMode
following 3 screen modes <Label Toggle Screen Mode>
<KeySequence ~+/Return>
<KeySequence \!SMt>
<Definition \x978>
D
<Mode All>>
Standard mode (UI, normal <Command SceenModeStandard
size) <Label Standard Screen Mode>
<KeySequence \!SMs>
<Definition \x979>
<Mode All>>
Full width with UI <Command ScreenModeFullWithUi
<Label Full Screen Mode with UI>
<KeySequence \!SMu>
<Definition \x97A>
21 This is a problem since FM-9 and is most likely a consequence of the new
user interface.
24 – 35
<Mode All>>
Full screen, no UI <Command ScreenModeFullScreen
<Label Full Screen Mode>
<KeySequence \!SMf>
<Definition \x97B>
<Mode All>>
Peferences > Interface <Command UiPreferences
<Label Interface...>
<KeySequence \!ip>
<Definition \x980>
<Mode All>>
Preferences > Alert Strings <Command UiAlertStringsPreferences
<Label Alert Strings...>
<KeySequence \!asp>
<Definition \x981>
<Mode All>>
Show all tool bars <Command ToolBarShowAll
<Label Show All>
<KeySequence \!TSA>
<Definition \x989>
<Mode All>>
Hide all tool bars <Command ToolBarHideAll
<Label Hide All>
<KeySequence \!THA>
<Definition \x98A>
<Mode All>>
Some graphic commands

Operate on first selected <Command SetFirstPenPattern
graphic object in a group <Label Set First Pen Pattern (black)>
<KeySequence \!0p>
Operate on selected graphic <Command IncrementPenPattern
object <Label Increment Pen Pattern>
<KeySequence \!\+p>
Keep next selected graphic <Command GraphicsKeepTool
tool active <Label Keep Tool>
<KeySequence \!gk>
This keeps the next selected graphic tool active until
SmartSelectionTool is activated.
Operate on hot spot graphic <Command GraphicsCreateLink
<Label Create Link to graphic...>
<KeySequence \!gcl>
Operate on hot spot graphic <Command GraphicsCreateLinkTable
<Label Create link table for graphic...>
<KeySequence \!gct>
Dead commands Following commands do nothing (FM-9 … 13):

<Command !WindowOpen** Not supported on all platforms **
<Label Open>
<KeySequence \!wo>
<Command ViewPublisherBoundaries
<Label Publisher Boundaries>
<KeySequence \!vl> (lowercase L)
<Command ReportCmds_byShortcut
<Label Report Commands by Shortcuts>
<KeySequence \!SCR2>
24 – 36
Commands
Viewer popup command The commands for the viewer also work in the ordinary edit
window:
Command KeySequence Definiiton
GotoNextPage \!pn \x34D
GotoPreviousPage \!pp \x34C
GotoFirstPage \!pf \x340
GotoLastPage \!pl \x341
2016-03-29
GotoPreviousScreen \!vsp \xD40

GotoNextScreen \!vsn \xD41
D
24 – 37
Command names from plugins and scripts

Available commands have various sources. Even native
FrameMaker comes with plugins: mapper.dll, masterpages.dll
etc. Most installations add scripts, both started automatically
or on demand.
To be able to set up custom menus and tool bars it is neces-
sary to get the command names from these sources. The best
method is to use the free FrameScript Report FM-commands
from itl.
Plugins For example, the plugin AutoText.dll from Silicon Prairie

Software creates commands which depend on a table in the
related document AutoText.fm. This is an excerpt of these
commands from my personal settings in the table:
Command name Command label Shortcut FCode
Editors note in frame [ctrl+3] Editors note in frame [ctrl+3] Ctrl+3 1400DF0
Callout figure [ctrl+4] Callout figure [ctrl+4] Ctrl+4 1410DF0
Frame outside column [ctrl+4] Frame outside column [ctrl+4] Ctrl+5 1420DF0
Icon frame [ctrl+6] Icon frame [ctrl+6] Ctrl+6 1430DF0
ExtendScript
example.zip.
ExtendScript simple.jsx contains the following statements
and thus
/ creates the commands listed below.
6 #target framemaker
7
8 var msg1 = "JavaScript alert message\nYou always get an i
9 var msg2 = "FrameMaker Alert dialogue\nIcon/Buttons depen
10
11 // set up menu with just two items
12 var mMenu = app.GetNamedMenu("!MakerMainMenu");
13 var simpleMenu = mMenu.DefineAndAddMenu("Simple", "Alerts
14 simpleMenu.DefineAndAddCommand(1,"msgJS","JS alert","");
15 simpleMenu.DefineAndAddCommand(2,"msgFM","FM Alert","");
16 UpdateMenus();
17
18 // watch the suptle difference in syntax: alert | Alert
19 function Command(cmd){
20 switch(cmd) {
21 case 1:
22 alert (msg1, "Message title");
23 break;
24 case 2:
25 Alert(msg2, Constants.FF_ALERT_CONTINUE_NOTE);
26 break;
27 }
28 }
Command name Command label FCode
msgJS JS alert 18B0DF0
msgFM FM Alert 18C0DF0
You see that there is no relation between the script file name
and the command names.
24 – 38
Commands
FrameScript
example.zip.
Ordinary scripts get generic names (ESLRUNxxx) which may
change form FrameMaker start to start. Hence a menu or tool
bar using these can not be distributed to other installations.
ESLSSRUN306 Primitive 18E0DF0
2016-03-29
ESLSSRUN307 Something Else 18F0DF0
To get a static command name to be used in a menu or tool

bar the script must be set up as an EventScript.
 EventScripts must be installed, not just run.
 In an EventScript commands must reside within Events.
 Menus and commands are defined within the Event
Initialize.
 It is good practice to remove the menu with Event
Terminate.
 A menu item is not necessary, if the command is used in a
toolbar only.
Installing FrameScript primitive.fsl containing the following
statements creates the command MyCommand1.
g p
13 // A menu item is not necessary, for example if the comma
14
15 // --- Set up a command name and the event trigger
16 Event Initialize
17 // Get Object Type(Menu) Name('!MakerMainMenu') NewVar(gv
18 // New Menu Label('My Menu') NewVar(gvMyMenu) AddTo(gvMai
19 New Command Name('MyCommand1') Label('My Command 1')
20 EventProc(evtCmdEvent) NewVar(gvMyCmd1) // AddTo(gvMyM
21 EnabledWhen(EnableAlwaysEnable)
22 EndEvent
23
24 // --- Remove command and menu at de-installtion time
25 Event Terminate
26 // Remove CommandObject(gvMyCmd1) From(gvMyMenu);
27 // Remove MenuObject(gvMyMenu) From(gvMainMenu);
28 EndEvent // Terminate
29
30 // --- The event procedure is the real task
31 Event evtCmdEvent
D
32 If ActiveDoc = 0
33 MsgBox 'No active document --- Nevertheless: Welcome to
34 Else
35 MsgBox 'We have a document open --- Eventhough: Welcome
36 EndIf
37 EndEvent // evtCmdEvent
The installed script gets the following properties:
MyCommand1 My Command 1 A0DF0
Note: Be aware that the FCodes generated for the script may differ
from FM session to FM session! Hence do not use them.
24 – 39
Installing the example script
Since this example script has no menu entry, you do not see
an action of it as long as you do not have a toolbar with a but-
ton …
24 – 40
Commands
Menu statements
Note: Commands do not need a corresponding menu entry. They
may be invoked by a keyboard short cut or a button only.
Menu A new menu or sub menu is defined with this statement:

Syntax <Menu menu-name <Label menu-label>>
Examples <Menu ETBmenu <Label Enhanced Toolbar (ETB)>>
2016-03-29
<Menu ETBlocalDocuments <Label Local documentation (pdf)>>
Reserved menu Many of the menus defined in the standard menu files for
FrameMaker are reserved menus. FrameMaker has intrinsic
knowledge about reserved menus; it can refer to these menus
directly by name.
Syntax <ReservedMenu !menu-name <Label menu-label>>
Menu-name FrameMaker relies on Permanent menus and also on Context

menus. Both are defined with the ReservedMenu statement in
the standard menu files. Custom menus must not use names
of these reserved menus. It is a good idea to prefix custom
menu names by a project abbreviation. For example, ETBmenu
or !_MTmenu.
Menu-label The Label detail is the same as for commands, because the
command is represented in the menu item. See Label on
page 30.
Reserved menus By convention, the names of reserved menus begin with an
exclamation point (!). The highlighted items in the table are
permanent menus 22).
Menu ID Description
!BookMainMenu Menu bar for complete menus (book window active)
!CustomMakerMainMenu Menu bar for custom menus (document window active)
!EmbeddedObjectMenu Submenu Edit > Object
!HelpMenu Menu Help
!MakerMainMenu Menu bar for complete menus (document window active)
!MenusMenu Submenu View > Menus
!MSWindowMenu Menu Window
!QuickBookMainMenu Menu bar for quick menus (book window active)
!QuickMakerMainMenu Menu bar for quick menus (document window active)
!RulerAlignMenu ¶-alignment pop-up menu in the formatting bar
¶-alignment pop-up menu in the formatting bar
D
!RulerAlignMenu
!RulerControlMenu Formatting bar: commands !ShowRulerToggle,
!ShowRulerAlignmentSpacingAndTabs and !ShowRulerParagraphTags –
all with an empty defintion (\x0).
!RulerParaMenu ¶-formats pop-up menu in the formatting tool bar
!RulerSpaceMenu Line-spacing pop-up menu in the formatting tool bar
a Structure menu bar (structured product interface only)
!StructureViewMainMenu
a View-only menu bar
!ViewOnlyMainMenu
a. Not used in any of the FM-13 *cfg files - depreciated?
22 This table is deducted from the various cmdxxx.cfg files of FM-13.
24 – 41
Permanent menus FrameMaker relies on some menus existing. In the table of

Reserved Menus their ID is bold. You cannot remove these
menus from a menu configuration file. FrameMaker will not
work properly without them.
Context menus The default context menu for a particular selection does not
contain every possible command. If a menu item is not appli-
cable to the selection and the current state of FM, he menu
item will be dimmed.
Context menus can not contain shifted commands. See
ShiftCommand on page 28).
Context menus can also be displayed by pressing Shift+F10.
In this case, the appearing menu depends on whether there
exists a selected object, an insertion point, or neither.23)
Context menu id Object providing the context
!AnchoredFrameContextMenu an anchored frame
!AutoSpellCheckContextMenu
!BookContextMenu a book window
!DocumentContextMenu the document as a whole (no active insertion point and nothing selected)
!EmbeddedObjectContextMenu an OLE object
!GraphicsContextMenu all graphic objects except an anchored frame
!MathContextMenu an equation
!MultiGraphicsContextMenu any grouped graphic object
!QuickBookContextMenu a book window when Quick Menus is the current menu set up
!StructureContextMenu the Structure View in FrameMaker+SGML
!StructuredTextContextMenu text in a structured text flow in FrameMaker+SGML
!TableContextMenu a table
!TableTextContextMenu text in a table
!TextContextMenu text
!TextLineContextMenu text line selected as text
!TextLineGraphicContextMenu text lines selected as graphic objects
!ViewerPopup a View-only document window
!ViewOnlyBookContextMenu a View-only book window
!ViewOnlyDitamapContextMenu DitaMap
!ViewOnlyDitamapContextMenuCon
tainer
TableMenuInTextContextMenu
Add This statement adds an item to a menu at the end of the

already existing entries. Hence normally a corresponding
Order statement exists in a customisation file.
Syntax <Add command <Menu menu-name>>
<Add submenu-name <Menu menu-name>>
<Add Separtorn <Menu menu-name>>
Command This identifies an already defined command.
Submenu-name This identifies an already defined menu.
23 This table is deducted from the various cmdxxx.cfg files of FM-13. See
also FP_EnabledWhen value in the FDK reference.
24 – 42
Commands
Menu-name Name of the menu to which the command or sub-menu shall

be added.
Separatorn Within a menu the separators must be numbered to get
unique names for an Order statement.
Examples <Add Open <Menu FileMenu>>
<Add ETBspecial <Menu ETBmenu>>
<Add Seaprator5 <Menu ETBmenu>>
Order This statement defines where a menu entry shall be placed in

2016-03-29
the menu.
Syntax <Order menu.new-item <First menu>>
<Order menu.new-item <Last menu>>
<Order menu.new-item <Before menu.ref-item>>
<Order menu.new-item <After menu.ref-item>>
Menu The menu we are talking about, defined by a Menu statement.
New-item The item to be placed. It has been defined in the menu.
Ref-item The reference item in menu relative to which the new item is
inserted.
Examples <Order !TextLineContextMenu.SpecialCharsContext
<Before !TextLineContextMenu.Undo>>
<Order !TextLineContextMenu.Separator1
<Before !TextLineContextMenu.Undo>>
<Order ViewMenu.ViewGraphicsOn
<Before ViewMenu.Separator3>>
D
24 – 43
Workspace definition
Workspaces are defined in files xxx.cfws (current) and xxx.fws
(last saved). In most cases we need not create or modify
(besides line 2) such a file.
Modify or create Menus and toolbars appear in a view due to the file location
workspace of them. Multiple workspaces can be defined for a particular
view. Activating a newly introduced toolbar (docked or
undocked) modifies the current workspace, which can be
saved to a new name.
workspace file The following is the definition found in Custom.cfws of the

example download (long lines are truncated to display the
structure):
1 <FrameUI version="1">
2 <data type="all" menuFile="custom_menus.cfg" toolbarFile="custom_toolset.xml"/>
3 <fm-workspace>
4 <workspace version="1">
5 <dock anchor="left" content="palette toolbar" is-closed="false"/>
6 <dock anchor="right" content="palette toolbar" is-closed="false">
7 <tab-pane mode="expanded" preferred-iconic-length="0" layout-mode="auto-flow">
8 <tab-group active-palette="00070CB2" is-closed="false">
9 <palette id="00070CB2" is-closed="false" preferred-unconstrained-size="135
10 <palette id="00060F46" is-closed="false" preferred-unconstrained-size="135
11 <palette id="000A10CE" is-closed="false" preferred-unconstrained-size="135
12 <palette id="00060BAA" is-closed="false" preferred-unconstrained-size="135
13 </tab-group>
14 <tab-group active-palette="00060DD6" is-closed="false">
15 <palette id="000C1118" is-closed="false" preferred-unconstrained-size="317
16 <palette id="00060DD6" is-closed="false" preferred-unconstrained-size="359
17 </tab-group>
18 </tab-pane>
19 </dock>
20 <dock anchor="top" content="multi-control-bar" is-closed="false">
21 <control-bar-pane >
22 <control-bar id="00060B9A" origin="4 35" size="858 34" is-closed="false" app-
23 </control-bar-pane>
24 </dock>
25 <dock anchor="bottom" content="palette" is-closed="false"/>
26 </workspace>
27 </fm-workspace>
28 </FrameUI>
Key in the workspace file are the palette and control-bar
statements, which hold various information about the panels
and toolbars.
Note: For customisation we are normally only dealing with the sec-
ond line which defines the menu set and the toolbar set.
Be aware that xml comments are removed from workspace
files!
Size of toolbar Only if a drop down box appears in the toolbar you may need
to adjust the size parameters in the control-bar statement.
You do this after the workspace file has been created. Nor-
mally you adjust the parameters size = preferred-size and
then minimum and maximum.
<control-bar id="004C0966" origin="874 31" size="255 34" is-closed="false" app-
24 – 44
Workspace definition
data="#lt;control-bar cb-data=#quot;custom_tb#quot; minimum-size=#quot;240 34#quot; maximum-

size=#quot;300 34#quot; preferred-size=#quot;255 34#quot;/>"/>
Custom menu If you want to refer to a custom menu you will change the ref-
erences in line 2, for example
from
<data type="all" menuFile="menus.cfg" toolbarFile="fmtoolbar.xml"/>
to
2016-03-29
<data type="all" menuFile="custom_menus.cfg" toolbarFile="fmtoolbar.xml"/>

You also need to set up a menu file custom-menus.cfg. and
place it in appropriate directory.
Custom toolbar set If you want to refer to a custom toolbar set, you will change
the references in line 2, for example
from
<data type="all" menuFile="menus.cfg" toolbarFile="fmtoolbar.xml"/>

to
<data type="all" menuFile="menus.cfg" toolbarFile="custom_toolbar.xml"/>
You will set up a corresponding list of toolbars in
custom_toolset.xml. This list refers to the individual tool bar
files.
Note: Toolbars containing a drop-down list can not be docked left or
right to become oriented vertically!
D
24 – 45
Initialisation files maker.ini and others

The *.ini files are a standard Windows initialisation files
which are divided into sections. Section names are enclosed
in brackets. The equal sign may be surrounded by spaces:
[Frame]
ProductInterface=FrameMaker
; Comment lines start with a semicolon.
The coding of these files vary. Most use the Windows cp 1252,
maker.ini uses UTF-8.
When opening an initialisation file in FrameMaker, assure to
open it as Text. When you’re finished editing the file, use the
Save As command to save it as Text Only.
For FM-13 the maker.ini file comprises about 350 entries.
Some of them are necessary to get back the behaviour of pre-
vious FM-versions , for example
SymbolSortingBeforeAlphaNumeric = On
Since FM-7.1 the file in $HOME is considered the master file and
only the file in the user-area is modified individually. These
files are now coded in UTF-8. Nevertheless special characters
can be defined in the traditional way using :
FindSpaceBefore=On !%),.:;?]}\u00bb\u201d\u2019\u203a
;SmartQuotes \xd4\xd5\xd2\xd3 ) English curved quotes
SmartQuotes=‘’“”
The last line shown above uses the Unicode of the characters,
while the comment line uses the traditional FrameRoman
notation.
Of course it is possible to establish a complete copy of the
$HOME file in the user-area and then open FrameMaker. How-
ever, some entries, such as ProductInterface are not present
in the main file. They describe items which might differ
between users of the same system.
Other ini files Special features are supported by additional ini files 24):
Initialisation file Purpose, used by
AuthorView.ini Set-up of the Author View
ditafm-output.ini Set-up for DITA output processing
ditafm.ini Set-up for DITA processing
DynaHelpPreview.ini Publisher: Dynamic Help extension
MathFlowPlugin.ini Set-up of the none-Adobe plug-in MathFlow
ModalDialogPosition.ini Save the current positions of the modal dialogues
pdfsize.ini Settings from Format > Document > Optimise PDF
Size > Options
SkinGallery.ini Publisher: skins (WebHelp, WildFire, AirHelp)
sqPalmXmlViewer.ini Publisher: Palm xml viewer
sqSkin.ini Publisher: sqSkin extension
WHATSTHS.INI Set-up for the What’s This function of Publisher
XmlCodeView.ini Set-up of the XML Code View
24 List according to FM-13 installation.
24 – 46
Initialisation files maker.ini and others
Entries in ini files To a void redundancy I do not list the entries of maker.ini
and other ini files here. Look at www.daube.ch for a main-
tained list.
Note: Since FM-12 Adobe maintains a document describing the
entries in maker.ini - See Help > Help Topics > 5 th icon
(FrameMaker Help Center) > FrameMaker Resources.
2016-03-29
D
24 – 47
24 – 48

Edd Formatting

Uploaded by

Document Information

Original Description:

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Edd Formatting

Uploaded by

Copyright:

Available Formats

Customising

Sources  Experiments and beta testing activities.

$HOME The FM installation directory. In my case this is

FCode The function code is the connection between the command

work on the document. The automatic behaviour depends on

UI User interface. The elements of user interaction: windows,

Unstructured mode knows only the WYSIWYGView. In the above

General procedure for customisation

2 A custom toolbar requires creation of a custom-toolbar.xml

mized, docked (left, right, bottom, top), floating, grouped.

Modifications to a workspace are temporary (until saved) and

Workspaces are saved in the user-area. The current workspace

3 A much clearer term would be toolbar-set.xml

Files for the UI

The UI information basically is split into 2 groups:

Product interface Structured Unstructured

Customising FrameMaker 12/13

<data type="all" menuFile="custom_menu.cfg" toolbarFile="custom_toolset.xml"/> structured.xml

However, the contents of this file must also be appended to

4 customui.cfg in FM-12 and later is only relevant before a workspace is se-

Example menu customisation

We will establish this only for the unstructured interface in

*** Example menu customisation

*** Define a new command with a name not yet kwnown to FM

Define a new workspace Our modified menus_custom.cfg must be referenced in a work-

Unstructured\WYSIWYGView and name it Custom.fws Edit line 2

5 The file coding is not at all consistent:

This tool bar shall be available in the unstructured interface,

You may also update the workspace Custom containing already

<ACTION command="msgJS" tooltip="Message via JavaScript">

11

list. See for example www.daube.ch.

7 Example provided by Shmuel Wolfson.

File custom_toolset.xml 1 Make a copy of fmtoolbar.xml and name it custom-

1 <?xml version="1.0" encoding="UTF-8"?>

As usual the toolbar is docked to the other toolbars with the

customui.cfg The file fminit\configui\customui.cfg is a special configura-

With the introduction of views, multiple files cmds and

Configuration file A configuration file consists of a series of statements that

 A statement may span several lines.

Statements in configuration files

8 This process is called Localisation in the progress indication during the

Debugging customisation files

To display error messages when you load a menu customisa-

you’ll see error messages about redefining a command

Tags in toolbar files

FMTOOLBARLIST This is the root tag in a toolbar file.

left: Toolbar will be docked at the left

ACTION The action tag defines the command assigned to an UI button.

TOGGLE A toggle tag is used to define two (logically alternating)

help Help String for the toggle command (default=

11 This tag attribute may be replaced by images = list of images (see

FLYOUT This is used to define a popup menu.

SEPARATOR This tag places a separator between two items

IMAGES This tag describes the images displayed on an ACTION, FLY-

Note concerning scripts

 Scripts must be loaded during the start of FrameMaker.

provides the command name. Installed ExtendScripts get

File name of script Command name

For details see Command names from plugins and scripts on

 Although there are special images for the roll-over situa-

If set to regular size, standard icons not found are depicted

Extract and rename 1 Open the dll in ResHacker.