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

Abierto
#3,561 4 comentarios 1 reacción 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
35/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
csharp
Área
cli

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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
Lenguaje dominante
C#
Estrellas
4.4k
Forks
341
Sin PR fusionados en 30 d

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de PowerShell/PSReadLine

Todos los issues de PowerShell/PSReadLine

Issues similares

Más issues de C#

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.