Skip to content

Commit f2e6ef7

Browse files
smoehansu
authored andcommitted
docs: More translation-revisiting changes.
1 parent 5140592 commit f2e6ef7

7 files changed

Lines changed: 77 additions & 122 deletions

File tree

docs/man/man9/hostmot2.9

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -871,7 +871,7 @@ Sets the master RC PWM frequency. Maximum is 1 kHz, minimum is .01 Hz. Defaults
871871

872872
.TP
873873
(float rw) width
874-
Sets the per channel pulse width in (ms/scale)
874+
Sets the per channel pulse width in (ms/scale).
875875

876876
.TP
877877
(float rw) offset
@@ -1123,7 +1123,7 @@ Only full GPIO pins have this parameter.
11231123
(bit r/w) is_opendrain
11241124
This parameter only has an effect if the "is_output" parameter is True.
11251125
If this parameter is False, the GPIO behaves as a normal output pin:
1126-
the IO pin on the connector is driven to the value specified by the "out" HAL pin (possibly inverted), and the value of the "in" and "in_not" HAL pins is undefined.
1126+
The IO pin on the connector is driven to the value specified by the "out" HAL pin (possibly inverted), and the value of the "in" and "in_not" HAL pins is undefined.
11271127
If this parameter is True, the GPIO behaves as an open-drain pin.
11281128
Writing 0 to the "out" HAL pin drives the IO pin low, writing 1 to the "out" HAL pin puts the IO pin in a high-impedance state.
11291129
In this high-impedance state the IO pin floats (weakly pulled high), and other devices can drive the value;

docs/man/man9/lcd.9

Lines changed: 22 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -46,35 +46,28 @@ and, as the output format mimics the ADM3 terminal format, it could be used
4646
to stream data to a serial device. Perhaps even a genuine ADM3.
4747
The strings contain a mixture of text values (which are displayed directly),
4848
"escaped" formatting codes and numerical format descriptors.
49-
For a detailed description of formatting codes see:
50-
http://en.wikipedia.org/wiki/Printf
49+
For a detailed description of formatting codes see: http://en.wikipedia.org/wiki/Printf .
5150

52-
The component can be configured to display an unlimited number of
53-
differently-formatted pages, which may be selected with a HAL pin.
51+
The component can be configured to display an unlimited number of differently-formatted pages, which may be selected with a HAL pin.
5452
.TP
5553
\fBEscaped codes\fR
56-
\en Inserts a clear-to-end, carriage return and line feed character. This will
57-
still linefeed and clear even if an automatic wrap has occurred (lcd has no
58-
knowledge of the width of the lcd display.) To print in the rightmost column it
59-
is necessary to allow the format to wrap and omit the \en code.
54+
\en Inserts a clear-to-end, carriage return and line feed character.
55+
This will still linefeed and clear even if an automatic wrap has occurred (lcd has no knowledge of the width of the lcd display).
56+
To print in the rightmost column it is necessary to allow the format to wrap and omit the \en code.
6057

61-
\et Inserts a tab (actually 4 spaces in the current version rather than a true
62-
tab.)
58+
\et Inserts a tab (actually 4 spaces in the current version rather than a true tab.)
6359

6460
\eNN inserts the character defined by the hexadecimal code NN.
65-
As the ',' character is used in the format string to separate LCD instances
66-
it must be represented by \e2C in the format string. (the decimal
67-
separator is handled differently)
61+
As the ',' character is used in the format string to separate LCD instances it must be represented by \e2C in the format string (the decimal separator is handled differently).
6862

6963
\e\e Inserts a literal \e.
7064

7165
.TP
7266
\fBNumerical formats\fR
7367

7468
\fBlcd\fR differs slightly from the standard printf conventions.
75-
One significant difference is that width limits are strictly enforced to prevent the LCD display
76-
wrapping and spoiling the layout. The field width includes the sign character
77-
so that negative numbers will often have a smaller valid range than positive.
69+
One significant difference is that width limits are strictly enforced to prevent the LCD display wrapping and spoiling the layout.
70+
The field width includes the sign character so that negative numbers will often have a smaller valid range than positive.
7871
Numbers that do not fit in the specified width are displayed as a line of asterisks (\fB********\fR).
7972

