Additional description of TN3270 #3047
Conversation
Signed-off-by: Martin Zeithaml <[email protected]>
Signed-off-by: Martin Zeithaml <[email protected]>
docs/user-guide/mvd-3270.md
Outdated
| @@ -0,0 +1,120 @@ | |||
| # 3270 Terminal | |||
| The 3270 Terminal Display Emulator plugin provides a user interface that emulates the basic functions of IBM 3270 family terminals. On the "back end," the plugin and the Zowe Application Server connect to any standard TN3270/E server. | |||
There was a problem hiding this comment.
Two things:
- Our style guide word usage standard is to use plug-in (instead of plugin)
- No need to use quotes w/ back end.
docs/user-guide/mvd-3270.md
Outdated
| # 3270 Terminal | ||
| The 3270 Terminal Display Emulator plugin provides a user interface that emulates the basic functions of IBM 3270 family terminals. On the "back end," the plugin and the Zowe Application Server connect to any standard TN3270/E server. | ||
|
|
||
| This terminal display emulator operates as a "Three-Tier" program. Due to web browsers being unable to supply TCP networking that terminals require, this terminal display emulator does not connect directly to your TN3270 server. Instead, the Zowe Application Server acts as a bridge, and uses websockets between it and the browser for terminal communication. As a result, terminal connections only work when the stack of network programs supports websockets and the TN3270 server destination is visible to the Zowe Application Server. |
There was a problem hiding this comment.
No quotes, no dash, no capitalization needed in three tier, unless this is an official name that uses quotes, the hyphen, and the capitalization
docs/user-guide/mvd-3270.md
Outdated
|
|
||
| This terminal display emulator operates as a "Three-Tier" program. Due to web browsers being unable to supply TCP networking that terminals require, this terminal display emulator does not connect directly to your TN3270 server. Instead, the Zowe Application Server acts as a bridge, and uses websockets between it and the browser for terminal communication. As a result, terminal connections only work when the stack of network programs supports websockets and the TN3270 server destination is visible to the Zowe Application Server. | ||
|
|
||
| The terminal connection can be customized per-user and saved for future sessions using the connection toolbar of the application. The preferences are stored within [the configuration dataservice storage](../extend/extend-desktop/mvd-configdataservice), which can also be used to set instance-wide defaults for multiple users. |
There was a problem hiding this comment.
"per user" doesn't need a hyphen, please remove
docs/user-guide/mvd-3270.md
Outdated
| ## Keyboard shortcuts | ||
| The terminal bundle that is used by tn3270-ng2 has several keyboard shortcuts to execute common TN3270 emulator functionality. Below is the current list of what function is mapped to which key combination. | ||
|
|
||
| Be aware that some browsers intercept key combinations that are common to browsers, such as Control+R or Control+T, and that the OS may also intercept certain combinations such as Windows+R or Alt+F4. |
There was a problem hiding this comment.
- our style for keyboard keys is to use backticks to format keys:
ctrl+R - please write out OS
docs/user-guide/mvd-3270.md
Outdated
|
|
||
| Be aware that some browsers intercept key combinations that are common to browsers, such as Control+R or Control+T, and that the OS may also intercept certain combinations such as Windows+R or Alt+F4. | ||
|
|
||
| Also be aware that the key combinations listed will only be handled by the terminal if the terminal has focus - which you can know by if the terminal's cursor is visible and blinking or not. To gain focus on the terminal, it is sufficient to click on the terminal's contents. The difference between focus and not focus may be the difference between F5 being interpreted as terminal PF5, or the browser reloading the page. |
There was a problem hiding this comment.
replace dash w/ comma: ... if the terminal has focus, which you can know ....
| Also be aware that the key combinations listed will only be handled by the terminal if the terminal has focus - which you can know by if the terminal's cursor is visible and blinking or not. To gain focus on the terminal, it is sufficient to click on the terminal's contents. The difference between focus and not focus may be the difference between F5 being interpreted as terminal PF5, or the browser reloading the page. | ||
|
|
||
|
|
||
| Action | Keyboard Shortcut | Note |
There was a problem hiding this comment.
please use backticks to format keyboard keys
docs/user-guide/mvd-3270.md
Outdated
| PF22 | Shift+F10 | | ||
| PF23 | Shift+F11 | | ||
| PF24 | Shift+F12 | | ||
| Reset | Alt+r | Terminal doesn't lock on bad input, just rejects and auto-resets. No use for reset button currently. |
There was a problem hiding this comment.
no need for dash in "auto resets"
docs/user-guide/mvd-3270.md
Outdated
| Tab | Tab | ||
|
|
||
| ## Key sequences | ||
| The **key sequences** allow users to define own key sequences. Each key sequence is a recorded set of keys with possibility of using the key modifiers (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. |
There was a problem hiding this comment.
Seems like there are some missing words in this sentence. Should it be: Key sequences allows user to define their own key sequences. ... set of keys with the possibility
docs/user-guide/mvd-3270.md
Outdated
|
|
||
|
|
||
| ### Syntax of the JSON | ||
| * All key sequences can be re-defined by user |
There was a problem hiding this comment.
- no dash: redefined
- the user
docs/user-guide/mvd-3270.md
Outdated
| * 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 demostrate this on the 2 simple key sequences: |
There was a problem hiding this comment.
write out the number when it is less than 10: two simple key ....
Signed-off-by: Martin Zeithaml <[email protected]>
|
Thanks for feedback, please, review the changes and sorry for delay, I was ill. Like this:
|
The changes look good, Martin, thank you. Hope you're feeling better. Re: the TN3270 description. I would check w/ your squad to see what placement they think works best for the user. If you do want to create a separate article, I would still list TN3270 in the Using the Zowe Desktop page b/c it's part of the components (as far as I understand) and you want the list to be complete. I'd write a brief one-sentence description of TN3270 and then link out to your new Using the TN3270 article. Reach out if you have questions. |
|
I have asked the WebUI squad, what they think about having TN3270 as new chapter and they agreed. Sean Grady (as WebUI leader) voted for that via Thump up. This PR can be finished. |
Thanks for the update, @Martin-Zeithaml. You should still include TN3270 in the Using the Zowe Desktop list just so that list is complete and not missing any components. In the Using the Zowe Desktop list, simply include a link to your new TN3270 page and that link can serve as the definition/explanation. Once that's done, I'm happy to merge your PR. Let me know if you have any questions. |
Description
For 2241
Extended the description of TN3270: