Add docs to the user manual about the terminal key bindings
ClosedPublic

Authored by ahmadsamir on Apr 7 2018, 9:38 AM.

Details

Summary

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

Sources used while writing this documentation:

Diff Detail

Repository
R319 Konsole
Branch
keybinding-editor-docs (branched from master)
Lint
No Linters Available
Unit
No Unit Test Coverage
ahmadsamir created this revision.Apr 7 2018, 9:38 AM
Restricted Application added a project: Konsole. · View Herald TranscriptApr 7 2018, 9:38 AM
Restricted Application added a subscriber: kde-doc-english. · View Herald Transcript
ahmadsamir requested review of this revision.Apr 7 2018, 9:38 AM

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?

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

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).

yurchor requested changes to this revision.Apr 7 2018, 11:11 AM
This revision now requires changes to proceed.Apr 7 2018, 11:11 AM
yurchor added inline comments.Apr 7 2018, 11:22 AM
doc/manual/index.docbook
1334

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

1339

e.g. -> ⪚

1343

going -> go

1363

<abbrev>i.e.</abbrev> -> &ie;

1365

Ctrl keys _are_ not pressed.

1407

etc -> &etc;

1410

<abbrev>e.g.</abbrev> -> &eg;
less -> <application>less</aplication> same for vim, screen, tmux
etc -> &etc;

1421

etc -> &etc;

1481

<abbrev>e.g.</abbrev> -> &eg;

ahmadsamir marked 7 inline comments as done.Apr 7 2018, 2:10 PM

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.

doc/manual/index.docbook
1334

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.

1343

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.

1365

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

ahmadsamir updated this revision to Diff 31592.Apr 7 2018, 2:11 PM
ahmadsamir marked an inline comment as done.

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

yurchor accepted this revision.Apr 7 2018, 2:21 PM
This revision is now accepted and ready to land.Apr 7 2018, 2:21 PM
hindenburg accepted this revision.Apr 7 2018, 4:05 PM

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

ahmadsamir updated this revision to Diff 31609.Apr 7 2018, 5:46 PM

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

ahmadsamir updated this revision to Diff 31622.Apr 7 2018, 7:31 PM
ahmadsamir edited the summary of this revision. (Show Details)
ahmadsamir removed a reviewer: yurchor.
ahmadsamir removed a subscriber: ltoscano.

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.

yurchor added inline comments.Apr 8 2018, 5:52 AM
doc/manual/index.docbook
1363 ↗(On Diff #31592)

<keycap>Ctrl</keycap> -> &Ctrl;

1365 ↗(On Diff #31592)

<keycap>Ctrl</keycap> -> &Ctrl;

ahmadsamir updated this revision to Diff 31654.Apr 8 2018, 9:32 AM

Change <keycap>Ctrl</keycap> to &Ctrl;

ahmadsamir marked 7 inline comments as done.Apr 8 2018, 9:33 AM
This revision was automatically updated to reflect the committed changes.