From 95cc1df43ecd29fcc3e3054b9e5a4e09f63ee618 Mon Sep 17 00:00:00 2001 From: Isaac Bennetch Date: Sat, 2 May 2015 11:17:35 -0400 Subject: [PATCH] Bug 4875: Improve documentation for BrowseMarkerEnable, BrowsePointerEnable, and related directives. Signed-off-by: Isaac Bennetch --- doc/config.rst | 29 +++++++++++++++++++++-------- 1 file changed, 21 insertions(+), 8 deletions(-) diff --git a/doc/config.rst b/doc/config.rst index 19b7f26e0b..6f7897c4d0 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -2254,26 +2254,36 @@ Theme settings :type: string [CSS color] :default: + The background color used when hovering over a row in the Browse panel. + See :file:`themes/themename/layout.inc.php`. + .. config:option:: $cfg['BrowsePointerColor'] :type: string [CSS color] :default: + The text color used when hovering over a row in the Browse panel. + Used when :config:option:`$cfg['BrowsePointerEnable']` is true. + See :file:`themes/themename/layout.inc.php`. + .. config:option:: $cfg['BrowseMarkerBackground'] :type: string [CSS color] :default: + The background color used to highlight a row selected by checkbox in the Browse panel or + when a column is selected. + Used when :config:option:`$cfg['BrowsePointerEnable']` is true. + See :file:`themes/themename/layout.inc.php`. + .. config:option:: $cfg['BrowseMarkerColor'] :type: string [CSS color] :default: - The colors (HTML) uses for the pointer and the marker in browse mode. - The former feature highlights the row over which your mouse is passing - and the latter lets you visually mark/unmark rows by clicking on the - corresponding checkbox. Highlighting / marking a column is done by - hovering over / clicking the column's header (outside of the text). + The color used when you visually mark a row or column in the Browse panel. + Rows can be marked by clicking the checkbox to the left of the row and columns can be + marked by clicking the column's header (outside of the header text). See :file:`themes/themename/layout.inc.php`. .. config:option:: $cfg['FontFamily'] @@ -2300,21 +2310,24 @@ Design customization :type: boolean :default: true - A value of ``true`` activates the navi pointer. + When set to true, hovering over an item in the navigation panel causes that item to be marked + (the background is highlighted). .. config:option:: $cfg['BrowsePointerEnable'] :type: boolean :default: true - Whether to activate the browse pointer or not. + When set to true, hovering over a row in the Browse page causes that row to be marked (the background + is highlighted). .. config:option:: $cfg['BrowseMarkerEnable'] :type: boolean :default: true - Whether to activate the browse marker or not. + When set to true, a data row is marked (the background is highlighted) when the row is selected + with the checkbox. .. config:option:: $cfg['LimitChars']