Skip to content

Commit b04f53f

Browse files
smoehansu
authored andcommitted
docs: More changes while revisiting translations
1 parent a3433f9 commit b04f53f

3 files changed

Lines changed: 25 additions & 28 deletions

File tree

docs/src/gui/qtvcp-vismach.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -438,7 +438,8 @@ Z = Color([0, 0, 1, 1], [Z])
438438
origin = Collection([X,Y,Z])
439439
----
440440

441-
Add it to the Window class Collection so it is never moved from the origin.
441+
Add it to the Window class Collection so it is never moved from the origin.
442+
442443
[source,python]
443444
----
444445
v.model = Collection([origin, model, world])

docs/src/gui/qtvcp.adoc

Lines changed: 15 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,6 @@ All `<options>` must appear before `<screen_name>`.
133133
If `<screen_name>` is missing, the default screen will be loaded.
134134

135135
QtVCP assumes the UI file and the handler file use the *same base name*.
136-
137136
QtVCP will first search the LinuxCNC configuration directory that was launched for the files, then in the system skin folder holding standard screens.
138137

139138
.Cycle Times
@@ -146,13 +145,12 @@ GRAPHICS_CYCLE_TIME = 100
146145
HALPIN_CYCLE = 100
147146
----
148147

149-
Adjusts the response rate of the GUI updates in milliseconds. +
148+
Adjusts the response rate of the GUI updates in milliseconds.
150149
Defaults to 100, useable range 50 - 200.
151150

152151
The widgets, graphics and HAL pin update can be set separately.
153152

154-
If the update time is not set right the screen can become unresponsive
155-
or very jerky.
153+
If the update time is not set right the screen can become unresponsive or very jerky.
156154

157155
=== Qt Designer UI File
158156

@@ -169,7 +167,7 @@ A handler file is a file containing _Python_ code, which *adds to QtVCP default
169167
A handler file allows one to _modify defaults_, or _add logic_ to a QtVCP screen without having to modify QtVCP's core code.
170168
In this way you can have *custom behaviors*.
171169

172-
If present a handler file will be loaded. +
170+
If present a handler file will be loaded.
173171
*Only one file* is allowed.
174172

175173
=== Libraries Modules
@@ -178,7 +176,8 @@ QtVCP, as built, does little more than display the screen and react to widgets.
178176
For more *prebuilt behaviors* there are available libraries (found in `lib/python/qtvcp/lib` in RIP LinuxCNC install).
179177

180178
*Libraries* are prebuilt _Python modules_ that *add features* to QtVCP.
181-
In this way you can select what features you want - yet don't have to build common ones yourself. +
179+
In this way you can select what features you want - yet don't have to build common ones yourself.
180+
182181
Such libraries include:
183182

184183
* `audio_player`
@@ -227,8 +226,8 @@ In that folder, QtVCP will load any of the available following files:
227226
There are _three ways_ to customize a screen/panel.
228227

229228
.Minor StyleSheet Changes
230-
Stylesheets can be used to *set Qt properties*. +
231-
If a widget uses properties they usually can be modified by stylesheets.
229+
Stylesheets can be used to *set Qt properties*.
230+
If a widget uses properties then they usually can be modified by stylesheets.
232231

233232
.Example of a widget with accompanying style sheet settings.
234233
[source,{css}]
@@ -260,7 +259,8 @@ The default path is in the configuration directory as a hidden file using the sc
260259
This file will be read and executed as Python code in the *handler file context*.
261260

262261
*Only local functions and local attributes* can be referenced.
263-
Global libraries can not be referenced. (usually seen as all capital words with no preceding self.)
262+
Global libraries can not be referenced.
263+
These are usually seen as all capital words with no preceding self.
264264

265265
What can be used can vary by screen and development cycle.
266266

@@ -299,14 +299,12 @@ There are several *builtin HAL panels* available.
299299

300300
In a terminal type `qtvcp <return>` to see a list:
301301

302-
*`test_panel`*::
303-
Collection of useful widgets for testing HAL components, including speech of LED state.
302+
*`test_panel`*:: Collection of useful widgets for testing HAL components, including speech of LED state.
304303
+
305304
.QtVCP HAL Test Builtin Panel
306305
image::images/qtvcp_test_panel.png["QtVCP HAL Test Builtin Panel",align="center"]
307306

308-
*`cam_align`*::
309-
A camera display widget for rotational alignment.
307+
*`cam_align`*:: A camera display widget for rotational alignment.
310308
+
311309
.cam_align - Camera Alignment VCP
312310
image::images/qtvcp-cam-align.png["Qtscreen x1mill",align="center"]
@@ -318,8 +316,7 @@ image::images/qtvcp-cam-align.png["Qtscreen x1mill",align="center"]
318316
.QtVCP Sim Builtin Panel
319317
image::images/qtvcp_sim_panel.png["QtVCP Sim Builtin Panel",align="center"]
320318

