[L2Ork-dev] Help doc improvement

[Albert Graef]

Hi Jonathan,

that sounds like an awesome idea to me! Have you already implemented this?
I'm really looking forward to giving it a whirl.

Thanks,
Albert


On Tue, Feb 23, 2021 at 12:35 AM Jonathan Wilkes <jon.w.wilkes at gmail.com>
wrote:

> Hi all,
>
> Just had a documentation epiphany:
>
> 1. add a div above the svg for a canvas (for now just assume every
> canvas window has such a div)
>
> 2. add an offset for checking mouse coords that subtracts the bottom
> of this div from the pageY
>
> 3. have the GUI check if a new canvas to be created has "-help.pd" in
> the title. E.g., "float-help.pd"
>
> 2. If so, flag it and stat "float.md"
>
> 3. If "float.md" exists, grab the contents, parse them with a markdown
> parser, and shove it all into the div's innerHTML from step 1.
>
> 4. Now we have a uniform help system where it's easy to write free
> prose, and it will wrap responsively when resizing the window, with an
> example patch at the bottom.
>
> 5. can easily add "float_de.md" and "float_fr.md" for multi-language help.
>
> This will make the core help docs *way* easier to edit, track in git,
> and read. And it shouldn't be *too* hard to convert the current mess
> of comments and cnv labels to markdown files to get started.
>
> As a side-benefit, we can also search for "patchname-help.html" and if
> it exists, load it up in the div's innerHTML. That will give people a
> way to write arbitrary html stuff to be displayed and used in
> conjunction the "patchname-help.pd" patch.
>
> If it works we can look later about how to edit the markdown in
> editmode, how to display/hide the example patch, etc.
>
> Best,
> Jonathan
> _______________________________________________
> L2Ork-dev mailing list
> L2Ork-dev at disis.music.vt.edu
> https://disis.music.vt.edu/listinfo/l2ork-dev



-- 
Dr. Albert Gr"af
Computer Music Research Group, JGU Mainz, Germany
Email: aggraef at gmail.com, web: https://agraef.github.io/
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://disis.music.vt.edu/pipermail/l2ork-dev/attachments/20210225/192c62fe/attachment.html>