gmoccapy: update docs

Author: hansu

docs/src/gui/gmoccapy.adoc

@@ -1134,56 +1134,27 @@ You have three options:
 * _hide cursor_ - Does allow to hide the cursor, what is very useful if you use a touch screen.
 * _hide tooltips_ - Hides the tool tips.
 
-.Virtual Keyboard
+.Jog Area
 
-The checkboxes allow the user to select if he wants the on board keyboard to be shown immediately
-when entering the MDI Mode, the offset page, the tooledit widget or when open a program in the EDIT mode.
-The keyboard button on the bottom button list will not be affected by these settings, so you are able to show or hide the keyboard by pressing the button.
+* _Jog button size_ - Change the size of the job buttons in the manual mode page
+* _Width right panel_ - Change the width of the right part of window (= width of the DRO)
 
-The default setting is:
 
-* _Show keyboard on offset_ = False
-* _Show keyboard on tooledit_ = False
-* _Show keyboard on MDI_ = True 
-* _Show keyboard on EDIT_ = True 
-* _Show keyboard on load file_ = False
+[[gmoccapy:turtle-jog]]
+.Turtle Jog
+This settings will have influence on the jog velocities.
 
-[NOTE]
-If this section is not sensitive, you have not installed a virtual keyboard, supported ones are _onboard_ and _matchbox-keyboard_.
+* _Hide turtle jog button_ - Will hide the button right of the jog velocity slider.
+  If you hide this button, please take care that the "rabbit mode" is activated,
+  otherwise you will not be able to jog faster than the turtle jog velocity,
+  which is calculated using the turtle jog factor.
+* _Turtle jog factor_ - Sets the scale to apply for turtle jog mode (button pressed, showing the turtle).
+  If you set a factor of 20, the turtle max. jog velocity will be 1/20 of the max. velocity of the machine.
 
 [NOTE]
-====
-If the keyboard layout is not correct, i.e. clicking Y gives Z, than the layout has not been set properly, related to your locale settings.
-For onboard it can be solved with a small batch file with the following content:
-
-----
-#!/bin/bash
-setxkbmap -model pc105 -layout de -variant basic
-----
-
-The letters "de" are for German, you will have to set them according to your locale settings.
-Just execute this file before starting LinuxCNC, it can be done also adding a starter to your local folder.
-
-----
-./config/autostart
-----
-
-So that the layout is set automatically on starting.
-
-For matchbox-keyboard you will have to make your own layout, for a German layout ask in the forum.
-====
-
-.GMOCCAPY with Onboard keyboard in edit mode
-image:images/gmoccapy_keyboard_edit_mode_mid.png["Onboard keyboard",align="left",link="images/gmoccapy_keyboard_edit_mode.png"]
-
-.On Touch Off
-
-This gives the option whether to show the preview tab or the offset page tab when you enter the touch off mode by clicking the corresponding bottom button.
-
-* _show preview_
-* _show offsets_
+This button can be controlled using the <<gmoccapy:jog-velocity,Turtle-Jog HAL Pin>>.
 
-.DRO Options
+.DRO
 You have the option to select the background colors of the different DRO states.
 So users suffering from protanopia (red/green weakness) are able to select proper colors.
 
@@ -1212,7 +1183,7 @@ making it easier to set the value, as you will not need to go over the touch off
 Imperial will show one digit more that metric.
 So if you are in imperial machine units and set the digit value to 1, you will get no digit at all in metric.
 ====
-* _toggle DRO mode_ - If not active, a mouse click on the DRO will not take any action. +
+* _Toggle DRO mode by clicking on the DRO_ - If not active, a mouse click on the DRO will not take any action. +
   By default this checkbox is active, so every click on any DRO will toggle the DRO readout from actual to relative to DTG (distance to go). +
   Neverthereless a click on the axis letter will open the popup dialog to set the axis value.
 
@@ -1259,25 +1230,164 @@ You are able to set some options:
 * _Max. messages_ - The maximum number of messages you want to see at once.
   If you set this to 10, the 11^th^ message will delete the first one, so you will only see the last 10.
 * _Font_ - The font and size you want to use to display the messages.
