» 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

nanotekt: vvvv+blender=lovvvve :D https://youtu.be/dUyeoi9mBIc

~3d ago

Patxi7: Pepper's Ghost & vvvv https://vimeo.com/632159133

~8d ago

mediadog: @manuelgonzalvez Needed to explicitly install VLC for VLC2; I use 3.0.6-win64 for stability.

~8d ago

mediadog: @manuelgonzalvez 42 getting crashes from DX11 VLC lib after last Win10 update. Switched to VLC2 plugin OK so far.

~9d ago

sunep: Looks interesting. Can't find a price though https://en.ids-imaging.com/ensenso-3d-camera-s-series.html

~20d ago

joreg: @guest re svg export: i'm afraid not.

~20d ago

joreg: @manuelgonzalvez what's stopping you? now is the time!

~20d ago

joreg: @schlonzo glad you like it!

~20d ago

schlonzo: the new burger menu is great!

~20d ago

schlonzo: the new burger menu is great!