help system
darvin opened this issue · comments
current help system is untranlability (
let's bring them to online - git wiki pages wfor example
You'll have to clarify. What do you mean online? I want PythonTurtle to be usable in an offline computer as well.
so we need write help in markdown for example, put it to github. and we need doc build system that will generate offfline help files from it and ship in package
i think that systems exist, i look for it
The most important thing is that operating the offline help will be dead simple. The current help screen is very simple and I'm pleased with that. If you want to revamp the help screen, that's okay, but I'll accept it only if it's very simple to use, so little children (which are the target audience here) would not be confused by it.
so let's autobuild it from online help, that will contain some meta information to generate children's pictures
Sounds good.
Let's rephrase this for 2019. We shall:
- turn the current help pages (as in /pythonturtle/resources and /images worktable) to a tree of generated HTML documents.
- make sure this can be rendered by the application directly on all target platforms.
- ensure the documentation can be translated easily in future (see gettext, Pootle/Crowdin/Transifex).
- optionally, allow the generated HTML documentation to be consumed with any web browser.
The two main objectives remain. It must be:
- Easy to consume in an offline fashion.
- Easy to understand for children (and adults alike).
The main benefit will be ease to extend the documentation. And flexibility to consume it in a modern, probably future-proof fashion.
Agreed.
I think the "help" page in the GUI needs a tab listing all the available commands (i.e. the API). Bonus points if each command had a thumbnail associated with it (maybe next to go(50) an animated GIF of the turtle moving up, next to turn(90) a moving GIF of the turtle rotating, etc)