321-
*`vismach_mill_xyz`*::
322-
3D openGL view of a 3-Axis milling machine.
319+
*`vismach_mill_xyz`*:: 3D OpenGL view of a 3-axis milling machine.
323320
+
324321
.QtVismach - 3-Axis Mill Builtin Panel
325322
image::images/qtvismach.png["QtVismach - 3-Axis Mill Builtin Panel",align="center"]
@@ -332,6 +329,7 @@ loadusr qtvcp test_panel
332329
----
333330

334331
But more typically like this:
332+
335333
[source,{hal}]
336334
----
337335
loadusr -Wn test_panel qtvcp test_panel
@@ -427,8 +425,7 @@ Necesitará privilegios de superusuario para copiar el archivo en la carpeta.
427425
////
428426

429427
.Add `qtvcp_plugin.py` link to the Qt Designer Search Path
430-
Then you must add a link to the `qtvcp_plugin.py` in one of the folders
431-
that Qt Designer will search into.
428+
Then you must add a link to the `qtvcp_plugin.py` in one of the folders that Qt Designer will search into.
432429

433430
In a _RIP_ version of LinuxCNC `qtvcp_plugin.py` will be:
434431

@@ -499,8 +496,7 @@ On the Object inspector click on the _ScreenOptions_. +
499496
Then switch to the Property Editor and, under the _ScreenOptions_ heading, toggle *`filedialog_option`*.
500497
//TODO Explain what this FileDialo_option does
501498

502-
Drag and drop a *`GCodeGraphics`* _widget_ and a *`GcodeEditor`*
503-
_widget_. +
499+
Drag and drop a *`GCodeGraphics`* _widget_ and a *`GcodeEditor`* _widget_. +
504500
Place and resize them as you see fit leaving some room for buttons.
505501

506502
.Add Action Buttons

docs/src/hal/halshow.adoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ _Reload tree view_ is useful when new components are loaded during runtime and s
9898
.Halshow: Show Tab
9999
image::images/halshow-show-tab.png["Halshow: Show Tab",align="center"]
100100

101-
Clicking on the node name in the tree, e.g. "Components", will show you (under the "Show" tab) all that HAL knows about the contents of that node.
101+
Clicking on the node name, "Components" in the tree for example, will show you (under the "Show" tab) all that HAL knows about the contents of that node.
102102
Figure <<fig:halshow-show-tab,Halshow Show Tab>> shows a list exactly like you will see if you click the "Components" name.
103103
The information display is exactly like those shown in traditional text based HAL analysis tools.
104104
The advantage here is that we have mouse click access, access that can be as broad or as focused as you need.
@@ -152,7 +152,8 @@ _Watch's_ refresh rate is a bit slow to see stepper pulses, but you can use it f
152152

153153
.New in 2.9
154154
****
155-
The pins and signals that are writable have buttons for manipulation on the right side. Pins that are linked to a signal have disabled buttons.
155+
The pins and signals that are writable have buttons for manipulation on the right side.
156+
Pins that are linked to a signal have disabled buttons.
156157
To set these values, the corresponding pin has to be unlinked from the signal.
157158
That can be done by right-click on the signal name and select "Unlink pin", see <<cap:watch-tab-context-menu,Watch Tach Context Menu>>.
158159
@@ -189,8 +190,7 @@ They will persist as long as LinuxCNC remains up but are gone as soon as LinuxCN
189190
The command entry has a BASH-like history (during the session), so you can restore inserted commands with the arrow up key.
190191
****
191192

192-
The entry box labeled "HAL Command:" will accept any of the commands listed for halcmd.
193-
These include:
193+
The entry box labeled "HAL Command:" will accept any of the commands listed for halcmd. These include:
194194

195195
- `loadrt`, `unloadrt` (load/unload real-time module)
196196
- `loadusr`, `unloadusr` (load/unload non-realtime component)
@@ -246,7 +246,7 @@ ID Type Name
246246
02 User iocontrol
247247
----
248248

249-
Sure enough there it is. Notice that its ID is 08.
249+
Sure enough, there it is. Notice that its ID is 08.
250250
Next we need to find out what functions are available with it so we look at functions:
251251

252252
----
@@ -265,8 +265,8 @@ Owner CodeAddr Arg FP Users Name
265265
04 E0B614AD E0DC7448 YES 1 stepgen.update-freq
266266
----
267267

268-
Here we look for owner #08 and see a function named ddt.0.
269-
We should be able to add ddt.0 to the servo thread and it will do its math each time the servo thread is updated.
268+
Here we look for owner #08 and see a function named `ddt.0`.
269+
We should be able to add `ddt.0` to the servo thread and it will do its math each time the servo thread is updated.
270270
Once again we look up the addf command and find that it uses three arguments like this:
271271

272272
[source,{hal}]
@@ -294,7 +294,7 @@ image::images/halshow-2.png["Addf command",align="center"]
294294
Next we need to connect ddt to something.
295295
But how do we know what pins are available?
296296
The answer is to look under pins.
297-
There we find ddt and see this:
297+
There we find `ddt` and see this:
298298

299299
----
300300
Component Pins:

0 commit comments

Comments
 (0)