HelpBook.osax
任意のバンドル内の Help Book を ヘルプビューアへ登録、表示を行うスクリプティング機能追加です。
macOS では、アプリケーションなどでは、そのバンドル内の HTML で書かれたヘルプファイル(Help Book といいます)をヘルプビューアで表示させることができます。アプリケーションとそのヘルプファイルをひとまとめにして扱うことができますので、非常にスマートな方法だと思います。
このスクリプティング機能追加は、AppleScript から次の様なことをできるようにします。
- AppleScript からアプリケーションを起動せずヘルプを表示させることができます。
- スクリプトバンドル形式の AppleScript に Help Book を持たせることができます。
ヘルプビューアに Help Book を登録すると、ヘルプビューアの高度な検索機能やAppleScript の実行機能が使えるようになります。普通の HTML ファイルでヘルプを提供するより、使いやすい説明書を作れます。
Memory (2020-02-06)
macOS 10.14 から System Integrity Protection(SIP)によって、サードパーティ製のスクリプティング機能追加がブロックされるようなりました。そこで、OpenHelpBook.scptd を開発しました。
OpenHelpBook.scptd は、AppleScript ライブラリとバンドル内のコマンドラインツールによって同等のことを行えます。
XModules として公開したライブラリの全てで OpenHelpBook への移行が完了したので引退です。
更新履歴
- 1.2 -- 2016-12-12
- Mac OS X 10.6 以降が必要です。
- コード署名を追加した。
- OS X 10.10 以降では、アプレットにヘルプメニューを追加できなくなったので、マニュアルから記述を削除しました。
- Help Book がセットアップされていないバンドルに対して register helpbook を実行すると異常終了する不具合を修正。
- 1.1.4 -- 2016-02-05
- ガーベージコレクションのサポートを追加した。
- 1.1.3 -- 2010-12-10
- Mac OS X 10.4 で動作するようにした。
- 1.1.2 -- 2010-08-24
- PackageMaker によるインストールパッケージを作った。
- 1.1.1/1.0.3 -- 2009-11-21
- バージョンを取得するコマンド、"HeloBookOSAX Version" を追加。
- オプション recovering InfPlist を追加。
- メモリリークを修正。
- インストーラをパッケージに含めるようにした。
- 1.1/1.0.2 -- 2009-10-16
- Mac OS X 10.6 に対応
- Mac OS X 10.4 以前をサポートの対象から外しました。
- Version 1.1 は Mac OS X 10.6 用で、Version 1.0.2 は Mac OS X 10.5 用です。
- 1.0.1 -- 2007.03.20
- 英語のマニュアルを追加
- 1.0 -- 2006.04.12
- 初公開