Skip to content

Commit 67acb4f

Browse files
committed
docs: More smallish changes while iterating through translations
1 parent d77880a commit 67acb4f

3 files changed

Lines changed: 15 additions & 16 deletions

File tree

docs/src/config/ini-config.adoc

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -882,7 +882,7 @@ LinuxCNC will not know your joint travel limits when using `NO_FORCE_HOMING = 1`
882882
[[sub:ini:sec:axis-letter]]
883883
=== [AXIS_<letter>] Section(((INI File,Sections,[AXIS_<letter>] Sections)))
884884

885-
The <letter> specifies one of: X Y Z A B C U V W
885+
The _<letter>_ specifies one of: X Y Z A B C U V W
886886

887887
* `MAX_VELOCITY = 1.2` - Maximum velocity for this axis in <<sub:ini:sec:traj,machine units>> per second.
888888
* `MAX_ACCELERATION = 20.0` - Maximum acceleration for this axis in machine units per second squared.
@@ -896,7 +896,7 @@ The <letter> specifies one of: X Y Z A B C U V W
896896
For a rotary axis (A,B,C typ) with unlimited rotation having no `MAX_LIMIT` for that axis in the `[AXIS_`<letter>`]` section a value of 1e99 is used.
897897
* `WRAPPED_ROTARY = 1` - When this is set to 1 for an ANGULAR axis the axis will move 0-359.999 degrees.
898898
Positive Numbers will move the axis in a positive direction and negative numbers will move the axis in the negative direction.
899-
* `LOCKING_INDEXER_JOINT = 4` - This value selects a joint to use for a locking indexer for the specified axis <letter>.
899+
* `LOCKING_INDEXER_JOINT = 4` - This value selects a joint to use for a locking indexer for the specified axis _<letter>_.
900900
In this example, the joint is 4 which would correspond to the B axis for a XYZAB system with trivkins (identity) kinematics.
901901
When set, a G0 move for this axis will initiate an unlock with the `joint.4.unlock pin` then wait for the `joint.4.is-unlocked` pin then move the joint at the rapid rate for that joint.
902902
After the move the `joint.4.unlock` will be false and motion will wait for `joint.4.is-unlocked` to go false.
@@ -950,12 +950,12 @@ For example, using trivkins with `coordinates=XZ`, the joint-axes relationships
950950
* JOINT_0 = X
951951
* JOINT_1 = Z
952952

953-
For more information on kinematics modules see the manpage: `$ man kins`
953+
For more information on kinematics modules see the manpage 'kins' (on the UNIX terminal type `man kins`).
954954

