Merge pull request #3576 from smoe/docs_fixes_20250812

Presumed final translation-associated weirdnesses (smoe:docs_fixes_20250812)

Author: andypugh

docs/src/config/core-components.adoc

@@ -95,8 +95,7 @@ unlock_joints_mask=0x38 selects joints 3,4,5
 [[sec:motion-pins]]
 === Pins(((motion:HAL pins)))
 
-These pins, parameters, and functions are created by the realtime 'motmod'
-module.
+These pins, parameters, and functions are created by the realtime 'motmod' module.
 
 * 'motion.adaptive-feed' - (float, in) When adaptive feed is enabled with 'M52 P1' , the
   commanded velocity is multiplied by this value. This effect is
@@ -109,13 +108,10 @@ module.
   controlled by M67 or M68.
 * 'motion.coord-error' - (bit, out) TRUE when motion has encountered an error, such as
   exceeding a soft limit
-* 'motion.coord-mode' - (bit, out) TRUE when motion is in 'coordinated mode', as opposed to
-  'teleop mode'
+* 'motion.coord-mode' - (bit, out) TRUE when motion is in 'coordinated mode', as opposed to 'teleop mode'
 * 'motion.current-vel' - (float, out) The current tool velocity in user units per second.
-* 'motion.digital-in-00' - (bit, in) These pins (00, 01, 02, 03 or more if configured) are
-  controlled by M62-65.
-* 'motion.digital-out-00' - (bit, out) These pins (00, 01, 02, 03 or more if configured) are
-  controlled by the 'M62-65'.
+* 'motion.digital-in-00' - (bit, in) These pins (00, 01, 02, 03 or more if configured) are controlled by M62-65.
+* 'motion.digital-out-00' - (bit, out) These pins (00, 01, 02, 03 or more if configured) are controlled by the 'M62-65'.
 * 'motion.distance-to-go' - (float,out) The distance remaining in the current move.
 * 'motion.enable' - (bit, in) If this bit is driven FALSE, motion stops, the machine is
   placed in the 'machine off' state, and a message is displayed for the
@@ -147,32 +143,18 @@ module.
 * 'motion.teleop-mode' - (bit, out) TRUE when motion is in 'teleop mode', as opposed to 'coordinated mode'
 * 'motion.tooloffset.x ... motion.tooloffset.w' - (float, out, one per axis) shows the tool offset in effect;
   it could come from the tool table ('G43' active), or it could come from the G-code ('G43.1' active)
-
-* 'motion.on-soft-limit' -
-  (bit, out) TRUE when the machine is on a soft limit.
-* 'motion.probe-input' -
-  (bit, in) 'G38.n'  uses the value on this pin to determine when the
-  probe has made contact.
+* 'motion.on-soft-limit' - (bit, out) TRUE when the machine is on a soft limit.
+* 'motion.probe-input' - (bit, in) 'G38.n'  uses the value on this pin to determine when the probe has made contact.
   TRUE for probe contact closed (touching),
   FALSE for probe contact open.
-* 'motion.program-line' -
-  (s32, out) The current program line while executing. Zero if not
-  running or between lines while single stepping.
-* 'motion.requested-vel' -
-  (float, out) The current requested velocity in user units per
-  second.  This value is the F-word setting from the G-code file,
-  possibly reduced to accommodate machine velocity and acceleration
-  limits. The value on this pin does not reflect the feed override or
-  any other adjustments.
-
-* 'motion.teleop-mode' -
-  (bit, out) TRUE when motion is in 'teleop mode', as opposed to
-  'coordinated mode'
-
-* 'motion.tooloffset.x ... motion.tooloffset.w' -
-  (float, out, one per axis) shows the tool offset in effect;
-  it could come from the tool table ('G43' active), or it could
-  come from the G-code ('G43.1' active)
+* 'motion.program-line' - (s32, out) The current program line while executing.
+  Zero if not running or between lines while single stepping.
+* 'motion.requested-vel' - (float, out) The current requested velocity in user units per second.
+  This value is the F-word setting from the G-code file, possibly reduced to accommodate machine velocity and acceleration limits.
+  The value on this pin does not reflect the feed override or any other adjustments.
+* 'motion.teleop-mode' - (bit, out) TRUE when motion is in 'teleop mode', as opposed to 'coordinated mode'
+* 'motion.tooloffset.x ... motion.tooloffset.w' - (float, out, one per axis) shows the tool offset in effect;
+  it could come from the tool table ('G43' active), or it could come from the G-code ('G43.1' active)
 
 === Parameters
 
