Merge pull request #1796 from smoe/docs_stupid_simple_stuff

SebKuzminsky · web-flow · commit d36be38adaad · 2022-07-04T08:55:12.000-06:00
More translation-triggered changes
diff --git a/docs/src/drivers/gm.adoc b/docs/src/drivers/gm.adoc
@@ -89,7 +89,7 @@ gm.0.gpio.0.in-0
 ----
 
 indicates the state of the first pin of the first GPIO
-connector on the GM6-PCI card. Hal pins are updated by function
+connector on the GM6-PCI card. HAL pins are updated by function
 
 ----
 gm.<nr of card>.read
@@ -180,7 +180,7 @@ gm.0.encoder.0.position
 refers to the position of encoder module of axis 0.
 
 The GM6-PCI card counts the encoder signal independently from LinuxCNC.
-Hal pins are updated by function:
+HAL pins are updated by function:
 
 ----
 gm.<nr of card>.read
@@ -197,7 +197,7 @@ gm.<nr of card>.read
 | .index-enabled     | (bit, IO)          | When True, counts and position are rounded or reset
                                             (depends on index-mode) on next rising edge of channel-I.
                                             Every time position is reset because of Index, index-enabled
-                                            pin is set to 0 and remain 0 until connected hal pin does
+                                            pin is set to 0 and remain 0 until connected HAL pin does
                                             not set it.
 | .velocity          | (float, Out)       | Velocity in scaled units per second. GM encoder uses high
                                             frequency hardware timer to measure time between encoder
@@ -262,14 +262,14 @@ Connect encoder position to LinuxCNC position feedback:
 net Xpos-fb gm.0.encoder.0.position => joint.0.motor-pos-fb
 ----
 
-=== Stepgen module
+=== StepGen module
 
-The GM6-PCI motion control card has six stepgen modules, one for each joint.
+The GM6-PCI motion control card has six StepGen modules, one for each joint.
 Each module has two output signals. It can produce Step/Direction,
-Up/Down or Quadrature (A/B) pulses. Each stepgen module is connected
+Up/Down or Quadrature (A/B) pulses. Each StepGen module is connected
 to the pins of the corresponding RJ50 axis connector.
 
-Every stepgen pin and parameter name begins as follows:
+Every StepGen pin and parameter name begins as follows:
 
 ----
 gm.<nr of card>.stepgen.<nr of axis>
@@ -281,10 +281,10 @@ where nr of axis is from 0 to 5. For example:
 gm.0.stepgen.0.position-cmd
 ----
 
-refers to the position command of stepgen module of axis 0 on card 0.
+refers to the position command of StepGen module of axis 0 on card 0.
 
 The GM6-PCI card generates step pulses independently from LinuxCNC.
-Hal pins are updated by function
+HAL pins are updated by function
 
 ----
 gm.<nr of card>.write
@@ -309,10 +309,10 @@ gm.<nr of card>.write
 | Parameters         | Type and Read/Write | Parameter description
 | .step-type         | (u32, R/W)          | When 0, module produces Step/Dir signal. When 1, it
                                              produces Up/Down step signals. And when it is 2, it
-											 produces quadrature output signals.
+                                             produces quadrature output signals.
 | .control-type      | (bit, R/W)          | When True, .velocity-cmd is used as reference and velocity
                                              control calculate pulse rate output. When False, .position-cmd
-											 is used as reference and position control calculate pulse rate output.
+                                             is used as reference and position control calculate pulse rate output.
 | .invert-step1      | (bit, R/W)          | Invert the output of channel 1 (Step signal in StepDir mode)
 | .invert-step2      | (bit, R/W)          | Invert the output of channel 2 (Dir signal in StepDir mode)
 | .maxvel            | (float, R/W)        | Maximum velocity in position units per second. If it is set to 0.0,
