ghostkeeper / settingsguide Goto Github PK

when trying to edit g-code in machine settings, the guide pops up and covers the g-code field preventing from sort of editing.

Get from the configuration file (cura.cfg) the language parameter in the general section. And use this information to define the new root for the md description file in order to add the possibility to integrate translated description file.

Hello,
Can you add polish translate ?
Thank you

After installing the plugin the background for the side-menu content is transparent. The plugin itself works. Cura 5.0.0, installed your latest version from the marketplace.
I used the default dark theme modified with a bigger font size, but changing to the default light theme hadn't fixed it either.
theme.txt

If you open the Cura Settings Guide (BEST CURA PLUGIN EVER!), then click in the main window, the guide gets hidden behind the main window and won't automatically come forward. This may confuse some (it did me for a while) because it appears as if the window has closed, but it will not reopen by reselecting the guide, as you would expect it to if it had closed.

Application version
All tested, 4.5.* through 4.7.1

Platform
Mac OSX Catalina (10.15.6)

Printer
Irrelevant

Reproduction steps

1. Open Cura Settings Guide
2. Click in main window
3. ::Poof::

Screenshot(s)
(Image showing the problem, perhaps before/after images.)

Actual results
Settings Guide window gets hidden by main window, with no way to bring it forward without minimizing or moving the main window. No "Windows" menu exists (I understand why) to choose which window is front-most, and reselecting "Cura Settings Guide" or right-clicking on a setting fails to bring the window forward.

Expected results
The window should either refuse to be hidden (as with the Marketplace window, which just throws a beep at you if you click outside of it), or, 1) there should be a "Windows" menu which lists open windows to select from (In understand why this is not there - there are usually no multiple windows in Cura - this menu could be set to only appear if there is a second window of some sort), or, 2) reselecting "Cura Settings Guide" from either the Extension menu or via right click on a setting should bring the window forward again.

Project file
N/A

Log file
N/A

Additional information
N/A

Would be great to have the possibility to define the tooltip width in case of using the setting 'Show articles in setting tooltip'. If the help is a very long article not all the complete text is visible in the help. Enlarge the tooltip windows will ensure the possibility to visualize the complete help article !

The plugin refuses to launch on the new 5.0.0 Cura beta release (SDK v8.0.0), when can we expect an update / workaround? Thanks!

