Merge pull request #3533 from LinuxCNC/docs_fixes_20250803

docs: optics while translating (smoe:docs_fixes_20250803)

Author: andypugh

docs/src/config/core-components.adoc

@@ -93,7 +93,7 @@ unlock_joints_mask=0x38 selects joints 3,4,5
 ----
 
 [[sec:motion-pins]]
-=== Pins(((motion (HAL pins))))
+=== Pins(((motion:HAL pins)))
 
 These pins, parameters, and functions are created by the realtime 'motmod'
 module.

docs/src/config/python-interface.adoc

@@ -40,7 +40,7 @@ The general pattern for `linuxcnc` usage is roughly like this:
 - Establish connections to the command, status and error NML channels as needed.
 - Poll the status channel, either periodically or as needed.
 - Before sending a command, determine from status whether it is in fact OK to do so
-  (for instance, there is no point in sending a 'Run' command if task is in the ESTOP state, or the interpreter is not idle)
+  (for instance, there is no point in sending a 'Run' command if task is in the ESTOP state, or the interpreter is not idle).
 - Send the command by using one of the `linuxcnc` command channel methods.
 
 To retrieve messages from the error channel, poll the error channel periodically, and process any messages retrieved.

docs/src/drivers/hal_pi_gpio.adoc

@@ -69,23 +69,23 @@ Depending on the dir and exclude masks.
 
 == Parameters
 
-Only the standard timing parameters which are created for all components exist.
+Only the standard timing parameters which are created for all components exist:
 
-*hal_pi_gpio.read.tmax
-*hal_pi_gpio.read.tmax-increased
-*hal_pi_gpio.write.tmax
-*hal_pi_gpio.write.tmax-increased
+* hal_pi_gpio.read.tmax
+* hal_pi_gpio.read.tmax-increased
+* hal_pi_gpio.write.tmax
+* hal_pi_gpio.write.tmax-increased
 
-For unknown reasons the driver also creates HAL _pins_ to indicate timing
+For unknown reasons the driver also creates HAL _pins_ to indicate timing:
 
-*hal_pi_gpio.read.time
-*hal_pi_gpio.write.time
+* hal_pi_gpio.read.time
+* hal_pi_gpio.write.time
 
 
 == Functions
 
-* 'hal_pi_gpio.read' - Add this to the base thread to update the HAL pin values to match the physical input values.
-* 'hal_pi_gpio.write' - Add this to the base thread to update the physical pins to match the HAL values.
+* `hal_pi_gpio.read` - Add this to the base thread to update the HAL pin values to match the physical input values.
+* `hal_pi_gpio.write` - Add this to the base thread to update the physical pins to match the HAL values.
 
 Typically the 'read' function will be early in the call list, before any encoder counters and the 'write' function will be later in the call list, after stepgen.make-pulses.
 

docs/src/gcode/coordinates.adoc

@@ -150,15 +150,15 @@ would still be in effect.
 
 [source,{ngc}]
 ----
-G54	uses parameters of coordinate system 1(((G54)))
-G55	uses parameters of coordinate system 2(((G55)))
-G56	uses parameters of coordinate system 3(((G56)))
-G57	uses parameters of coordinate system 4(((G57)))
-G58	uses parameters of coordinate system 5(((G58)))
-G59	uses parameters of coordinate system 6(((G59)))
-G59.1	uses parameters of coordinate system 7(((G59.1)))
-G59.2	uses parameters of coordinate system 8(((G59.2)))
-G59.3	uses parameters of coordinate system 9(((G59.3)))
+G54	uses parameters of coordinate system 1
+G55	uses parameters of coordinate system 2
+G56	uses parameters of coordinate system 3
+G57	uses parameters of coordinate system 4
+G58	uses parameters of coordinate system 5
+G59	uses parameters of coordinate system 6
+G59.1	uses parameters of coordinate system 7
+G59.2	uses parameters of coordinate system 8
+G59.3	uses parameters of coordinate system 9
 ----
 
 === Default Coordinate System

docs/src/gcode/g-code.adoc

@@ -1183,7 +1183,7 @@ It is an error if:
   due to the spindle speed
 
 [[gcode:g38]]
-== G38.n Straight Probe(((G38.n Probe)))
+== G38._n_ Straight Probe(((G38.n Probe)))
 
 [source,{ngc}]
 ----
@@ -1202,11 +1202,11 @@ You will not be able to use a probe move until your machine has been set
 up to provide a probe input signal.
 The probe input signal must be connected to 'motion.probe-input' in a .hal
 file.
