このコマンドは、手動で検索インデックスを更新します(--bgindexオプションでサーバーを実行していない場合)。デフォルトでは、このコマンドは--cleanオプションを指定しない限り、変更のあったファイルのみを更新します。

以下の手順は、ヘルプサーバーを実行したいコンピュータ上にHoudiniがインストールされていることを想定しています。 技術的にはHoudiniから必要なファイルすべてをコピーすることができますが、このドキュメントの範囲を越えておりサポートしていません。 インストーラ(無料のAprrenticeでも可)を使った方が簡単で便利です。

1. ($HFSなどの環境変数を利用可能にしたいので)Houdiniシェルからサーバーを実行します。

   Houdiniに同梱されているユーティリティからシェルを実行することで、Houdiniシェル環境が得られます。

   Mac

   Applications/Houdini/Current/Utilities/Houdini Terminal X.X.X

   Windows

   スタートメニュー > Side Effects Software > Command Line Tools X.X.X

   Linux

   cdでHoudiniインストールディレクトリに移動し、source ./houdini_setupを実行します。

   または、あなたの環境で$HFS変数を設定してください。

2. 実行には以下のスクリプトを使用します。(hython ではなく ) 通常のPython 2.7 を使ってスクリプトを実行できることを忘れないでください。

   import argparse
   import sys
   from os.path import expandvars
   
   # HoudiniライブラリをPythonパスに追加します。
   sys.path.append(expandvars("$HFS/houdini/python2.7libs"))
   
   # HoudiniのサードパーティPythonライブラリを追加します。
   # 残念なことに、このパスはプラットフォーム依存です。
   if sys.platform in ("linux", "linux2"):
      sys.path.append(expandvars("$HFS/python/lib/python2.7/site-packages-forced"))
   elif sys.platform == "darwin":
       sys.path.append(
           expandvars(
               "$HFS/Frameworks/Python.framework/Versions/Current/lib/python2.7/site-packages-forced"
           )
       )
   elif sys.platform in ("win32", "win64"):
       sys.path.append(expandvars("$HFS/python27/lib/site-packages-forced"))
   
   from houdinihelp.hconfig import HoudiniAppConfig
   from houdinihelp.server import get_houdini_app
   
   
   class MyConfig(HoudiniAppConfig):
       # 供給させたいディレクトリ
       DOCUMENTS = [
           # $HFS/houdini/help内の"ばらばらな"(ZIP圧縮されていない)ファイル
           expandvars("$HFS/houdini/help"),
           {
               # これは、$HFS/houdini/help内の.zipファイルから
               # ドキュメントを読み込めるようにします。
               "type": "object",
               "classname": "bookish.stores.ZipTree",
               "args": {
                   "dirpath": expandvars("$HFS/houdini/help"),
               }
           },
           # これは、ユーザープリファレンスのhelpディレクトリ下にファイルを追加します。
           expandvars("$HOUDINI_USER_PREF_DIR/help"),
           # サーバーに追加したい他のディレクトリ...
           "/my/dir",
       ]
   
       # ユーザープリファレンスディレクトリ内にキャッシュを格納します。
       CACHE_DIR = expandvars("$HOUDINI_USER_PREF_DIR/config/Help")
   
       # 使用するフルテキストインデックス
       INDEX_DIR = expandvars("$HFS/houdini/config/Help/index")
   
       # houを使用しないページマネージャを指定します。
       PAGES_CLASS = "houdinihelp.hpages.HoudiniPagesWithoutHou"
   
   
   if __name__ == "__main__":
       parser = argparse.ArgumentParser(description="Starts bookish help server")
       parser.add_argument("--host", metavar="HOSTNAME", default="0.0.0.0",
                           help="IP address to serve on.")
       parser.add_argument("--port", metavar="NUM", type=int, default=8888,
                           help="Port number to serve on.")
       parser.add_argument("--config", metavar="FILE", default=None,
                           help="Configuration file to override defaults.")
       parser.add_argument("--log", metavar="FILE", default=None,
                           help="File to output the log to.")
       parser.add_argument("--loglevel", default="INFO",
                           help="The verbosity of the log: DEBUG, INFO, WARNING, or ERROR.")
       args = parser.parse_args()
   
       app = get_houdini_app(
           use_houdini_path=False,
           config_obj=MyConfig,
           config_file=args.config,
           logfile=args.log,
           loglevel=args.loglevel,
           debug=False,
       )
   
       app.run(host=args.host, port=args.port, threaded=True)
   

   (Pythonがhoudinihelpをインポートできない旨のエラーが出た場合、Houdiniのライブラリのパスが正しいかチェックしてください。flaskをインポートできない旨のエラーが出た場合、サードパーティのライブラリのパスが正しいかチェックしてください。)

3. スクリプトを実行後、ブラウザアプリケーション(例えば、ChromeやSafari)を開いて、http://localhost:8888/にアクセスしてみてください。

4. 以下の単純なサンプルスクリプトは、コマンドライン上でホスト名とポート番号を設定することができますが、ディレクトリや他のオプションはハードコーディングで指定します。

   必要に応じて、コマンドラインオプションからもっと多くのオプション(例えば、ホスト名やポート番号)を取得できるようにスクリプトを編集することができます(Pythonのargparseモジュールのドキュメントを参照してください)。

   コンフィグファイルを使うことでオプションを上書きすることもできます。例えば、コンフィグファイルの引数を使って上記のスクリプトを実行することができます:

   python runserver.py --config /Users/matt/helpserver.cfg
   

   そして、そのコンフィグファイルの中で、オプションを上書きすることができます:

   EXTRA_DOCUMENTS = ["/path/to/my/help_dir/"]