AppleScriptDoc
AppleScriptDoc とは
ライブラリ/モジュールとしての AppleScript のリファレンスマニュアルを生成するアプリケーションです。
ソースコードにかかれたコメントから、スクリプトのリファレンスマニュアルを HTML として出力します。バンドル形式のスクリプトの場合、バンドル内に(ヘルブビューアに表示する) Help Book としてリファレンスマニュアルをセットアップできます。
つまり、ソースコードを書きながら、そのコメントを書くように気軽にマニュアルの執筆でき、ライブラリの使用時に素早くアクセスできる使いやすいマニュアルを生成できるということです。
必要なシステム
- OS X 10.9 以降
- macOS 10.14.6 で開発/テストしております。
- OpenHelpBook.scptd
- AppleScript からヘルプビューアで Help Book を表示するために必要です。
- ダウンロードパッケージに含まれています。
インストール
OpenHelpBook.scptd（AppleScript Library）
OpenHelpBook.scptd 
を、
/ホームフォルダ/ライブラリ/Script Librareis/
もしくは、
/ライブラリ/Script Librareis/
にコピーしてください。
AppleScriptDoc
アプリケーション AppleScriptDoc は好きな場所に配置してください。
更新履歴
- 1.8.2 -- 2020-06-26
- HTML タグ以外での “<”, “>”, “&”, “"” を実体参照に変換します。
- 1.8.1 -- 2020-06-05
- 最近使ったスクリプトのリストの項目が重複することがある不具合を修正。
- 1.8 -- 2020-01-17
- App Notarizetion に対応。
- ハンドラーページに複数の @example を含められるようにした。
- AppeScript コマンド setup helpbook を追加。
- テキストファイル .applescript をサポート。
- Sparkel フレームワークを更新 (1.22.0)。
- HelpBook.osax の代わりに、OpenHelpBook.scptd を添付。
- OS X 10.9 以降が必要。
- OpenHelpBook.scptd が AppleScript Libraries を必要としているため。
- 1.7.1 -- 2017-09-29
- @example によるスクリプトリンクの改善
- コード中の「=」をパーセントエスケープするようにした。
- ハンドラーページの「Edit Script」リンクとクリップボードアイコンのリンクが動作しない不具合を修正。
- Sparkle フレームワークを更新 (1.17.0)。
- 1.7 -- 2017-02-01
- コード署名を追加。
- カスタムアイコンを設定。
- 複数の @syntax タグをサポート。
- @example タグを追加。
- AppleScriptDoc が書かれたコメントの中で入れ子になったコメントをサポート。
- 最近使ったファイルが存在しない場合のエラー処理を改善。
- 「Help Book を設定」は、Mac OS X 10.6 で導入された新しいヘルプブックのバンドル構造を生成します。
- 他、内部の多くの変更。
- 1.6 -- 2016-02-12
- Mac OS X 10.8 以降が必要になりました。
- コードのクリーアップの近代化
- HelpBook のインデックス作成に、Help Indexer ではなく、hiutil コマンドを使うようにした。
- 1.5.1 -- 2013-05-24
- 「Help Book を書き出す」が動作しない不具合を修正。
- 1.5 -- 2013-04-19
- AppleScript Studio から AppleScriptObjC に移行。
- Mac OS X 10.6 以降が必要になった。
- 1.4.4 -- 2012-11-28
- 番号付きリストを HTML に変換できない不具合を修正。
- 1.4.3 -- 2012-11-20
- ハンドラページで「Edit Script」が動作しない不具合を修正
- 1.4.2 -- 2012-11-09
- ターゲットスクリプトをウインドウへのドロップで指定できない不具合を修正。
- 1.4.1 -- 2012-06-06
- 1.4 -- 2012-05-17
- インデックスページに、ページ内の見出しにジャンプするポップアップメニューを追加。
- 1.3.2 -- 2012-05-01
- Mac OS X 10.6 のヘルプビューアで、「Edit Script」リンクやハンドラのコピーが動作しない不具合を修正。
- 出力される HTML をいくらか調整。
- その他、細かい修正。
- HelpBook.osax を付属するようにした。
- 1.3.1 -- 2009-12-20
- バンドルの Info.plist に CFBundleIndentifer が無い場合、自動的に設定するようにした。
- Mac OS X 10.6 では、Help Book を表示するには CFBundleIdentifier が必要なようです。
- 1.3 -- 2009-11-09
- Mac OS X 10.6 に対応。
- Mac OS X 10.4 をサポートからはずした。
- デフォルトのフォントサイズを 12px に変更。
- 1.2.3 -- 2009-01-06
- Sparkle を使用して、セルフアップデート機能を追加。
- @reference でファイルへの相対参照を使用できるようにした。
- インデックスページからの相対パスを設定すれば、ハンドラページでも正しくリンクが設定されます。
- 1.2.2 -- 2008-12-15
- オプションキーを押しながら履歴ポップアップメニュー項目を選択することにより、選択項目を削除できるようにした。
- 1.2.1 -- 2008-12-10
- 1.2 -- 2008-11-27
- スクリプトエディタを使わずに、スクリプトのスタイルを所得するようにした。
- 1.1.2 -- 2008-04-07
- @syntax タグを追加
- @references タグを追加
- 「Help Book を書き出す」の処理中にキャンセルできるようにした。
- @param タグの中で、((<link word>)) を使えるようにした。
- ((< >)) で囲まれた URL と mail address を自動的にリンクに変換するようにした。
- 細かい不具合修正
- 1.1.1 -- 2008.01.16
- 「ファイルに保存」が動作しない不具合を修正
- Info.plist を持たないスクリプトバンドルに、「Help Book をセットアップ」が動作しない不具合を修正
- 「Help Book を書き出す」機能で、「Help Book のルート」と「ファイルを出力」の関係が正しく認識されないことがある不具合を修正。
- 「Help Book を書き出す」機能で、スクリプトごとに前回の「Help Book のルート」と「ファイルを出力」の設定を記録するようにした。
- 1.1 -- 2007.09.05
- AppleScriptDoc でアプリケーションとしてスクリプトを統合した。
- 英語マニュアルの追加
- 1.0.2 -- 2007.06.15
- ハンドラへのリンクは ((<handler_name>)) で記述するようにした。
- XHTML を出力するようにした。
- 1.0.1 -- 2007.03.01
- ヘルプビューアでしか動作しないリンクを Safari など通常の Web ブラウザでクリックした時に、メッセージを表示するようにした。
- 1.0 -- 2007.02.21
