D12015: Add docs to the user manual about the terminal key bindings

[Kurt Hindenburg]

This revision was automatically updated to reflect the committed changes.
Closed by commit R319:666c1c8372f8: Add docs to the user manual about the 
terminal key bindings (authored by ahmadsamir, committed by hindenburg).

REPOSITORY
  R319 Konsole

CHANGES SINCE LAST UPDATE
  https://phabricator.kde.org/D12015?vs=31654&id=31879

REVISION DETAIL
  https://phabricator.kde.org/D12015

AFFECTED FILES
  doc/manual/index.docbook
  src/EditProfileDialog.ui

To: ahmadsamir, #konsole, hindenburg, yurchor, ltoscano
Cc: kde-doc-english, hindenburg, #konsole, herrold, ngraham

D12015: Add docs to the user manual about the terminal key bindings

[Ahmad Samir]

ahmadsamir marked 7 inline comments as done.

REPOSITORY
  R319 Konsole

BRANCH
  keybinding-editor-docs (branched from master)

REVISION DETAIL
  https://phabricator.kde.org/D12015

To: ahmadsamir, #konsole, hindenburg, yurchor, ltoscano
Cc: kde-doc-english, hindenburg, #konsole, herrold, ngraham

D12015: Add docs to the user manual about the terminal key bindings

[Ahmad Samir]

ahmadsamir updated this revision to Diff 31654.
ahmadsamir added a comment.


  Change Ctrl to &Ctrl;

REPOSITORY
  R319 Konsole

CHANGES SINCE LAST UPDATE
  https://phabricator.kde.org/D12015?vs=31622&id=31654

BRANCH
  keybinding-editor-docs (branched from master)

REVISION DETAIL
  https://phabricator.kde.org/D12015

AFFECTED FILES
  doc/manual/index.docbook
  src/EditProfileDialog.ui

To: ahmadsamir, #konsole, hindenburg, yurchor, ltoscano
Cc: kde-doc-english, hindenburg, #konsole, herrold, ngraham

D12015: Add docs to the user manual about the terminal key bindings

[Yuri Chornoivan]

yurchor added inline comments.

INLINE COMMENTS

> index.docbook:1363
> +
> +A + preceding a Mode name means that mode is 
> set; for a modifier key, that means it's pressed, 
> whereas for all other modes it means that particular mode is in effect (&ie; 
> active). For example +Ctrl means the key combination will work 
> only if the Ctrl key is pressed.
> +

Ctrl -> &Ctrl;

> index.docbook:1365
> +
> +A - preceding a Mode name means that mode is 
> reset; basically this is the opposite of putting 
> + before a Mode name, so for a modifier key that means the key 
> isn't pressed, whereas for all other modes it means that particular mode is 
> inactive. For example -Ctrl means the key combination will 
> work only if the Ctrl key is not 
> pressed.
> +

Ctrl -> &Ctrl;

REPOSITORY
  R319 Konsole

BRANCH
  keybinding-editor-docs (branched from master)

REVISION DETAIL
  https://phabricator.kde.org/D12015

To: ahmadsamir, #konsole, hindenburg, yurchor, ltoscano
Cc: kde-doc-english, hindenburg, #konsole, herrold, ngraham

D12015: Add docs to the user manual about the terminal key bindings

[Ahmad Samir]

ahmadsamir added reviewers: yurchor, ltoscano.

REPOSITORY
  R319 Konsole

BRANCH
  keybinding-editor-docs (branched from master)

REVISION DETAIL
  https://phabricator.kde.org/D12015

To: ahmadsamir, #konsole, hindenburg, yurchor, ltoscano
Cc: kde-doc-english, hindenburg, #konsole, herrold, ngraham

D12015: Add docs to the user manual about the terminal key bindings

[Ahmad Samir]

ahmadsamir updated this revision to Diff 31622.
ahmadsamir edited the summary of this revision.
ahmadsamir removed a reviewer: yurchor.
ahmadsamir removed a subscriber: ltoscano.
ahmadsamir added a comment.


  I finally found doc/user/README.keyboard which mentioned some more stuff 
about the key bindings.
  Added "credits" about the resources I used while writing this doc.

REPOSITORY
  R319 Konsole

CHANGES SINCE LAST UPDATE
  https://phabricator.kde.org/D12015?vs=31609&id=31622

BRANCH
  keybinding-editor-docs (branched from master)

REVISION DETAIL
  https://phabricator.kde.org/D12015

AFFECTED FILES
  doc/manual/index.docbook
  src/EditProfileDialog.ui

To: ahmadsamir, #konsole, hindenburg, yurchor
Cc: kde-doc-english, hindenburg, #konsole, herrold, ngraham, ltoscano

D12015: Add docs to the user manual about the terminal key bindings

[Ahmad Samir]

ahmadsamir updated this revision to Diff 31609.
ahmadsamir added a comment.


  Add a section about NewLine mode
  Replace "Return" with Carriage Return in the output field section
  Change version to 18.08

