summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDries2012-01-27 15:37:10 (GMT)
committer Dries2012-01-27 15:37:10 (GMT)
commit52f55295368c88f4308c72b9066010947409bc93 (patch)
treeda83aa35acda7a55e7a40071b6bf0e324f409efc
parentcdcb9ec42c0e9f1b1ed7204af82c50e817c1680c (diff)
- Patch #1394790 by joachim: explain system_admin_compact_mode().
-rw-r--r--core/modules/system/system.module13
1 files changed, 12 insertions, 1 deletions
diff --git a/core/modules/system/system.module b/core/modules/system/system.module
index a5bfd10..c0467f0 100644
--- a/core/modules/system/system.module
+++ b/core/modules/system/system.module
@@ -2911,7 +2911,18 @@ function confirm_form($form, $question, $path, $description = NULL, $yes = NULL,
}
/**
- * Determines if the current user is in compact mode.
+ * Determines whether the current user is in compact mode.
+ *
+ * Compact mode shows certain administration pages with less description text,
+ * such as the configuration page and the permissions page.
+ *
+ * Whether the user is in compact mode is determined by a cookie, which is set
+ * for the user by system_admin_compact_page().
+ *
+ * If the user does not have the cookie, the default value is given by the
+ * system variable 'admin_compact_mode', which itself defaults to FALSE. This
+ * does not have a user interface to set it: it is a hidden variable which can
+ * be set in the settings.php file.
*
* @return
* TRUE when in compact mode, FALSE when in expanded mode.