» 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

~2h ago

u7angel: twitch livestream vvvv gamma

~24h ago

u7angel: @domj, sure

~1d ago

domj: @u7angel: nice! How about the talk later at 7?

~1d ago

u7angel: vvvv-gamma-presentation will be streamed on twitch, starts 2pm, channel name is vvvv gamma

~1d ago

joreg: vvvv heads in #hamburg #kiel: if you're bored this thursday, please come join us for a workshop and/or talk: vvvv-gamma-presentation

~2d ago

sebescudie: @teckor: maybe ui-plugin ?

~2d ago

tekcor: wasn't there a contribution for making native windows GUIs?

~3d ago

joreg: Looking for a #vvvv job in #berlin? don't miss this one: https://discourse.vvvv.org/t/looking-for-vvvv-artists-permanent-in-berlin/17448

~3d ago

domj: vvvv gamma audio input with Naudio https://youtu.be/iBRZ3tsc_BI