Skip to content

Commit d77880a

Browse files
committed
docs: More smallish changes while reiterating through translation
1 parent 7f33f39 commit d77880a

File tree

6 files changed

+147
-146
lines changed

6 files changed

+147
-146
lines changed

Diff for: docs/src/config/ini-config.adoc

+4-4
Original file line numberDiff line numberDiff line change
@@ -229,10 +229,10 @@ GMOCCAPY can be used both ways and offers also many connections for hardware con
229229
Descriptions of the interfaces are in the Interfaces section of the User Manual.
230230

231231
* `DISPLAY = axis` - The file name of the executable providing the user interface to use.
232-
Prominent valid options are (all in lower case): 'axis', 'touchy', 'gmoccapy', 'gscreen', 'tklinuxcnc', 'qtvcp', 'qtvcp-qtdragon' or 'qtvcp-qtplasmac'.
233-
* `POSITION_OFFSET = RELATIVE` - The coordinate system (RELATIVE or MACHINE) to show on the DRO when the user interface starts.
232+
Prominent valid options are (all in lower case): `axis`, `touchy`, `gmoccapy`, `gscreen`, `tklinuxcnc`, `qtvcp`, `qtvcp-qtdragon` or `qtvcp-qtplasmac`.
233+
* `POSITION_OFFSET = RELATIVE` - The coordinate system (`RELATIVE` or `MACHINE`) to show on the DRO when the user interface starts.
234234
The RELATIVE coordinate system reflects the G92 and G5__x__ coordinate offsets currently in effect.
235-
* `POSITION_FEEDBACK = COMMANDED` - The coordinate value (COMMANDED or ACTUAL) to show on the DRO when the user interface starts.
235+
* `POSITION_FEEDBACK = COMMANDED` - The coordinate value (`COMMANDED` or `ACTUAL`) to show on the DRO when the user interface starts.
236236
In AXIS this can be changed from the View menu.
237237
The COMMANDED position is the position requested by LinuxCNC.
238238
The ACTUAL position is the feedback position of the motors if they have feedback like most servo systems.
@@ -263,7 +263,7 @@ Descriptions of the interfaces are in the Interfaces section of the User Manual.
263263
* `DEFAULT_SPINDLE_0_SPEED = 100` - The default spindle RPM when the spindle is started in manual mode.
264264
On multi spindle machine there will be entries for each spindle number. Only used by the QtVCP-based user interfaces.
265265
- _deprecated_ - use the [SPINDLE_n] section instead.
266-
* `SPINDLE_INCREMENT = 200` - The increment used when clicking increase/decrease buttons Only used by the QtVCP based user interfaces.
266+
* `SPINDLE_INCREMENT = 200` - The increment used when clicking increase/decrease buttons. Only used by the QtVCP based user interfaces.
267267
- _deprecated_ - use the [SPINDLE_n] section instead.
268268
* `MIN_SPINDLE_0_SPEED = 1000` - The minimum RPM that can be manually selected.
269269
On multi spindle machine there will be entries for each spindle number. Only used by the QtVCP-based user interfaces.

Diff for: docs/src/gui/qtdragon.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -448,7 +448,7 @@ qtdragon.spindle-volts
448448
----
449449

450450
This bit pin is an output to the spindle control to pause it. +
451-
You would connect it to spindle.0.inhibit.
451+
You would connect it to `spindle.0.inhibit`.
452452

453453
[source,{hal}]
454454
----

Diff for: docs/src/gui/qtvcp-widgets.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -2932,7 +2932,7 @@ You can create your own subroutines for use with ngcgui. +
29322932
they must follow these rules:
29332933

29342934
* For creating a subroutine for use with NGCGUI, the filename and the subroutine name must be the same.
2935-
* The subroutine must be in a folder within linuxcnc's INI designated search path
2935+
* The subroutine must be in a folder within linuxcnc's INI designated search path.
29362936
* On the first line there may be a comment of type info:
29372937
* The subroutine must be surrounded by the sub and endsub tags.
29382938
* The variables used must be numbered variables and must not skip number.

