#3000 - Integrated minimodule and miniblock editor

By Chris Graham
Added 24th Dec 2016, 5:32 AM
2 views

Identifier	#3000
Issue type	Feature request or suggestion
Title	Integrated minimodule and miniblock editor
Status	Open
Tags	Roadmap: Over the horizon (custom)
Handling member	Deleted
Addon	core
Description	Have an inline editor for editing minimodules and miniblocks. When you go to a page that doesn't exist, or an existing minimodule page, there'd be add/edit minimodule links (as there are add/edit Comcode page links right now). When you add a block that does not exist, there'd be an add miniblock link. It'd have to make it clear that this is PHP code. Probably it would add some sample minimodule/miniblock code in right away to start from, if it's a new file. There'd be a preview button.
Steps to reproduce
Additional information	The intent of the functionality is so that newbie programmers can learn to do simple programming before having to learn about filesystems, external code editors, and FTP (or whatever). It should be as simple as coding was for the early home computers in the 1980s where you could immediately type in commands.
Related to	#2847 - Training through private institutes (on hold)
Funded?	No

The system will post a comment when this issue is modified (e.g., status changes). To be notified of this, click "Enable comment notifications".

Rating

Unrated

Comments

By Guest posted 3rd Feb 2020, 3:11 PM

I don't know where to post this idea, so I'll post it here...

It would be cool to have some tool that could read out what PHP code means in human readable text.
My comments on Twitter:
https://twitter.com/occhris/status/1224124287784800262

It would probably be a completely separate project we'd link out to.

By Guest posted 3rd Feb 2020, 4:41 PM

I am probably completely missing the overall point but I thought documentation within the source code solved this to some degree .
https://www.naturaldocs.org/features/output/

By Guest posted 3rd Feb 2020, 4:51 PM

It explains what individual functions we implement do, but it doesn't tell people how the code works.
And code comments done are typically explaining more complex algorithms, definitely not explaining the syntax of the code.

By Guest posted 3rd Feb 2020, 5:00 PM

Well that Natural Docs project is the closest I could come to answering the question. The output image shown on the link in my first reply seems to explain the code in plain understandable English and the rest of the site seems to give the impression that it is a potential answer. Perhaps though you are thinking of something entirely different to me, but Natural Docs seems like a solution to what I think you mean :)

By Guest posted 3rd Feb 2020, 7:27 PM

Nah, it's just a multi-language API docs builder, we already have this for PHP: https://compo.sr/docs/api/

What I didn't mention, is I could create something that does what I describe in a few days from the Code Quality Checker's PHP parser we already have. It would be pretty far down on my list of priorities to do that, but I thought it was worth logging the idea.

#3000 - Integrated minimodule and miniblock editor

Rating

Comments

Statistics