How to display the icon in the wiki style docs?

[magneto]

When writing documentation for your digital asset, does anyone knows how to reference the icon?

I use this but it doesn't show up:

#icon: opdef:Sop/bridge?IconImage

Thanks

[Zero]

This works for me:

#largeicon: /icons/large/MISC/python.png

The path above is relative to

$HFS/houdini/help

.

Hope this helps.

[magneto]

Thanks, does the icon file have to be present there on disk? I am trying to make the operator self contained, so that's why was trying to use the icon already saved inside the OTL.

Any way to do that?

Edited June 12, 2012 by magneto

[old school]

Yes you can inject your icon image (with a sensible resolution of course) as an extra file in your asset and then use that as your asset's icon.

Given your first post, you should add a new image file called IconImage.png (as a .png image file) to your asset, then use in the help:

#icon: opdef:Sop/bridge?IconImage.png

I usually name the help images something more appropriate. If it is a bridge asset, why not use something like BridgeIcon.png?

[magneto]

Thanks oldschool, will try this at lunch. You are right, bridgeIcon is a better name.

I wonder how Houdini stores the OTL icon though? I mean the one you choose in the first tab as the icon of the asset which Houdini uses in the network editor, etc. Is this not stored as some sort of Extra File inside the OTL?

That's why my thought was, since the path in the Icon parameter looks like the one you posted, it must be stored in the OTL, thus should be accessible for the help card too.

Not a big issue, just wondering so that I don't have to store 2 different icons

[old school]

Yep you can use the same icon embedded in the asset for both the node icon and the help icon.

Almost all default assets that ship with Houdini source their icons from the Houdini installation and not from an icon image embedded in the asset fyi.

[magneto]

Thanks oldschool. Reason I wanted to use the embedded icon is because I want to upload it to Houdini exchange.

Btw I tried the same path used in the icon parameter of the asset, in the help icon, but it doesn't show up.

Basically this:

#icon: opdef:Sop/bridge?IconImage

[notawhale]

I know it's old post, but have the same issue, so I found how to solve it. You need to embed a image to a asset and in the help page write this:

#icon: opdef:\/Sop/bridge?icon.png

 

[Jordan Walsh]

While im here... you can also point to an extra file in the help like this:

#icon: opdef:.?icon.png

Unfortunate you cant do this with the Operator type Icon.. as changing name space or version of the HDA means you have to update the icon path too