feature request: -doc switch for faust2firefox

[magnetophon]

When you run faust2svg or faust2firefox with this proposed -doc switch, it generates an svg, where clicking a core building block links you to the relevant part of the documentation and clicking a function that comes from the library enters the content of that function, as usual, but the function block also gets an additional link that brings you to the relevant part of the library docs.

I guess that the library part of the request would take an amount manpower that is currently not available, but maybe making the core parts clickable links would be doable?

[sletz]

What do you mean by the : proposed-docswitch ?

[magnetophon]

Instead of running faust2firefox myDsp.dsp, you'd run: faust2firefox -doc myDsp.dsp.

[sletz]

Are you sure ?

faust2firefox -doc osc.dsp
WARNING : unrecognized option(s) : "-doc","-doc"

[magnetophon]

This is a feature request, as mentioned in the title. The -doc switch doesn't exist yet but I would like it to.

[josmithiii]

I like this idea. However, I would integrate it into the normal faust2firefox output without adding a -doc option:

For language primitives, the link could go to a tag in the Faust Quick Reference manual.

For library functions, the name of the function (linked) could appear in the upper-left corner of the opened function block. An alternate click (like option-click) on the unopened block could go directly to the doc without opening the block.

That would be nice, Julius

On Sat, Jun 20, 2020 at 8:37 AM Bart Brouns [email protected] wrote:

When you run faust2svg or faust2firefox with this proposed -doc switch, it generates an svg, where clicking a core building block links you to the relevant part of the documentation and clicking a function that comes from the library enters the content of that function, as usual, but the function block also gets an additional link that brings you to the relevant part of the library docs.

I guess that the library part of the request would take an amount manpower that is currently not available, but maybe making the core parts clickable links would be doable?

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/grame-cncm/faust/issues/450, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAQZKFJ37A4DBV4CXSS5IITRXTJUFANCNFSM4ODNZJFQ .

-- Julius O. Smith III [email protected] Professor of Music and, by courtesy, Electrical Engineering CCRMA, Stanford University http://ccrma.stanford.edu/~jos/