REPOSITORY
  R319 Konsole

CHANGES SINCE LAST UPDATE
  https://phabricator.kde.org/D12015?vs=31592&id=31609

BRANCH
  keybinding-editor-docs (branched from master)

REVISION DETAIL
  https://phabricator.kde.org/D12015

AFFECTED FILES
  doc/manual/index.docbook
  src/EditProfileDialog.ui

To: ahmadsamir, #konsole, hindenburg, yurchor
Cc: ltoscano, kde-doc-english, hindenburg, #konsole, herrold, ngraham

D12015: Add docs to the user manual about the terminal key bindings

[Kurt Hindenburg]

hindenburg accepted this revision.
hindenburg added a comment.


  Thanks, LGTM - this is too late for 18.04 so it will go in 18.08

REPOSITORY
  R319 Konsole

BRANCH
  keybinding-editor-docs (branched from master)

REVISION DETAIL
  https://phabricator.kde.org/D12015

To: ahmadsamir, #konsole, hindenburg, yurchor
Cc: ltoscano, kde-doc-english, hindenburg, #konsole, herrold, ngraham

D12015: Add docs to the user manual about the terminal key bindings

[Yuri Chornoivan]

yurchor accepted this revision.
This revision is now accepted and ready to land.

REPOSITORY
  R319 Konsole

BRANCH
  keybinding-editor-docs (branched from master)

REVISION DETAIL
  https://phabricator.kde.org/D12015

To: ahmadsamir, #konsole, hindenburg, yurchor
Cc: ltoscano, kde-doc-english, hindenburg, #konsole, herrold, ngraham

D12015: Add docs to the user manual about the terminal key bindings

[Ahmad Samir]

ahmadsamir updated this revision to Diff 31592.
ahmadsamir marked an inline comment as done.
ahmadsamir added a comment.


  Update the diff to address some of the issues pointed out in the review
  request

REPOSITORY
  R319 Konsole

CHANGES SINCE LAST UPDATE
  https://phabricator.kde.org/D12015?vs=31574&id=31592

BRANCH
  keybinding-editor-docs (branched from master)

REVISION DETAIL
  https://phabricator.kde.org/D12015

AFFECTED FILES
  doc/manual/index.docbook
  src/EditProfileDialog.ui

To: ahmadsamir, #konsole, hindenburg, yurchor
Cc: ltoscano, kde-doc-english, hindenburg, #konsole, herrold, ngraham

D12015: Add docs to the user manual about the terminal key bindings

[Ahmad Samir]

ahmadsamir marked 7 inline comments as done.
ahmadsamir added a comment.


  In D12015#241801 , @ltoscano wrote:
  
  > The doc team was automatically added as subscriber.
  >  Regarding the entity, just expand it inline, or define the entity in this 
file: we add it for people who have more contributions (and it would introduce 
a dependency on a new version of Frameworks, so you would need to keep the 
expanded version here anyway).
  
  
  OK, thanks for the pointers.
  
  @yurchor: thanks for the review.

INLINE COMMENTS

> yurchor wrote in index.docbook:1332
> Would it be better to have multiple sect1s (sect2s -> sect1s) in a chapter 
> rather than have just one?

Actually I want all the content to be in one page, since it's all relevant and 
the user would have to keep going back and forth between multiple files to look 
stuff up.

> yurchor wrote in index.docbook:1341
> going -> go

I am not a native speaker, but "going" sounds (more) correct to me.

I would use "go" like this:
To open the Key Bindings Editor "click" the menu entry , and "go" to 
the keyboard tab.

> yurchor wrote in index.docbook:1363
> Ctrl keys _are_ not pressed.

It was supposed to be "key", I've fixed that.

REPOSITORY
  R319 Konsole

REVISION DETAIL
  https://phabricator.kde.org/D12015

To: ahmadsamir, #konsole, hindenburg, yurchor
Cc: ltoscano, kde-doc-english, hindenburg, #konsole, herrold, ngraham

D12015: Add docs to the user manual about the terminal key bindings

[Yuri Chornoivan]

yurchor added inline comments.

INLINE COMMENTS

> index.docbook:1332
> +
> +
> +How &konsole; Uses Key Bindings

Would it be better to have multiple sect1s (sect2s -> sect1s) in a chapter 
rather than have just one?

> index.docbook:1337
> +Introduction
> +&konsole; uses *.keytab files to translate key combinations into 
> control characters and escape sequences that are sent to the shell or to 
> interactive programs (typically programs that use the Alternate Screen 
> buffer, e.g. vim, less, screen) running in the shell.
> +

e.g. -> ⪚

> index.docbook:1341
> +
> +You can open the Key Bindings Editor from the menu entry 
> SettingsEdit Current 
> Profile, and going to the 
> Keyboard tab. Listed there are the Key Bindings schemas 
> that come by default with &konsole;.
> +

going -> go