@@ -191,10 +173,9 @@ change or removal at any time.
 * 'motion.debug-float-3' - (float, RO) This is used for debugging purposes.
 * 'motion.debug-s32-0' - (s32, RO) This is used for debugging purposes.
 * 'motion.debug-s32-1' - (s32, RO) This is used for debugging purposes.
-* 'motion.servo.last-period' - (u32, RO) The number of CPU cycles between invocations of the servo
-  thread. Typically, this number divided by the CPU speed gives the time
-  in seconds, and can be used to determine whether the realtime motion
-  controller is meeting its timing constraints
+* 'motion.servo.last-period' - (u32, RO) The number of CPU cycles between invocations of the servo thread.
+  Typically, this number divided by the CPU speed gives the time in seconds,
+  and can be used to determine whether the realtime motion controller is meeting its timing constraints
 * 'motion.servo.last-period-ns' - (float, RO)
 
 === Functions
@@ -316,7 +297,7 @@ See the motion man page 'motion(9)' for details on the pins and parameters.
 
 == iocontrol
 
-iocontrol - accepts non-realtime I/O commands via NML, interacts with HAL .
+iocontrol - accepts non-realtime I/O commands via NML, interacts with HAL.
 
 iocontrol's HAL pins are turned on and off in non-realtime context.  If you have strict timing requirements or simply need more I/O, consider using the realtime synchronized I/O provided by <<sec:motion,motion>> instead.
 

docs/src/config/python-interface.adoc

@@ -321,7 +321,8 @@ see <<python:reading-ini-values,ReadingINI file values>> for an example.
 *settings*:: '(returns tuple of floats)' -
   current interpreter settings: +
   settings[0] = sequence number, +
-  settings[1] = feed rate, settings[2] = speed, +
+  settings[1] = feed rate, +
+  settings[2] = speed, +
   settings[3] = `G64 P` blend tolerance, +
   settings[4] = `G64 Q` naive CAM tolerance.
 

docs/src/gcode/coordinates.adoc

@@ -148,7 +148,7 @@ command would not have been modal and any commands issued after it would
 have returned to using the G55 offsets because that coordinate system
 would still be in effect.
 
-[source,{ngc}]
+[source,{ngc}](((G54)))(((G55)))(((G56)))(((G57)))(((G58)))(((G59)))(((G59.1)))(((G59.2)))(((G59.3)))
 ----
 G54	uses parameters of coordinate system 1
 G55	uses parameters of coordinate system 2

docs/src/gui/gui-dev-reference.adoc

@@ -12,18 +12,17 @@
 :css: {basebackend@docbook:'':css}
 
 This document attempts to be a 'best practices' reference for general use screen development. +
-While it's possible to program just about anything to work with linuxcnc, using common frame work,
- language and configuration requirements allows easier transition between screens and more developers 
-to maintain them. +
+While it is possible to program just about anything to work with LinuxCNC, using a common frame work,
+language and configuration requirements allows easier transition between screens and more developers to maintain them. +
 That said, nothing in this document is written in stone.
 
 == Language
-Python is currently the preferred language of linuxcnc's screen code. +
+Python is currently the preferred language of LinuxCNC's screen code. +
 Python has a low entry bar for new users to modify the screens to suit them. +
-Python has a rich array of documentation, tutorials and libraries to pull from. + 
-It is already used and integrated into linuxcnc's system requirements. +
+Python has a rich array of documentation, tutorials and libraries to pull from. +
+It is already used and integrated into LinuxCNC's system requirements. +
 While C or C\++ could be used, it severely limits who can maintain and develop them. +
-It would be better to extend python with C/C++ modules for whatever function that requires it.
+It would be better to extend Python with C/C++ modules for whatever function that requires it.
 
 == Localization of float numbers in GUIs
 Different locales use different decimal separators and thousands separators. Locale-specific
