From 32f33e7bb34598e8603b9f6a931ef063f6bd31f2 Mon Sep 17 00:00:00 2001 From: Robert Bisewski Date: Tue, 3 Oct 2017 22:49:21 -0500 Subject: [PATCH 1/5] improving HOWTO document --- docs/startup-HOWTO.html | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/startup-HOWTO.html b/docs/startup-HOWTO.html index 07a9f47c..fe317ad9 100644 --- a/docs/startup-HOWTO.html +++ b/docs/startup-HOWTO.html @@ -635,7 +635,7 @@ separated by : from the actual proxy password.

12. Statusbar

-

/STATUSBAR displays a list of statusbars:

+

/STATUSBAR displays a list of the current statusbars, along with their position and visibility:

 Name                           Type   Placement Position Visible
  window                         window bottom    0        always
@@ -644,9 +644,9 @@ separated by : from the actual proxy password.

  topic                          root   top       1        always
-

/STATUSBAR <name> prints the statusbar settings and it’s items. /STATUSBAR <name> ENABLE|DISABLE enables/disables the statusbar. /STATUSBAR <name> RESET resets the statusbar to it’s default settings, or if the statusbar was created by you, it will be removed.

+

/STATUSBAR <name> prints the statusbar settings (type, placement, position, visibility) as well as its items. /STATUSBAR <name> ENABLE|DISABLE enables/disables the statusbar. /STATUSBAR <name> RESET resets the statusbar to its default settings, or if the statusbar was created by you, it will be removed.

-

Type can be window or root, meaning if the statusbar should be created for each split window, or just once. Placement can be top or bottom. Position is a number, the higher the value the lower in screen it is. Visible can be always, active or inactive. Active/inactive is useful only with split windows, one split window is active and the rest are inactive. These settings can be changed with:

+

The statusbar type can be either window or root. If the type is window, then a statusbar will be created for each split window, otherwise it will be created only once. Placement can be top or bottom, which refers to the top or bottom of the screen. Position is a number, the higher the value the lower it will appear in-screen. Visible can be always, active or inactive. Active/inactive is useful only with split windows; one split window is active and the rest are inactive. To adjust these settings, the following commands are available:

 /STATUSBAR <name> TYPE window|root
  /STATUSBAR <name> PLACEMENT top|bottom
@@ -654,10 +654,10 @@ separated by : from the actual proxy password.

  /STATUSBAR <name> VISIBLE always|active|inactive
-

When loading a new statusbar scripts, you’ll need to also specify where you want to show it. Statusbar items can be modified with:

+

