GithubHelp home page GithubHelp logo

costas-basdekis / marlingcodedocumentation Goto Github PK

View Code? Open in Web Editor NEW
18.0 18.0 8.0 803 KB

Displays GCode documentation for Marlin in the Octoprint terminal command line

Python 22.59% CSS 4.55% JavaScript 49.43% Less 0.12% Jinja 23.31%

marlingcodedocumentation's People

Contributors

costas-basdekis avatar impact123 avatar jessehawkins avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

marlingcodedocumentation's Issues

"Include from" causes unsightly overlap

I suggest that these changes be made to stop this:

https://i.imgur.com/PHy8UU3.png

Change from:

/octoprint_marlingcodedocumentation/templates/marlingcodedocumentation.jinja2:81: Include from Marlin
/octoprint_marlingcodedocumentation/templates/marlingcodedocumentation.jinja2:85: Include from RepRap
/octoprint_marlingcodedocumentation/templates/marlingcodedocumentation.jinja2:89: Include from Klipper

Change to:

/octoprint_marlingcodedocumentation/templates/marlingcodedocumentation.jinja2:81: Marlin
/octoprint_marlingcodedocumentation/templates/marlingcodedocumentation.jinja2:85: RepRap
/octoprint_marlingcodedocumentation/templates/marlingcodedocumentation.jinja2:89: Klipper

End result:

https://i.imgur.com/DvBgBPH.png

While writing this, it occured to me that this setting might make more sense to bury in a settings page with other plugins. Perhaps some users with multiple printers might need to switch between documentation on the fly, but then just have an option to show/hide these on the console tab.

Problem with documentation for command M121

For command M120, the documentation says:

Enable endstops and keep them enabled when not homing

For command M121, the documentation says:

Disable endstops and keep them enabled when not homing

Notice that both commands say that the endstops will remain ENABLED when not homing. I THINK that for M121, it is supposed to read keep them disabled when not homing?

not an issue but a request

I am hoping for an option to turn off the "Are you sure you want to replace the current command?" box

Terminal Font Remains Styled After Uninstall

When uninstalling, the terminal GCODE is still displayed in the style (css) given to it by MarlinGcodeDocumentation. This makes reading on a dark theme extremely difficult. I have both uninstalled and re-installed Themeify to try and fix the issue, with no luck.

Klipper documentation doesn't seem to be working

I'm starting to use klipper for the first time and the plugin doesn't seem to recognise any of the commands.
I tried switching on plugin logging but the log shows nothing unusual. I also don't seem to find any errors in the inspect console.
Anything I should look into?

Klipper documentation seems broken

First, let me thank you for this wonderful plugin that I learned to appreciate while using Marlin. Now that I begin experimenting with Klipper I noticed that most of the klipper entries seem broken where "traditional" gcode commangs are concerned and mostly missing when it comes to those klipper specific "human-readable" commands and macros.
As far as I understand the plugin scrapes the respective firmware's gcode documentation page for the supported commands. Klipper seems to describe a few of the supported commands in details and apparently refers to other pages for the rest. Some commands like G10 are just mentioned and end up without a brief description in the plugin.
Klipper also allows defining all kinds of additional makros that can be used like the predefined ones. It would be fantastic to have some kind of documentation for those.
Would it be feasable to have some additional way of adding or eve modifying the standard information source for the languages, maybe by means of some json file structured like what updater.py feeds into all_codes.js? This information could be a kind of overlay to the scraped data, augmenting it with missing information (e.g. missing brief description, etc) and additional macros.

Feature request: Add an option to default to all collapsed.

Whenever I reload the OctoPrint interface my list of saved g-codes loads with all expanded. I then have to click the Collapse All button to see the full list (or more of the full list) like an index. I know, it's just another button press, but I want to be lazy. ;-)

This could be another item to put in the configuration window that I requested in issue #12.

Klipper Support

Hi!

Let me first say this is very useful as it is. I use Klipper and many of the commands are not recognized, I was just wondering if someday there could be support for Klipper. Thanks!

DroneMang

Fails to Work with MultiLine Terminal

If using Multi Line Terminal (0.1.3) plugin, this fine plugin fails to show GCode help.
Not sure what you can do to fix that tho as two or more lines might garble up the page.
Maybe add a ? to perform the actual info - I could live with that.
Thought about this some more - only offer help on last line!

Great plugin, just some thoughts

The basic idea is great, since you get the documentation right there where you need it! Thank you for providing this. :-)

Some thoughts:

I think it would be better, if the tab or the frame showing the documentation, could be placed below the Terminal buttons (below the "Advanced options..." link).

Also some top and bottom padding between the lines, especially to the buttons, would slightly improve readability.

There should be an option or switch to disable the how to use box.

Interference from autoscroll plugin

With both this plugin and autoscroll plugin installed, the "expand all" and "collapse all" buttons get over written to "now" and "now" after scrolling back in the terminal history. Not sure if this is a fault here or with autoscroll.

Feature request: Add configuration for the documentation repository selections

Having the check boxes for which documentation repositories are used on the main interface is getting really cluttered. I use consolidated tabs and all the selections don't fit so I can't see all of them:
2021-03-13 16_27_41-10% 06_58 (printing)

It would be nice to move these to a configuration interface to reduce the clutter. Maybe have a quick link to the configuration page (like a pencil icon next to the expand and collapse buttons) instead of always having to find it in the OctoPrint configuration window.

Plugin issues

I am running multiple instances of OctoPrint, in all of the instances, this plug in is not producing references for the commands. I have tried dozens of commands and nothing, all say Unknown Command, I have uninstalled the plugin, done data clean up, reinstalled... can't seem to get this to work.

image

Button icons not present

  • OP 0.15.1
  • Python 3.7.3
  • Plugin 0.11.0
  • Terminal Messaging 0.1.0

image

Let ne know if you need anymore information!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.