Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Dead links (The Internal Edition) #595

Open
twisst opened this issue Dec 22, 2024 · 8 comments · May be fixed by processing/processing-contributions#68 or #624
Open

Dead links (The Internal Edition) #595

twisst opened this issue Dec 22, 2024 · 8 comments · May be fixed by processing/processing-contributions#68 or #624

Comments

@twisst
Copy link
Contributor

twisst commented Dec 22, 2024

At the risk of becoming a nuisance, I have now compiled a list of internal broken links :-)

404  https://processing.org/reference/libraries/[email protected] in https://processing.org/reference/libraries/
404  https://processing.org/reference/libraries/[email protected] in https://processing.org/reference/libraries/
404  https://processing.org/reference/libraries/[email protected] in https://processing.org/reference/libraries/
404  https://processing.org/reference/libraries/Papa in https://processing.org/reference/libraries/
404  https://processing.org/reference/libraries/Papa in https://processing.org/reference/libraries/
404  https://processing.org/reference/libraries/[email protected] in https://processing.org/reference/libraries/
404  https://processing.org/reference/libraries/www.pierdr.com in https://processing.org/reference/libraries/
404  https://processing.org/reference/tools/modes/ in https://processing.org/people/
404  https://processing.org/reference/PGraphics_textFont_.html in https://processing.org/reference/pfont
404  https://processing.org/reference/String_.html in https://processing.org/reference/text_
404  https://processing.org/reference/rightshift_.html in https://processing.org/reference/green_
404  https://processing.org/reference/rightshift_.html in https://processing.org/reference/blue_
404  https://processing.org/reference/rightshift_.html in https://processing.org/reference/red_
404,301  http://processing.org/learning/pixels/ in https://processing.org/tutorials/text/
404,301  http://processing.org/learning/transform2d/ in https://processing.org/tutorials/text/
404,301  http://processing.org/reference/updatePixels.html in https://processing.org/tutorials/pixels/
404,301  http://processing.org/reference/draw_.html)draw()%5D in https://processing.org/tutorials/pvector/
404  https://processing.org/reference/floatconvert.html in https://processing.org/examples/datatypeconversion
404  https://processing.org/reference/intconvert.html in https://processing.org/examples/datatypeconversion
404  https://processing.org/reference/byteconvert.html in https://processing.org/examples/datatypeconversion
404  https://processing.org/reference/charconvert.html in https://processing.org/examples/datatypeconversion
404  https://processing.org/reference/pixels[].html in https://processing.org/examples/mandelbrot
404  https://processing.org/reference/Pimage_pixels[J.html in https://processing.org/examples/blur
404  htts://processing.org/reference/Pimage_.html in https://processing.org/examples/convolution
404  htts://processing.org/reference/Pimage_.html in https://processing.org/examples/pixelarray
404  https://processing.org/reference/PVector_sub.html in https://processing.org/examples/vectormath
404  https://processing.org/reference/PGraphics_alpha_.html in https://processing.org/reference/pimage_copy_
404  https://processing.org/libraries appears 520 times, everywhere where the breadcrumbs appear.
404  https://processing.org/reference/libraries/serial/LIB_serial/serialEvent_.html in https://processing.org/reference/libraries/serial/serial
404  https://processing.org/reference/libraries/net/LIB_net/clientEvent_.html in https://processing.org/reference/libraries/net/client
404  https://processing.org/reference/librari...d/MultiChannel_availableChannels_.html in https://processing.org/reference/libraries/sound/multichannel_activechannel
404  https://processing.org/reference/libraries/sound/sound/Sound_list.html in https://processing.org/reference/libraries/sound/multichannel_useportaudio_
404  https://processing.org/reference/libraries/sound/sound/Sound_list.html in https://processing.org/reference/libraries/sound/sound_inputdevice_
404  https://processing.org/reference/libraries/sound/sound/Sound_list.html in https://processing.org/reference/libraries/sound/sound_outputdevice_
404  https://processing.org/reference/librarie...und/sound/Sound_outputDevice_.html in https://processing.org/reference/libraries/sound/multichannel_availablechannels_
404  https://processing.org/reference/libraries/sound/sound/AudioSample_cue_.html in https://processing.org/reference/libraries/sound/audiosample_jump_
404  https://processing.org/reference/libraries/sound/sound/AudioSample_cue_.html in https://processing.org/reference/libraries/sound/audiosample_jumpframe_
404  https://processing.org/reference/libraries/sound/sound/AudioSample_cue_.html in https://processing.org/reference/libraries/sound/audiosample_pause_
404  https://processing.org/reference/libraries/sound/sound/AudioSample_play_.html in https://processing.org/reference/libraries/sound/audiosample_jump_
404  https://processing.org/reference/libraries/sound/sound/AudioSample_play_.html in https://processing.org/reference/libraries/sound/audiosample_jumpframe_
404  https://processing.org/reference/libraries/sound/sound/MultiChannel.html in https://processing.org/reference/libraries/sound/sound

