Skip to content

Commit 0207414

Browse files
committed
docs: whatever was noticed while translating
1 parent 5e9005f commit 0207414

7 files changed

Lines changed: 53 additions & 64 deletions

File tree

docs/src/config/python-interface.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -321,7 +321,8 @@ see <<python:reading-ini-values,ReadingINI file values>> for an example.
321321
*settings*:: '(returns tuple of floats)' -
322322
current interpreter settings: +
323323
settings[0] = sequence number, +
324-
settings[1] = feed rate, settings[2] = speed, +
324+
settings[1] = feed rate, +
325+
settings[2] = speed, +
325326
settings[3] = `G64 P` blend tolerance, +
326327
settings[4] = `G64 Q` naive CAM tolerance.
327328

docs/src/gcode/coordinates.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ command would not have been modal and any commands issued after it would
148148
have returned to using the G55 offsets because that coordinate system
149149
would still be in effect.
150150

151-
[source,{ngc}]
151+
[source,{ngc}](((G54)))(((G55)))(((G56)))(((G57)))(((G58)))(((G59)))(((G59.1)))(((G59.2)))(((G59.3)))
152152
----
153153
G54 uses parameters of coordinate system 1
154154
G55 uses parameters of coordinate system 2

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

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,17 @@
1212
:css: {basebackend@docbook:'':css}
1313

1414
This document attempts to be a 'best practices' reference for general use screen development. +
15-
While it's possible to program just about anything to work with linuxcnc, using common frame work,
16-
language and configuration requirements allows easier transition between screens and more developers
17-
to maintain them. +
15+
While it is possible to program just about anything to work with LinuxCNC, using a common frame work,
16+
language and configuration requirements allows easier transition between screens and more developers to maintain them. +
1817
That said, nothing in this document is written in stone.
1918

2019
== Language
21-
Python is currently the preferred language of linuxcnc's screen code. +
20+
Python is currently the preferred language of LinuxCNC's screen code. +
2221
Python has a low entry bar for new users to modify the screens to suit them. +
23-
Python has a rich array of documentation, tutorials and libraries to pull from. +
24-
It is already used and integrated into linuxcnc's system requirements. +
22+
Python has a rich array of documentation, tutorials and libraries to pull from. +
23+
It is already used and integrated into LinuxCNC's system requirements. +
2524
While C or C\++ could be used, it severely limits who can maintain and develop them. +
26-
It would be better to extend python with C/C++ modules for whatever function that requires it.
25+
It would be better to extend Python with C/C++ modules for whatever function that requires it.
2726

2827
== Localization of float numbers in GUIs
2928
Different locales use different decimal separators and thousands separators. Locale-specific
@@ -37,16 +36,16 @@ are suggested if parsing float to string and vice-versa:
3736

3837
== Basic Configuration
3938
Currently, most screens use a combination of INI file and preference file entries to configure their functions. +
40-
INi text files are usually used for the common machine controller settings, while text based preference files
39+
INI text files are usually used for the common machine controller settings, while text based preference files
4140
are used for more GUI related properties (such as sounds, size, colors). +
42-
There can be other files used for translations, stylizing and function customization. These are highly dependent
41+
There can be other files used for translations, stylizing and function customization. These are highly dependent
4342
on the underlying widget toolkit.
4443

4544
=== INI [DISPLAY]
4645
The *[DISPLAY]* section of the INI is for specifying screen related settings. +
4746

4847
==== Display
49-
The most important of is specifying the name of the screen that the linuxcnc script will use to load. +
48+
The most important of is specifying the name of the screen that the LinuxCNC script will use to load. +
5049
The screen program usually recognizes switches such as to set full screen. +
5150
Title is for the window title and icon is used for iconizing the window.
5251

@@ -93,7 +92,7 @@ ANGULAR_INCREMENTS = continuous, .5, 1, 45, 90, 360
9392
----
9493

