Improve the keyboard navigation options in the paged display provided by `ShowCommandHelp` (F1)

Aperta
#3,561 4 commenti 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
csharp
Ambito
cli

Direzione di ricerca

Start at the ShowCommandHelp implementation and inspect how its paged display handles the existing up- and down-arrow keys. Define completion around PageUp/PageDown and Home/End navigation, while treating the proposed online-help, examples, and search commands as additional scope to clarify before implementation; no file or test path is named in the issue.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Area-CommandHelp Issue-Enhancement
Prerequisites
  • Write a descriptive title.
Description of the new feature/enhancement

Pressing F1 (bound to function ShowCommandHelp) helpfully provides a paged display of the help topic for the command to the left of the cursor.

However, the keyboard navigation provided is currently limited to line-by-line scrolling (up- and down-arrow keys).

It would be helpful to also support keys for the following navigation keys (possibly also via alternate keys if required for cross-platform compatibility):

  • PageUp/Down (scroll a page up / down)
  • Home/End (scroll to the top / bottom)

Additional commands could be implemented, which would make F1 a "one-stop shop" for all help needs, so that user won't need to use Get-Help explicitly (though, of course, are free to).

  • o to open the online help (equivalent of Get-Help -Online)
  • x to jump to the EXAMPLES section (analog of Get-Help -Examples
  • f to search within the topic and jump to matches
Lingua principale
C#
Stelle
4.4k
Fork
341
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di PowerShell/PSReadLine

Tutte le issue di PowerShell/PSReadLine

Issue simili

Altre issue su C#

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.