+* _Font filter_ - A filter for the font chooser above.
 * _Use frames_ - If you activate the checkbox, each message will be displayed in a frame,
   so it is much easier to distinguish the messages. But you will need a little bit more space.
 * _Launch test message_-button - It will show a message, so you can see the changes of your settings without the need to generate an error.
 
 
-.Themes and Sounds
+.Themes
+
+* _Theme_ - This lets the user select what desktop theme to apply. By default "Follow System Theme" is set.
+
+* _Icon Theme_ - Change the icon theme. Currently there are three themes available:
+  - classic
+  - material
+  - material light
+
++
+For more information and how to create custom icon themes, see section <<gmoccapy:icon-theme-section,Icon Theme>>.
+
+
+* _G-code Theme_ - Select a colour theme for the G-code viewer/editor.
+
+* _G-code Font_ - Select a font for the G-code viewer/editor. Default is "monospace 10".
+
+.Sound
+
+Select what error and messages sounds should be played and if sound should be played at all.
+
+
+=== Behaviour
+
+.GMOCCAPY settings page Behaviour
+image::images/gmoccapy_settings_behaviour.png["Configuration page",align="left"]
+
+.Virtual Keyboard
+
+The checkboxes allow the user to select if he wants the on board keyboard to be shown immediately
+when entering the MDI Mode, the offset page, the tooledit widget or when open a program in the EDIT mode.
+The keyboard button on the bottom button list will not be affected by these settings, so you are able to show or hide the keyboard by pressing the button.
+
+The default setting is:
+
+* _Show keyboard on offset_ = False
+* _Show keyboard on tooledit_ = False
+* _Show keyboard on MDI_ = True 
+* _Show keyboard on EDIT_ = True 
+* _Show keyboard on load file_ = False
+
+[NOTE]
+If this section is not sensitive, you have not installed a virtual keyboard, supported ones are _onboard_ and _matchbox-keyboard_.
+
+[NOTE]
+====
+If the keyboard layout is not correct, i.e. clicking Y gives Z, than the layout has not been set properly, related to your locale settings.
+For onboard it can be solved with a small batch file with the following content:
+
+----
+#!/bin/bash
+setxkbmap -model pc105 -layout de -variant basic
+----
 
-This lets the user select what desktop theme to apply and what error and messages sounds should be played.
+The letters "de" are for German, you will have to set them according to your locale settings.
+Just execute this file before starting LinuxCNC, it can be done also adding a starter to your local folder.
 
-By default "Follow System Theme" is set.
+----
+./config/autostart
+----
 
-It further allows to change the icon theme.
-Currently there are three themes available:
+So that the layout is set automatically on starting.
 
-* classic
-* material
-* material light
+For matchbox-keyboard you will have to make your own layout, for a German layout ask in the forum.
+====
 