Diff for: docs/src/hal/haltcl.adoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -108,8 +108,8 @@ Because INI files can repeat the same ITEM in the same SECTION multiple times, `
108108
When there is just one value and it is a simple value (all values that are just letters and numbers without whitespace are in this group),
109109
then it is possible to treat `$::SECTION(ITEM)` as though it is not a list.
110110

111-
When the value could contain special characters--quote characters, curly-brace characters, embedded whitespace, and other characters that have special meaning in Tcl.
112-
It is necessary to distinguish between the list of values and the initial (and possibly only) value in the list.
111+
When the value could contain special characters (quote characters, curly-brace characters, embedded whitespace, and other characters that have special meaning in Tcl)
112+
then it is necessary to distinguish between the list of values and the initial (and possibly only) value in the list.
113113

114114
In Tcl, this is written `[lindex $::SECTION(ITEM) 0]`.
115115

@@ -197,7 +197,7 @@ MAXACCEL = 10.0
197197
STEPGEN_MAXACCEL = 10.5
198198
----
199199

200-
With `haltcl`, you can use Tcl commands to do the computation and eliminate the STEPGEN_MAXACCEL INI file item altogether:
200+
With `haltcl`, you can use Tcl commands to do the computation and eliminate the `STEPGEN_MAXACCEL` INI file item altogether:
201201

202202
[source,tcl]
203203
----

Diff for: docs/src/hal/parallel-port.adoc

+25-24
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@ The config string represents the hexadecimal address of the port, optionally fol
8080
The directions are _in_, _out_, or _x_, and determine the direction of the physical pins 2 to 9 of the D-Sub 25 connector.
8181
If the direction is not specified, the data group will by default be configured as outputs. For example:
8282

83+
.Command to load the real-time module 'hal_partport' with the additional _<config-string>_ to specify the port at which the parallel-port card is expected.
8384
[source,{hal}]
8485
----
8586
loadrt hal_parport cfg="0x278 0x378 in 0x20A0 out"
@@ -189,48 +190,48 @@ loadrt hal_parport cfg="0x378 0xc000"
189190

190191
Please note that your values will differ.
191192
The Netmos cards are Plug-N-Play, and might change their settings depending on which slot you put them into,
192-
so if you like to \'get under the hood' and re-arrange things, be sure to check these values before you start LinuxCNC.
193+
so if you like to 'get under the hood' and re-arrange things, be sure to check these values before you start LinuxCNC.
193194

194195
== Pins
195196

196-
* 'parport.<p>.pin-<n>-out' (bit) Drives a physical output pin.
197-
* 'parport.<p>.pin-<n>-in' (bit) Tracks a physical input pin.
198-
* 'parport.<p>.pin-<n>-in-not' (bit) Tracks a physical input pin, but inverted.
197+
* `parport.<p>.pin-`__<n>__`-out` (bit) Drives a physical output pin.
198+
* `parport.<p>.pin-`__<n>__`-in` (bit) Tracks a physical input pin.
199+
* `parport.<p>.pin-`__<n>__`-in-not` (bit) Tracks a physical input pin, but inverted.
199200

200-
For each pin, '<p>' is the port number, and '<n>' is the physical pin number in the 25 pin D-shell connector.
201+
For each pin, _<p>_ is the port number, and '<n>' is the physical pin number in the 25 pin D-shell connector.
201202

202-
For each physical output pin, the driver creates a single HAL pin, for example: 'parport.0.pin-14-out'.
203+
For each physical output pin, the driver creates a single HAL pin, for example: `parport.0.pin-14-out`.
203204

204-
For each physical input pin, the driver creates two HAL pins, for example: 'parport.0.pin-12-in' and 'parport.0.pin-12-in-not'.
205+
For each physical input pin, the driver creates two HAL pins, for example: `parport.0.pin-12-in` and `parport.0.pin-12-in-not`.
205206

206-
The '-in' HAL pin is TRUE if the physical pin is high, and FALSE if the physical pin is low.
207-
The '-in-not' HAL pin is inverted and is FALSE if the physical pin is high.
207+
The `-in` HAL pin is TRUE if the physical pin is high, and FALSE if the physical pin is low.
208+
The `-in-not` HAL pin is inverted and is FALSE if the physical pin is high.
208209

209210
== Parameters
210211

211-
* 'parport.<p>.pin-<n>-out-invert' (bit) Inverts an output pin.
212-
* 'parport.<p>.pin-<n>-out-reset' (bit) (only for 'out' pins) TRUE if this pin should be reset when the '-reset' function is executed.
213-
* parport.<p>.reset-time' (U32) The time (in nanoseconds) between a pin is set by 'write' and reset by the 'reset' function if it is enabled.
212+
* `parport.`__<p>__`.pin-`__<n>__`-out-invert` (bit) Inverts an output pin.
213+
* `parport.`__<p>__`.pin-`__<n>__`-out-reset` (bit) (only for `-out` pins) TRUE if this pin should be reset when the `-reset` function is executed.
214+
* `parport.`__<p>__`.reset-time` (U32) The time (in nanoseconds) between a pin is set by `-write` and reset by the `-reset` function if it is enabled.
214215

215-
The '-invert' parameter determines whether an output pin is active high or active low.
216-
If '-invert' is FALSE, setting the HAL '-out' pin TRUE drives the physical pin high, and FALSE drives it low.
217-
If '-invert' is TRUE, then setting the HAL '-out' pin TRUE will drive the physical pin low.
216+
The `-invert` parameter determines whether an output pin is active high or active low.
217+
If `-invert` is FALSE, setting the HAL `-out` pin TRUE drives the physical pin high, and FALSE drives it low.
218+
If `-invert` is TRUE, then setting the HAL `-out` pin TRUE will drive the physical pin low.
218219

219220
[[sub:parport-functions]]
220221
== Functions
221222

222-
* 'parport.<p>.read' (funct) Reads physical input pins of port '<portnum>' and updates HAL '-in' and '-in-not' pins.
223-
* 'parport.read-all' (funct) Reads physical input pins of all ports and updates HAL '-in' and '-in-not' pins.
224-
* 'parport.<p>.write' (funct) Reads HAL '-out' pins of port '<p>' and updates that port's physical output pins.
225-
* 'parport.write-all' (funct) Reads HAL '-out' pins of all ports and updates all physical output pins.
226-
* 'parport.<p>.reset' (funct) Waits until 'reset-time' has elapsed since the associated 'write', then resets pins to values indicated by '-out-invert' and '-out-invert' settings.
227-
'reset' must be later in the same thread as 'write.
228-
'If '-reset' is TRUE, then the 'reset' function will set the pin to the value of '-out-invert'.
223+
* `parport.`__<p>__`.read' (funct) Reads physical input pins of port number _<p>_ and updates HAL `-in` and `-in-not` pins.
224+
* `parport.read-all` (funct) Reads physical input pins of all ports and updates HAL `-in` and `-in-not` pins.
225+
* `parport.`__<p>__`.write` (funct) Reads HAL `-out` pins of port number _<p>_ and updates that port's physical output pins.
226+
* `parport.write-all` (funct) Reads HAL `-out` pins of all ports and updates all physical output pins.
227+
* `parport.`__<p>__`.reset` (funct) Waits until `reset-time` has elapsed since the associated `write`, then resets pins to values indicated by `-out-invert` and `-out-invert` settings.
228+
`reset` must be later in the same thread as `write`.
229+
If `-reset` is TRUE, then the `reset` function will set the pin to the value of `-out-invert`.
229230
This can be used in conjunction with stepgen's 'doublefreq' to produce one step per period.
230231
The <<sec:stepgen,stepgen stepspace>> for that pin must be set to 0 to enable doublefreq.
231232

232233
The individual functions are provided for situations where one port needs to be updated in a very fast thread, but other ports can be updated in a slower thread to save CPU time.
233-
It is probably not a good idea to use both an '-all' function and an individual function at the same time.
234+
It is probably not a good idea to use both an `-all` function and an individual function at the same time.
234235

235236
== Common problems
236237

@@ -249,7 +250,7 @@ If the module loads but does not appear to function, then the port address is in
249250
== Using DoubleStep
250251

251252
To setup DoubleStep on the parallel port you must add the function parport.n.reset after parport.n.write and configure stepspace to 0 and the reset time wanted.
252-
So that step can be asserted on every period in HAL and then toggled off by parport after being asserted for time specified by parport.n.reset-time.
253+
So that step can be asserted on every period in HAL and then toggled off by parport after being asserted for time specified by `parport.`__n__`.reset-time`.
253254

254255
For example:
255256

0 commit comments

Comments
 (0)