SuperCollider: links written within parenthesis are unusable

[elgiano]

In SuperCollider HelpFiles, all linkes written within parenthesis are unusable. Link hrefs still contain the closing parenthesis, leading to a variety of 404 pages.

For example, in FluidBufSpectralShape, if I try to click on "(https://www.audiocontentanalysis.org/)", I get redirected to https://www.audiocontentanalysis.org/).

[jamesb93]

@tedmoore can I assign this one to you as you are more familiar with the SC docs?

@elgiano thanks for raising this. Pretty critical we make links work I'd think :)

[tedmoore]

Thanks @elgiano for alerting us! I'll take a look.

[tedmoore]

Unfortunately @elgiano, these links are working for me, including the one in question. So maybe it's a Linux issue? I don't have a Linux machine nearby, so maybe the next time we do beta testing we'll double check this on all the OSes.

[elgiano]

@tedmoore
Interesting... could you please do one more check for me?
Open the generated html file for FluidBufSpectralShape, here is how to find it, in case you need:

SCDoc.findHelpFile("FluidBufSpectralShape")

Line 56 looks like this for me:

<p> The drawings in Peeters 2003 (<a href="http://recherche.ircam.fr/anasyn/peeters/ARTICLES/Peeters_2003_cuidadoaudiofeatures.pdf)">http://recherche.ircam.fr/anasyn/peeters/ARTICLES/Peeters_2003_cuidadoaudiofeatures.pdf)</a> are useful, as are the commented examples below. For the mathematically-inclined reader, the tutorials and code offered here (<a href="https://www.audiocontentanalysis.org/)">https://www.audiocontentanalysis.org/)</a> are interesting to further the understanding. For examples of the impact of computing the moments in power magnitudes, and/or in exponential frequency scale, please refer to the <a href="./../Classes/FluidSpectralShape.html">FluidSpectralShape</a> helpfile.

Do you also get a closing parenthesis inside href, like href="http://recherche.ircam.fr/anasyn/peeters/ARTICLES/Peeters_2003_cuidadoaudiofeatures.pdf)" ?

[tedmoore]

Hi @elgiano,

Thanks again for your help with this. On 1.0.0-TB2.beta6 (the current release) line 56 is something else, but line 58 is:

<p> The drawings in Peeters 2003 (<a href="http://recherche.ircam.fr/anasyn/peeters/ARTICLES/Peeters_2003_cuidadoaudiofeatures.pdf">http://recherche.ircam.fr/anasyn/peeters/ARTICLES/Peeters_2003_cuidadoaudiofeatures.pdf</a>) are useful, as are the commented examples below. For the mathematically-inclined reader, the tutorials and code offered here (<a href="https://www.audiocontentanalysis.org/">https://www.audiocontentanalysis.org/</a>) are interesting to further the understanding. For examples of the impact of computing the moments in power magnitudes, and/or in exponential frequency scale, please refer to the <a href="./../Classes/FluidSpectralShape.html">FluidSpectralShape</a> helpfile.

so no closing parenthesis inside the href.

[tedmoore]

@elgiano I've added a space both before and after the link (so just inside the parens), or ( so just inside the parens ). I hope this fixes it! Let me know if it doesn't.

[elgiano]

@tedmoore The spaces should fix it! However, in which commit did you add them? I can't find it...

[tedmoore]

Here it is! Thanks for the bump to include it here. 3c744bc

[tedmoore]

It's on dev and we just merged that to main so it will be in the beta7 release that should be coming out in the next day or two!

[elgiano]

Thanks!! I'll try asap

[tedmoore]

Hi @elgiano, I'm doing a checkup pass on lots of open issues. Did you get a chance to check on this yet!? Cheers.

[elgiano]

I just checked the main branch and there is still only one error. The rest looks all good! Thanks.
Here is the error:

$ rg mathematics release-packaging
release-packaging/HelpSource/Classes/FluidSpectralShape.schelp
11:##the four first statistical moments (https://en.wikipedia.org/wiki/Moment_(mathematics) ), more commonly known as:

release-packaging/HelpSource/Classes/FluidBufSpectralShape.schelp
12:##the four first statistical moments (https://en.wikipedia.org/wiki/Moment_(mathematics) ), more commonly known as:

$ rg mathematics install
install/FluidCorpusManipulation/HelpSource/Classes/FluidSpectralShape.schelp
16:    the four first statistical moments (LINK::https://en.wikipedia.org/wiki/Moment_(mathematics)::), more commonly known as:

install/FluidCorpusManipulation/HelpSource/Classes/FluidBufSpectralShape.schelp
16:    the four first statistical moments (LINK::https://en.wikipedia.org/wiki/Moment_(mathematics::) ):

install/FluidCorpusManipulation/HelpSource/sc_ref/Classes/FluidSpectralShape.schelp
16:    the four first statistical moments (LINK::https://en.wikipedia.org/wiki/Moment_(mathematics)::), more commonly known as:

install/FluidCorpusManipulation/HelpSource/sc_ref/Classes/FluidBufSpectralShape.schelp
16:    the four first statistical moments (LINK::https://en.wikipedia.org/wiki/Moment_(mathematics::) ):

As you can see, in FluidBufSpectralShape one closing parenthesis is erroneously excluded from the URL. However, this does not happen in FluidSpectralShape even though the respective HelpSources from release-packaging look exactly the same. Strange, isn't it?
The latest release for linux has the same error. However, the error doesn't happen if I build with -DDOCS=OFF, i.e. sclang parses the links correctly when they are not previously wrapped in a LINK::[...]::.