View Issue Details
| ID | Project | Category | View Status | Date Submitted | Last Update |
|---|---|---|---|---|---|
| 0003000 | Composr | core | public | 2016-12-24 10:32 | 2022-08-15 16:56 |
| Reporter | Chris Graham | Assigned To | |||
| Severity | Feature-request | ||||
| Status | non-assigned | Resolution | open | ||
| Product Version | |||||
| Fixed in Version | |||||
| Summary | 0003000: Integrated minimodule and miniblock editor | ||||
| 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. | ||||
| 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. | ||||
| Tags | Roadmap: Over the horizon | ||||
| Time estimation (hours) | 6 | ||||
| Sponsorship open | |||||
|
|
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. |
|
|
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/ |
|
|
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. |
|
|
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 :) |
|
|
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. |
| Date Modified | Username | Field | Change |
|---|---|---|---|
| 2016-12-24 10:32 | Chris Graham | New Issue | |
| 2019-06-27 18:54 | Chris Graham | Tag Attached: Roadmap: v12 | |
| 2020-02-03 20:11 | Chris Graham | Note Added: 0006353 | |
| 2020-02-03 21:41 | Adam Edington | Note Added: 0006355 | |
| 2020-02-03 21:51 | Chris Graham | Note Added: 0006356 | |
| 2020-02-03 22:00 | Adam Edington | Note Added: 0006357 | |
| 2020-02-04 00:27 | Chris Graham | Note Added: 0006358 | |
| 2021-07-23 22:38 | Chris Graham | Assigned To | => Patrick Schmalstig |
| 2021-07-23 22:38 | Chris Graham | Status | non-assigned => assigned |
| 2022-08-15 16:56 | Chris Graham | Assigned To | Patrick Schmalstig => |
| 2022-08-15 16:56 | Chris Graham | Status | assigned => non-assigned |
| 2024-03-26 00:58 | Patrick Schmalstig | Tag Renamed | Roadmap: v12 => Roadmap: Over the horizon |
