Update Docs: add Thumbnail info, add xorg.log, optimize and organize images (#447)

* Update Docs: add Thumbnail info, add xorg.log, optimize pngs

* Organize images in subfolders

README.md

@@ -6,10 +6,13 @@ KlipperScreen is a touchscreen GUI that interfaces with [Klipper](https://github
 
 [Click here to access the documentation.](https://klipperscreen.readthedocs.io/en/latest/)
 
-Screenshots are included in the documentation.
 
 ### Inspiration
 KlipperScreen was inspired by [OctoScreen](https://github.com/Z-Bolt/OctoScreen/) and the need for a touchscreen GUI that
 will natively work with [Klipper](https://github.com/kevinOConnor/klipper) and [Moonraker](https://github.com/arksine/moonraker).
 
-![Main Menu](docs/img/main_panel.png)
+
+![Main Menu](docs/img/panels/main_panel.png)
+
+
+[More Screenshots](https://klipperscreen.readthedocs.io/en/latest/panels/)

docs/Changelog.md

@@ -2,12 +2,12 @@
 
 Breaking changes will be listed here.
 
-#### 2022 01 09
+#### [2022 01 11](https://github.com/jordanruthe/KlipperScreen/commit/8a8c6c064cc6d097b1b34a5c42b4001367e545a6)
 * The Preheat panel has been deprecated in favor of an all in one Temperature panel
 
 Remove preheat panel from your Klipperscreen.conf or replace the occurrences of preheat with temperature
 
-#### 2021 05 20
+#### [2021 05 20](https://github.com/jordanruthe/KlipperScreen/commit/8a8c6c064cc6d097b1b34a5c42b4001367e545a6)
 * Default configuration is not merged if a user configuration is set for a specific option
 
 For instance, if `menu __main` is user defined, the main menu will not have any defaults.

docs/Panels.md

@@ -1,15 +1,15 @@
 # Panels
 
 ### Main Menu
-![Main Menu](img/main_panel.png)
+![Main Menu](img/panels/main_panel.png)
 
 ### Job Status
-![Job Status](img/job_status.png)
+![Job Status](img/panels/job_status.png)
 
 ### Bed Level
 type: bed_level
 
-![Bed Level](img/bed_level.png)
+![Bed Level](img/panels/bed_level.png)
 
 The bed level panel has the ability to have preset locations from Klipper. Please see documentation on the following
 Klipper Sections:
@@ -26,74 +26,74 @@ panel.
 ### Bed Mesh
 type: bed_mesh theme:material-dark
 
-![Bed Mesh](img/bed_mesh.png)
+![Bed Mesh](img/panels/bed_mesh.png)
 
 ### Extrude
 type: extrude theme:material-dark
 
-![Extrude](img/extrude.png)
+![Extrude](img/panels/extrude.png)
 
 ### Fan
 type: fan
 
-![Fan](img/fan.png)
+![Fan](img/panels/fan.png)
 
 ### Fine Tune
 type: fine_tune theme:custom
 
-![Fine Tune Panel](img/fine_tune.png)
+![Fine Tune Panel](img/panels/fine_tune.png)
 
 ### Gcode Macros
 type: gcode_macros theme: material-darker
 
-![Gcode Macros Panel](img/gcode_macros.png)
+![Gcode Macros Panel](img/panels/gcode_macros.png)
 
 ### Menu
 type: menu
 
-![Menu Panel](img/menu.png)
+![Menu Panel](img/panels/menu.png)
 
 ### Move
 type: move
 
-![Move Panel](img/move.png)
+![Move Panel](img/panels/move.png)
 
 ### Network
 type: network
 
-![Network Panel](img/network.png)
+![Network Panel](img/panels/network.png)
 
 ### Power
 type: power
 
-![Power](img/power.png)
+![Power](img/panels/power.png)
 
 ### Print
 type: print
 
-![Print Panel](img/print.png)
+![Print Panel](img/panels/print.png)
 
 ### Settings
 type: settings theme:colorized
 
-![Settings](img/settings.png)
+![Settings](img/panels/settings.png)
 
 ### System
 type: system
 
-![System Panel](img/system.png)
+![System Panel](img/panels/system.png)
 
 ### Temperature
 type: temperature theme:custom
 
-![Temperature](img/temperature.png)
+![Temperature](img/panels/temperature.png)
 
 ### Z Calibrate
 type: zcalibrate
 
-![Z Calibrate](img/zcalibrate.png)
+![Z Calibrate](img/panels/zcalibrate.png)
 
 ### Limits
 type: limits theme: material-dark
 
-![Limits](img/limits.png)
+![Limits](img/panels/limits.png)

docs/Quicktips.md

@@ -1,11 +1,10 @@
 # Quicktips
 quick tips, without much explanation
 
-### Hide macros, outputs or fans
 
-As you probably already noticed, you can show and hide the gcode macros in the interface settings, but there is more…
-
-Did you know, that you can also hide gcode macros by prefixing the name with an underscore?
+## Hide macros, outputs or fans
+As you probably already noticed, you can show and hide the gcode macros in the interface settings,
+but you can also hide gcode macros by prefixing the name with an underscore.
 
 ```
 [gcode_macro MY_AWESOME_GCODE]
@@ -29,3 +28,47 @@ Lets hide a temperature_fan:
 
 fan1 will show in the interface, but _fan2 will be hidden.
 
+
+## Thumbnails
+KlipperScreen can display thumbnails in the file browser and as previews in the print status.
+
+
+![Job Status](img/panels/job_status.png)
+
+
+* [PrusaSlicer](#PrusaSlicer)
+* [SuperSlicer](#SuperSlicer)
+* [Cura](#Cura)
+* [ideaMaker](#ideaMaker)
+
+### PrusaSlicer
+In “Expert” mode PrusaSlicer has an option in the “Printer Settings” tab to activate previews.
+Under General / Firmware.
+
+
+![PrusaSlicer](img/quicktips/PrusaSlicer-thumbnails.png)
+
+
+### SuperSlicer
+In “Expert” mode SuperSlicer has some very convenient options in the “Printer Settings” tab to activate and customize the previews.
+
+
+![SuperSlicer](img/quicktips/SuperSlicer-thumbnails.png)
+
+
+### Cura
+The Cura plugin [“Cura2Moonraker”](https://github.com/emtrax-ltd/Cura2MoonrakerPlugin) is required for this.
+
+
+![Cura](img/quicktips/Cura-thumbnails.png)
+
+
+### ideaMaker
+To enable thumbnails, open the Advanced tab in the printer settings, enable the GCode Thumbnails for Octoprint and Mainsail option and enter your prefered square format image size in the Resolution fields (e.g. 400 X 400). It’s necessary that the thumbnail width and height resolution is equal.
+
+
+![IdeaMaker4](img/quicktips/IdeaMaker-thumbnails.png)
+
+
+## Supported Macros
+[Macros](macros.md)

docs/Theming.md

@@ -29,5 +29,5 @@ window { background-image: url("/home/pi/mainsail/img/background.svg");}
 button {background-color: rgba(0,0,0,0); border-radius:2em;}
 ```
 
-![Custom theme example with background](img/theme_example.png)
+![Custom theme example with background](img/theming/theme_example.png)
 

docs/Troubleshooting.md

@@ -4,12 +4,12 @@ This page will have common problems and common solutions to those problems.
 
 ## First Steps
 
-The first step to troubleshooting any problem is getting the cause of the error. KlipperScreen log output will occur
-in two places. Check for the file `/tmp/KlipperScreen.log` and look at the contents by running
-`cat /tmp/KlipperScreen.log` or grabbing the file over WinSCP or another scp program.
+The first step to troubleshooting any problem is getting the cause of the error.
+Check for the file `/tmp/KlipperScreen.log` and look at the contents by running
+`cat /tmp/KlipperScreen.log` or grab the file over WinSCP or another sftp program.
 
-If that file is non-existent, there is a problem in KlipperScreen starting up. To get the error output in this case,
-run `journalctl -xe -u KlipperScreen`.
+If that file is non-existent, run `journalctl -xe -u KlipperScreen` and check `/var/log/Xorg.0.log`
+where you can find issues with the X server.
 
 
 ## Common Errors
@@ -51,13 +51,10 @@ the proper drivers.
 ### Touch not working on debian Bullseye
 
 Some dsi screens have issues where touch doesn't work with debian bullseye, the current fix
-(at least until upstream is fixed) consist in editing `/boot/config.txt` and changing:
+(at least until upstream is fixed) consist in runnig `raspi-config`> go to Advanced > GL Driver
+select G2 and reboot.
 
-`dtoverlay=vc4-kms-v3d`
+![config](img/troubleshooting/gldriver.png)
 
-to:
-
-`dtoverlay=vc4-fkms-v3d`
-
-and reboot. That should make the touch work, if your screen is rotated 180 degrees, then you may need to adjust
+That should make the touch work, if your screen is rotated 180 degrees, then you may need to adjust
 [the touch rotation](Hardware.md) as described in the Hardware page.

docs/index.md

@@ -12,15 +12,13 @@ A physical touchscreen is not strictly required, for example you may install a r
 
 Main Menu
 
-![Main Menu](img/main_panel.png)
+![Main Menu](img/panels/main_panel.png)
 
 Job Status
 
-![Job Status](img/job_status.png)
+![Job Status](img/panels/job_status.png)
 
 [More](panels.md)
-### Supported Macros
-[More](macros.md)
 
 ### Inspiration
 KlipperScreen was inspired by [OctoScreen](https://github.com/Z-Bolt/OctoScreen/) and the need for a touchscreen GUI that

docs/macros.md

@@ -1,10 +1,9 @@
 # Supported Macros
-Klipperscreen supports gcode_macros in various panels.
 
 ## Extrude Panel
 
 ### LOAD_FILAMENT / UNLOAD_FILAMENT
-Load and Unload Filament macro is used in the Extrude-Panel if it is available.
+Load and Unload Filament macros are used in the Extrude-Panel if it is available.
 The selected speed is transferred to this macro.
 The following example macros show how this can be used in the macro.
 
@@ -42,3 +41,16 @@ gcode:
     M300
     M300
 ```
+
+```
+[gcode_macro UNLOAD_FILAMENT]
+gcode:
+    {% set max_velocity = printer.configfile.settings['extruder'].max_extrude_only_velocity %}
+    G91
+    M300 # beep
+    G92 E0
+    G1 E{speed} F300 # purge
+    G1 E-420 F{max_velocity}
+    M300
+    M300
+```

mkdocs.yml

@@ -3,10 +3,12 @@ nav:
     - Hardware.md
     - Installation.md
     - Configuration.md
+    - Quicktips.md
     - Theming.md
     - Troubleshooting.md
-    - changelog.md
-    - panels.md
+    - Translations.md
+    - Changelog.md
+    - Panels.md
     - Contact.md
 theme: readthedocs
 repo_url: https://github.com/jordanruthe/KlipperScreen/