search

wagtail / guide

A website to teach Wagtail CMS to content editors, moderators and administrators.
https://guide.wagtail.org
BSD 3-Clause "New" or "Revised" License
30 stars 26 forks source link

New content: Page-level keyboard shortcuts #346

Open Ozyugoo opened 11 months ago

Ozyugoo commented 11 months ago

I think that keyboard shortcuts on page level needs to be documented centering on how to navigate the page with keyboard shortcuts for all users.

Ozyugoo commented 11 months ago

This document provides comprehensive information about the keyboard shortcuts available on our website, enhancing your user experience and productivity. These shortcuts allow you to navigate the website efficiently without relying solely on your mouse or touchpad.

Keyboard Navigation

Users can navigate the web pages and interact with elements using the keyboard. One can access the functions without the use of a mouse.

Some basic keyboard shortcuts

The Tab Key moves forward through the elements on the page such as links, buttons, and form fields. Use the Shift + Tab to move backward through the elements. Use the Spacebar to activate buttons or links that are on focus. Use the Arrow keys (up and down) to scroll through the content.

Website Navigation

Access Links: The Tab key navigates and keeps the links in focus. When the link is on focus, Press Enter to follow the link. Form Fields: Use the Tab key to move through form fields, keep the input field on focus, and select options in dropdown menus, etc. Use Enter will submit the form. Menus and Dropdowns: Press Enter to open the menu. Use the Tab keys to go through the menu items, and press Enter to select an item. Users can access Wagtail websites using browser Shortcuts: Ctrl + L (Cmd + L on Mac): Focus the browser's address bar, allowing you to type a new URL. Ctrl + W (Cmd + W on Mac): Close the current tab. Ctrl + T (Cmd + T on Mac): Open a new tab. Ctrl + Tab (Cmd + Option + Right Arrow on Mac): Switch between open tabs. Ctrl + Shift + T (Cmd + Shift + T on Mac): Reopen the last closed tab.

Ozyugoo commented 11 months ago

@thibaudcolas Please kindly review.

lb- commented 11 months ago

I personally don't think we need to document generic browser shortcuts like tab.

However, I think we could document some shortcuts for the rich text editor.

However, it's probably best for these to be provided canonically in the UI itself. Not in the guide.

See the following issues for the planning/requests for these.

Ozyugoo commented 11 months ago

I personally don't think we need to document generic browser shortcuts like tab.

However, I think we could document some shortcuts for the rich text editor.

However, it's probably best for these to be provided canonically in the UI itself. Not in the guide.

See the following issues for the planning/requests for these.

Thank you, I will read through this links and come with a better idea.

thibaudcolas commented 11 months ago

@Ozyugoo as LB mentions it’s not terribly useful to us to document very generic keyboard commands. This is documentation for Wagtail, not for how internet browsers or operating systems work.

I’d agree it’d be best for those shortcuts to be documented in the UI but this isn’t mutually exclusive, so let’s have docs in the guide until we’re in a position to have them elsewhere instead or in addition.

lb- commented 11 months ago

I agree with Thibaud, nothing's stopping us from having the keyboard shortcuts listed in the Guide and also within the UI itself.

Just need to make sure they are kept in sync if they change / are added to.

lb- commented 11 months ago

We may also want to document the usage of shift+click for multiple areas in the UI, usually for large listings of check boxes.

Ozyugoo commented 11 months ago

We may also want to document the usage of shift+click for multiple areas in the UI, usually for large listings of check boxes.

Thank you for tips, I will take time to study it and document something.

Ozyugoo commented 11 months ago

@Ozyugoo as LB mentions it’s not terribly useful to us to document very generic keyboard commands. This is documentation for Wagtail, not for how internet browsers or operating systems work.

I’d agree it’d be best for those shortcuts to be documented in the UI but this isn’t mutually exclusive, so let’s have docs in the guide until we’re in a position to have them elsewhere instead or in addition.

Noted, thank you for the feedback