Integrated language help feature in OpenSCAD

[t-paul]

Outline

Add more interactive help features for built-in functions and modules. Right now there's already a nice summary of parameters linked as cheat sheet. Scope of this projects would be to use this information in extended form and make it available in a more direct way in the editor.

Details

• Convert the cheat sheet information into machine readable format
• Find a way to generate the existing HTML format based on the core data
• Add context help to editor giving help for built-in functions and modules, e.g. by adding formatted help output to the console window, including the links to further documentation like the language manual on Wikibooks

Expected Outcome

Cheat sheet is integrated into the application and additional context help for built-in functions and modules is available.

Project Properties

Skills

• Programming language is C++
• GUI programming with the Qt framework

Difficulty

Easy

Size

Medium (175h)

Additional Information

• Potential mentor(s): Marius Kintel (IRC: kintel), Torsten Paul (IRC: teepee)
• Organization website: https://www.openscad.org/

[guptushar27]

I want to work on this issue. Please Assign this to me.
Thanks

[t-paul]

@guptushar27 Those projects are planned for GSoC, for how that process works, see https://summerofcode.withgoogle.com/how-it-works and https://opencax.github.io/ - If you want discuss, join the IRC channel, link above.

[siyangwu358]

How can I join your channel to discuss with you.