-G38.n uses motion.probe-input to determine when the probe has made (or
+G38._n_ uses motion.probe-input to determine when the probe has made (or
 lost) contact.
 TRUE for probe contact closed (touching), FALSE for probe contact open.
 
-Program 'G38.n axes' to perform a straight probe operation.
+Program 'G38._n_ axes' to perform a straight probe operation.
 The axis words are optional, except that at least one of them must be
 used.
 The axis words together define the destination point that the probe will
@@ -1405,10 +1405,9 @@ G43 <H->
   a compensated axis is moved, that axis's endpoint is the compensated
   location.
 
-'G43' without an H word uses the currently loaded tool from the last
-'Tn M6'.
+'G43' without an H word uses the currently loaded tool from the last 'T__n__ M6'.
 
-'G43 Hn' uses the offset for tool n.
+'G43 H__n__' uses the offset for tool _n_.
 
 The active tool length compensation values are stored in the numbered
 parameters '5401-5409'.
@@ -1445,10 +1444,9 @@ It is an error if:
 G43.1 axes
 ----
 
-* 'G43.1 axes' - change subsequent motions by replacing the current
-  offset(s) of axes.
-  G43.1 does not cause any motion. The next time a compensated axis
-  is moved, that axis's endpoint is the compensated location.
+* 'G43.1 axes' - change subsequent motions by replacing the current offset(s) of axes.
+  G43.1 does not cause any motion. The next time a compensated axis is moved,
+  that axis's endpoint is the compensated location.
 
 .G43.1 Example
 [source,{ngc}]
@@ -1459,8 +1457,7 @@ G43.1 Z0.250 (replace current tool offset with 0.250, DRO now shows Z0.250)
 M2 (end program)
 ----
 
-* See <<gcode:g90-g91,G90>> & <<sec:select-tool,T>> & <<mcode:m6,M6>>
-  sections for more information.
+* See <<gcode:g90-g91,G90>> & <<sec:select-tool,T>> & <<mcode:m6,M6>> sections for more information.
 
 It is an error if:
 
@@ -1479,11 +1476,11 @@ G43.2 H- or axes-
 
 * 'H' - tool number
 
-* 'G43.2 Hn' - applies an additional simultaneous tool offset to subsequent motions by adding the offset(s) of tool n.
+* 'G43.2 H__n__' - applies an additional simultaneous tool offset to subsequent motions by adding the offset(s) of tool _n_.
 
 * 'G43.2 axes' - applies an additional simultaneous tool offset to subsequent motions by adding the value(s) of any axis words.
 
-.G43.2 Hn Example
+.G43.2 H__n__ Example
 [source,{ngc}]
 ----
 G90 (set absolute mode)
@@ -1509,14 +1506,12 @@ geometry offsets and which are wear offsets, or that you should have
 only one of each.
 
 Like the other G43 commands, G43.2 does not cause any motion. The next
-time a compensated axis is moved, that axis's endpoint is the compensated
-location.
+time a compensated axis is moved, that axis's endpoint is the compensated location.
 
 It is an error if:
 
 * 'H' is unspecified and no axis offsets are specified.
-* 'H' is specified and the given tool number does not exist in the tool
-  table.
+* 'H' is specified and the given tool number does not exist in the tool table.
 * 'H' is specified and axes are also specified.
 
 NOTE: G43.2 does not write to the tool table.
@@ -1849,8 +1844,7 @@ the bottom of the hole.
 The length of the dwell is specified by a 'P-' word in the G74 block.
 The feed rate 'F-' is spindle speed multiplied by distance per revolution
 (thread pitch).
-In example S100 with 1.25MM per revolution thread pitch gives a feed of
-F125.
+In example S100 with 1.25MM per revolution thread pitch gives a feed of F125.
 
 [[gcode:g76]]
 == G76 Threading Cycle(((G76 Threading Cycle)))
@@ -1945,7 +1939,7 @@ It is an error if:
 * 'E-' is greater than half the drive line length.
 
 .HAL Connections
-The pins 'spindle.N.at-speed' and the 'encoder.n.phase-Z' for the
+The pins 'spindle.N.at-speed' and the 'encoder._n_.phase-Z' for the
 spindle must be connected in your HAL file before G76 will work.
 See the <<sec:motion-pins,spindle>> pins in the Motion section for more
 information.

docs/src/gcode/m-code.adoc

@@ -697,13 +697,12 @@ parameter of the INI file) is executed with the optional P and Q values
 as its two arguments.
 
 Execution of the G-code file pauses until the external program exits.
-If the external program exits with exit code other than '0' gcode program execution is
-stopped.
+If the external program exits with exit code other than '0' G-code program execution is stopped.
 Any valid executable file can be used. The file must be located in the search
 path specified in the INI file configuration.
 See the <<sub:ini:sec:display,Display>> section for more information on search paths.
 
-After creating a new M1nn program, the GUI should be restarted so that the
+After creating a new M1__nn__ program, the GUI should be restarted so that the
 new program is taken into account, otherwise a 'Unknown M-code' error will occur.
 
 [WARNING]
@@ -714,11 +713,11 @@ in other operating systems to create or edit the files.
 
 The error 'Unknown M-code used' denotes one of the following:
 