8073
Each format begins with a "%" symbol. (For a literal % use "%%").
@@ -85,41 +78,33 @@ This is the default and is not strictly necessary.
8578

8679
"0" Pad the number to the specified width with the numeral 0.
8780

88-
"+" Force display of a + symbol before positive numbers. This (like the \- sign)
89-
will appear immediately to the left of the digits for a space-padded number
90-
and in the extreme left position for a 0-padded number.
81+
"+" Force display of a + symbol before positive numbers.
82+
This (like the \- sign) will appear immediately to the left of the digits for a space-padded number and in the extreme left position for a 0-padded number.
9183

92-
"1234567890" A numerical entry (other than the leading 0 above) defines the
93-
total number of characters to display including the decimal separator and the sign.
84+
"1234567890" A numerical entry (other than the leading 0 above) defines the total number of characters to display including the decimal separator and the sign.
9485
Whilst this number can be as many digits as required, the maximum field width is 20 characters.
95-
The inherent precision of the "double" data type means
96-
that more than 14 digits will tend to show errors in the least significant digits.
86+
The inherent precision of the "double" data type means that more than 14 digits will tend to show errors in the least significant digits.
9787
The integer data types will never fill more than 10 decimal digits.
9888

9989
Following the width specifier should be the decimal specifier.
10090
This can only be a full-stop character (.) as the comma (,) is used as the instance separator.
101-
Currently lcd does not access the locale information to determine the correct separator
102-
but the \fBdecimal\-separator\fR HAL parameter can be used to choose any desired separator.
91+
Currently lcd does not access the locale information to determine the correct separator but the \fBdecimal\-separator\fR HAL parameter can be used to choose any desired separator.
10392

104-
Following the decimal separator should be a number that determines
105-
how many places of decimals to display. This entry is ignored in the case of integer formats.
93+
Following the decimal separator should be a number that determines how many places of decimals to display. This entry is ignored in the case of integer formats.
10694

107-
All the above modifiers are optional, but to specify a decimal precision the
108-
decimal point must precede the precision, e.g., as in "%.3f".
95+
All the above modifiers are optional, but to specify a decimal precision the decimal point must precede the precision, e.g., as in "%.3f".
10996
The default decimal precision is 4.
11097

11198
The numerical formats supported are:
11299

113100
\fB%f %F\fR (for example, %+09.3f) These create a floating-point type HAL pin.
114-
The example would be displayed in a 9-character field, with 3 places of decimals,
115-
as a decimal separator, padded to the left with 0s and with a sign displayed for
116-
both positive and negative. Conversely a plain %f would be 6 digits of decimal,
101+
The example would be displayed in a 9-character field, with 3 places of decimals, as a decimal separator,
102+
padded to the left with 0s and with a sign displayed for both positive and negative. Conversely a plain %f would be 6 digits of decimal,
117103
variable format width, with a sign only shown for negative numbers.
118104
Both %f and %F create exactly the same format.
119105

120106
\fB%i %d\fR (For example %+ 4d) Creates a signed (s32) HAL pin.
121-
The example would display the value at a fixed 4 characters, space padded,
122-
width including the "+" giving a range of +999 to \-999. %i and %d create identical output.
107+
The example would display the value at a fixed 4 characters, space padded, width including the "+" giving a range of +999 to \-999. %i and %d create identical output.
123108

124109
\fB%u\fR (for example %08u) Creates an unsigned (u32) HAL pin.
125110
The example would be a fixed 8 characters wide, padded with zeros.
@@ -131,16 +116,14 @@ A width may be specified, though the u32 HAL type is only 8 hex digits wide.
131116
\fB%o\fR Creates an unsigned (u32) pin and displays the value in octal representation.
132117

133118
\fB%c\fR Creates a u32 HAL pin and displays the character corresponding to the value of the pin.
134-
Values less than 32 (space) are suppressed. A width specifier may be used,
135-
for example %20c might be used to create a complete line of one character.
119+
Values less than 32 (space) are suppressed. A width specifier may be used, for example %20c might be used to create a complete line of one character.
136120

