<div dir="ltr"><div>Hi Jonathan,</div><div><br></div><div>that sounds like an awesome idea to me! Have you already implemented this? I'm really looking forward to giving it a whirl.</div><div><br></div><div>Thanks,</div><div>Albert</div><div><br></div></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Tue, Feb 23, 2021 at 12:35 AM Jonathan Wilkes <<a href="mailto:jon.w.wilkes@gmail.com">jon.w.wilkes@gmail.com</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">Hi all,<br>
<br>
Just had a documentation epiphany:<br>
<br>
1. add a div above the svg for a canvas (for now just assume every<br>
canvas window has such a div)<br>
<br>
2. add an offset for checking mouse coords that subtracts the bottom<br>
of this div from the pageY<br>
<br>
3. have the GUI check if a new canvas to be created has "-help.pd" in<br>
the title. E.g., "float-help.pd"<br>
<br>
2. If so, flag it and stat "float.md"<br>
<br>
3. If "float.md" exists, grab the contents, parse them with a markdown<br>
parser, and shove it all into the div's innerHTML from step 1.<br>
<br>
4. Now we have a uniform help system where it's easy to write free<br>
prose, and it will wrap responsively when resizing the window, with an<br>
example patch at the bottom.<br>
<br>
5. can easily add "float_de.md" and "float_fr.md" for multi-language help.<br>
<br>
This will make the core help docs *way* easier to edit, track in git,<br>
and read. And it shouldn't be *too* hard to convert the current mess<br>
of comments and cnv labels to markdown files to get started.<br>
<br>
As a side-benefit, we can also search for "patchname-help.html" and if<br>
it exists, load it up in the div's innerHTML. That will give people a<br>
way to write arbitrary html stuff to be displayed and used in<br>
conjunction the "patchname-help.pd" patch.<br>
<br>
If it works we can look later about how to edit the markdown in<br>
editmode, how to display/hide the example patch, etc.<br>
<br>
Best,<br>
Jonathan<br>
_______________________________________________<br>
L2Ork-dev mailing list<br>
<a href="mailto:L2Ork-dev@disis.music.vt.edu" target="_blank">L2Ork-dev@disis.music.vt.edu</a><br>
<a href="https://disis.music.vt.edu/listinfo/l2ork-dev" rel="noreferrer" target="_blank">https://disis.music.vt.edu/listinfo/l2ork-dev</a></blockquote></div><br clear="all"><br>-- <br><div dir="ltr" class="gmail_signature"><div dir="ltr"><div><div dir="ltr"><div><div dir="ltr">Dr. Albert Gr"af<br>Computer Music Research Group, JGU Mainz, Germany<br>Email: <a href="mailto:aggraef@gmail.com" target="_blank">aggraef@gmail.com</a>, web: <a href="https://agraef.github.io/" target="_blank">https://agraef.github.io/</a></div></div></div></div></div></div>