9594
==== Machine Type Hint
96-
The screen often needs to be adjusted based on machine type. Lathes have different controls and display DROs
95+
The screen often needs to be adjusted based on machine type. Lathes have different controls and display DROs
9796
differently. Foam machine display the plot differently. +
9897
The old way to do this was adding switches LATHE = 1, FOAM = 1 etc
9998

@@ -124,15 +123,15 @@ DEFAULT_LINEAR_VELOCITY =
124123
MIN_LINEAR_VELOCITY =
125124
MAX_LINEAR_VELOCITY =
126125
127-
DEFAULT_ANGULAR_VELOCITY =
128-
MIN_ANGULAR_VELOCITY =
129-
MAX_ANGULAR_VELOCITY =
126+
DEFAULT_ANGULAR_VELOCITY =
127+
MIN_ANGULAR_VELOCITY =
128+
MAX_ANGULAR_VELOCITY =
130129
----
131130

132131
==== Spindle Manual Controls
133132
Manual controls for spindle control could be, (or a combinations of) buttons, sliders or dials +
134133
You can set limits that are less then the what the machine controller can utilize by setting these entries. +
135-
If your screen is capable of running multiple spindles, then should accept entries higher then the shown '_0_'
134+
If your screen is capable of running multiple spindles, then should accept entries higher then the shown '_0_'.
136135

137136
[source,{ini}]
138137
----
@@ -156,8 +155,8 @@ MDI_COMMAND_MACRO1 = G53 G0 Z0;G53 G0 X0 Y0,Goto\nMachn\nZero
156155
----
157156

158157
=== INI [FILTER]
159-
This section allows setting of what files are shown in the file chooser and
160-
what filter programs will preprocess its output before sending it to linuxcnc. +
158+
This section allows setting of what files are shown in the file chooser and
159+
what filter programs will preprocess its output before sending it to LinuxCNC. +
161160
The extensions follow this pattern: +
162161
PROGRAM_EXTENSION = .extension,.extension2[space]Description of extensions +
163162
The filter program definitions are such: +
@@ -179,7 +178,7 @@ py = python3
179178
----
180179

181180
=== INI [HAL]
182-
Most screens will need some HAL pins. They need to be connected after the screen creates them.+
181+
Most screens will need some HAL pins. They need to be connected after the screen creates them.
183182

184183
==== Postgui Halfile
185184
These files should be run one after another in order, after all the GUI HAL pins have been made.
@@ -204,8 +203,8 @@ POSTGUI_HALCMD = loadusr halmeter
204203
== Extended Configuration
205204

206205
=== Embedding GUI Elements
207-
Allowing users to build small panels independently, that can be embedded into the main screen
208-
is a common and very useful customization. Some screens allow embedding of 3rd party foreign programs,
206+
Allowing users to build small panels independently, that can be embedded into the main screen
207+
is a common and very useful customization. Some screens allow embedding of 3rd party foreign programs,
209208
others only the native widget toolkit based panels. +
210209
Usually these are embedded in tabs or side panel widgets. +
211210
This is how to describe the optional title, loading command and location widget name: +
@@ -233,7 +232,7 @@ MESSAGE_ICON = INFO
233232
----
234233

235234
This style gives multiple messages defined by a number. +
236-
This example shows 3 possible messages based around a VFD error nuumber.
235+
This example shows 3 possible messages based around a VFD error number.
237236

238237
[source,{ini}]
239238
----

docs/src/gui/qtvcp-libraries.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -652,7 +652,7 @@ as the widgets get a reference to the `MainWindow` from the `_hal_init()` functi
652652
from qtvcp.qt_makegui import VCPWindow
653653
----
654654

655-
* *Instantiate `VCPWindow` module*+
655+
* *Instantiate `VCPWindow` module* +
656656
Add this Python code to your instantiate section:
657657
+
658658
[source,python]