137121
\fB%b\fR This specifier has no equivalent in printf.
138122
It creates a bit (boolean) type HAL pin. The b should be followed by two characters
139123
and the display will show the first of these when the pin is true, and the second when false.
140124
Note that the characters follow, not precede the "b", unlike the case with other formats.
141125
The characters may be "escaped" Hex values.
142-
For example "%b\eFF " will display a solid black block if true,
143-
and a space if false and "%b\e7F\e7E" would display right-arrow for false and left-arrow for true.
126+
For example "%b\eFF " will display a solid black block if true, and a space if false and "%b\e7F\e7E" would display right-arrow for false and left-arrow for true.
144127
An unexpected value of 'E' indicates a formatting error.
145128

146129
\fBPages\fR
@@ -150,8 +133,7 @@ A "Page" in this context refers to a separate format which may be displayed on t
150133
\fBInstances\fR
151134
The instance separator is the comma. This creates a completely separate lcd instance,
152135
for example to drive a second lcd display on the second 7I73.
153-
The use of comma to separate instances is built in to the modparam reading code
154-
so not even escaped commas "\e," can be used.
136+
The use of comma to separate instances is built in to the modparam reading code so not even escaped commas "\e," can be used.
155137
A comma may be displayed by using the \e2C sequence.
156138

157139
.SH AUTHOR