Statusbar items can also be added or removed via command. Note that when loading new statusbar scripts that add items, you will need to specify where you want to show the item and how it is aligned. This can be accomplished using the below commands:

 /STATUSBAR <name> ADD [-before | -after <item>] [-priority #] [-alignment left|right] <item>
  /STATUSBAR <name> REMOVE <item>
-

The item name with statusbar scripts is usually same as the script’s name. Script’s documentation should tell if this isn’t the case. So, to add mail.pl before the window activity item (see the list with /STATUSBAR window), use: /STATUSBAR window ADD -before act mail.

+

For statusbar scripts, the item name is usually equivalent to the script name. The documentation of the script ought to tell you if this is not the case. For example, to add mail.pl before the window activity item, use: /STATUSBAR window ADD -before act mail.

From e1e632d31e1d8efc3370db76ddcc4bda200e4d31 Mon Sep 17 00:00:00 2001 From: Robert Bisewski Date: Thu, 5 Oct 2017 22:47:15 -0500 Subject: [PATCH 2/5] correcting and expanding content of statusbar help text --- docs/help/in/statusbar.in | 31 ++++++++++++++++++++----------- 1 file changed, 20 insertions(+), 11 deletions(-) diff --git a/docs/help/in/statusbar.in b/docs/help/in/statusbar.in index ac475dd5..7fff7fb8 100644 --- a/docs/help/in/statusbar.in +++ b/docs/help/in/statusbar.in @@ -5,22 +5,31 @@ %9Parameters:%9 - ENABLE: Enables the statusbar. - DISABLE: Disabled the statusbar. + ENABLE: Adds a statusbar to the list of statusbars. + DISABLE: Removes a statusbar from the list. RESET: Restores the default statusbar configuration. - TYPE: Identifies the type of statusbar. - PLACEMENT: Identifies the placement of the statusbar. - POSITION: Identifies the position of the statusbar. - VISIBLE: Identifies the visibility of the statusbar. - ADD: Adds a statusbar into the configuration. - REMOVE: Removes a statusbar from the configuration. + TYPE: Refers to the type of statusbar, for each split window + or only for the current root screen. + PLACEMENT: Refers to the placement of the statusbar, either at the + top or the bottom of the screen. + POSITION: Refers to the position of the statusbar. Represented as + an unsigned integer, with 0 implying the first position. + VISIBLE: Refers to the visibility of the statusbar or item. If set + to always it is visible on all screens, otherwise if set + to inactive or active then it is only visible on inactive + or active screens, respectively. + ADD: Adds an item to the specified statusbar. It can be set to + appear before/after another item and left/right aligned + to a specified position on the screen. + REMOVE: Removes an item from the specified statusbar. - The name of the statusbar; if no argument is given, the list of statusbars - will be displayed. + Where name refers to the name of the statusbar; if no argument is + given, the entire list of statusbars will be displayed. %9Description:%9 - Modified the attributes of the statusbar. + Allows adjustment of the attributes and items of a statusbar, as well + as where it is located and whether or not it is currently visible. %9Examples:%9 From 0883ff8d320be47336e05aa38cf11427bd79b3af Mon Sep 17 00:00:00 2001 From: Robert Bisewski Date: Fri, 6 Oct 2017 07:13:30 -0500 Subject: [PATCH 3/5] reverting changes to startup HOWTO --- docs/startup-HOWTO.html | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/startup-HOWTO.html b/docs/startup-HOWTO.html index fe317ad9..07a9f47c 100644 --- a/docs/startup-HOWTO.html +++ b/docs/startup-HOWTO.html @@ -635,7 +635,7 @@ separated by : from the actual proxy password.

12. Statusbar

-

/STATUSBAR displays a list of the current statusbars, along with their position and visibility:

+

/STATUSBAR displays a list of statusbars:

 Name                           Type   Placement Position Visible
  window                         window bottom    0        always
@@ -644,9 +644,9 @@ separated by : from the actual proxy password.

  topic                          root   top       1        always
-

/STATUSBAR <name> prints the statusbar settings (type, placement, position, visibility) as well as its items. /STATUSBAR <name> ENABLE|DISABLE enables/disables the statusbar. /STATUSBAR <name> RESET resets the statusbar to its default settings, or if the statusbar was created by you, it will be removed.

+

/STATUSBAR <name> prints the statusbar settings and it’s items. /STATUSBAR <name> ENABLE|DISABLE enables/disables the statusbar. /STATUSBAR <name> RESET resets the statusbar to it’s default settings, or if the statusbar was created by you, it will be removed.

-

The statusbar type can be either window or root. If the type is window, then a statusbar will be created for each split window, otherwise it will be created only once. Placement can be top or bottom, which refers to the top or bottom of the screen. Position is a number, the higher the value the lower it will appear in-screen. Visible can be always, active or inactive. Active/inactive is useful only with split windows; one split window is active and the rest are inactive. To adjust these settings, the following commands are available:

+

Type can be window or root, meaning if the statusbar should be created for each split window, or just once. Placement can be top or bottom. Position is a number, the higher the value the lower in screen it is. Visible can be always, active or inactive. Active/inactive is useful only with split windows, one split window is active and the rest are inactive. These settings can be changed with:

 /STATUSBAR <name> TYPE window|root
  /STATUSBAR <name> PLACEMENT top|bottom
@@ -654,10 +654,10 @@ separated by : from the actual proxy password.

  /STATUSBAR <name> VISIBLE always|active|inactive
-

Statusbar items can also be added or removed via command. Note that when loading new statusbar scripts that add items, you will need to specify where you want to show the item and how it is aligned. This can be accomplished using the below commands:

+

When loading a new statusbar scripts, you’ll need to also specify where you want to show it. Statusbar items can be modified with:

 /STATUSBAR <name> ADD [-before | -after <item>] [-priority #] [-alignment left|right] <item>
  /STATUSBAR <name> REMOVE <item>
-

For statusbar scripts, the item name is usually equivalent to the script name. The documentation of the script ought to tell you if this is not the case. For example, to add mail.pl before the window activity item, use: /STATUSBAR window ADD -before act mail.

+

The item name with statusbar scripts is usually same as the script’s name. Script’s documentation should tell if this isn’t the case. So, to add mail.pl before the window activity item (see the list with /STATUSBAR window), use: /STATUSBAR window ADD -before act mail.

From 84bfea52af8776e13d754e2ee20387f07556fc90 Mon Sep 17 00:00:00 2001 From: Robert Bisewski Date: Fri, 6 Oct 2017 07:54:54 -0500 Subject: [PATCH 4/5] adjusting text content as per the pull-request discussion --- docs/help/in/statusbar.in | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/docs/help/in/statusbar.in b/docs/help/in/statusbar.in index 7fff7fb8..13977891 100644 --- a/docs/help/in/statusbar.in +++ b/docs/help/in/statusbar.in @@ -6,15 +6,17 @@ %9Parameters:%9 ENABLE: Adds a statusbar to the list of statusbars. - DISABLE: Removes a statusbar from the list. + DISABLE: Removes a statusbar from the list. Note that for + built-in statusbars they can be enabled again should the + user wish to add back the default statusbars. RESET: Restores the default statusbar configuration. - TYPE: Refers to the type of statusbar, for each split window - or only for the current root screen. - PLACEMENT: Refers to the placement of the statusbar, either at the - top or the bottom of the screen. - POSITION: Refers to the position of the statusbar. Represented as - an unsigned integer, with 0 implying the first position. - VISIBLE: Refers to the visibility of the statusbar or item. If set + TYPE: Sets the type of statusbar, for each split window or only + for the current root screen. + PLACEMENT: Sets the placement of the statusbar, either at the top or + the bottom of the screen. + POSITION: Sets the position of the statusbar. Represented as a + number, with 0 implying the first position. + VISIBLE: Sets the visibility of the statusbar or item. If set to to always it is visible on all screens, otherwise if set to inactive or active then it is only visible on inactive or active screens, respectively. From 4b42eca7c57fdd3d5ded8d5b1d4c75d01fc28569 Mon Sep 17 00:00:00 2001 From: Robert Bisewski Date: Fri, 6 Oct 2017 07:58:27 -0500 Subject: [PATCH 5/5] minor word correction --- docs/help/in/statusbar.in | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/help/in/statusbar.in b/docs/help/in/statusbar.in index 13977891..7d64b816 100644 --- a/docs/help/in/statusbar.in +++ b/docs/help/in/statusbar.in @@ -17,8 +17,8 @@ POSITION: Sets the position of the statusbar. Represented as a number, with 0 implying the first position. VISIBLE: Sets the visibility of the statusbar or item. If set to - to always it is visible on all screens, otherwise if set - to inactive or active then it is only visible on inactive + always it is visible on all screens, otherwise if set to + inactive or active then it is only visible on inactive or active screens, respectively. ADD: Adds an item to the specified statusbar. It can be set to appear before/after another item and left/right aligned