Skip to content

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

Open
@mklement0

Description

@mklement0

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    Area-CommandHelpLabel for issues related to ShowCommandHelp and the pagerIssue-EnhancementIt's a feature request.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions