2022-12-25

hhelp2022


ここでは、Houdini 日本語ドキュメントのサーバプロセスである hhelp をローカルで実行して使う方法を紹介する。こうすることで、

  1. 検索機能の向上 (2022年12月現在うまくいっていない)
  2. ポップアップヘルプの日本語化
が可能になる。


使用したバージョン:
  • ドキュメント 19.0.720
  • Houdini ビルド 19.5.435 (Python3.9)
ZIP ファイルへのリンクは一番下にあり。

1. ファイルのダウンロードと配置

以下、hhelp を実行し日本語ヘルプファイルを使う PC に既に Houdini (19.5.435 Py3.9) がインストールされている前提で話を進める。

  1. ドキュメントファイルのダウンロード元は以下の通り。
  2. ダウンロードしたファイルを解凍する。ここでは、D:\SideFX\HoudiniFiles\_Help\Houdini19.0.720jaとしており、このディレクトリ直下に help/ と index/ ディレクトリがあるようにしている。
      なお、D:\SideFX\HoudiniFiles\ は、環境変数 HSITE で指定している。

2. 設定ファイル (.cfg) の作成

設定ファイルを定義し、デフォルトの英語ヘルプではなく、日本語ヘルプを参照するようにする。

  1. テキストエディタで以下の設定を、自分の環境にあわせて正しいパスで記述する。
    DOCUMENTS = ["$HSITE/_Help/Houdini19.0.720ja/help"]
INDEX_DIR = "$HSITE/_Help/Houdini19.0.720ja/index"
    DOCUMENTS には [] が必須だが、INDEX_DIR には無用。なぜかというと、前者には複数指定可能だが、後者は一意に指定するから。
  2. 上記を、h19config.cfg というファイル名で保存する (ファイル名は何でも良い)。

3. hhelp プロセスの実行

  1. Command Line Tools を起動
  2. hhelp -C <フルパス>/h19config.cfg index を実行。
      これにより設定ファイルの中に日本語のインデックスが再生成される。
      3分~5分ぐらいかかる。
      過去にこのコマンドを実行したことがあれば、index の前に
      hhelp -C <フルパス>/h19config.cfg clear-cache
      を実行する。(2022: フルパスでの記述は必須ではなくなった?)
  3. インデックス作成後、
    hhelp -C <フルパス>/h9config.cfg serve --port=48626
    を実行。
      これでドキュメントのサーバプロセスが、Houdini のビルトインブラウザも使っているポート 48626 で実行された。

なお、作業ディレクトリに *.cfg ファイルがある場合は、必ずしもフルパスでの記述は不要。

3. ドキュメントを見る

上記の hhelp プロセスで提供される日本語ドキュメントを見るにはいくつかの方法がある

  1. Web ブラウザを使う
    ローカルの場合、Web ブラウザを開き、以下のアドレスを入力。
    http://localhost:48626
      もし 'localhost' が解決できない場合、hosts ファイルを変更する必要がある。Windows の場合, C:\Windows\System32\Drivers\etc\ 以下にある。
      以下の行の最初の '#' を取り去る。
      # 127.0.0.1       localhost
    または、IP アドレスを直打ちする。 
    http://127.0.0.1:48626
    ローカルでないホストで実行している場合は、以下のようにする。
    http://<ホスト名>:48626
    すると以下のように Help が表示される。
  2. Houdini ビルトインブラウザを使う
    Houdini を起動し、F1 を押すと、ビルトインHelpブラウザが表示される。
    デフォルトでは、http://127.0.0.1:48626となっている。

4. ローカルで走らせるメリット

ローカルで走らせるメリットはいくつかある。

  1. インタラクティブな検索
    ローカルで走らせるメリットの一つに検索能力の向上が上げられる。例えば、下図では「ジオメトリ｣を検索フィールドに入れたときの様子。

    よりインタラクティブな検索が可能になる。

    ビルトインブラウザでも同様。
  2. ポップアップヘルプの日本語化
    hhelp をローカルで走らせることにより、ポップアップヘルプを日本語で表示することが出来る。

    これにより、ヘルプファイルを開かなくとも、カーソルをパラメータの上に持っていくだけで、短い概要を読むことが可能。

詳細情報、制限事項

  • この機能に関するドキュメントは「セントラルヘルプサーバーの起動」の項を参照
  • トップページの一部が日本語にならない

      この画像のようにページの一部が日本語になっていない場合は、一度サーバプロセスを停止し、次のコマンドを実行する。
          hhelp -C <フルパス>/h19config.cfg clear-cache
      を実行してから index を再実行する。
  • デフォルトポート番号
    • Houdini のヘルプブラウザが使うデフォルトポート番号は 48626
    • hhelp が使うデフォルトポート番号は 8080
      • この二つを合わせるには、hhelp 実行時に以下のようにポート番号を指定する。
       hhelp  -C h19config.cfg serve --port=48626

リンク

最終更新: 2022-12-25
投稿者 時刻:
ラベル: , , , , ,

0 件のコメント:

コメントを投稿

登録: コメントの投稿 (Atom)