setting.php の利用方法をコメントに明示

baserproject · Aug 17, 2020 · 1a2fb07 · 1a2fb07
1 parent 73370cc
commit 1a2fb07
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 2 deletions.
diff --git a/app/Config/setting.php b/app/Config/setting.php
@@ -11,8 +11,15 @@
  */
 
 /**
- * メニューを非表示にする例
- * $config['BcApp.adminNavigation.Contents.Contents.menus.ContentsTrash.disable'] = true;
+ * baserCMS アプリケーション設定
+ *
+ * `/lib/Baser/Config/setting.php` に全ての設定が記述されています。
+ * 必要な設定をこのファイルに記述するとこちらが優先されます。
+ *
+ * （例）
+ * $config['BcApp'] = [
+ *	'title' => __d('baser', 'Custom baserCMS')
+ * ];
  */
 $config = [];
 
diff --git a/lib/Baser/Config/setting.php b/lib/Baser/Config/setting.php
@@ -23,6 +23,20 @@
 	// テンプレートの基本となる拡張子（.php 推奨）
 	'templateExt' => '.php',
 	// システムナビ
+	//
+	// 初期状態で表示するメニューは、`Contents` キー配下に定義し、「設定」内に格納する場合は、`Systems` キー配下に定義する
+	//
+	// ■ メインメニュー
+	// `title` : 表示名称
+	// `type` : `system` または、コンテンツを特定する任意の文字列を指定。「設定」内に格納する場合は、`system` を指定
+	// `url` : リンク先URL
+	// `menus` : サブメニューが存在する場合に配列で指定
+	// `disable` : 非表示にする場合に `true` を指定
+	//
+	// ■ サブメニュー
+	// `title` : 表示名称
+	// `url` : リンク先URL
+	// `disable` : 非表示にする場合に `true` を指定
 	'adminNavigation' => [
 		'Contents' => [
 			'Dashboard' => [