» 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

~2d ago

joreg: Know someone who should learn #vvvv? Send them to one of our intro workshops in #Berlin https://nodeforum.org/announcements/2020-series-of-2h-introduction-workshops-to-vvvv-gamma/ #creativecoding

~3d ago

udo2013: @sunep:had an idea how to restore midi-data by one lick and bring the sliders in original position.patch in forum."restore midi.."

~9d ago

sunep: @udo2013 make a forum post about and I can share my subpatch

~9d ago

sunep: @udo2013 I have myself dealt with that problem by using LTP (Value) in pickup mode

~12d ago

~12d ago

~15d ago

joreg: @soundreactor: yes

~15d ago

soundreactor: is 50beta.. supposed to be working in windows 7 ?