[Bf-docboard-svn] bf-manual: [9379] trunk/blender_docs/manual/interface/controls: Improve "Interface Controls" section

Aaron Carlisle noreply at blender.org
Mon Jun 27 16:01:15 CEST 2022 

Revision: 9379
          https://developer.blender.org/rBM9379
Author:   Blendify
Date:     2022-06-27 16:01:15 +0200 (Mon, 27 Jun 2022)
Log Message:
-----------
Improve "Interface Controls" section

Adjustments to the "Interface Controls" section for conciseness,
clarity, and sometimes also grammar and correctness.

Author: @arc_

Differential Revision: https://developer.blender.org/D15279

Modified Paths:
--------------
    trunk/blender_docs/manual/interface/controls/buttons/buttons.rst
    trunk/blender_docs/manual/interface/controls/buttons/decorators.rst
    trunk/blender_docs/manual/interface/controls/buttons/eyedropper.rst
    trunk/blender_docs/manual/interface/controls/buttons/fields.rst
    trunk/blender_docs/manual/interface/controls/buttons/menus.rst
    trunk/blender_docs/manual/interface/controls/nodes/arranging.rst
    trunk/blender_docs/manual/interface/controls/nodes/editing.rst
    trunk/blender_docs/manual/interface/controls/nodes/groups.rst
    trunk/blender_docs/manual/interface/controls/nodes/introduction.rst
    trunk/blender_docs/manual/interface/controls/nodes/parts.rst
    trunk/blender_docs/manual/interface/controls/nodes/selecting.rst
    trunk/blender_docs/manual/interface/controls/nodes/sidebar.rst
    trunk/blender_docs/manual/interface/controls/templates/color_picker.rst
    trunk/blender_docs/manual/interface/controls/templates/color_ramp.rst
    trunk/blender_docs/manual/interface/controls/templates/curve.rst
    trunk/blender_docs/manual/interface/controls/templates/data_block.rst
    trunk/blender_docs/manual/interface/controls/templates/list_view.rst
    trunk/blender_docs/manual/interface/controls/templates/operator_search.rst

Modified: trunk/blender_docs/manual/interface/controls/buttons/buttons.rst
===================================================================
--- trunk/blender_docs/manual/interface/controls/buttons/buttons.rst	2022-06-24 13:48:47 UTC (rev 9378)
+++ trunk/blender_docs/manual/interface/controls/buttons/buttons.rst	2022-06-27 14:01:15 UTC (rev 9379)
@@ -55,14 +55,14 @@
    Radio buttons.
 
 Radio buttons are used to choose one option from a selection of options.
-Active button is indicated by a color on the icon background.
+The active button is indicated by a colored background.
 
 
 Cycling
 -------
 
-Use :kbd:`Ctrl-Wheel`, while hovering with the mouse over radio
-buttons, to cycle between the options.
+Use :kbd:`Ctrl-Wheel` while hovering the mouse over radio
+buttons to cycle between the options.
 
 
 .. _ui-direction-button:

Modified: trunk/blender_docs/manual/interface/controls/buttons/decorators.rst
===================================================================
--- trunk/blender_docs/manual/interface/controls/buttons/decorators.rst	2022-06-24 13:48:47 UTC (rev 9378)
+++ trunk/blender_docs/manual/interface/controls/buttons/decorators.rst	2022-06-27 14:01:15 UTC (rev 9379)
@@ -16,12 +16,12 @@
 Clicking the rhombus icon again will remove the keyframe.
 A solid rhombus icon indicates there is a keyframe on the current frame,
 while a non-solid rhombus icon indicates that the property has a keyframe on another frame.
-Clicking the non-solid rhombus icon will add a keyframe to the current property value and frame.
+Clicking the non-solid rhombus icon will create a keyframe on the current frame with the current property value.
 
 If a property is being :doc:`driven </animation/drivers/index>`
-by another property then the decorator shows the driver icon.
+by another, the decorator shows the driver icon.
 
-Decorators make it quick and easy to glance over properties and see the state of the property.
+Decorators make it quick and easy to glance over properties and see their state.
 
 .. seealso::
 

