baserCMS Documentation

Githubでこのページを編集

Home / 5 / ucmitz / specification / baser core / common / ヘルプ設計書

ヘルプ設計書

ヘッダーヘルプ

画面右上に配置するヘルプボタンをクリックする事で、画面タイトル下にヘルプを表示する。
各画面ごとにヘルプ内容を定義する事ができる。

ヘッダーヘルプ配置方法

ヘルプ内容のファイルは、エレメントとして、templates/Admin/element/help/ 内に作成する。
各画面での定義は、ビューテンプレートにて、次を実行する。

$this->BcAdmin->setHelp('help_file_name');

 

フィールドヘルプ

編集画面などにてフィールドの横に?マークを表示し、クリックするとツールチップでヘルプを表示できる。

フィールドヘルプ配置方法

アイコンとヘルプ内容のタグを対象フィールドの次に配置する。

bca-help クラス属性の付与されたタグをトリガーとして、次の、bca-helptext クラス属性のついたタグの内容をツールチップとして表示する。

<!-- 例 -->
<i class="bca-icon--question-circle bca-help"></i>
<div class="bca-helptext"><?php echo __d('baser', '半角英数字とハイフン、アンダースコアのみで入力してください。') ?></div>