Help を作る

アプリケーションにヘルプを追加する方法のメモ。

まず、ヘルプを追加したい Xcode プロジェクトのフォルダの中にヘルプファイルを入れるフォルダを作り、その中に、html のヘルプファイルを入れる。

ここでは、help という名前のフォルダを作って、help.html というヘルプファイルを作った。

次に、Xcode でプロジェクトファイルを開いて、このフォルダを追加する。

Resources を右クリックして、追加から、既存のファイル...を選ぶ。

ここで、作った help フォルダを選ぶ。

追加のオプションを聞かれるので、追加したフォルダにフォルダ参照を作成するを選び、追加をクリックする。

これで、help フォルダが Resources に追加される。

次に、info.plist ファイルの中身をいじって、ヘルプファイルにアクセスできるようにする。

エディタが表示してあればそのまま、そう出なければダブルクリックして中身を表示する。

ここで、Information Property List もしくは、その下の項目のどれかを選ぶ。

Information Property List を選んだ場合は、

それ以外の項目の場合は

がテーブルの右に現れるのでクリックすると、新たな項目が追加される(2つ追加する)。そしたら、Help Book directory pathHelp Book main page CONTENT attribute を選ぶ(XCode 3.1x)。

追加されたら、Help Book directory path には上で追加したフォルダの名前を、Help Book main page CONTENT attribute には、ヘルプファイルの ID みたいなものを入力する。ここでは、Test Help としておく。

これが終わったら、ファイルを保存する。

次に、help.html をテキストエディタで開いて(DreamWeaver でコードをいじってもいい)、ヘッダー部分 <head>~</head> に次の一行を追加する。これは、一番最初に読み込みたいページだけにつける。

<meta name="AppleTitle" content="Test Help">

この content の部分が、info.plist の Help Book main page CONTENT attribute と一致するようにする。あとは、ヘルプファイルをちゃんと作り、保存して、Xcode プロジェクトでビルドする。

追記:ちなみに、XCode 3.2 ではこの部分のラベルが変わっている。Help Book directory path Help Book directory name になり、Help Book main page CONTENT attributeHelp Book Identifier になった。でも、変わったのはリストに出てくるラベルだけのようで、XML にしてみると前と同じ key になっている。

これで、メニューの Help からアプリケーションのヘルプを選ぶと、ヘルプファイルが表示される。

help ファイルの方は、内容が多い場合は、いくつものファイルを相対リンクしてヘルプサイトみたいなのを作ってからフォルダを追加して最初に開きたいファイルに meta タグを追加すれば、後はリンクをたどってヘルプファイルを移動できる。