> index.docbook:1361
> +
> +A + preceding a Mode name means that mode is 
> set; for a modifier key, that means it's pressed, 
> whereas for all other modes it means that particular mode is in effect 
> (i.e. active). For example +Ctrl means the 
> key combination will work only if the Ctrl key is 
> pressed.
> +

i.e. -> &ie;

> index.docbook:1363
> +
> +A - preceding a Mode name means that mode is 
> reset; basically this is the opposite of putting 
> + before a Mode name, so for a modifier key that means the key 
> isn't pressed, whereas for all other modes it means that particular mode is 
> inactive. For example -Ctrl means the key combination will 
> work only if the Ctrl keys is not 
> pressed.
> +

Ctrl keys _are_ not pressed.

> index.docbook:1405
> +
> +The Normal Screen buffer (default): allows you to scroll back to view 
> previous lines of output, this is the default buffer you usually use to 
> execute commands... etc
> +

etc -> &etc;

> index.docbook:1408
> +
> +The Alternate Screen buffer: the terminal switches to this buffer when 
> you run an interactive program (e.g. less, vim, screen, 
> tmux... etc)
> +

e.g. -> ⪚
less -> less same for vim, screen, tmux
etc -> &etc;

> index.docbook:1419
> +
> +If this mode is set, the key combination uses a key on the Keypad 
> (Number Pad). This mode is useful to distinguish between keys on the keyboard 
> and keys on the Keypad. For example when Num Lock is on 
> you can configure two separate key combinations, one using the key labelled 
> 1 on the keyboard (usually under the F1 key) 
> and the other using the key labelled 1 on the Keypad. The same 
> concept applies when Num Lock is off for the End, Home, 
> Cursor Keys ...etc on the Keypad
> +

etc -> &etc;

> index.docbook:1479
> +
> +This can be used to send ASCII control characters, 
> e.g. \x00 which is the NUL character
> +

e.g. -> ⪚

REPOSITORY
  R319 Konsole

REVISION DETAIL
  https://phabricator.kde.org/D12015

To: ahmadsamir, #konsole, hindenburg, yurchor
Cc: ltoscano, kde-doc-english, hindenburg, #konsole, herrold, ngraham

D12015: Add docs to the user manual about the terminal key bindings

[Yuri Chornoivan]

yurchor requested changes to this revision.
This revision now requires changes to proceed.

REPOSITORY
  R319 Konsole

REVISION DETAIL
  https://phabricator.kde.org/D12015

To: ahmadsamir, #konsole, hindenburg, yurchor
Cc: ltoscano, kde-doc-english, hindenburg, #konsole, herrold, ngraham

D12015: Add docs to the user manual about the terminal key bindings

[Luigi Toscano]

ltoscano added a comment.


  The doc team was automatically added as subscriber.
  Regarding the entity, just expand it inline, or define the entity in this 
file: we add it for people who have more contributions (and it would introduce 
a dependency on a new version of Frameworks, so you would need to keep the 
expanded version here anyway).

REPOSITORY
  R319 Konsole

REVISION DETAIL
  https://phabricator.kde.org/D12015

To: ahmadsamir, #konsole, hindenburg
Cc: ltoscano, kde-doc-english, hindenburg, #konsole, herrold, ngraham

D12015: Add docs to the user manual about the terminal key bindings

[Ahmad Samir]

ahmadsamir added a comment.


  I totally missed the Newline mode, I'll update the diff (hopefully soon).

REPOSITORY
  R319 Konsole

REVISION DETAIL
  https://phabricator.kde.org/D12015

To: ahmadsamir, #konsole, hindenburg
Cc: kde-doc-english, hindenburg, #konsole, herrold, ngraham

D12015: Add docs to the user manual about the terminal key bindings

[Ahmad Samir]

ahmadsamir added a comment.


  I couldn't find a guide on how to get my name and email added to the docbook 
entities in KDE, I would appreciate any pointers about that.
  
  Also, should I add the docs team on this review or is there another way to 
notify them about this docbook addition?

REPOSITORY
  R319 Konsole

REVISION DETAIL
  https://phabricator.kde.org/D12015

To: ahmadsamir, #konsole, hindenburg
Cc: kde-doc-english, hindenburg, #konsole, herrold, ngraham

D12015: Add docs to the user manual about the terminal key bindings

[Ahmad Samir]

ahmadsamir created this revision.
ahmadsamir added reviewers: Konsole, hindenburg.
Restricted Application added a project: Konsole.
Restricted Application added a subscriber: kde-doc-english.
ahmadsamir requested review of this revision.

REVISION SUMMARY
  Also mention the manual on the Keyboard tab in the Edit Profile Dialog
  to make it more discoverable for users.

REPOSITORY
  R319 Konsole

BRANCH
  keybinding-editor-docs (branched from master)

REVISION DETAIL
  https://phabricator.kde.org/D12015

AFFECTED FILES
  doc/manual/index.docbook
  src/EditProfileDialog.ui

To: ahmadsamir, #konsole, hindenburg
Cc: kde-doc-english, hindenburg, #konsole, herrold, ngraham