955955
* `TYPE = LINEAR` - The type of joint, either `LINEAR` or `ANGULAR`.
956956
* `UNITS = INCH` - (((UNITS)))
957-
If specified, this setting overrides the related `[TRAJ] UNITS` setting.
958-
(e.g., `[TRAJ]LINEAR_UNITS` if the `TYPE` of this joint is `LINEAR`, `[TRAJ]ANGULAR_UNITS` if the `TYPE` of this joint is `ANGULAR`)
957+
If specified, this setting overrides the related `[TRAJ] UNITS` setting,
958+
e.g., `[TRAJ]LINEAR_UNITS` if the `TYPE` of this joint is `LINEAR`, `[TRAJ]ANGULAR_UNITS` if the `TYPE` of this joint is `ANGULAR`.
959959
* `MAX_VELOCITY = 1.2` - Maximum velocity for this joint in <<sub:ini:sec:traj,machine units>> per second.
960960
* `MAX_ACCELERATION = 20.0` - Maximum acceleration for this joint in machine units per second squared.
961961
* `BACKLASH = 0.0000` - (((Backlash))) Backlash in machine units.
@@ -1067,15 +1067,15 @@ These parameters are Homing related, for a better explanation read the <<cha:hom
10671067
When it is yes, it will affect the kind of home pattern used.
10681068
Currently, you can't home to index with steppers unless you're using StepGen in velocity mode and PID.
10691069
* `HOME_INDEX_NO_ENCODER_RESET = NO` -
1070-
Use YES if the encoder used for this joint does not reset its counter when an index pulse is detected after assertion of the joint index_enable HAL pin.
1070+
Use YES if the encoder used for this joint does not reset its counter when an index pulse is detected after assertion of the joint `index_enable` HAL pin.
10711071
Applicable only for `HOME_USE_INDEX = YES`.
10721072
* `HOME_IGNORE_LIMITS = NO` -
10731073
When you use the limit switch as a home switch and the limit switch this should be set to YES.
10741074
When set to YES the limit switch for this joint is ignored when homing.
10751075
You must configure your homing so that at the end of your home move the home/limit switch is not in the toggled state you will get a limit switch error after the home move.
10761076
* `HOME_IS_SHARED =` _<n>_ -
1077-
If the home input is shared by more than one joint set <n> to 1 to prevent homing from starting if the one of the shared switches is already closed.
1078-
Set <n> to 0 to permit homing if a switch is closed.
1077+
If the home input is shared by more than one joint set _<n>_ to 1 to prevent homing from starting if the one of the shared switches is already closed.
1078+
Set _<n>_ to 0 to permit homing if a switch is closed.
10791079
* `HOME_ABSOLUTE_ENCODER = 0` | `1` | `2` - Used to indicate the joint uses an absolute encoder.
10801080
At a request for homing, the current joint value is set to the `HOME_OFFSET` value.
10811081
If the `HOME_ABSOLUTE_ENCODER` setting is 1, the machine makes the usual final move to the `HOME` value.
@@ -1332,7 +1332,7 @@ The value of _num_spindles_ is set by `[TRAJ]SPINDLES=` .
13321332
There is usually no need to change this number.
13331333
* `TOOL_TABLE = tool.tbl` - The file which contains tool information, described in the User Manual.
13341334
* `DB_PROGRAM = db_program` - Path to an executable program that manages tool data.
1335-
(When a DB_PROGRAM is specified, a TOOL_TABLE entry is ignored)
1335+
When a DB_PROGRAM is specified, a TOOL_TABLE entry is ignored.
13361336
* `TOOL_CHANGE_POSITION = 0 0 2` -
13371337
Specifies the XYZ location to move to when performing a tool change if three digits are used.
13381338
Specifies the XYZABC location when 6 digits are used.

docs/src/hal/rtcomps.adoc

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -261,12 +261,11 @@ The component exports two functions. Each function acts on all of the PWM genera
261261
* (funct) `pwmgen.make-pulses` - High speed function to generate PWM waveforms (no floating point).
262262
The high speed function `pwmgen.make-pulses` should be run in the base (fastest) thread, from 10 to 50&#8239;µs depending on the capabilities of the computer.
263263
That thread's period determines the maximum PWM carrier frequency, as well as the resolution of the PWM or PDM signals.
264-
If the base thread is 50,000&#8239;ns then every 50uS the module decides if it is time to change the state of the output.
265-
At 50% duty cycle and 25 Hz PWM frequency this means that the output changes state every (1/25)&#8239;s / 50&#8239;µs * 50% = 400 iterations.
266-
This also means that you have a 800 possible duty cycle values (without dithering)
264+
If the base thread is 50,000&#8239;ns then every 50&#8239;µs the module decides if it is time to change the state of the output.
265+
At 50% duty cycle and 25&#9239;Hz PWM frequency this means that the output changes state every (1/25)&#8239;s / 50&#8239;µs * 50% = 400 iterations.
266+
This also means that you have a 800 possible duty cycle values (without dithering).
267267
* (funct) `pwmgen.update` - Low speed function to scale and limit value and handle other parameters.
268-
This is the function of the module that does the more complicated mathematics to work out how many base-periods the output should be high for,
269-
and how many it should be low for.
268+
This is the function of the module that does the more complicated mathematics to work out how many base-periods the output should be high for, and how many it should be low for.
270269

271270
[[sec:encoder]]
272271
== Encoder(((encoder)))

docs/src/hal/tools.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
== Halcmd
1515

1616
`halcmd` is a command line tool for manipulating the HAL.
17-
There is a rather complete man page for link:../man/man1/halcmd.1.html[`halcmd``], which will be installed if you have installed LinuxCNC from either source or a package.
17+
There is a rather complete man page for link:../man/man1/halcmd.1.html[`halcmd`], which will be installed if you have installed LinuxCNC from either source or a package.
1818
The manpage provides usage info:
1919

2020
----
@@ -345,4 +345,4 @@ Component pins that cannot be associated with a known thread function report the
345345
This helps with the understanding what the source of a pin value is.
346346
Use this information with applications like `halshow`, `halmeter`, `halscope` or the `halcmd show` command in a terminal.
347347

348-
// vim: set syntax=asciidoc:
348+
// vim: set syntax=asciidoc:

0 commit comments

Comments
 (0)