In my defense, I do plan to fix them all myself :-)

The only one that someone else should probably fix, is the https://processing.org/libraries link in the breadcrumbs at the top of all pages in the Libraries section. That link could either be changed to https://processing.org/reference/libraries or a redirect could be made.

twisst added a commit to twisst/processing-website that referenced this issue Dec 24, 2024
@swastikCommits
Copy link

Is this fixed? I am willing to work on it

@SableRaf
Copy link
Collaborator

Hey @twisst :) Are you still planning on working on this or should we assign it to someone else?

@twisst
Copy link
Contributor Author

twisst commented Apr 3, 2025

Hi @SableRaf, I don't mind letting it go, but are you sure that my fix would not work? You said "most of these changes can't be made directly in the website repository anyway. For example, the contributions, reference, and examples are all generated from other sources".
I could not find those other sources in the repository, and when I had a chance to talk to @Stefterv in Berlin he wasn't sure either.

@SableRaf
Copy link
Collaborator

SableRaf commented Apr 4, 2025

Hi @twisst and apologies for the confusion. Information about data sources for various part of the website can be found in the README here: https://github.com/processing/processing-website?tab=readme-ov-file#page-content

@twisst
Copy link
Contributor Author

twisst commented Apr 4, 2025

Aaah I see. It makes sense now. I'll have a go applying the changes I previously made to the JSONs to the source files instead.

@twisst
Copy link
Contributor Author

twisst commented Apr 4, 2025

I suspect most broken links are caused by the script that converts the Javadoc annotations to a json file. Things mostly go wrong where the java files use '@see_external'.

This line in the documentation for the green() function. In my commit you see that it results in a 404 instead of this page.
Same 404 is in the documentation for red() and blue().

I'm not 100% sure if the script needs to be changed or maybe some internal redirects on the website, but it is probably better I'm not the one messing with either :-) Same goes for the breadcrumb links I already mentioned above.

These are the other 404's in the list above that are somehow caused by the automatic conversion:

  • the JSON for DatatypeConversion contains ["floatconvert", "intconvert", "byteconvert", "charconvert"] even though the .pde it is based on only mentions "int(), float(), char(), byte()". On the website this somehow leads to a link to byteconvert.html when it should be byteconvert_.html.
  • pixels[] in Topics/Fractals and L-Systems/Mandelbrot/Mandelbrot.pde ends up in Mandelbrot.json as 'pixels[]' -- which results in a 404 because it should be 'pixels'.
  • Blur.json contains 'PImage_pixels[]' but that should be 'PImage_pixels' to get a proper link. Blur.pde does mention 'PImage' and also 'pixels' but not 'PImage_pixels'.
  • Convolution.pde contains 'PImage', which results in Convolution.json linking to 'PImage_' instead of to 'PImage'.
  • ditto PixelArray: linking to 'PImage_' instead of to 'PImage'.
  • VectorMath leads to 'PVector_sub' instead of 'PVector_sub_' (so here there should be an underscore).
  • this line in Client.java leads to content/references/translations/en/net/Client.json linking to 'LIB_net/clientEvent_' instead of 'net/clientEvent_'
  • PFont: 'PGraphics_textFont_' where it should be 'textFont_'
  • PImage_copy_.json: 'PGraphics_alpha_' instead of 'alpha_'
  • text: 'String_' instead of 'String' (another case of '@see_external')
  • Serial: 'LIB_serial/serialEvent_' instead of 'serial/Serial_serialEvent_'
  • AudioSample.java has these lines '@see AudioSample#cue(float)' and '@see AudioSample#play()' and that leads to 404's in AudioSample_jumpFrame_.json, AudioSample_jump_.json, AudioSample_pause_.json
  • I'm getting bored now :-) but the same problem is occuring in MultiChannel.java and Sound.java

I'm going to make a PR now for the links I could fix.

twisst added a commit to twisst/processing-website that referenced this issue Apr 5, 2025
fixes processing#595 or at least the dead links that are in the tutorials
@twisst twisst linked a pull request Apr 5, 2025 that will close this issue
@mingness
Copy link

mingness commented Apr 5, 2025

@twisst Thanks for your work on this issue - I think a plausible solution is one that you suggested - change the script in processing-contributions that creates the jsons to change common formatting "errors". For now we could merge the changes in the yaml that you've created a PR for, but this is not a permanent solution, since these entries will be overwritten the next time the library is updated. I'll converse more in the PR

@mingness
Copy link

mingness commented Apr 5, 2025

@Stefterv apologies have forgotten - are the json artifacts from processing-contributions now used for the website?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
4 participants