-To create custom icon themes, see section <<gmoccapy:icon-theme-section,Icon Theme>> for details.
+.GMOCCAPY with Onboard keyboard in edit mode
+image:images/gmoccapy_keyboard_edit_mode_mid.png["Onboard keyboard",align="left",link="images/gmoccapy_keyboard_edit_mode.png"]
+
+.On Touch Off
+
+This gives the option whether to show the preview tab or the offset page tab when you enter the touch off mode by clicking the corresponding bottom button.
+
+* _show preview_
+* _show offsets_
+
+
+.Run from Line
+
+You can allow or disallow the run from line.
+This will set the corresponding button insensitive (grayed out), so the user will not be able to use this option.
+The default is disable run from line.
+
+[WARNING]
+It is not recommend to use run from line, as LinuxCNC will not take care of any previous lines in the code before the starting line.
+So errors or crashes are fairly likely.
+
+
+.Keyboard shortcuts
+
+Some users want to jog their machine using the keyboard buttons and there are others that will never allow this.
+So everybody can select whether to use them or not. +
+Keyboard shortcuts are disabled by default. They can be activated by the checkbox
+
+* _Use keyboard shortcuts_
+
+[WARNING]
+It is not recommended to use keyboard jogging, as it represents a serious risk for operator and machine.
+
+Please take care if you use a lathe, then the shortcuts will be different,
+see the <<gmoccapy:lathe-section,Lathe Specific Section>>.
+****
+General::
+
+ * _F1_ - Trigger Estop (will work even if keyboard shortcuts are disabled)
+ * _F2_ - Toggle machine on/off
+ * _F3_ - Manual mode
+ * _F5_ - MDI mode
+ * _ESC_ - Abort
+
+In Manual Mode::
+
+ * _Arrow_Left_ or _NumPad_Left_ - Jog X minus
+ * _Arrow_Right_ or _NumPad_Right_ - Jog X plus
+ * _Arrow_up_ or _NumPad_Up_ - Jog Y plus
+ * _Arrow_Down_ or _NumPad_Down_ - Jog Y minus
+ * _Page_Up_ or _NumPad_Page_Up_ - Jog Z plus
+ * _Page_Down_ or _NumPad_Page_Down_ - Jog Z minus
+
+In Auto Mode::
+
+ * _R_ or _r_ - Run program
+ * _P_ or _p_ - Pause program
+ * _S_ or _s_ - Resume program
+ * _Control + R_ or _Control + r_ - Reload the loaded file
+
+Message handling (see <<gmoccapy:message-behavior,Message behavior and appearance>>)::
+
+ * _WINDOWS_ - Delete last message
+ * _Control + Space_ - Delete all messages
+****
+
+.File to load on start up
+
+Select the file you want to be loaded on start up.
+If a file is loaded, it can be set by pressing the current button.
+To avoid that any program is loaded at start up, just press the None button.
+
+The file selection screen will use the filters you have set in the INI file,
+if there aren't any filters given, you will only see *NGC files*.
+The path will be set according to the INI settings in `[DISPLAY] PROGRAM_PREFIX`.
+
+.Jump to dir
+
+You can set here the directory to jump to if you press the corresponding button in the file selection dialog.
+
+// image::images/gmoccapy_file_selection_dialog_with_keyboard.png["Directory selection",align="left"]
+
+
+.File and folder list
+
+For the file chooser page it is possible to change the sorting options with these parameters.
 
 === Hardware
 
@@ -1318,7 +1428,7 @@ MAX = 6000
 It is no error giving wrong values.
 If you give a maximum of 2000 and your spindle makes 4000 RPM, only the bar level will be wrong on higher speeds than 2000 RPM.
 
-.Unlock options
+.Unlock settings
 
 There are three options to unlock the settings page:
 
@@ -1328,19 +1438,6 @@ There are three options to unlock the settings page:
 
 Default is _use unlock code_ (default code is *123*).
 
-[[gmoccapy:turtle-jog]]
-.Turtle Jog
-This settings will have influence on the jog velocities.
-
-* _Hide turtle jog button_ - Will hide the button right of the jog velocity slider.
-  If you hide this button, please take care that the "rabbit mode" is activated,
-  otherwise you will not be able to jog faster than the turtle jog velocity,
-  which is calculated using the turtle jog factor.
-* _Turtle jog factor_ - Sets the scale to apply for turtle jog mode (button pressed, showing the turtle).
-  If you set a factor of 20, the turtle max. jog velocity will be 1/20 of the max. velocity of the machine.
-
-[NOTE]
-This button can be controlled using the <<gmoccapy:jog-velocity,Turtle-Jog HAL Pin>>.
 
 [[gmoccapy:advanced-settings]]
 === Advanced Settings
@@ -1408,77 +1505,6 @@ The tool will be loaded after all axes are homed, because before it is not
 allowed to execute MDI commands. If you use NO_FORCE_HOMING you can not use
 this feature, because the needed all_homed_signal will never be emitted.
 
