From 5549bc5b03ed98a907b3d7a048abf32f7a1fe2d4 Mon Sep 17 00:00:00 2001 From: Hannah Laman <156121079+hanlaman@users.noreply.github.com> Date: Mon, 15 Apr 2024 09:52:42 -0400 Subject: [PATCH] Update index.rst Use ellipses consistently in menu items and commands #16025 Updated the JupyterLab documentation to mention Apple's Human Interface Guidelines for menus' style improvements. --- docs/source/index.rst | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/docs/source/index.rst b/docs/source/index.rst index 4f8cfa6d377c..4d65c0e9f4ba 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -51,3 +51,24 @@ See the sections below (and the top-level links above) for more information abou extension/extension_dev developer/contributing privacy_policies + +.. .. only:: html + + + +Menu Item Labeling Guidelines +------------------------------ + +When labeling menu items in JupyterLab, consider the following guidelines to ensure clarity and consistency for users: + +1. **Menu Items with Dialog Boxes:** Append an ellipsis (...) to menu items that pop up a dialog box to accept additional information. For example, "Save As..." or "Export Notebook As...". + +2. **Menu Items with Immediate Action:** Omit the ellipsis from menu items that take immediate action without requiring additional input. For example, "Save" or "Close". + +3. **Cascading Menus:** Cascading menus, such as "File > Save and Export Notebook As", should not have an ellipsis. However, submenu items within cascading menus that require additional information should have an ellipsis. + +Adhering to these guidelines improves the user experience by clearly indicating when additional input is needed for an action. It also maintains consistency with Apple's design principles for menu labeling. + +For more information on JupyterLab's interface and customization options, refer to the relevant sections in the documentation.