@@ -37,16 +36,16 @@ are suggested if parsing float to string and vice-versa:
 
 == Basic Configuration
 Currently, most screens use a combination of INI file and preference file entries to configure their functions. +
-INi text files are usually used for the common machine controller settings, while text based preference files 
+INI text files are usually used for the common machine controller settings, while text based preference files
 are used for more GUI related properties (such as sounds, size, colors). +
-There can be other files used for translations, stylizing and function customization. These are highly dependent 
+There can be other files used for translations, stylizing and function customization. These are highly dependent
 on the underlying widget toolkit.
 
 === INI [DISPLAY]
 The *[DISPLAY]* section of the INI is for specifying screen related settings. +
 
 ==== Display
-The most important of is specifying the name of the screen that the linuxcnc script will use to load. +
+The most important of is specifying the name of the screen that the LinuxCNC script will use to load. +
 The screen program usually recognizes switches such as to set full screen. +
 Title is for the window title and icon is used for iconizing the window.
 
@@ -93,7 +92,7 @@ ANGULAR_INCREMENTS = continuous, .5, 1, 45, 90, 360
 ----
 
 ==== Machine Type Hint
-The screen often needs to be adjusted based on machine type. Lathes have different controls and display DROs 
+The screen often needs to be adjusted based on machine type. Lathes have different controls and display DROs
 differently. Foam machine display the plot differently. +
 The old way to do this was adding switches LATHE = 1, FOAM = 1 etc
 
@@ -124,15 +123,15 @@ DEFAULT_LINEAR_VELOCITY =
 MIN_LINEAR_VELOCITY =
 MAX_LINEAR_VELOCITY =
 
-DEFAULT_ANGULAR_VELOCITY = 
-MIN_ANGULAR_VELOCITY = 
-MAX_ANGULAR_VELOCITY = 
+DEFAULT_ANGULAR_VELOCITY =
+MIN_ANGULAR_VELOCITY =
+MAX_ANGULAR_VELOCITY =
 ----
 
 ==== Spindle Manual Controls
 Manual controls for spindle control could be, (or a combinations of) buttons, sliders or dials +
 You can set limits that are less then the what the machine controller can utilize by setting these entries. +
-If your screen is capable of running multiple spindles, then should accept entries higher then the shown '_0_'
+If your screen is capable of running multiple spindles, then should accept entries higher then the shown '_0_'.
 
 [source,{ini}]
 ----
@@ -156,8 +155,8 @@ MDI_COMMAND_MACRO1 = G53 G0 Z0;G53 G0 X0 Y0,Goto\nMachn\nZero
 ----
 
 === INI [FILTER]
-This section allows setting of what files are shown in the file chooser and 
-what filter programs will preprocess its output before sending it to linuxcnc. +
+This section allows setting of what files are shown in the file chooser and
+what filter programs will preprocess its output before sending it to LinuxCNC. +
 The extensions follow this pattern: +
 PROGRAM_EXTENSION = .extension,.extension2[space]Description of extensions +
 The filter program definitions are such: +
@@ -179,7 +178,7 @@ py = python3
 ----
 
 === INI [HAL]
-Most screens will need some HAL pins. They need to be connected after the screen creates them.+
+Most screens will need some HAL pins. They need to be connected after the screen creates them.
 
 ==== Postgui Halfile
 These files should be run one after another in order, after all the GUI HAL pins have been made.
@@ -204,8 +203,8 @@ POSTGUI_HALCMD = loadusr halmeter
 == Extended Configuration
 
 === Embedding GUI Elements
-Allowing users to build small panels independently, that can be embedded into the main screen 
-is a common and very useful customization. Some screens allow embedding of 3rd party foreign programs, 
+Allowing users to build small panels independently, that can be embedded into the main screen
+is a common and very useful customization. Some screens allow embedding of 3rd party foreign programs,
 others only the native widget toolkit based panels. +
 Usually these are embedded in tabs or side panel widgets. +
 This is how to describe the optional title, loading command and location widget name: +
@@ -233,7 +232,7 @@ MESSAGE_ICON = INFO
 ----
 
 This style gives multiple messages defined by a number. +