docs/src/gui/qtvcp-vismach.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -309,7 +309,7 @@ Either by adding the component object as the first variable and substituting the
309309
by substituting the full component/pinname string for a coordinate. +
310310

311311
This example creates a _rectangular prism with opposite corners_ at the specified positions and edges parallel to the XYZ axes. +
312-
the Z start coordinate will be controlled by the HAL pin 'Zstart'
312+
The Z start coordinate will be controlled by the HAL pin 'Zstart'.
313313

314314
[source,python]
315315
----

docs/src/gui/qtvcp.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -974,8 +974,8 @@ If QtVCP finds these it will call them, if not it will silently ignore them.
974974
_Class patching_, also known as _monkey patching_, allows to *override function calls in an imported module*. +
975975
Class patching must be done _before the module is instantiated_, and it _modifies all instances_ made after that. +
976976
An example might be patching button calls from the G-code editor to call functions in the handler file instead. +
977-
Class patching function redefined here, will be called with the HandlerClass instance as 'self' rather then +
978-
the patched class instance. This can make access to the patched class function/variables more difficult. +
977+
Class patching function redefined here, will be called with the HandlerClass instance as 'self' rather than the patched class instance.
978+
This can make access to the patched class function/variables more difficult. +
979979
When class patching outside of the HandlerClass class, the function call will use the patched class instance as 'self'.
980980

981981
*`initialized__(self):`*::

docs/src/man/man9/hostmot2.9.adoc

Lines changed: 26 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -477,13 +477,12 @@ There is a limit of 64 bits in total.
477477

478478
The valid format characters and the pins they create are:
479479

480-
p: (Pad)::
481-
Does not create any pins, used to ignore sections of the bit stream that are not required.
480+
p: (Pad):: Does not create any pins, used to ignore sections of the bit stream that are not required.
482481

483-
b: (Boolean).:: (bit, out) hm2_XXXX.N.ssi.MM.<name>.
484-
If any bits in the designated field width are non-zero then the HAL pin will be "True".
485-
(bit, out) hm2_XXXX.N.ssi.MM.<name>-not. An inverted version of the above, the
486-
HAL pin will be "True" if all bits in the field are zero.
482+
b: (Boolean).:: (bit, out) hm2_XXXX.N.ssi.MM.<name>. +
483+
If any bits in the designated field width are non-zero then the HAL pin will be "True". +
484+
(bit, out) hm2_XXXX.N.ssi.MM.<name>-not. +
485+
An inverted version of the above, the HAL pin will be "True" if all bits in the field are zero.
487486

488487
u: (Unsigned):: (float, out) hm2_XXXX.N.ssi.MM.<name>.
489488
The value of the bits
@@ -492,35 +491,26 @@ u: (Unsigned):: (float, out) hm2_XXXX.N.ssi.MM.<name>.
492491
example if the field is 8 bits wide and the scalmax parameter was 20
493492
then a value of 255 would return 20, and 0 would return 0.
494493

495-
s: (Signed):: (float, out) hm2_XXXX.N.ssi.MM.<name>.
496-
The value of the bits
497-
interpreted as a 2s complement signed number then scaled similarly to
494+
s: (Signed):: (float, out) hm2_XXXX.N.ssi.MM.<name>. +
495+
The value of the bits interpreted as a 2s complement signed number then scaled similarly to
498496
the unsigned variant, except symmetrical around zero.
499497