-* The specified User Defined Command does not exist
-* The file is not an executable file
-* The file name has an extension
-* The file name does not follow this format Mnnn where nnn = 100 through 199
-* The file name used a lower case M
+* The specified User Defined Command does not exist.
+* The file is not an executable file.
+* The file name has an extension.
+* The file name does not follow this format Mnnn where nnn = 100 through 199.
+* The file name used a lower case M.
 
 For example to open and close a collet closer that is controlled by a
 parallel port pin using a bash script file using M101 and M102. Create two

docs/src/gui/axis.adoc

@@ -754,13 +754,11 @@ running 'in-place', this can be done by using 'scripts/rip-environment'.
 [[sec:axis-lathe-mode]]
 == Using AXIS in Lathe Mode(((AXIS:Lathe Mode)))
 
-By including the line 'LATHE = 1'
-in the [DISPLAY] section of the INI file, AXIS selects lathe mode. The
-'Y' axis is not shown in coordinate readouts, the view is changed to
-show the Z axis extending to the right and the X axis extending towards
-the bottom of the screen, and several controls (such as those for
-preset views) are removed.  The coordinate readouts for X are replaced
-with diameter and radius.
+By including the line 'LATHE = 1' in the [DISPLAY] section of the INI file, AXIS selects lathe mode.
+The 'Y' axis is not shown in coordinate readouts, the view is changed
+to show the Z axis extending to the right and the X axis extending towards
+the bottom of the screen, and several controls (such as those for preset views) are removed.
+The coordinate readouts for X are replaced with diameter and radius.
 
 .AXIS Lathe Mode
 image::images/axis-lathe.png["AXIS Lathe Mode",align="center"]

docs/src/gui/gmoccapy.adoc

@@ -655,11 +655,11 @@ To connect encoders, the following pins are exported:
 - *gmoccapy.jog.jog-velocity.count-enable*          _(bit IN)_ - Must be True, to enable counts
 - *gmoccapy.feed.feed-override.counts*              _(s32 IN)_ - feed override
 - *gmoccapy.feed.feed-override.count-enable*        _(bit IN)_ - Must be True, to enable counts
-- *gmoccapy.feed.reset-feed-override*               _(bit IN)_ - reset the feed override to *0%
+- *gmoccapy.feed.reset-feed-override*               _(bit IN)_ - reset the feed override to 0%
 - *gmoccapy.spindle.spindle-override.counts*        _(s32 IN)_ - spindle override
 - *gmoccapy.spindle.spindle-override.count-enable*  _(bit IN)_ - Must be True, to enable counts
-- *gmoccapy.spindle.reset-spindle-override*         _(bit IN)_ - reset the spindle override to *0%
-- *gmoccapy.rapid.rapid-override.counts*            _(s32 IN)_ - Maximal Velocity of the *chine
+- *gmoccapy.spindle.reset-spindle-override*         _(bit IN)_ - reset the spindle override to 0%
+- *gmoccapy.rapid.rapid-override.counts*            _(s32 IN)_ - Maximal velocity of the machine
 - *gmoccapy.rapid.rapid-override.count-enable*      _(bit IN)_ - Must be True, to enable counts
 
 To connect potentiometers, use the following pins:

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

@@ -166,12 +166,12 @@ filter extension = program to run
 [source,{ini}]
 ----
 [FILTER]
-# Controls what programs are shown in the file manager
+# Controls what programs are shown in the file manager:
 PROGRAM_EXTENSION = .ngc,.nc,.tap G-Code File (*.ngc,*.nc,*.tap)
 PROGRAM_EXTENSION = .png,.gif,.jpg Greyscale Depth Image
 PROGRAM_EXTENSION = .py Python Script
 
-# specifies what special 'filter' programs runs based on program ending
+# Maps data/source code file extensions to a special 'filter' program for the display/execution:
 png = image-to-gcode
 gif = image-to-gcode
 jpg = image-to-gcode

docs/src/gui/qtvcp-libraries.adoc

@@ -996,7 +996,7 @@ Requires no user intervention.
   * *okdialog* - _requiring the user to click OK to close the dialog_. +
 OK messages have _two HAL pins_:
   ** One HAL pin to launch the dialog, and
-  ** One to signify it's waiting for response.
+  ** one to signify it is waiting for a response.
   * *yesnodialog* - _requiring the user to select yes or no buttons to close the dialog_. +
 Yes/No messages have _three HAL pins_:
   ** One to show the dialog,
@@ -1089,7 +1089,7 @@ Requires no user intervention.
   * *okdialog* - _requiring the user to click OK to close the dialog_. +
 OK messages use _two HAL pins_:
   ** One HAL pin to launch the dialog, and
-  ** One to signify it's waiting for response.
+  ** one to signify it's waiting for response.
   * *yesnodialog* - _requiring the user to select yes or no buttons to close the dialog_. +
 Yes/No messages use _three HAL pins_:
   ** One to show the dialog,