Your contact

Nachfolgender Link öffnet ein Pupup-Fenster für diese Website.Klaus Müller

+49 (0)89 892623-660

Report: FM commands

ReportCommands.fsi

Problem description

The commands that can be started using a key combination are listed in the appendix of the FrameMaker Online Help. This list does not include plug-in or script commands.

Naturally, user-specific modifications or extensions to the FM commands are also not taken into consideration in the help.

In addition, the Help neither lists the internal name nor the numerical command ID or associated FDK command of the commands, which is important for invoking these commands via FrameScript.

To top

Function description

The script creates a report of all commands that are available in the current FrameMaker environment at runtime. This includes the internal command name, command title, assigned shortcuts, numerical command ID and optionally the associated FDK name of the command (if available).

All modifications of the commands (via FM-cfg files, CustomUI.cfg, scripts or plugins) will be displayed.

The order of the commands in this report corresponds with the order of their initialization by FrameMaker. The group titles will be read out from the corresponding comment lines of the FM-cfg files.

The report also supports the script developer in the direct invocation of the commands in addition to a quick determination of the key combinations of individual commands.

Although it is generally recommended to use the corresponding FrameScript commands in scripts instead of the direct invocation of the commands, they are not always available for all commands. There is no corresponding FrameScript command specifically for FM commands that were implemented through plugins and, of course, for all other plugin and script commands.

In these cases, the commands can be directly started in FrameScripts. Here are two examples:

  • Remove Structure from Flow:
    RemoveStruct (KBD_STRIP_FLOWSTRUCTURE):
    Execute FC KbdStripFlowStructure;
  • Apply Master Pages:
    ApplyMasterPages (no FDK command available):
    Execute FC MenuCommand('ApplyMasterPages');

To top

Requirements

  • FrameMaker 6.0 or higher
  • FrameScript/ElmScript 4.1 or higher

Notes

The script works with structured and unstructured documents.

Warning: In FrameMaker 8, some shortcuts are not correctly returned by FrameMaker or the FDK and are thus displayed incorrectly by the script.
This applies to all commands with shortcuts that contain the position and function keys (Left, Right, Up, Down, Home, End, PageUp, PageDn, F1, F2, ..., F12).
We are not aware of a solution to solve this problem. This error has been corrected in FrameMaker 9.

To top