Oracle Help for Javaのファイル形式 Previous topic
前へ
Next topic
次へ

マップ・ファイル(.xml)

マップ・ファイルは、ヘルプのトピックIDと、コンテンツを含むHTMLファイル、およびヘルプセットで定義されているウィンドウ・タイプを関連付けるために使用されます。これらのIDとマップ・ファイルは、状況依存ヘルプのAPI、目次ファイルおよび索引ファイルで使用されます。OHJのマップ・ファイルの形式は、JavaHelp 1.0の仕様で規定されているファイル形式に類似しています。OHJでは、<mapID>タグにwintype属性を追加しています。マップ・ファイルが提供する間接化によって、開発者はトピックIDを設計し、後で実際のコンテンツ・ファイルに関連付けることができます。またマップ・ファイルによって、ヘルプ・システムのアップグレードに伴う問題も減少します。(現在のほとんどのオーサリング・ツールでは、自動的にファイル名を作成し割り当てることによってソース・ファイルからHTMLコンテンツ・ファイルを生成します。トピックの追加や削除などによりヘルプ・システムをアップグレードする場合、これらのファイル名が同期しなくなる可能性があります。マップ・ファイルでは、古いトピックIDを新しいHTMLコンテンツ・ファイルに一致させる方法が提供されます。)トピックIDやファイル名で有効な文字は、英数字と、等号(=)を除くファイル名として使用できる記号類です。トピックIDは、ヘルプセット内で一意である必要があります。相対URLは、マップ・ファイルの絶対URLに対して解決されます。

マップ・ファイルの例を示します。

  <?xml version='1.0' ?>

  <map version="1.0">
    <mapID target="topic1" url="file1.html" />
    <mapID target="topic2" url="file2.html#a1" />
    <mapID target="t3" url="file3.html" wintype="intro" />
    <mapID target="t4" url="file4.html#a2" wintype="intro" />
    <mapID target="t5.tsk" url="file5.html" wintype="task" />
    <mapID target="t5.cncpt" url="file5.html" wintype="concept" />
  </map>

マップ・ファイルでは、トピックIDおよびURLにウィンドウ・タイプを割り当てることもできます。前述の例で、topic1およびtopic2のmapIDにはウィンドウ・タイプが関連付けられていないため、ヘルプセットで定義されているデフォルトのウィンドウ・タイプが使用されます。t3およびt4のmapIDは、introというウィンドウ・タイプで表示されるHTMLコンテンツ・ファイルにマップされます。t5.tskのmapIDでは、taskというウィンドウ・タイプで定義されているウィンドウに、file5.htmlを表示します。t5.cncptのmapIDでは、同じコンテンツ・ファイル(file5.html)を、別のウィンドウ・タイプ(concept)に表示します。URLとwintypeとの関連付けは、トピックIDのかわりにURLを使用してトピック間をリンクする際にも使用されるので注意してください。たとえば、あるトピックでターゲットがfile5.htmlにハードコードされている場合、このリンクをクリックするとHTMLコンテンツはtaskのウィンドウ・タイプで表示されます。

この仕組みを利用すれば、HTMLファイルにウィンドウ・タイプを割り当てることも、別のトピックIDにリンクすることでこれらの関連付けを無効にすることもできます。たとえば、ヘルプ・システムのトピック間のリンク、目次と索引からのリンク、およびハードコードされたfile5.htmlへのリンクの場合にはt5.tskを使用し、Introductory Tutorialからのリンクの場合にはt5.cncptを使用できます。このような情報をマップ・ファイルに保持することにより、ヘルプの作成者はこれらの関連付けを集中管理できます。


  Previous topic
前へ
Next topic
次へ