-This example shows 3 possible messages based around a VFD error nuumber.
+This example shows 3 possible messages based around a VFD error number.
 
 [source,{ini}]
 ----

docs/src/gui/qtvcp-libraries.adoc

@@ -652,7 +652,7 @@ as the widgets get a reference to the `MainWindow` from the `_hal_init()` functi
 from qtvcp.qt_makegui import VCPWindow
 ----
 
-* *Instantiate `VCPWindow` module*+
+* *Instantiate `VCPWindow` module* +
   Add this Python code to your instantiate section:
 +
 [source,python]

docs/src/gui/qtvcp-vismach.adoc

@@ -309,7 +309,7 @@ Either by adding the component object as the first variable and substituting the
 by substituting the full component/pinname string for a coordinate. +
 
 This example creates a _rectangular prism with opposite corners_ at the specified positions and edges parallel to the XYZ axes. +
-the Z start coordinate will be controlled by the HAL pin 'Zstart'
+The Z start coordinate will be controlled by the HAL pin 'Zstart'.
 
 [source,python]
 ----
@@ -409,7 +409,7 @@ Sets the _display color of the part based on a designated HAL bit pin state_. +
   `hal_comp`;; The _HAL component Object_ or None. +
     In QtVCP if you are reading _system pins_ directly, then the component argument is set to `None`. +
   `hal_pin`;; The _name of the BIT HAL IN pin_ that will change the color. +
-    if hal_comp is 'None' then this must be the full name of a system pin other wise this is the pin name excluding the component name
+    if hal_comp is 'None' then this must be the full name of a system pin other wise this is the pin name excluding the component name.
 
 === HALColorRGB
 Sets the _display color of the part based on a designated HAL U32 pin value_. +
@@ -424,7 +424,7 @@ combined as 0xXXBBGGRR +
   `hal_comp`;; The _HAL component Object_ or None. +
     In QtVCP if you are reading _system pins_ directly, then the component argument is set to `None`. +
   `hal_pin`;; The _name of the U32 HAL IN pin_ that will change the color. +
-    if hal_comp is 'None' then this must be the full name of a system pin other wise this is the pin name excluding the component name +
+    if hal_comp is 'None' then this must be the full name of a system pin other wise this is the pin name excluding the component name. +
   `alpha=`;; Sets the opacity. (0-1.0)
 
 === Heads Up Display
@@ -477,11 +477,10 @@ chuckassembly = HideCollection([chuckassembly],comp,'hide-chuck')
 chuckassembly = HideCollection([chuckassembly],None,'myvismach.hide-chuck') 
 ----
 
-=== Plot Color Based on Mtotion Type
-If you wish to plot different colors for different motions you need to add some more python code. +
+=== Plot Color Based on Motion Type
+If you wish to plot different colors for different motions you need to add some more Python code.
 
-
-add this at the top of the file:
+Add this at the top of the file:
 
 [source,python]
 ----
@@ -499,7 +498,8 @@ and this to the Window class:
         #v.setColorsAttribute('FEED',(0,1,0))
         #print(v.colors)
 ----
-You can set DEFAULT, FEED, TRAVERSE, ARC, PROBE, ROTARYINDEX, TOOLCHANGE colors with setColorsAttribute()
+
+You can set DEFAULT, FEED, TRAVERSE, ARC, PROBE, ROTARYINDEX, TOOLCHANGE colors with setColorsAttribute().
 
 === Capture
 This sets the current position in the model.
@@ -603,7 +603,7 @@ class Window(QWidget):
 
         # uncomment to change feed color
         #v.setColorsAttribute('FEED',(0,1,0))
-        #  and to see all colors printed to the terminal
+        # and to see all colors printed to the terminal
         #print(v.colors)
 
         v.model = Collection([model, world])

docs/src/gui/qtvcp-widgets.adoc

@@ -457,7 +457,7 @@ Allows one to *adjust a HAL pin value using a sliding pointer*.
 
 [[sub:qtvcp:widgets:tabwidget]]
 === `TabWidget` - Tab Widget
