A serie of python scripts which manages node(s) comment and add "documentation to comment" functionality.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
h2c
AddToOPmenu.xml
OnCreated.py
README.md
auto_help_display.gif
result.png
translate.gif

README.md

HoudiniHelp2CommentSuite

A serie of python scripts which manage node(s) comment and add documentation to comment functionality.

AUTHOR:

eng. ANDREA LEGANZA

TESTED VERSION/S:

HOUDINI 16/16.5

DESCRIPTION:

When learning Houdini it may be hard to undestand the flow of nodes and to take a sneak peak on the purpose of a single node: a user has to select right click on node -> help and wait for Houdini internal browser to load the help page.

These scripts simplify this operations letting user automatically/manually populate node comment with proper text.

RESULTS:

Script result Script result Script result

INSTALLATION:

  1. close Houdini
  2. copy h2c folder inside <$houdini>/scripts/
  3. Add the content of file AddToOPmenu.xml into <$houdini>/OPMenu.xml, this is required to display menu on RMB. I placed after "Edit Comment" voice, but is up to you.
  4. optional: copy OnCreated.py inside <$houdini>/scripts/ : this script automatically adds help as comment for every new node
  5. start Houdini
  6. create a node (eg: geometry)
  7. selecte node -> right mouse button -> Help to comment -> select proper menu voice

WARNING:

If your path contains SPACES some scripts don't work, i filled a bug on 05/19/2018, this issue is cross-platform, a temp fix IF YOUR HOME PATH HAS NOT SPACES (otherwise use a folder without spaces in its path) to:

  1. replace on OPmenu.xml all occurrences $HFS/houdini/scripts/h2c/ with $HOME/scripts/h2c or ($HOME/h2c)
  2. create the folder in your home folder
  3. install scripts in that folder.
  4. close and reopen Houdini.

RIGHT MOUSE BUTTON MENU VOICES ON NODE/S:

  1. Use help as comment: populate node/selected nodes comment with online documentation headline
  2. Use help as comment for children: populate node/selected nodes and its/theri children notes comment with online documentation headline
  3. Display node comment: make node/selected nodes comment visible
  4. Hide node comment: hides node/selected nodes comment
  5. Remove node comment: removes node/selected nodes comment
  6. Display children comments: make children nodes of node/selected nodes comment visible
  7. Hide children comments: hides children nodes of node/selected nodes comment
  8. Remove children comments: removes children nodes of node/selected nodes comment
  9. Translate comment: translates comment using Google Translate service (it may take some seconds when using on multiple nodes)
  10. "Layout" submenu: these options modify space between nodes to let user avoid comments overlap (if you select a single node and it has children it will lay out its children, otherwise it will layout selected nodes):
    1. Lay out all increasing space: lay out increasing space between nodes (+0.5)
    2. Lay out all decreasing space: lay out increasing space between nodes (-0.5)
    3. Lay out all to x.y: quick layout all to fixed space value
  11. "Settings" submenu: these options let change auto-tranlsate settings:
    1. Enable/Disable show help on node selection: load help page when selecting or creating a new node; if a browser tab is not found is added to main window.
    2. Auto translate new nodes comments: translates online documentation headline comment when creating a new node. NOTE: this options delays node creation depending on your network connection while requesting comment tranlsation to Google.
    3. Set auto translate language: insert desidered language, eg: en (no translation), it, fr, es, ru etc
    4. Disable Geometry file node generation: Enable/Disable automatic Geometry file node creation inside Geometry node

NOTE:

  1. Scripts works when selecting a single node and with multiple nodes
  2. Some nodes don't have headline or the whole documentation file.
  3. Script should work on every OS due to OS path separator code, if fails fix/report please.
  4. Scripts are separated to make them simpler to study and undertand.

CONTRIBUTING:

Please feel free to fix/optimize the scripts.