Ultimaker Dark makes some bitmaps hardly readable. Some cannot be read (see Cooling/Fan Speed : there's some light grey text displayed in transparency mode. Could they be displayed on a white background ?

Keyboard navigation with the arrow keys is missing. But the spacebar opens/closes subitems as expected. Arrow keys (up/down) would make the navigation much easier. No need to look at the list, point and click, and then go back to the contents. Could be read as a pdf.

Is this the standard behaviour ? It works the same in Cura, the arrow keys events being sent to the 3D viewer even when the focus is somewhere in the SideBar.

In "Wipe Nozzle Between Layers", the last paragraph has "debris" misspelled as "debree".

On high resolution systems it is hard to read the guide due to small font sizes and also the images look quite small on a high resolution system.

It would be good to have a simple plus or minus symbol in order to increase or decrease the viewing size, much like modern web browsers have. It would certainly make it more accessible to a wider audience.

I tried a couple of different common hotkeys used by modern browsers to increase the size of the viewing experience but to no avail.

I would like to thank you for your time and help working on this great project.

Could be nice in the setting description to have the name of the Cura parameter. Something wich could be automaticaly add to the description ?

I'd like to add a troubleshooting article about imprecise prints and dimensional accuracy.

This needs to deal with the aspect of shrinkage, overextrusion and the way the material gets pushed out of the way by previously printed things. Shrinkage is an issue for big parts. Overextrusion is an issue everywhere but mainly for small parts. The way the material gets pushed out of the way by other parts is an issue in the walls.

Shrinkage should be quite obvious and refer to the shrinkage article to guide the user to fix it.

Overextrusion needs an explanation as to why it's a problem. Perhaps name a common source for overextrusion that causes dimensional inaccuracy: Wall Overlap Compensation, and flow changes when moving to a thinner outer wall.

The way material gets pushed aside needs a thorough explanation and diagrams to help the reader visualise what's going on. Essentially, this is the issue where you're printing the inner wall first, and it has all the space in the world to flow out on both sides, resulting in a wider line than intended. When the outer wall is then printed next to it, it gets pushed further out to one side, effectively doubling the inaccuracy caused by the meniscus shape of the bead. A similar issue happens when lines cross, but that is irrelevant for dimensional accuracy since lines only cross in the infill in Cura, and infill isn't on the outside of the print.

There is another common cause: Badly calibrated steppers and backlash in the gantry. Those are printer issues, nothing Cura can really do anything about. May be worth mentioning though.

This is going to be quite a difficult article to write, because there are so many aspects to it, and the results I have experience with may be quite different from what most people experience. This definitely needs a lot of research.

Cura 5,x, Wintel 10/64bit
SettingsGuied 2.9.0.

What's the problem:
When searching for specific setting Cura unfolds all catagories tabs showing all settings.

What should have happened:
Cura should return only the settings that includes the searched keyword.

Solution / workaround:
Uninstalling the plug for search to work as intended.

Hello,

Is it possible to add in the parameter list also the printer settings ?

When the Settings Guide gets opened, it is synch'd with the settings category. Could it automatically open the help for the item that has the focus in the sidebar ?

Description: When open the plugin through right click on a setting, the window opens but it doesn't show any information.
Funny thing though is that if you select a setting in the plugin, then close the dialog, then right click on a different setting and open the plugin again, the selected setting is still incorrect, the title is also incorrect but the description is actually the one from the setting that I want to look at.

Version: 1.2.0

Operating System: macOS

Reproduce steps:

1. Open Cura (with the plugin installed)
2. Open print settings panel
3. Right click on "Layer Height". Select Setting Guide

Actual result: The dialog appears but not information about the selected setting.

Expected result: The dialog shows information about "Layer Height".

Reproducibility: 100%

Hello,

When clicking a bitmap, it is displayed in a popup, but this popup is limited to the Cura Settings Guide window boudaries.

It seems to me that there was'nt such a problem with the previous version.

Also, it is displayed transparent. Could it be opaque on a white background, and larger (maybe 3x instead of 2x) ?

Hello,
First off, thanks for taking the time to build a great add-on package! It does a great job documenting the Cura features and the images are fantastic to help explain some of the nuances of Cura.

I'm using Cura 4.13.1 with Settings Guide 2.8.1 on Windows 10 and the issue I'm running into is being able to view the full settings guide window for a Cura feature. The settings guide window pops up normally when I mouse over a feature but for some reason, the scroll bar does not show up on the right side of the resulting settings guide screen so I'm unable to see the bottom of the guide. Further, when I mouse off of the Cura feature and over to the settings guide screen, the guide disappears. I've tried all the usual keys (up/down arrows, pgup/pgdown) and still am unable to scroll. Interestingly, when I right click on a feature and then click on the "settings guide" selection in the drop-down menu, a settings guide window pops up that does allow me to scroll up and down but it doesn't appear to be the same content.

Am I missing a step to allow me to scroll the settings guide window or is there an issue with this?

I'd like to add a new article about having gaps in the surface, prints not being watertight.

There's two kinds that could be addressed. Gaps are caused by underextrusion, in which case they are everywhere. And there's gaps arising from where line types are supposed to meet, but don't, like between the skin and infill.

Underextrusion gaps should refer to the underextrusion article, and give a few extra suggestions for things that are common to cause actual gaps. I'm thinking having too wide a line width or printing too fast.

Gaps between different line types are more interesting. We should address both the case between skin and walls and the case between infill and walls. The case between infill and skin can be omitted then. People will get the idea. We should explain the physical aspect of why this occurs at these boundaries: As the nozzle creates lines and turns back, the line it just created isn't solidified yet and will be pulled along back, causing it to regress a little bit from its intended endpoint. Main ways to resolve these issues are, from the top of my head:

• Infill/skin overlap settings.
• Printing slower.
• Increasing temperature.
• Not using a lines pattern / using connected infill lines or zigzag pattern.

There's also a really common question from people asking why there's gaps in their walls in layer view because they accidentally enabled coasting, or it was enabled for them in a profile. I don't think it's in scope to address this since it's a problem with layer view rather than the actual print. But it's something to consider.

1. Enable "show articles in settings tooltips"
2. Open Settings visibility in preferences, hover the cursor over settings.

Side-note: the text under the left picture of "Connect Top/bottom Polygons says "Naive concentric pattern", should it be "native"?
Side-note2: The text under "minimum support area" Starts with "The raison d'être for", should be "The reason for"?

Maybe it is an any idea to create a gitbook ( https://www.gitbook.com/ ) from the articles?

I often point towards article in this repo when I answer a question from a external forum. Having these available as pdf or online book could make it more clear for the not-programmers on there.

I want to ask for the addition of the Brazilian Portuguese language to the settings guide, please help me with my work, thank you.

While tree support can be activated at the same time as ordinary support, this is generally not desirable.

It's no longer the case since 4.8. Perhap's a modification can be made in the original text according to the Cura release ?

Hello,

After upgrading my Cura to 4.9.1 from 4.8.0 my settings guide no longer displays correctly and seems to be too large for the allowable area.


I am running a Macbook Air running version 10.13.6.
Thanks M.

Initially raised the issue at Master fork here:

smartavionics/Cura#170

The settings guide has the following incorrect information under the setting "Enable Draft Shield":

The draft shield can double as a Prime Tower. Since it's printed before the object, the printing of the draft shield is a way to get the material purged and properly flowing.

This information is only partially correct. Yes, the draft shield for a given layer is printed before the part on that layer, but it is not the first thing printed by a newly selected extruder, so it does not serve the function of priming the extruder. After the first layer, each extruder in a 2 extruder machine prints two layers at a time. The draft shield is indeed printed before the part on a given layer, but that extruder will have to print it's portion of the previous layer first, then the draft shield for the new layer, and finally the part on the new layer. The other extruder then comes and finishes that new layer, prints the draft shield for the subsequent layer, then prints the part on the subsequent layer. So each time there is an extruder change, the newly selected extruder has to first print a layer of the part, before it prints a layer of the draft shield. That means that the draft shield does not actually prime the newly selected extruder. To illustrate, here is the order of operations for the first few layers:

Layer 1: Extruder 1 prints the bed adhesion (skirt or brim), then prints the part, then prints the draft shield. Extruder 2 prints it's portion of the bed adhesion (if applicable), then the part. On this first layer, the bed adhesion serves to prime extruder 2.
Layer 2: Extruder 2, still selected, then prints the draft shield for layer two and finally part layer 2. Extruder 1 then comes in and prints layer 2 of the part (there is no priming operation first).
Layer 3: Extruder 1, still selected, then prints the draft shield for layer three and then prints part layer 3. Extruder 2 then comes in and prints layer 3 of the part (again, no prime).
Layer 4: Extruder 2, still selected, prints draft shield layer 4, then part layer 4. Extruder 1 prints part layer 4 (no prime first).
Layer 5: Extruder 1, still selected, prints draft shield layer 5, then part layer 5. Extrude 2 prints part layer 5 (no prime first).

That pattern continues for the whole part. After layer 1, each extruder must print its portion of the layer in progress, without any priming activity, then print the draft shield for a new layer and print its portion of that new layer. I dearly wish there was a way for the draft shield (or ooze shield) to serve as an extruder primer, but as it stands, it does not serve that function. This is easy enough to demonstrate by simply slicing a two color file and watching the animation for each layer in the preview window.

I'd like to add a troubleshooting article about banding.

Banding is caused by there being differences in the print process or the model geometry across the Z dimension. This is very generic, so the article would need to list a couple of common occurrences:

• Difference in geometry, e.g. a horizontal surface causing skin, which is solid and prevents shrinkage, while infill allows shrinkage.
• Model splitting into multiple parts, e.g. because of a screw hole.
• Differences in environment, e.g. part of the print was printed at night when it's colder in the room.
• Adaptive layers, different layer heights.
• General periodic change, like the nozzle getting clogged halfway through the print.

To showcase this in a photograph, using Adaptive Layers is probably the easiest.

The current implementation of the extended "Hints" in the Machine Settings dialogue appear to be restricted to the child window frame. As a result this means that all of the hints provided will at least partially obscure the Start and End GCode sections, while the Marlin Flavour and GCode hints will obscure the entire window. This obstruction requires little more than leaving the mouse cursor in an inopportune location - such as might be done haphazardly when looking for issues in one of the two GCode sections.

The same restriction also means that these dialogues can extend well beyond what is visible, with no means of actually scrolling to see what has been truncated.

I'm unsure as to what a suitable alternative would be. The information is useful, even if only to a specific audience, but the dialogues are simply too large to be confined like that. Their size also means that popping out to the sides - as is the case for print settings - may still not provide enough room, but at least it wouldn't obscure the remainder of the Settings window.

Testing done using Cura 5.1, Settings Guide 2.9.0, under Win11 on a 1920x1080 desktop at 100% scale.

See Ultimaker/Cura#10893

The SettingsGuide plugin generate a lot of error message in the log file with the new Cura release.

Cura 4.9.1 Windows 10 .
Ie : 2021-05-15 15:37:16,344 - WARNING - [MainThread] UM.Qt.QtApplication.__onQmlWarning [411]: file:///C:/Users/5axes/AppData/Roaming/cura/4.9/plugins/SettingsGuide2/SettingsGuide2/resources/qml/SettingsGuide.qml:223:4: QML Connections: Implicitly defined onFoo properties in Connections are deprecated. Use this syntax instead: function onFoo(<arguments>) { ... } 2021-05-15 15:37:16,346 - WARNING - [MainThread] UM.Qt.QtApplication.__onQmlWarning [411]: file:///C:/Logiciels_Cetim/Ultimaker/Ultimaker Cura 4.9.1/qml/UM/RecolorImage.qml:16:5: QML Image: Cannot open: file:///C:/Users/5axes/AppData/Roaming/cura/4.9/plugins/SettingsGuide2/SettingsGuide2/resources/icons/camera.svg 2021-05-15 15:37:16,374 - WARNING - [MainThread] UM.Qt.QtApplication.__onQmlWarning [411]: file:///C:/Users/5axes/AppData/Roaming/cura/4.9/plugins/SettingsGuide2/SettingsGuide2/resources/qml/SettingsSidebar.qml:120:4: QML Connections: Implicitly defined onFoo properties in Connections are deprecated. Use this syntax instead: function onFoo(<arguments>) { ... } 2021-05-15 15:37:16,401 - WARNING - [MainThread] UM.Qt.QtApplication.__onQmlWarning [411]: file:///C:/Users/5axes/AppData/Roaming/cura/4.9/plugins/SettingsGuide2/SettingsGuide2/resources/qml/SettingsGuide.qml:19:2: QML Connections: Implicitly defined onFoo properties in Connections are deprecated. Use this syntax instead: function onFoo(<arguments>) { ... } .... etc

2.9.0 on Cura 5.0.0 as well as Cura 5.1.0

Preferences/Configure Cura.../Printers/Machine Settings - Hover over inputs especially Start and End G-code, Settings dialog completely blocks input fields. This forces you to quickly enter the desired value prior to the Settings dialog opening.

Thanks ! Settings Guide is back !!!

But the window is not resizable under Windows 10. The mouse cursor changes when it goes over the borders, but the borders can't be grabbed...

(I don't remember with 3.6)

Just wanted to say thank you to @Ghostkeeper and all the contributors for this awesome plugin. I didn't know it existed but now that I do, I'll never use Cura without it :) It really helps when I forget something and it basically covers all details I'd go online to find.

Incorrect display insite the if statement

Just instaled the 4.5 beta release of Cura, the SettingsGuide Plugin is not available in the cura menu.

Hello,
I regularly stumble over "Walls->Hole Horizontal Expansion". I think, the implementation in Cura is non-intuitive. It would be great, if the guide would include, how exactly the number affects holes. The guide already explains that positive numbers make holes bigger but not by how much. Intuitively, i would expect that the diameter is increased by the entered value, but instead it seems to work similar to "Horizontal Expansion", where the value indicates the displacement of the walls. So if you enter a setting of 1mm the hole diameter will increase by 2mm. Maybe someone could confirm that? If I'm right, I would suggest to add the following to the guide:

The entered value indicates the displacement of the walls. So a value of 1mm will increase hole diameters by 2mm.

Hello Ghostkeeper
This is not realy an issue but more a question concerning the translation of the glossary.md new page.

• If we translate in a different langage the alphabetique order will not be preserved. Should we have to modify also the initial order ?
• I want to keep the term in English after translation. Is that ok for you?

Hoiw to reproduce the bug :

1 - open Cura Setting Guide
2 - click an image or an animation*
3 - close Cura Settings
4 - right click ( 🥇 ) another parameter
5 - Cura Settings Guide will open the help for the new parameter, but with the previous bitmap/popup/animation overlapping the new one

When closing Cura Settings Guide, the main window should close the maximized popup/bitmap/animation

(also, the title always have (undefined) following "Cura Settings Guide")

Settings Guide lives in a modal window. This makes sense when using only one monitor. On a multi head computer, it would be great to have the help on the 2nd monitor, non modal, with an automatic synchronization (parameter <-> help). I think that many people use at least 2, even with a laptop.

A workaround I've been using since 3.6 is opening a 2nd Cura instance. But there is no synch...

Reword the last bit to clarify that it only stops at the end if lift head is enabled. One could interpret it as if the printer would wait regardless of the setting. I had to read that more than a few times.

New article suggestion in the troubleshooting section

Layer Separation and Splitting

• Print temperature is too low
• Layer height is too large
• Print Speed is too high

Pop up windows are too small and I can’t see a way to make them bigger or even to scroll within them.

Cura 5.0, windows 10, plug-in version 2.9.0

I'd like to add a troubleshooting article that helps the user to create parts that are stronger. While it's not technically a print defect, it's still a common question that people have.

Topics to discuss in this article are:

• Terminology between different types of strength: Hardness/Young's Modulus, yield strength, toughness, etc. And how prints can be strong in one direction but weak in another. How we want to increase strength without increasing printing time and material usage. This serves as an introduction as to why you'd want to optimise this as well, and to make the reader realise that simply going for 100% density might as well be the best solution.
• How to adjust the model to make it tougher.
• The walls normally provide the majority of the strength of the part, rather than the infill. So increase the wall thickness.
• Increasing infill density, and different patterns.
• Improving layer adhesion.
• Improving horizontal adhesion between infill and walls (requires #61).
• Optimising the direction of the layers and lines to improve strength in a certain direction. Also using the Infill Line Directions and Top/Bottom Line Directions settings.
• Stiffness, for the case of flexible filaments.

2020-01-31 16:35:41,787 - ERROR - [MainThread] UM.Settings.ContainerStack.getConfigurationTypeFromSerialized [342]: Could not get configuration type: 'type'

When printing the serialized data:

[general]
version = 4
name = settings_guide_stack
id = settings_guide_stack

[metadata]

[containers]
0 = empty
1 = empty
2 = empty
3 = empty
4 = empty
5 = empty
6 = settings_guide_stack_settings #2
7 = settings_guide_definitions

Is it possible to have also in the regular Windows of the SettingsGuide the dependance parameter as we have in the tooltip.

Could be nice to have in the "troubleshooting" section a new article dedicate to the new settings of the 5.0 release compare to the 4.X parameters ( mainly on the shell section parameter and concerning the wall distribution) . The idea is to identify and resume in one page the new parameters.

Note : this article could be located in the troubleshooting section as many user don't know how to modify their existing profile with the new settings

Good evening . Congratulations on the amazing work you have done with this extension
I ask your permission to add the Greek language

Drag and Drop of the Cura package for installation doesn't install correctly the new version in Cura.

Tested on Win10 with Cura 4.9 and 4.10 with the SettingsGuide2.7.0-sdk7.0.0.curapackage file.

hereafter the error message in cura after the restart

the same parameter is define two times in Articles
support/support_infill_angle.md
&
support/support_infill_angles.md