[Bf-docboard-svn] bf-manual: [9401] trunk/blender_docs/manual/interface: Improve "Tools & Operators" section
Aaron Carlisle
noreply at blender.org
Sun Jul 10 03:19:01 CEST 2022
Revision: 9401
https://developer.blender.org/rBM9401
Author: Blendify
Date: 2022-07-10 03:19:01 +0200 (Sun, 10 Jul 2022)
Log Message:
-----------
Improve "Tools & Operators" section
Grammar fixes and clarifications for the section "User Interface" -> "Tools & Operators".
Author: @arc_
https://developer.blender.org/D15315
Modified Paths:
--------------
trunk/blender_docs/manual/interface/annotate_tool.rst
trunk/blender_docs/manual/interface/operators.rst
trunk/blender_docs/manual/interface/selecting.rst
trunk/blender_docs/manual/interface/tool_system.rst
trunk/blender_docs/manual/interface/undo_redo.rst
Modified: trunk/blender_docs/manual/interface/annotate_tool.rst
===================================================================
--- trunk/blender_docs/manual/interface/annotate_tool.rst 2022-07-08 14:05:54 UTC (rev 9400)
+++ trunk/blender_docs/manual/interface/annotate_tool.rst 2022-07-10 01:19:01 UTC (rev 9401)
@@ -5,6 +5,7 @@
The annotation tool is available in multiple editors.
It can be used to add notes to e.g. 3D objects or node setups.
+The arrow in the screenshot below is an annotation.
.. figure:: /images/interface_annotate-tool_node-editor.png
:align: center
@@ -17,7 +18,7 @@
Annotation Tools
================
-The annotation tool can be activated in the Toolbar and has following sub-tools:
+The annotation tool can be activated in the Toolbar and has the following sub-tools:
.. _tool-annotate-freehand:
@@ -33,8 +34,8 @@
.. _tool-annotate-polygon:
Annotate Polygon
- Click multiple times to create multiple connected lines.
- The current polygon is finished when :kbd:`Esc` is pressed.
+ Click multiple times to create multiple connected lines, then press :kbd:`RMB`,
+ :kbd:`Return` or :kbd:`Esc` to confirm.
.. _tool-annotate-eraser:
@@ -62,17 +63,20 @@
Determines where the annotations are drawn.
:3D Cursor:
- Draw annotations on an imaginary plane that goes through
- the :doc:`/editors/3dview/3d_cursor` and is aligned to your view.
- :View:
- Draw annotations in screen space rather than 3D space;
- meaning the annotations will stay on the same position in the screen,
- even when the view moves or rotates.
+ Only available in the 3D Viewport. The new annotations become part of the 3D scene;
+ they're drawn on an imaginary plane that goes through the :doc:`/editors/3dview/3d_cursor`
+ and is aligned to your view.
:Surface:
- Draw annotations on the surface of the object under the mouse.
+ Only available in the 3D Viewport. The new annotations become part of the 3D scene;
+ they're drawn onto the surface of the object under the mouse. If there is no surface,
+ you get the same behavior as *3D Cursor*.
:Image:
- Draw annotations in same space as the image/preview/nodes meaning as you zoom
- in or out the annotations stay the same size relative to the zoom factor.
+ Only available in 2D editors such as the :doc:`Image Editor </editors/image/introduction>`.
+ The annotations become part of the 2D space, meaning their position and size change as you
+ pan and zoom in the editor.
+ :View:
+ The new annotations are 2D and get stuck to the screen. They keep the same position,
+ rotation and size no matter how you pan, orbit or zoom in the editor.
Stabilize Stroke
Helps to reduce jitter of the strokes while drawing by delaying and correcting the location of points.
Modified: trunk/blender_docs/manual/interface/operators.rst
===================================================================
--- trunk/blender_docs/manual/interface/operators.rst 2022-07-08 14:05:54 UTC (rev 9400)
+++ trunk/blender_docs/manual/interface/operators.rst 2022-07-10 01:19:01 UTC (rev 9401)
@@ -3,9 +3,9 @@
Operators
*********
-Operators execute an action as soon as the operator is started
-which make them different from tools which require some sort of input.
-Operators can be started from a :ref:`ui-operator-buttons`,
+Operators execute an action the moment they're activated,
+which makes them different from tools (which require some sort of input).
+Operators can be started from :ref:`ui-operator-buttons`,
:ref:`ui-header-menu`, or :ref:`bpy.ops.wm.search_menu`.
Examples of operators include adding a new object,
deleting it, or setting its shading to smooth.
@@ -14,29 +14,27 @@
Operator Properties
===================
-Most operators have properties that can be adjusted to refine the result of the operation.
-To adjust an operators properties, the operator must first be executed.
-This will execute the operation with its default property values.
-These properties can then be adjusted using :ref:`bpy.ops.screen.redo_last`.
+Most operators have properties that can be adjusted to refine their result.
+First run the operator (which will use its default settings),
+then adjust the properties in the :ref:`bpy.ops.screen.redo_last` region.
Modal Operators
===============
-Modal operators exist as concept in between :doc:`Tools </interface/tool_system>`
-and regular described above operators.
-They require some sort of input to interactively control the operator's properties.
+Modal operators exist as a concept in between :doc:`Tools </interface/tool_system>`
+and regular operators.
+They require some sort of interactive input.
Slider Operators
----------------
-Slider operators are a type of modal operator used interactively adjust a factor property.
-Slider operators will display a percentage graphic in the editor's :ref:`ui-region-header`.
-Slider operators can adjust the operator's factor value by moving
-the mouse left or right to decrease or increase the factor property.
+Slider operators are used to interactively adjust a percentage value
+in the editor's :ref:`ui-region-header`.
-Values can be snapped to 10% increments by holding :kbd:`Ctrl`
-and changed using precision by holding :kbd:`Shift`.
-Values can extend beyond the 0-100% range by toggling "overshoot" on with :kbd:`E`.
-Note, overshoot is not be available for all slider operators.
+You can adjust the percentage by dragging the slider left or right.
+This can be made coarser (snapping in 10% increments) by holding :kbd:`Ctrl`
+and more precise by holding :kbd:`Shift`.
+For some sliders, you can toggle "overshoot" with :kbd:`E`, which lets
+you go beyond the 0-100% range.
Modified: trunk/blender_docs/manual/interface/selecting.rst
===================================================================
--- trunk/blender_docs/manual/interface/selecting.rst 2022-07-08 14:05:54 UTC (rev 9400)
+++ trunk/blender_docs/manual/interface/selecting.rst 2022-07-10 01:19:01 UTC (rev 9401)
@@ -11,8 +11,8 @@
.. note::
Some editors deviate from the keyboard shortcuts shown below. For example, most editors
- use :kbd:`Shift` to add a single item to the selection, but the
- :doc:`Outliner </editors/outliner/introduction>` uses :kbd:`Ctrl`.
+ use :kbd:`Shift-LMB` to add a single item to the selection, but the
+ :doc:`Outliner </editors/outliner/introduction>` uses :kbd:`Ctrl-LMB`.
Similarly, most editors use :kbd:`Ctrl-RMB` for performing a *Lasso Select*,
but :doc:`node editors </interface/controls/nodes/introduction>` use :kbd:`Ctrl-Alt-LMB`.
@@ -106,7 +106,7 @@
Holding :kbd:`Ctrl` will remove them.
You can change the radius of the circle in the tool settings (which can be found
-in the area header, in the Tool tab of the Sidebar :kbd:`N`, or in the Active Tool tab
+in the area header, the Tool tab of the Sidebar :kbd:`N`, or the Active Tool tab
of the :doc:`Properties editor </editors/properties_editor>`).
.. note::
Modified: trunk/blender_docs/manual/interface/tool_system.rst
===================================================================
--- trunk/blender_docs/manual/interface/tool_system.rst 2022-07-08 14:05:54 UTC (rev 9400)
+++ trunk/blender_docs/manual/interface/tool_system.rst 2022-07-10 01:19:01 UTC (rev 9401)
@@ -7,15 +7,19 @@
Tools are accessed from the :ref:`Toolbar <ui-region-toolbar>`.
-This is a general introduction to tools, individual tools have their own documentation.
+This is a general introduction to tools. Individual tools have their own documentation.
-There can only be one active tool which is stored for each space & mode.
+There can only be one active tool per :doc:`Workspace </interface/window_system/workspaces>`
+and :doc:`mode </editors/3dview/modes>`.
+This tool is remembered: if you're in Edit Mode and have the Extrude tool selected,
+then switch to Object Mode (which has no Extrude tool) and back to Edit Mode,
+the Extrude tool will still be active.
-Tools may set their own keys which override other keys
-although typically they use the :kbd:`LMB`, sometimes with modifier keys.
-*Keymaps can be edited from the preferences.*
+Most tools are controlled using just :kbd:`LMB`, though some also have modifier keys
+(shown in the :doc:`Status Bar </interface/window_system/status_bar>` while using the tool).
+This can all be customized in the :doc:`Keymap Preferences </editors/preferences/keymap>`.
-Some tools define gizmos (*Shear* and *Spin* for example) to help control the tool.
+Some tools define gizmos (*Shear* and *Spin* for example) to help control them.
.. _ui-region-toolbar:
@@ -30,11 +34,12 @@
.. figure:: /images/interface_tool-system_buttons-popup.png
:align: right
- Button with pop-up menu indicator.
+ Expanded tool group.
-The Toolbar shows buttons for each tool.
-For tool buttons which have a small triangle in their bottom right corner, a pop-up menu will be revealed
-when you :kbd:`LMB` drag so that you can select other tools of the same group.
+The Toolbar contains buttons for the various tools.
+Buttons with a small triangle in their bottom right corner are tool groups
+which can be opened by holding :kbd:`LMB` on them for a moment
+(or dragging :kbd:`LMB` to open them instantly).
Hovering your cursor over a tool for a short time will show its name,
while hovering longer will show the full tooltip.
@@ -50,16 +55,15 @@
:Shortcut: :kbd:`Shift-Spacebar`
-You can switch tools with a toolbar that will pop up at the location of your cursor
-after pressing :kbd:`Shift-Spacebar`.
+Pressing :kbd:`Shift-Spacebar` will pop up a small toolbar right at
+your cursor for faster access.
The shortcuts for selecting the tools are displayed on the right.
-Alternatively, you can map this action to :kbd:`Spacebar` in the Preferences.
-Then you'll be able use :kbd:`Spacebar`
-like a modifier key (similar to pressing :kbd:`Ctrl` or :kbd:`Shift`).
-
-:kbd:`Spacebar T` for Transform, :kbd:`Spacebar D` for Annotate,
-:kbd:`Spacebar M` for measure, etc.
+Alternatively, you can map this action to :kbd:`Spacebar` in the Keymap Preferences.
+Then you'll be able use :kbd:`Spacebar` like a modifier key
+(similar to holding :kbd:`Ctrl` or :kbd:`Shift`).
+For example, you can press :kbd:`Spacebar T` for Transform,
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-docboard-svn
mailing list