Re: [PD-dev] formatting HTML doc in Pd distro?
On 6/30/2019 1:05 AM, Miller Puckette wrote: > Any advice would be very helpful! Stay in the HTML format. Following https://www.w3schools.com/html/html_basic.asp anyone can come up with an object documentation. HTML is the way to go. No need for latex, md, or whatever. HTML is really simple and works on any computer and is very straightforward to maintain and enhance. Most importantly it does not add compiling dependency. * big heading h2 smaller heading paragraph paragraph 2 * Having the ability to open local or remote URLs is a total Pd enhancer. :) Mensaje telepatico asistido por maquinas. ___ Pd-dev mailing list Pd-dev@lists.iem.at https://lists.puredata.info/listinfo/pd-dev
Re: [PD-dev] formatting HTML doc in Pd distro?
On 6/30/2019 10:41 PM, Miller Puckette wrote: > The gotcha is that I can't find a way to typeset equations in native HTML... How about making the rendered image (of the math equation) with https://www.codecogs.com/latex/eqneditor.php and include the image in the HTML doc. (isn't this is what Latex do when it generates an HTML output ?) ? Mensaje telepatico asistido por maquinas. ___ Pd-dev mailing list Pd-dev@lists.iem.at https://lists.puredata.info/listinfo/pd-dev
Re: [PD-dev] formatting HTML doc in Pd distro?
On Sun, Jun 30, 2019 at 08:30:40PM +0200, IOhannes m zm??lnig wrote: > On 6/30/19 6:05 AM, Miller Puckette wrote: > > Any advice would be very helpful! > > personally, i'd go for markdown as the source format and use pandoc to > compile it to the final documentation. > > reasons: > - the source document is human readable (with a somewhat meaningful > visual layout, as opposed to LaTeX) > - can be compiled to LaTeX (and can include LaTeX-snippets, e.g. for > complicated formulae). > > thus, the repository *could* only contain the source-code of the > documentation (md), which would still be a meaningful (although not as > nicely laid out) documentation for the power-user who uses a git clone. > the documentation would still need to be compiled during the release > phase though (which i don't see as a big problem; i'd make this step > optional though). > Cool, I'll investigate this. It might be cleaner than latex2html. Meanwhile, the original reason I made the "manual" in HTML was so that it could be easy to browse. Now that PDF readers are universally available and PDFs can contain links, it might be better to distribute the doc in PDF. This would be possible either via latex or (I guess) pandoc. > > > But I don't think it's a good idea to put latex compilation in the Pd > > compile chain, > > why? > ATM I can (and do) compile Pd using only "make", "cc" and "ln" - trying to keep the dependencies to an absolute minimum. > > Make Pd able to open files in the native OS (maybe via a new > > "pdcontrol" object that would issue system commands > > afaik, the way to "open files" (using the default application, which is > what we really want here), is highly system specific. > e.g. cf the `::pd_menucommands::menu_openfile` (in > tcl/pd_menucommands.tcl) which (kind of) implements this already, and > which i would probably use *as is*. > Yep. Just needs to be available from within Pd vanilla :) > gfmdsar > IOhannes > > ___ > Pd-dev mailing list > Pd-dev@lists.iem.at > https://lists.puredata.info/listinfo/pd-dev ___ Pd-dev mailing list Pd-dev@lists.iem.at https://lists.puredata.info/listinfo/pd-dev
Re: [PD-dev] formatting HTML doc in Pd distro?
> > For the moment I'm planning to just put an attempt at documentation for > > slop~ > > on my own page and point to it from the slop~ help file (which will require > > fixing Pd to be able to open URLs). > > > This is what I don't get. How would you "fix Pd" to open URLs? With the new > [pdcontrol] object? > > cheers Yep. At the moment, I'm thinking of having it take an "open" message to open a file in the OS, a "fetch" or "httpget" or something to open a URL, and a "system" to run a program asynchronously and return its standard output as Pd messages. Maybe also a message to open a program and keep it open so that Pd can send it stuff as input and collect the output. All this would be kicked up to teh Tcl/Tk layer, so none of it would be "real-time". Also high time to be able to get the patch's containing directory using only Pd vanilla. I think there are 10 or 20 other things this object should eventually do! cheers M ___ Pd-dev mailing list Pd-dev@lists.iem.at https://lists.puredata.info/listinfo/pd-dev
Re: [PD-dev] formatting HTML doc in Pd distro?
Em dom, 30 de jun de 2019 às 02:52, Miller Puckette escreveu: > To pd dev - > > I'm struggling to finish the design of a slew-limiting low-pass filter > (slop~) to add to Pd vanilla > Yay! > Make Pd able to open files in the native OS (maybe via a new "pdcontrol" > object that would issue system commands and be extensible to get various > notifications in the future). > Yay! x 2 For the moment I'm planning to just put an attempt at documentation for > slop~ > on my own page and point to it from the slop~ help file (which will require > fixing Pd to be able to open URLs). This is what I don't get. How would you "fix Pd" to open URLs? With the new [pdcontrol] object? cheers ___ Pd-dev mailing list Pd-dev@lists.iem.at https://lists.puredata.info/listinfo/pd-dev
