» VL: Help Patches
This site relies heavily on Javascript. You should enable it if you want the full experience. Learn more.

VL: Help Patches

Help!

One of the most requested features for VL ever since was the support for help-patches. Obviously they had to come back, but it took us a while to figure out how exactly. One of the brainstorming sessions at LINK was especially helpful to sort out the details. Thanks everyone for your input...

Help Patches

So for the user it is just as before: Press F1 on a node that you need help for. Now what happens is:

  • If a help-patch is found, it is opened and a bubble indicates the node you were looking for
  • If no help-patch was found, a bubble indicates that no help-patch was found
Help patch was found...
No help patch available...

In both cases, you can now optionally opt-in for more help: Click the bubble to open the help browser showing the nodes Node Info.

Node Info

Shows some info about the node plus 3 lists of how-to patches this node is used in:

  • most relevant (the dedicated help-patch)
  • still relevant
  • list of other patches using this node (automatically generated)

This should increase the chance of finding good info about how a node can be used in different scenarios.

When "follow mode" is active, you can click around in the patch and always get the node info to the last selected node.

Help Flags

Creators of libraries who want to provide help patches now use help flags to indicate relevance for a node. Read all about using help flags in the graybook.


Available for testing in latest previews!

joreg, Friday, Jan 31st 2020 Digg | Tweet | Delicious 2 comments  
sebl 31/01/2020 - 19:39

vvvvery helpful, thanks!

ludnny 03/02/2020 - 14:01

thanks, this is a very great step forward!
I especially like the list of "other patches using this node".

  • 1

anonymous user login

Shoutbox

~7h ago

joreg: absolutely. if it is for a repo that is public, just submit a pullrequest. otherwise please start a forum thread.

~7h ago

benjawmino: @joreg I ended up figuring out BezierSegment yesterday, so nevermind! Tell me, could a user submit a help patch? :)

~7h ago

joreg: @benjawmino please elaborate on this question a bit in a new forum thread. otherwise it is hard to answer..

~2d ago

benjawmino: so are there no splines/curves in gamma yet??

~5d ago

skyliner: wanna do drone shows or applications? then check this super cool project of our man e1n

~9d ago

NoseBleedIndustries: Thanks Joreg! The few minutes I was able to see, very good workshops!

~9d ago

joreg: @NoseBleedIndustries please give us some days, we'll have an announcement soon...

~9d ago

NoseBleedIndustries: I could not assist the Node20 (workshops ) Any Idea when we will have access to the links of the recordings?

~11d ago

bjoern: unity has c# bindings for usd, under apache license: https://github.com/Unity-Technologies/usd-unity-sdk