» Conventions.HelpPatch
This site relies heavily on Javascript. You should enable it if you want the full experience. Learn more.

Conventions.HelpPatch

Italian | Spanish

A HelpPatch demonstrates the functionality of a node. Ideally a novice should quickly get an idea of what the node is about and an expert should get detailed information on its usage.

Design Tips

  • create a helppatch for a node by selecting it and pressing F1. if the node does not have a helppatch yet, a dummy patch with already the right name will open. simply press CTRL+S to save the patch to disk and then start modifying it.
  • first find the most simple usage scenario of a node which will give the novice a quick overview
  • now explain the node a second time with a more advanced usage scenario and put that graph right next to the simple scenario
  • find further scenarios if applicable and place them right next to the existing
  • create IOBoxes for input pins that you set to values other than their default
  • don't label them (as if they were inputs) but write a comment next to them and explain their usage
  • in all your texts/comments please stick to the naming conventions.
  • create a see also section where you place related nodes that the user is supposed to also checkout.
  • add links to online information (wikipedia,..) regarding the functionality of the node

Contribute

If you want your helppatch included with the next release please add them to this forum thread: missing-helppatches

anonymous user login

Shoutbox

~7d ago

ddf: stride is great

~7d ago

joreg: vvvv meetup live now: https://youtu.be/EiHW0X6zjKE NODE20

~7d ago

~8d ago

~11d ago

david: NODE20 is online http://20.nodeforum.org First infos on how this all works this year...

~17d ago

domj: Relaxing saturday blend. 1 part soundcloud, 1 part spotify, 1 part bitwig. https://www.twitch.tv/dominikjancik

~18d ago

tonfilm: anyone intereseted in a 48h no-code game jam? https://itch.io/jam/nocodejam-1

~18d ago

domj: Last chance today to see Tanzometr, AV dance performance using weight sensors and Schéma/vvvv https://bit.ly/tanzometr-tix https://bit.ly/tanz-photo