-This widget allows the tab height to be adjusted with stylesheets
+This widget allows the tab height to be adjusted with stylesheets.
 
 The `TabWidget` properties can be defined in a _stylesheet_ with the following code added to the `.qss` file. +
 `name_of_tab` being the widget name defined in Qt Designer's editor. +
@@ -719,22 +719,22 @@ usually this is selected from the screenOptions widget.
 *`halpin_option`*::
   Will set a HAL pin true when the axis is selected.
 *`joint_number`*::
-  Should be set to the appropriate joint number
+  Should be set to the appropriate joint number.
 *`axis_letter`*::
-  Should be set to the appropriate axis letter
+  Should be set to the appropriate axis letter.
 
 These are the click-and-hold menu properties: +
 
 *`showLast`*::
-  show the 'Set to last' action
+  Show the 'Set to last' action.
 *`showDivide`*::
-  show the 'Divide by 2' action
+  Show the 'Divide by 2' action.
 *`showGotoOrigin`*::
-  show the 'Go to G53/G5x origin' action
+  Show the 'Go to G53/G5x origin' action.
 *`showZeroOrigin`*::
-  show the 'Zero Origin' action
+  Show the 'Zero Origin' action.
 *`showSetOrigin`*::
-  show the 'Set Origin' action
+  Show the 'Set Origin' action.
 *`dialog_code_string`*::
   Sets which dialog will pop up with numerical entry,
   i.e. 'ENTRY' or 'CALCULATOR' to call a typing only entry dialog or a touch/typing calculator type entry dialog.
@@ -811,15 +811,15 @@ You can also click on the label and see a list of actions. +
 These are the click-on-menu options:
 
 *`showLast`*::
-  show the 'Set to last' action
+  Show the 'Set to last' action.
 *`showDivide`*::
-  show the 'Divide by 2' action
+  Show the 'Divide by 2' action.
 *`showGotoOrigin`*::
-  show the 'Go to G53/G5x origin' action
+  Show the 'Go to G53/G5x origin' action.
 *`showZeroOrigin`*::
-  show the 'Zero Origin' action
+  Show the 'Zero Origin' action.
 *`showSetOrigin`*::
-  show the 'Set Origin' action
+  Show the 'Set Origin' action.
 *`dialogName`*::
   Sets which dialog window will pop up with numerical entry, i.e. ENTRY or CALCULATOR.
 

docs/src/gui/qtvcp.adoc

@@ -233,7 +233,7 @@ Subclassing just means our handler file first loads the original handler file an
 This is useful for changing/adding behaviour while still retaining standard handler updates from LinuxCNC repositories.
 
 You may still need to use the handler copy dialog to copy the original handler file to decide how to patch it.
-See 'custom handler file'
+See 'custom handler file'.
 
 There should be a folder in the config folder; for screens: named '<CONFIG FOLDER>/qtvcp/screens/<SCREEN NAME>/' +
 add the handle patch file there, named like so <ORIGINAL SCREEN NAME>_handler.py, +
@@ -304,8 +304,8 @@ This file will be read and executed as Python code in the *handler file context*
 *Only local functions and local attributes* can be referenced. +
 Global libraries defined in the screen's handler file can be referenced by importing the handler file. +
 These are usually seen as all capital words with no preceding self. +
-'self' references the window class functions +
-'self.w' typically references the widgets
+'self' references the window class functions. +
+'self.w' typically references the widgets.
 
 What can be used can vary by screen and development cycle.
 
@@ -974,8 +974,8 @@ If QtVCP finds these it will call them, if not it will silently ignore them.
   _Class patching_, also known as _monkey patching_, allows to *override function calls in an imported module*. +
   Class patching must be done _before the module is instantiated_, and it _modifies all instances_ made after that. +
   An example might be patching button calls from the G-code editor to call functions in the handler file instead. +
-  Class patching function redefined here, will be called with the HandlerClass instance as 'self' rather then +
-  the patched class instance. This can make access to the patched class function/variables more difficult. +
+  Class patching function redefined here, will be called with the HandlerClass instance as 'self' rather than the patched class instance.
+  This can make access to the patched class function/variables more difficult. +
   When class patching outside of the HandlerClass class, the function call will use the patched class instance as 'self'. 
 
 *`initialized__(self):`*::