Modified: trunk/blender_docs/manual/interface/controls/buttons/eyedropper.rst
===================================================================
--- trunk/blender_docs/manual/interface/controls/buttons/eyedropper.rst	2022-06-24 13:48:47 UTC (rev 9378)
+++ trunk/blender_docs/manual/interface/controls/buttons/eyedropper.rst	2022-06-27 14:01:15 UTC (rev 9379)
@@ -8,7 +8,7 @@
 The eyedropper can be used to select different kinds of data:
 
 Color
-   This is the most common usage, the eyedropper is used to sample a pixels color from anywhere within Blender.
+   This is the most common usage. The eyedropper is used to sample a pixel's color from anywhere within Blender.
 
    .. note::
 
@@ -21,7 +21,7 @@
 
 Objects/Object-Data
    This is used with object buttons (such as parent, constraints or modifiers) to
-   select an object from the 3D Viewport or Outliner.
+   select an object from the 3D Viewport or Outliner, rather than having to select it from a dropdown.
 
 Camera Depth
    Number fields effecting distance can also use the eyedropper.

Modified: trunk/blender_docs/manual/interface/controls/buttons/fields.rst
===================================================================
--- trunk/blender_docs/manual/interface/controls/buttons/fields.rst	2022-06-24 13:48:47 UTC (rev 9378)
+++ trunk/blender_docs/manual/interface/controls/buttons/fields.rst	2022-06-27 14:01:15 UTC (rev 9379)
@@ -64,7 +64,7 @@
    Multi-value editing.
 
 You can edit multiple number fields at once by pressing down
-:kbd:`LMB` on the first field, and then drag vertically over
+:kbd:`LMB` on the first field, and then dragging vertically over
 the fields you want to edit. Finally you can either drag left or right to
 adjust value with the mouse, or release the :kbd:`LMB` and type in a value.
 
@@ -103,8 +103,8 @@
 Instead of evaluating the value and discarding the expression,
 a driver is added to the property with the expression entered.
 
-The expression ``#frame`` is a quick way to access map a value to the current frame,
-but more complex expressions are also supported, ``#fmod(frame, 24) / 24`` for example.
+The expression ``#frame`` is a quick way to map a value to the current frame,
+but more complex expressions like ``#fmod(frame, 24) / 24`` are also supported.
 
 This is simply a convenient shortcut to add drivers which can also be added via the :kbd:`RMB` menu.
 
@@ -146,8 +146,10 @@
 
    Color fields. With and without alpha.
 
-The color field stores a color value shown in its background.
-Clicking :kbd:`LMB` on color fields opens the :doc:`/interface/controls/templates/color_picker`.
-Color fields with an alpha channel are divided in half: on the left the color is shown without an alpha channel and
-on the right the color with an alpha channel shown over a checker pattern.
-Colors can be copied to other color fields by being dragged and dropped to another color field.
+The color field stores a color value.
+Clicking on it with :kbd:`LMB` opens the :doc:`/interface/controls/templates/color_picker`.
+
+Color fields with an alpha channel are divided in half: on the left, the color is shown without an alpha channel,
+and on the right, it's shown with an alpha channel over a checker pattern.
+
+Colors can be copied to other color fields by dragging and dropping.

Modified: trunk/blender_docs/manual/interface/controls/buttons/menus.rst
===================================================================
--- trunk/blender_docs/manual/interface/controls/buttons/menus.rst	2022-06-24 13:48:47 UTC (rev 9378)
+++ trunk/blender_docs/manual/interface/controls/buttons/menus.rst	2022-06-27 14:01:15 UTC (rev 9379)
@@ -5,7 +5,7 @@
 *****
 
 Blender uses a variety of different menus for accessing options and :doc:`/interface/operators`.
-Selecting menus can be interacted with in the following ways:
+Menus can be interacted with in the following ways:
 
 Mouse selection
    :kbd:`LMB` on the desired item.
@@ -13,9 +13,9 @@
    You can use the number keys or numpad to input an item in the list to select.
    For example, :kbd:`Numpad1` will select the first item and so on.
 