docs/man/man9/pwmgen.9

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,7 @@ The number of channels actually loaded depends on the number of \fItype\fR value
1515
The value of each \fItype\fR determines the outputs for that channel.
1616
.P
1717
.TP
18-
type 0: single output A single output pin, \fBpwm\fR, whose duty cycle is determined by the input value for positive inputs,
19-
and which is off (or at \fBmin\-dc\fR) for negative inputs.
18+
type 0: single output A single output pin, \fBpwm\fR, whose duty cycle is determined by the input value for positive inputs, and which is off (or at \fBmin\-dc\fR) for negative inputs.
2019
Suitable for single ended circuits.
2120
.TP
2221
type 1: pwm/direction
@@ -47,9 +46,7 @@ Operates on all channels at once.
4746
Enables PWM generator \fIN\fR - when false, all \fBpwmgen.\fIN\fR output pins are low.
4847
.TP
4948
\fBpwmgen.\fIN\fB.value\fR float in
50-
Commanded value. When \fBvalue\fR = 0.0, duty cycle is 0%,
51-
and when \fBvalue\fR = \(+-\fBscale\fR, duty cycle is \(+- 100%
52-
(subject to \fBmin\-dc\fR and \fBmax\-dc\fR limitations).
49+
Commanded value. When \fBvalue\fR = 0.0, duty cycle is 0%, and when \fBvalue\fR = \(+-\fBscale\fR, duty cycle is \(+- 100% (subject to \fBmin\-dc\fR and \fBmax\-dc\fR limitations).
5350
.TP
5451
\fBpwmgen.\fIN\fB.pwm\fR bit out (output types 0 and 1 only)
5552
PWM/PDM waveform.
@@ -69,8 +66,7 @@ Range is from \-1.0 to +1.0.
6966
.TP
7067
\fBpwmgen.\fIN\fB.max\-dc\fR float in/out
7168
The maximum duty cycle. A value of 1.0 corresponds to 100%.
72-
This can be useful when using transistor drivers with bootstrapped power supplies,
73-
since the supply requires some low time to recharge.
69+
This can be useful when using transistor drivers with bootstrapped power supplies, since the supply requires some low time to recharge.
7470
.TP
7571
\fBpwmgen.\fIN\fB.min\-dc\fR float in/out
7672
The minimum duty cycle. A value of 1.0 corresponds to 100%.
@@ -95,6 +91,5 @@ Because software-generated PWM uses a fairly slow timebase (several to many micr
9591
For example, if \fBmake\-pulses\fR is called at a 20 kHz rate, and \fBpwm\-freq\fR is 2 kHz, there are only 10 possible duty cycles.
9692
If \fBdither\-pwm\fR is false, the commanded duty cycle will be rounded to the nearest of those values.
9793
Assuming \fBvalue\fR remains constant, the same output will repeat every PWM cycle.
98-
If \fBdither\-pwm\fR is true, the output duty cycle will be dithered between the two closest values,
99-
so that the long-term average is closer to the desired level.
94+
If \fBdither\-pwm\fR is true, the output duty cycle will be dithered between the two closest values, so that the long-term average is closer to the desired level.
10095
\fBdither\-pwm\fR has no effect if \fBpwm\-freq\fR is zero (PDM mode), since PDM is an inherently dithered process.

docs/src/gui/qtdragon.adoc

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,8 @@ It will work in window mode on any monitor with higher resolution but not on mon
4646

4747
== Getting Started - The INI File
4848

49-
If your configuration is not currently set up to use QtDragon,
50-
you can change it by editing the INI file sections.
51-
For an exhaustive list of options, see the <<sub:ini:sec:display,display section>> of INI file documentation.
49+
If your configuration is not currently set up to use QtDragon, you can change it by editing the INI file sections.
50+
For an exhaustive list of options, see the <<sub:ini:sec:display,display section>> of the INI file documentation.
5251

5352
[NOTE]
5453
You can only have one of each section ( ie [HAL] ) in the INI file. If you see in these docs multiple section options
@@ -444,7 +443,7 @@ qtdragon.led-probe
444443

445444
These pins are inputs related to spindle VFD indicating. +
446445
The volt and amp pins are used to calculate spindle power.
447-
(You must also set the MAX_SPINDLE_POWER in the INI.)
446+
You must also set the MAX_SPINDLE_POWER in the INI.
448447

449448
[source,{hal}]
450449
----
@@ -584,8 +583,7 @@ It uses a HAL non-realtime component which utilizes the external offsets feature
584583
The component has a HAL pin that specifies an interpolation type, which must be one of cubic, linear or nearest (0, 1, 2 respectively).
585584
If none is specified or if an invalid number is specified, the default is assumed to be cubic.
586585

587-
When Z LEVEL COMP is enabled, the compensation component reads a probe data file,
588-
which must be called 'probe_points.txt'.
586+
When Z LEVEL COMP is enabled, the compensation component reads a probe data file, which must be called 'probe_points.txt'.
589587
The file can be modified or updated at any time while compensation is disabled.
590588
When next enabled, the file will be reread and the compensation map is recalculated.
591589
This file is expected to be in the configuration directory.
@@ -683,8 +681,11 @@ then the tool is lowered until it touches the plate, triggering the probe signal
683681
Z0 is set to probe height - plate thickness.
684682

685683
The second method uses a tool setter in a fixed position and a known height above the table where the probe signal will be triggered.
686-
In order to set Z0 to the top of the workpiece, it has to know how far above the table the probe trigger point is (tool setter height).
687-
and how far above the table the top of the workpiece is.
684+
In order to set Z0 to the top of the workpiece, it has to know
685+
686+
. how far above the table the probe trigger point is (tool setter height) and
687+
. how far above the table the top of the workpiece is.
688+
688689
This operation has to be done every time the tool is changed as the tool length is not saved.
689690

690691
For touching off with a touch probe, whether you use the touchplate operation with thickness set to 0 or use a probing routine,

docs/src/gui/qtvcp-widgets.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2549,7 +2549,7 @@ def _releasedOutput(self, btncode):
25492549
self['joy_{}_pressed'.format(btncode.lower())].emit(False)
25502550
----
25512551

2552-
As coded they these function _issue (emit) PyQt5 signals (joy_btn_pressed and joy_<letter>_pressed) for the any button pressed or released_.
2552+
As coded these function _issue (emit) PyQt5 signals (joy_btn_pressed and joy_<letter>_pressed) for the any button pressed or released_.
25532553

25542554
Signal 'joy_btn_pressed' outputs a string code for the button. +
25552555
Signal 'joy_<letter>_pressed' outputs a bool value.

0 commit comments

Comments
 (0)