» 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

~2d ago

joreg: @jib watch this howto manage items in a spread for a start: https://youtu.be/tiFLGTrDagc

~2d ago

jib: Hi guys ! in Gamma, what's the way to do things that Buffer node does in Beta ?

~3d ago

david: Reminder: vvvv meetup is starting in 10 mins. https://www.youtube.com/watch?v=LzqaoN7QCSg

~4d ago

joreg: Reminder: 6th worldwide #vvvv meetup tomorrow, Nov 24: 6.-worldwide-vvvv-meetup with presentations by u7angel and team, texone and baxtan

~7d ago

tonfilm: That's going to be interesting, let's hope Intel is doing something similar: https://www.tomshardware.com/news/amd-allows-SAM-on-nvidia-gpus

~7d ago

neuston: THX @joreg and sorry for late reply as I left vl for a while. I've responded to related (UI performance issues) thread, no worry

~8d ago

~11d ago

schack: I need some help and hints to realise Text-To-Speech within beta 40 x64!!! THX