-If the menu content is too large to fit on the screen, small menu
-scrolling indicator triangle appears on bottom or top of menu.
-Scrolling is done by moving the mouse below or above the scrolling indicator.
+If a menu is too large to fit on the screen, a small
+scrolling triangle appears on the top or bottom.
+Scrolling is done by moving the mouse above or below this triangle.
 
 
 .. rubric:: Shortcuts
@@ -23,12 +23,13 @@
 - Use :kbd:`Wheel` while hovering with the mouse.
 - Arrow keys can be used to navigate.
 - Each menu item has an underlined character which can be pressed to activate it.
-- Number keys or numpad can be used to access menu items.
-  (Where :kbd:`1` is the first menu item, :kbd:`2` the second, etc.
-  For larger menus :kbd:`Alt-1` the 11th... up to :kbd:`Alt-0` the 20th.)
+- Number keys or numpad can also be used to activate menu items.
+  (:kbd:`1` for the first menu item, :kbd:`2` for the second etc.
+  For larger menus, :kbd:`Alt-1` activates the 11th and so on, up to :kbd:`Alt-0` for the 20th.)
 - Press :kbd:`Return` to activate the selected menu item.
-- Press :kbd:`Esc` to cancel the menu, or move the mouse cursor far from the pop-up,
-  or by :kbd:`LMB` clicking anywhere out of it.
+- Press :kbd:`Esc` to close the menu without activating any menu item. This can also be
+  done by moving the mouse cursor far away from the menu, or by :kbd:`LMB` clicking anywhere
+  outside of it.
 
 
 .. _bpy.types.UIPopupMenu:
@@ -51,7 +52,7 @@
 ----------------
 
 Sometimes it's helpful to gain some extra horizontal space in the header by collapsing menus.
-This can be accessed from the header context menu,
+This can be accessed from the header context menu:
 click :kbd:`RMB` on the header and select *Collapse Menus*.
 
 .. list-table::
@@ -74,11 +75,11 @@
 
    The 3D Viewport Mode Select menu.
 
-The Select menu (short selector) lets you choose between a set of options.
-Select menu appears as an icon and/or text with down arrow on the right side of the button.
-The menu options are shown with :kbd:`LMB` click on the button.
-The selected option is then shown as active on the menu button.
-You can also use :kbd:`Ctrl-Wheel` to cycle through options without opening the menu.
+A Select menu (or "selector" for short) lets you choose between a set of options.
+It appears as an icon and/or text with a down arrow on the right side.
+To use it, click the button with :kbd:`LMB` to show the available options,
+then click the desired option (once selected, it'll appear inside the button).
+You can also use :kbd:`Ctrl-Wheel` to cycle through the options without opening the menu.
 
 .. container:: lead
 
@@ -93,31 +94,28 @@
 .. figure:: /images/interface_controls_buttons_menus_popup-menu.png
    :align: right
 
-   The Transform Orientations pop-up menu.
+   The Transform Orientations popover menu.
 
-Popover menus are overlays.
-Like Select Menus, pop-up menus also include down arrow on the right
-side of menu button. However, pop-up menus allow more content to be shown,
-such as title, list options, buttons, sliders, etc.
-Popover menus group controls into a menu, which is automatically hidden
-when mouse pointer leaves menu boundaries (including a margin).
+Popover menus are similar to Select Menus, but can show more varied content
+such as a title, buttons, sliders, etc.
 
 
 Context Menu
 ============
 
-Context menus are pop-ups opened with the :kbd:`Menu` key for editors and :kbd:`RMB` for properties.
-Context menu contents depend on the location of the mouse pointer.
+Context menus are pop-ups that can be opened with :kbd:`RMB`.
+In most editors, it's also possible to use the :kbd:`Menu` key.
+The contents of the menu depend on the location of the mouse pointer.
 
-When invoked in an editor the menu contains a list of operators sensitive to the editor's mode.
-Or when invoked over buttons and properties common options include:
+When invoked in an editor, the menu contains a list of operators sensitive to the editor's mode.
+When invoked over buttons and properties, common options include:
 
 .. for the property associated with the control.
 
 Single
-   Set or get single value.
+   Apply the change to a single value of a set (e.g. only the X coordinate of an object's Location).
 All

@@ Diff output truncated at 10240 characters. @@

More information about the Bf-docboard-svn mailing list