デジタルアセットを作成する時、そのヘルプを2箇所の内のどれかに格納することができます:

• アセットのType Propertiesウィンドウの Help タブ。

• Houdiniパス内のファイル。

以下の一般形式と詳しい説明を参照してください。

通常では、ヘルプをアセットの Help タブに貼り付けるのが一番良くて便利な選択肢です。その方法でヘルプを取り扱うのであれば、このセクションを無視してください。

しかしながら、ヘルプをファイルとして維持したいのであれば、ヘルプサーバーがそのヘルプを見つけられるように正しい命名規則を守る必要があります。

• HOUDINIPATH/help/nodes/dir/にファイルを作成します。dirは、ノードタイプカテゴリの“省略”バージョンです(これらのディレクトリ名は古くからの習慣のお決まりです)。例:

  カテゴリ	ディレクトリ
  Object	obj
  SOP	sop
  DOP	dop
  COP	cop2
  ROP	out

• ディレクトリ内では、スコープされていないノードのファイル名パターンは以下の通りです:

  [namespace--]name[-version].txt

  例えば、ネームスペースもバージョンも持たないbravo SOPは以下のようになります:

  bravo.txt

  com.corpネームスペースにbravo SOPがある場合は、そのファイル名は以下のようになります:

  com.corp--bravo.txt

  バージョン2のノードは以下のようになります:

  bravo--foo-2.txt

• スコープされたノードに関しては、再帰ファイル名パターンは以下の通りです:

  [scope@]filename.txt

  再帰的なscope部分を構築するには、スラッシュ(例えばObject/alfa)をアンダースコアに置換します。

  例えば、スコープされたネームスペース付きのSOPノードcom.corp::Object/alfa::2.0::com.corp::bravo::3.0に関しては、そのヘルプは以下のようになります:

  /nodes/sop/com.corp--Object_alfa-2.0@com.corp--bravo-3.0.txt

  これにより、いくつもの再帰スコープを完全にコード化することができます。

一般的なwikiマークアップのリファレンスに関しては、Houdini wikiマークアップを参照してください。

= My Asset =

#icon: path/to/icon

"""ノードの簡単な挙動の要約。"""

== 概要 ==

ノードの目的とオペレーションの説明。

@inputs

Label:
    入力の目的。

@parameters

Label:
    #id: internalname

    パラメータの説明。

Label:
    #id: internalname

    パラメータの説明。

@related

* [Node:sop/copy]

• リンクの作成と画像や他のメディアを含める方法は、wikiマークアップリファレンスを参照してください。

• ヘルプサーバーは、アセットセクションをノードのURLのサブURLとして扱います。例えば、あなたがのアセットが以下の場合だったとします:

  /nodes/sop/mynamespace--myextrude
  

  …以下のURLでアセット内のセクションにアクセスすることができます:

  /nodes/sop/mynamespace--myextrude/section_name
  

  例えば、セクション内にMainImage.jpgという画像ファイルがあれば、アセットのヘルプにそれを使用することができます:

  [Image:./MainImage.jpg]
  

  Tip

  セクション名に拡張子(例えば、.jpg)があるので、サーバーがそのファイルタイプを推測することができます。

• 別の方法としては、Houdiniのopdef:構文を使用することで、セクションを参照することができます。例:

  [Image:opdef:.?MainImage.jpg]
  

• 他のノードからテキストを“インクルード”することが役立つことが多いです。例えば、2つのノードが非常に似たインターフェースを持っていたり、あるノードのインターフェースが他のノードからプロモートしたパラメータを含んでいる場合です。

  パラメータに#id:プロパティがある限り、それを他のページで含めることができます。例えば、あるアセットに以下のパラメータがあったとします:

  @parameters
  
  Group:
      #id: group
  
      動かすグループまたはポイント番号。
  
  Distance:
      #id: dist
  
      ポイントを動かす距離。
  

  以下のように他のアセットのヘルプからこのパラメータを含めることができます:

  @parameters
  
  :include otherasset#group:
  
  :include otherasset#dist:
  

• パラメータを複製したりプロモートしても、ラベルや内部名が異なっていることがあります。Includeパス内で#id部分の後にスラッシュを追加することで、その 内容 だけを含めることができます:

  @parameters
  
  Point group:
      #id: ptgroup
  
      :include otherasset#group/: