intra-mart Accel Platform サイトツアー仕様書 初版 2015-04-01

3. 概要

3.1. サイトツアーとは

サイトツアーとは画面内に簡易ヘルプを表示する機能です。
intra-mart Accel Platform で提供するテーマに埋め込まれている、ヘルプドロップダウンから呼び出すことができます。
クライアントサイド JavaScript も提供しているため、テーマの適用されていない画面でも独自に呼び出すことができます。

3.1.1. サイトツアーの種類

サイトツアーは画面内にある説明を同時に表示する一括表示と、順を追って説明を表示するステップ表示の二種類があります。

  • 一括表示
    • 手順ではなく、画面内の項目を説明する場合

      一括表示
  • ステップ表示
    • 説明する項目が多い場合

    • 手順を追って説明をする場合

      ステップ表示
  • 上記の枠線の部分でステップの操作が行えます。

3.1.2. ホームURL初回アクセス時の動作について

ホームURLに登録されているURLに初めてアクセスしたとき、ヘルプドロップダウンの利用を促すメッセージが表示されます。

サイトツアー

コラム

ホームURLに指定した画面にヘルプが埋め込まれていない場合でも、このメッセージは表示されます。

コラム

もう一度メッセージを表示したい場合は、ブラウザのクッキーを削除する必要があります。

3.2. 仕様

  • テーマが適用されている画面で利用することができます。

  • 表示している画面内にヘルプ埋め込まれている場合に、ヘルプを呼び出すメニューが活性になります。

  • ヘルプが埋め込まれていない、またはヘルプを指定している要素が非表示の場合は、ヘルプを呼び出すメニューが非活性になり、クリックすることができません。

  • 画面にヘルプが埋め込まれているかどうかは、ヘルプドロップダウンにマウスを乗せるたびに確認しています。
    • そのため、初期表示時にはヘルプがなく、あとからヘルプを追加した場合でも、ヘルプを呼び出すことができます。
  • サイトツアーの種類がステップ表示だった場合、右下にステップを操作するメニューが表示されます。
    • キーボード操作でも前後のステップに移動することができます。
  • ダイアログ内でサイトツアーを呼び出したい場合は、特定のオプションを指定することで、ダイアログの閉じるアイコンの隣にサイトツアーを呼び出すアイコンが表示されます。

3.3. 注意事項

  • フレームをまたがった説明はできません。

  • 画面に複数のヘルプを同時に表示する際には、それぞれのヘルプの表示位置が重ならないように調整してください。
    • そのため、複数の言語に対応する場合はそれぞれの言語で表示されることを想定した位置にヘルプを表示するように注意してください。
  • 国際化対応は呼び出し側で行ってください。
    • imart type=”message” や imart type=”string” を利用し、プロパティファイルから取得した文字列を表示するようにしてください。
  • その他の制限事項についてはリリースノートに記載されています。必ず制限事項を確認してください。