Document new functionality added to the TN3270

[Martin-Zeithaml]

Description

There is a new functionality added to the TN3270, which allows the user to define key sequences. This feature is not documented yet.

Pages to Update

3270 Terminal

Additional context

Requested description to be added:

Key Sequences

The key sequences feature allows users to define own key sequences. Each key sequence is basically a clipboard with possibility of using the modifiers keys (Ctrl, Alt, Shift), function keys (F1, F2, ...) and the combinations (such as Ctrl+E or Shift+F1). The definition is stored in the _keySequences.json file.

Syntax of the JSON

• keySequences is an array of individual key sequences
• title will be displayed in the key sequences menu
• description is used as hover help for each item in the key sequences menu
• keys is an array of the key strokes
  • normal for the typewriter keys
  • special for the function, modifiers and other special keys
    • The value corresponds to the javascript key code
  • prompt is used for user input and this input is pasted on the current cursor position
• ctrl, alt and shift are boolean values for setting modifiers keys
• If you combine normal, special or prompt in one array item, only one action will be made in the order of normal, special and prompt

Example

Let's show this on the 2 defined key sequences:

• Hello, world
  • Types Hello, world only
• ISPF command SWAP NEXT
  • Presses Home to get on the command line/input field
  • Ctrl+E will delete whatever might be in the input field
    • Ctrl+E is predefined in the TN3270 as "EOF - Erase end of field"
  • Types SWAP NEXT
  • Hits Enter

{ "keySequences":
  [
    { "title": "Hello, world",
      "description": "Types Hello, world",
       "keys": [ { "normal":  "Hello, world" } ]
    },
    { "title": "SWAP NEXT",
      "description": "ISPF: Swap next command",
       "keys": [ { "special": "Home" },
                 { "normal":  "E", "ctrl": "true" },
                 { "normal":  "SWAP NEXT" },
                 { "special": "Enter" } 
               ]
    }
  ]
}

[Martin-Zeithaml]

Done with #3047