explain system_admin_compact_mode [#1394790]

Comment	File	Size	Author
#12	1394790-12.drupal.system_admin_compact_mode-missing-docs.patch	1.03 KB	joachim
#1	1394790.drupal.system_admin_compact_mode-missing-docs.patch	743 bytes	joachim

Comment #1

joachim commented 5 January 2012 at 09:41

Status:

Active

» Needs review

Status	File	Size
new	1394790.drupal.system_admin_compact_mode-missing-docs.patch	743 bytes

Here's a patch.

Log in or register to post comments

Comment #2

jhodgdon

she/her

English

commented 6 January 2012 at 15:21

Status:

Needs review

» Needs work

Seems like a good thing to fix, thanks!

The documentation in the patch needs some cleanup:
- All lines should wrap as close to 80 characters as possible without going over.
- Needs some copy editing (grammar etc.).
- "ie" should be "i.e.,".
- "UI" should be written out as "user interface".

It's also actually not accurate to say there is no user interface for this. There is a path for it (admin/compact), so if someone visits admin/compact/on or admin/compact/off, it will turn compact mode on/off. theme_system_compact_link() makes these links, and this is called in several places in the code.

Log in or register to post comments

Comment #3

joachim commented 6 January 2012 at 15:32

admin/compact sets the cookie; it doesn't set the variable.

Log in or register to post comments

Comment #4

jhodgdon

she/her

English

commented 6 January 2012 at 16:47

True. But the patch says "This is hidden, ie there is no UI to control it,...", without explaining whether "this" refers to the cookie or the variable. I read it to say that there was no user interface for anything related to this function.

So, I don't think it would hurt to be clear, or to point out the UI for the cookie, or at least @see the related functions. Right?

Log in or register to post comments

Comment #5

sven.lauer commented 7 January 2012 at 15:41

While we are improving the docs for this function, wouldn't it be nice to explain what compact mode _is_?

Log in or register to post comments

Comment #6

jhodgdon

she/her

English

commented 7 January 2012 at 16:38

Yes, that too.

Log in or register to post comments

Comment #7

joachim commented 8 January 2012 at 09:52

Status:

Needs work

» Needs review

Shan't bother with a patch while we refine the text:

Determines if 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'. This does not have a user interface to set it; i.e. it is a hidden variable which can be set in the settings.php file.

Log in or register to post comments

Comment #8

jhodgdon

she/her

English

commented 9 January 2012 at 16:42

Looks pretty good...

A couple of grammar/usage/typographical nitpicks:
- "i.e.", as you are using it, needs a comma after it. Or "i.e." could just be left out without changing the meaning in any way, I think?
- "Determines if" -> "Determines whether"

Also, maybe this explanatory text should mention that if the admin_compact_mode variable is not set, it defaults to FALSE?

Log in or register to post comments

Comment #9

jhodgdon

she/her

English

commented 20 January 2012 at 05:15

Status:

Needs review

» Needs work

forgot status change on previous comment

Log in or register to post comments

Comment #10

joachim commented 25 January 2012 at 07:58

Status:

Needs work

» Needs review

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.