@@ -332,7 +332,7 @@ image::images/GM_RefSignals.png["Reference signal timing diagrams",align="center
 
 .HAL example
 
-Setting stepgen module of axis 0 to generate 1000 step pulse per position unit:
+Setting StepGen module of axis 0 to generate 1000 step pulse per position unit:
 
 ----
 setp gm.0.stepgen.0.step-type 0         # 0:stepDir, 1:UpDown, 2:Quad
@@ -349,7 +349,7 @@ setp gm.0.stepgen.0.stepspace1000       # 1000 ns = 1 us
 setp gm.0.stepgen.0.dirdelay 2000       # 2000 ns = 2 us
 ----
 
-Connect stepgen to axis 0 position reference and enable pins:
+Connect StepGen to axis 0 position reference and enable pins:
 
 ----
 net Xpos-cmd joint.0.motor-pos-cmd => gm.0.stepgen.0.position-cmd
@@ -362,7 +362,7 @@ The GM6-PCI motion control card has one enable output and one fault
 input HAL pins, both are connected to each RJ50 axis connector
 and to the CAN connector.
 
-Hal pins are updated by function:
+HAL pins are updated by function:
 
 ----
 gm.<nr of card>.read
@@ -400,7 +400,7 @@ gm.0.dac.0.value
 ----
 
 refers to the output voltage of DAC module of axis 0.
-Hal pins are updated by function:
+HAL pins are updated by function:
 
 ----
 gm.<nr of card>.write
@@ -469,7 +469,7 @@ gm.0.can-gm.0.position
 
 refers to the output position of axis 0 in position units.
 
-Hal pins are updated by function:
+HAL pins are updated by function:
 
 ----
 gm.<nr of card>.write
@@ -566,7 +566,7 @@ gm.0.joint.0.home-sw-in
 
 indicates the state of the axis 0 home switch.
 
-Hal pins are updated by function:
+HAL pins are updated by function:
 
 ----
 gm.<nr of card>.read
diff --git a/docs/src/drivers/hostmot2.adoc b/docs/src/drivers/hostmot2.adoc
@@ -225,7 +225,7 @@ The above configuration produced this printout.
 
 [NOTE]
 That the I/O Pin nnn will correspond to the pin number shown on
-the HAL Configuration screen for GPIOs. Some of the Stepgen, Encoder
+the HAL Configuration screen for GPIOs. Some of the StepGen, Encoder
 and PWMGen will also show up as GPIOs in the HAL Configuration screen.
 
 == PIN Files
@@ -465,7 +465,7 @@ GPIO pins default to input.
 
 == StepGen
 
-Stepgens have names like 'hm2_<BoardType>.<BoardNum>.stepgen.<Instance>.'.
+StepGens have names like 'hm2_<BoardType>.<BoardNum>.stepgen.<Instance>'.
 'Instance' is a two-digit number that corresponds to the HostMot2 stepgen
 instance number.
 There are 'num_stepgens' instances, starting with 00.
@@ -475,13 +475,13 @@ time), but currently only uses two: Step and Direction outputs.
 footnote:[At present, the firmware supports multi-phase stepper outputs,
 but the driver doesn't. Interested volunteers are solicited.]
 
-The stepgen representation is modeled on the stepgen software
-component. Stepgen default is active high step output (high during step
+The StepGen representation is modeled on the stepgen software
+component. StepGen default is active high step output (high during step
 time low during step space). To invert a StepGen output pin you invert
 the corresponding GPIO pin that is being used by StepGen. To find the
 GPIO pin being used for the StepGen output run 'dmesg' as shown above.
 
-Each stepgen instance has the following pins and parameters:
+Each StepGen instance has the following pins and parameters:
 
 === Pins
 
@@ -564,7 +564,7 @@ output run 'dmesg' as described above.
 == PWMGen
 
 PWMgens have names like
-'hm2_<BoardType>.<BoardNum>.pwmgen.<Instance>.'. 'Instance' is a
+'hm2_<BoardType>.<BoardNum>.pwmgen.<Instance>'. 'Instance' is a
 two-digit number that corresponds to the HostMot2 pwmgen instance
 number. There are 'num_pwmgens' instances, starting with 00.
 
diff --git a/docs/src/drivers/shuttle.adoc b/docs/src/drivers/shuttle.adoc
@@ -71,8 +71,7 @@ of the device (the order in which the driver found them), for example
 '<Prefix>.button-<ButtonNumber>' (bit out)::
   These pins are True (1) when the button is pressed.
 '<Prefix>.button-<ButtonNumber>-not' (bit out)::
-  These pins have the inverse of the button state, so they're True
-  (1) when the button is not pressed.
+  These pins have the inverse of the button state, so they're True (1) when the button is not pressed.
 '<Prefix>.counts' (s32 out)::
   Accumulated counts from the jog wheel (the inner wheel).
 '<Prefix>.spring-wheel-s32' (s32 out)::
diff --git a/docs/src/drivers/vfs11.adoc b/docs/src/drivers/vfs11.adoc
@@ -31,14 +31,14 @@ component vfs11_vfd, named spindle-vfd
 
 == Command Line Options
 
-'vfs11_vfd' is mostly configured through inifile options. The command
+'vfs11_vfd' is mostly configured through INI file options. The command
 line options are:
 
 * '-n or --name <halname>' : set the HAL component name
-* '-I or --ini <inifilename>' : take configuration from this ini file.
+* '-I or --ini <inifilename>' : take configuration from this INI file.
   Defaults to environment variable INI_FILE_NAME.
 * '-S or --section <section name>' : take configuration from this
-  section in the ini file. Defaults to 'VFS11'.
+  section in the INI file. Defaults to 'VFS11'.
 * '-d or --debug' enable debug messages on console output.
 * '-m or --modbus-debug' enable modbus messages on console output
 * '-r or --report-device' report device properties on console at startup
@@ -81,7 +81,7 @@ option.
   put the VFD into emergency-stopped status. No operation possible until
   cleared with err-reset or powercycling.
 * '<n>.frequency-command' (float, out)
-  current target frequency in HZ as set through speed-command (which is
+  current target frequency in Hz as set through speed-command (which is
   in RPM), from the VFD
 * '<n>.frequency-out' (float, out)
   current output frequency of the VFD
@@ -222,7 +222,7 @@ TARGET=1
 # for RECONNECT_DELAY seconds
 RECONNECT_DELAY=1
 
-# misc flags
+# misc. parameters
 DEBUG=10
 MODBUS_DEBUG=0
 POLLCYCLES=10
@@ -338,7 +338,7 @@ The Ubuntu +libmodbus5+ and +libmodbus-dev+ packages are
 only available starting from Ubuntu 12 ('Precise Pengolin'). Moreover,
 these packages lack support for the MODBUS_RTS_MODE_*
 flags. Therefore, building vfs11_vfd using this library might generate
-a warning if RTS_MODE= is specified in the ini file.
+a warning if RTS_MODE= is specified in the INI file.
 
 To use the full functionality on lucid and precise:
 
@@ -348,7 +348,7 @@ To use the full functionality on lucid and precise:
   https://github.com/stephane/libmodbus/blob/master/README.rst[here].
 
 Libmodbus does not build on Ubuntu Hardy, hence vfs11_vfd is not
-available on hardy.
+available on Hardy.
 
 // Michael Haberler; loosely based on gs2_vfd by Steve Padnos and John Thornton.
 
diff --git a/docs/src/examples/gs2-example.adoc b/docs/src/examples/gs2-example.adoc
@@ -11,7 +11,7 @@ GS2 VFD to drive a spindle.
 The spindle speed and direction is controlled by LinuxCNC.
 
 Using the GS2 component involves very little to set up. We start with
-a Stepconf Wizard generated config. Make sure the pins with "Spindle
+a StepConf Wizard generated config. Make sure the pins with "Spindle
 CW" and "Spindle PWM" are set to unused in the parallel port setup
 screen.
 
@@ -48,15 +48,15 @@ based on your physical requirements but these are beyond the scope of
 this manual. Refer to the GS2 manual that came with the drive for more
 information on the drive parameters.
 
-* The communications switches must be set to RS-232C
-* The motor parameters must be set to match the motor
+* The communications switches must be set to RS-232C.
+* The motor parameters must be set to match the motor.
 * P3.00 (Source of Operation Command) must be set to Operation
-  determined by RS-485 interface, 03 or 04
+  determined by RS-485 interface, 03 or 04.
 * P4.00 (Source of Frequency Command) must be set to Frequency
-  determined by RS232C/RS485 communication interface, 05
-* P9.01 (Transmission Speed) must be set to 9600 baud, 01
+  determined by RS232C/RS485 communication interface, 05.
+* P9.01 (Transmission Speed) must be set to 9600 baud, 01.
 * P9.02 (Communication Protocol) must be set to "Modbus RTU mode,
-  8 data bits, no parity, 2 stop bits", 03
+  8 data bits, no parity, 2 stop bits", 03.
 
 A PyVCP panel based on this example is <<gs2-rpm-meter,here>>.
 
diff --git a/docs/src/gcode/g-code.adoc b/docs/src/gcode/g-code.adoc
@@ -142,7 +142,7 @@ rapid rate (or slower). 'G0' is typically used as a positioning move.
 
 === Rapid Velocity Rate
 
-The MAX_VELOCITY setting in the ini file [TRAJ] section defines the
+The MAX_VELOCITY setting in the INI file [TRAJ] section defines the
 maximumrapid traverse rate. The maximum rapid traverse rate can be
 higher than the individual axes MAX_VELOCITY setting during a
 coordinated move. The maximum rapid traverse rate can be slower than the
@@ -964,7 +964,7 @@ It is a good idea to include a plane selection in the preamble
 of each G-code file.
 
 The effects of having a plane selected are discussed in Section
-<<gcode:g2-g3,G2 G3 Arcs>> and Section <<gcode:g80-g89,G81 G89>>
+<<gcode:g2-g3,G2 G3 Arcs>> and Section <<gcode:g80-g89,G81 G89>>.
 
 [[gcode:g20-g21]]
 == G20, G21 Units(((G20 Units)))
@@ -985,7 +985,7 @@ desired G28 position has been stored with G28.1.
 G28 uses the values stored in <<sub:numbered-parameters,parameters>>
 5161-5169 as the X Y Z A B C U V W final point to move to. The parameter
 values are 'absolute' machine coordinates in the native machine 'units'
-as specified in the ini file. All axes defined in the ini file will be
+as specified in the INI file. All axes defined in the INI file will be
 moved when a G28 is issued. If no positions are stored with G28.1 then
 all axes will go to the <<sec:machine-coordinate-system,machine origin>>.
 
@@ -1019,14 +1019,14 @@ desired G30 position has been stored with G30.1.
 G30 functions the same as G28 but uses the values stored in
 <<sub:numbered-parameters,parameters>> 5181-5189 as the X Y Z A B C U V
 W final point to move to. The parameter values are 'absolute' machine
-coordinates in the native machine 'units' as specified in the ini file.
-All axes defined in the ini file will be moved when a G30 is issued. If
+coordinates in the native machine 'units' as specified in the INI file.
+All axes defined in the INI file will be moved when a G30 is issued. If
 no positions are stored with G30.1 then all axes will go to the
 <<sec:machine-coordinate-system,machine origin>>.
 
 [NOTE]
 G30 parameters will be used to move the tool when a M6 is programmed
-if TOOL_CHANGE_AT_G30=1 is in the [EMCIO] section of the ini file.
+if TOOL_CHANGE_AT_G30=1 is in the [EMCIO] section of the INI file.
 
 * 'G30' - makes a <<gcode:g0,rapid move>> from the current
   position to the 'absolute' position of the values in parameters
@@ -2576,8 +2576,8 @@ becomes the specified value. All of the coordinate system's origins
 'G92' uses the values stored in <<sub:numbered-parameters,parameters>>
 5211-5219 as the X Y Z A B C U V W offset values for each axis.
 The parameter values are 'absolute' machine coordinates
-in the native machine 'units' as specified in the ini file.
-All axes defined in the ini file will be offset when G92 is active.
+in the native machine 'units' as specified in the INI file.
+All axes defined in the INI file will be offset when G92 is active.
 If an axis was not entered following the G92, that axis' offset
 will be zero.
 
diff --git a/docs/src/gui/pyvcp-examples.adoc b/docs/src/gui/pyvcp-examples.adoc
@@ -199,7 +199,7 @@ net my-jogspeed halui.axis.jog-speed <= pyvcp.jog-speed-f
 
 After resetting the E-Stop and putting it into jog mode and moving the
 jog speed slider in the PyVCP panel to a value greater than zero the
-PyVCP jog buttons should work. You can not jog when running a g code
+PyVCP jog buttons should work. You can not jog when running a G-code
 file or while paused or while the MDI tab is selected.
 
 == Port Tester