-.File to load on start up
-
-Select the file you want to be loaded on start up.
-If a file is loaded, it can be set by pressing the current button.
-To avoid that any program is loaded at start up, just press the None button.
-
-The file selection screen will use the filters you have set in the INI file,
-if there aren't any filters given, you will only see *NGC files*.
-The path will be set according to the INI settings in `[DISPLAY] PROGRAM_PREFIX`.
-
-.Jump to dir
-
-You can set here the directory to jump to if you press the corresponding button in the file selection dialog.
-
-// image::images/gmoccapy_file_selection_dialog_with_keyboard.png["Directory selection",align="left"]
-
-
-.Run from Line
-
-You can allow or disallow the run from line.
-This will set the corresponding button insensitive (grayed out), so the user will not be able to use this option.
-The default is disable run from line.
-
-[WARNING]
-It is not recommend to use run from line, as LinuxCNC will not take care of any previous lines in the code before the starting line.
-So errors or crashes are fairly likely.
-
-
-.Keyboard shortcuts
-
-Some users want to jog their machine using the keyboard buttons and there are others that will never allow this.
-So everybody can select whether to use them or not. +
-Keyboard shortcuts are disabled by default. They can be activated by the checkbox
-
-* _Use keyboard shortcuts_
-
-[WARNING]
-It is not recommended to use keyboard jogging, as it represents a serious risk for operator and machine.
-
-Please take care if you use a lathe, then the shortcuts will be different,
-see the <<gmoccapy:lathe-section,Lathe Specific Section>>.
-****
-General::
-
- * _F1_ - Trigger Estop (will work even if keyboard shortcuts are disabled)
- * _F2_ - Toggle machine on/off
- * _F3_ - Manual mode
- * _F5_ - MDI mode
- * _ESC_ - Abort
-
-In Manual Mode::
-
- * _Arrow_Left_ or _NumPad_Left_ - Jog X minus
- * _Arrow_Right_ or _NumPad_Right_ - Jog X plus
- * _Arrow_up_ or _NumPad_Up_ - Jog Y plus
- * _Arrow_Down_ or _NumPad_Down_ - Jog Y minus
- * _Page_Up_ or _NumPad_Page_Up_ - Jog Z plus
- * _Page_Down_ or _NumPad_Page_Down_ - Jog Z minus
-
-In Auto Mode::
-
- * _R_ or _r_ - Run program
- * _P_ or _p_ - Pause program
- * _S_ or _s_ - Resume program
- * _Control + R_ or _Control + r_ - Reload the loaded file
-
-Message handling (see <<gmoccapy:message-behavior,Message behavior and appearance>>)::
-
- * _WINDOWS_ - Delete last message
- * _Control + Space_ - Delete all messages
-****
 
 [[gmoccapy:icon-theme-section]]
 == Icon Theme

docs/src/gui/images/gmoccapy_3_axis.png

@@ -3858,7 +3858,7 @@ uncomment selection</property>
                                         <property name="can-focus">False</property>
                                         <property name="xpad">5</property>
                                         <property name="ypad">5</property>
-                                        <property name="label" translatable="yes">Width right pane</property>
+                                        <property name="label" translatable="yes">Width right panel</property>
                                         <property name="xalign">0</property>
                                       </object>
                                       <packing>
@@ -4345,6 +4345,7 @@ clicking on the DRO</property>
                                           <object class="GtkLabel" id="label8">
                                             <property name="visible">True</property>
                                             <property name="can-focus">False</property>
+                                            <property name="tooltip-text" translatable="yes">Grid size in Inch</property>
                                             <property name="margin-start">3</property>
                                             <property name="hexpand">True</property>
                                             <property name="label" translatable="yes">Grid size</property>
@@ -4360,6 +4361,7 @@ clicking on the DRO</property>
                                           <object class="GtkSpinButton" id="grid_size">
                                             <property name="visible">True</property>
                                             <property name="can-focus">True</property>
+                                            <property name="tooltip-text" translatable="yes">Grid size in Inch</property>
                                             <property name="invisible-char">●</property>
                                             <property name="xalign">1</property>
                                             <property name="primary-icon-activatable">False</property>