500-
f: (bitField):: (bit, out) hm2_XXXX.N.ssi.MM.<name>-NN.
501-
The value of each individual
502-
bit in the data field. NN starts at 00 up to the number of bits in the
503-
field. (bit, out) hm2_XXXX.N.ssi.MM.<name>-NN-not. An inverted version
504-
of the individual bit values.
505-
506-
e: (Encoder):: (s32, out) hm2_XXXX.N.ssi.MM.<name>.count.
507-
The lower 32 bits of the
508-
total encoder counts. This value is reset both by the ...reset and the
509-
...index-enable pins. (s32, out) hm2_XXXX.N.ssi.MM.<name>.rawcounts.
510-
The lower 32 bits of the total encoder counts. The pin is not affected
511-
by reset and index. (float, out) hm2_XXXX.N.ssi.MM.<name>.position.
512-
The encoder position in machine units. This is calculated from the
513-
full 64-bit buffers so will show a True value even after the counts
514-
pins have wrapped. It is zeroed by reset and index enable. (bit, IO)
515-
hm2_XXXX.N.ssi.MM.<name>.index-enable. When this pin is set "True" the
516-
module will wait until the raw encoder counts next passes through an
517-
integer multiple of the number of counts specified by counts-per-rev
518-
parameter and then it will zero the counts and position pins, and set
519-
the index-enable pin back to "False" as a signal to the system that
520-
"index" has been passed. this pin is used for spindle-synchronised
521-
motion and index-homing. (bit, in) (bit, out)
522-
hm2_XXXX.N.ssi.MM.<name>.reset. When this pin is set high the counts
523-
and position pins are zeroed.
498+
f: (bitField):: (bit, out) hm2_XXXX.N.ssi.MM.<name>-NN. +
499+
The value of each individual bit in the data field.
500+
NN starts at 00 up to the number of bits in the field. +
501+
(bit, out) hm2_XXXX.N.ssi.MM.<name>-NN-not. +
502+
An inverted version of the individual bit values.
503+
504+
e: (Encoder):: (s32, out) hm2_XXXX.N.ssi.MM.<name>.count. +
505+
The lower 32 bits of the total encoder counts. This value is reset both by the ...reset and the ...index-enable pins. +
506+
(s32, out) hm2_XXXX.N.ssi.MM.<name>.rawcounts. +
507+
The lower 32 bits of the total encoder counts. The pin is not affected by reset and index. +
508+
(float, out) hm2_XXXX.N.ssi.MM.<name>.position. +
509+
The encoder position in machine units. This is calculated from the full 64-bit buffers so will show a True value even after the counts pins have wrapped. It is zeroed by reset and index enable. +
510+
(bit, IO) hm2_XXXX.N.ssi.MM.<name>.index-enable. +
511+
When this pin is set "True" the module will wait until the raw encoder counts next passes through an integer multiple of the number of counts specified by counts-per-rev parameter and then it will zero the counts and position pins, and set the index-enable pin back to "False" as a signal to the system that "index" has been passed. this pin is used for spindle-synchronised motion and index-homing. +
512+
(bit, in) (bit, out) hm2_XXXX.N.ssi.MM.<name>.reset. +
513+
When this pin is set high the counts and position pins are zeroed.
524514
h: (Split encoder, high-order bits)::
525515
Some encoders (Including Fanuc) place the encoder part-turn counts and
526516
full-turn counts in separate, non-contiguous fields. This tag defines
@@ -545,11 +535,10 @@ m: (Multi-turn)::
545535
Two parameters are universally created for all SSI instances
546536

547537
hm2_XXXX.N.ssi.MM.frequency-khz (float r/w)::
548-
This parameter sets the SSI clock frequency. The units are kHz, so 500
549-
will give a clock frequency of 500,000 Hz.
538+
This parameter sets the SSI clock frequency. The units are kHz, so 500 will give a clock frequency of 500,000 Hz.
550539
hm2_XXXX.N.ssi.timer-number-num (s32 r/w)::
551-
This parameter allocates the SSI module to a specific hm2dpll timer
552-
instance. This pin is only of use in firmwares which contain a hm2dpll
540+
This parameter allocates the SSI module to a specific hm2dpll timer instance.
541+
This pin is only of use in firmwares which contain a hm2dpll
553542
function and will default to 1 in cases where there is such a
554543
function, and 0 if there is not. The pin can be used to disable reads
555544
of the encoder, by setting to a nonexistent timer number, or to 0.

0 commit comments

Comments
 (0)