Difference between revisions of "Interface Bars"

From All n One's bxp software Wixi

Jump to: navigation, search
m (→‎General)
Line 49: Line 49:
  
 
= Bars - Reference Details =  
 
= Bars - Reference Details =  
 +
  
 
== Header Bars ==
 
== Header Bars ==
Line 57: Line 58:
  
 
{| class="wikitable"
 
{| class="wikitable"
−
! style="width:50px;" | Number
+
! style="width:50px;" | &hash;
 
! style="width:150px;" | Title
 
! style="width:150px;" | Title
−
! style="width:200px;" | Description
+
! style="width:50px;" | Params
 +
! style="width:150px;" | Description / Link
 
! style="width:400px;" | Image
 
! style="width:400px;" | Image
 
|-
 
|-
−
| 0 || Logo Bar || Displays the client logo || [[file:menu_bar_000.png|400px]]
+
| 0 || Logo Bar || No || Includes logo.jpg [[Default_bxp_system_images]] || [[file:menu_bar_000.png|400px]]
 
|-
 
|-
−
| 8 || Boundary Top || ||  [[file:menu_bar_008.png|400px]]
+
| 8 || Boundary Top - All || No || ||  [[file:menu_bar_008.png|400px]]
 
|-
 
|-
−
| 15 || Turns off logout and username display ||  ||  [[file:menu_bar_015.png|400px]]
+
| 15 || Boundary Top - No Name || No ||  ||  [[file:menu_bar_015.png|400px]]
 
|-
 
|-
−
| 22 || Boundary Top - Clear || A clear top bar with the username and logout but is transparent ||  [[file:menu_bar_022.png|400px]]
+
| 22 || Boundary Top - Clear || No || Background is transparent ||  [[file:menu_bar_022.png|400px]]
 
|-
 
|-
−
| 32 || Logout Button ||  || [[file:menu_bar_032.png|400px]]
+
| 32 || Logout Button ||  No || Background is transparent. cssMaster_Button styled || [[file:menu_bar_032.png|400px]]
 
|-
 
|-
 
|}
 
|}
 +
 +
  
 
=== Title bars ===
 
=== Title bars ===
 +
  
  
 
{| class="wikitable"
 
{| class="wikitable"
−
! style="width:50px;" | Number
+
! style="width:50px;" | &hash;
 
! style="width:150px;" | Title
 
! style="width:150px;" | Title
−
! style="width:200px;" | Description
+
! style="width:50px;" | Params
 +
! style="width:150px;" | Description / Link
 
! style="width:400px;" | Image
 
! style="width:400px;" | Image
 
|-
 
|-
−
| 1 || Banner Bar || || [[file:menu_bar_001.png|400px]]
+
| 1 || Banner Bar || No || Includes banner.jpg [[Default_bxp_system_images]] || [[file:menu_bar_001.png|400px]]
 
|-
 
|-
−
| 21 || Title bar with no links || Set in Control Bar Settings ||  [[file:menu_bar_021.png|400px]]
+
| 21 || Control Bar Title || No || Set in Control Bar Settings ||  [[file:menu_bar_021.png|400px]]
 
|-
 
|-
−
| 33 || Custom Page Banner || || [[file:menu_bar_033.png|400px]]
+
| 33 || Custom Page Banner || No || Default image preset. Change with JavaScript || [[file:menu_bar_033.png|400px]]
 
|-
 
|-
 
|}
 
|}
 +
 +
  
 
== Navigation Bars ==
 
== Navigation Bars ==
Line 98: Line 106:
  
 
{| class="wikitable"
 
{| class="wikitable"
−
! style="width:50px;" | Number
+
! style="width:50px;" | &hash;
 
! style="width:150px;" | Title
 
! style="width:150px;" | Title
−
! style="width:200px;" | Description
+
! style="width:50px;" | Params
 +
! style="width:150px;" | Description / Link
 
! style="width:400px;" | Image
 
! style="width:400px;" | Image
 
|-
 
|-
−
| 3 || Navigation Bar || Placeable bread crumb bar || [[file:menu_bar_003.png|400px]]
+
| 3 || Navigation Bar || No || Placeable bread crumb bar || [[file:menu_bar_003.png|400px]]
 
|-
 
|-
−
| 19 || I Want To || [[The_I_Want_To_bar]] || [[File:IWantToBar.png|400px]]
+
| 19 || I Want To - Full || No || [[The_I_Want_To_bar]] || [[File:IWantToBar.png|400px]]
 
|-
 
|-
−
| 31 || I Want To Control Bar || || [[file:menu_bar_031.png|400px]]
+
| 31 || I Want To - Collapsible || No || The I Want To bar as collapsible menus || [[file:menu_bar_031.png|400px]]
 
|-
 
|-
−
| 35 || Hides the breadcrumb || || No relevant image
+
| 35 || Hides the breadcrumb || No || [[The_Breadcrumb]] || No relevant image
 
|-
 
|-
 
|}
 
|}
 +
 +
  
 
=== System Access Management based ===
 
=== System Access Management based ===
 +
 +
 +
These bars change dynamically with the module access of the user as set in the System Access Management module.
  
  
 
{| class="wikitable"
 
{| class="wikitable"
−
! style="width:50px;" | Number
+
! style="width:50px;" | &hash;
 
! style="width:150px;" | Title
 
! style="width:150px;" | Title
−
! style="width:200px;" | Description
+
! style="width:50px;" | Params
 +
! style="width:150px;" | Description / Link
 
! style="width:400px;" | Image
 
! style="width:400px;" | Image
 
|-
 
|-
−
| 12 || IconGrid || || [[file:menu_bar_012.png|400px]]
+
| 12 || IconGrid || No || Large icon buttons for each module. (160x160) || [[file:menu_bar_012.png|400px]]
 
|-
 
|-
−
| 13 || IconBar || Apple style bar for the modules you have access to. || [[file:menu_bar_013.png|400px]]
+
| 13 || IconBar || No || Apple style bar for the modules you have access to. (32x32) || [[file:menu_bar_013.png|400px]]
 
|-
 
|-
−
| 34 || Win8 Style Icon Bar || || [[file:menu_bar_034.png|400px]]
+
| 34 || Win8 Style Icon Bar || No || Similar to IconBar but taller icons || [[file:menu_bar_034.png|400px]]
 
|-
 
|-
 
|}
 
|}
Line 133: Line 148:
  
 
=== Control Bar based ===
 
=== Control Bar based ===
 +
 +
 +
These bars change dynamically with the Public and Private links set up in the Control Bar module.
  
  
 
{| class="wikitable"
 
{| class="wikitable"
−
! style="width:50px;" | Number
+
! style="width:50px;" | &hash;
 
! style="width:150px;" | Title
 
! style="width:150px;" | Title
−
! style="width:200px;" | Description
+
! style="width:50px;" | Params
 +
! style="width:150px;" | Description / Link
 
! style="width:400px;" | Image
 
! style="width:400px;" | Image
 
|-
 
|-
−
| 2 || Control Bar || [[Module_-_Control_Bar]] || [[file:menu_bar_002.png|400px]]
+
| 2 || Control Bar - Drop Down || No || Drop down system menu [[Module_-_Control_Bar]] || [[file:menu_bar_002.png|400px]]
 
|-
 
|-
−
| 10 || Compressed menu bar || Currently disabled || No image
+
| 14 || Control Bar - Icons || No || Icon version of drop down menus. || [[file:menu_bar_014.png|400px]]
 
|-
 
|-
−
| 14 || Icon Control Bar || Larger button options customised for specific tasks. || [[file:menu_bar_014.png|400px]]
+
| 38 || Control Bar - Big buttons || No || [[Control_Bar_Big_Buttons]] || [[file:menu_bar_038.png|400px]]
 
|-
 
|-
−
| 38 || Control Bar Big buttons || [[Control_Bar_Big_Buttons]] || [[file:menu_bar_038.png|400px]]
+
| 10 || Compressed menu bar || No || Currently disabled || No image
 
|-
 
|-
 
|}
 
|}
 +
 +
  
 
== Content Bars ==
 
== Content Bars ==
Line 158: Line 179:
  
 
{| class="wikitable"
 
{| class="wikitable"
−
! style="width:50px;" | Number
+
! style="width:50px;" | &hash;
 
! style="width:150px;" | Title
 
! style="width:150px;" | Title
−
! style="width:200px;" | Description
+
! style="width:50px;" | Params
 +
! style="width:150px;" | Description / Link
 
! style="width:400px;" | Image
 
! style="width:400px;" | Image
 
|-
 
|-
−
| 4 || Content || The primary body of the page || Varies by page
+
| 4 || Content ||  No || The primary body of the page || Varies by page
 
|-
 
|-
−
| 25 || Custom HTML Header || Any amount of custom HTML added through the System Access Management > System Settings module || Varies by content
+
| 25 || Custom HTML Header ||  No || Any amount of custom HTML added through the System Access Management > System Settings module || Varies by content
 
|-
 
|-
−
| 26 || Custom HTML Footer ||  Any amount of custom HTML added through the System Access Management > System Settings module || Varies by content
+
| 26 || Custom HTML Footer ||  No || Any amount of custom HTML added through the System Access Management > System Settings module || Varies by content
 
|-
 
|-
−
| 27 || No Security Forms ||  For forms that are public to all users to fill in. || [[file:menu_bar_027.png|400px]]
+
| 27 || No Security Forms ||  No || For forms that are public to all users to fill in. || [[file:menu_bar_027.png|400px]]
 
|-
 
|-
−
| 37 || Did You Know ||  Useful facts and tips about bxp. || [[file:Didyouknow 001.png|400px]]
+
| 37 || Did You Know ||  No || Useful facts and tips about bxp. || [[file:Didyouknow 001.png|400px]]
 
|-
 
|-
 
|}
 
|}
Line 181: Line 203:
  
 
{| class="wikitable"
 
{| class="wikitable"
−
! style="width:50px;" | Number
+
! style="width:50px;" | &hash;
 
! style="width:150px;" | Title
 
! style="width:150px;" | Title
−
! style="width:200px;" | Description
+
! style="width:50px;" | Params
 +
! style="width:150px;" | Description / Link
 
! style="width:400px;" | Image
 
! style="width:400px;" | Image
 
|-
 
|-
−
| 11 || Voting Bar || [[Module_-_Voting_Management]] || [[file:menu_bar_011.png|400px]]
+
| 11 || Voting Bar || No || [[Module_-_Voting_Management]] || [[file:menu_bar_011.png|400px]]
 
|-
 
|-
−
| 23 || eCourse Asset || Used with a - notation allows an eCourse asset to be drawn.  so 23-123 will draw asset 123 || Varies by asset
+
| 23 || eCourse Asset || Yes - Asset Id || Used with a - notation allows an eCourse asset to be drawn.  so 23-123 will draw asset 123 || Varies by asset
 
|-
 
|-
−
| 24 || eCourse Search || Provides a large centred search button which can be heavily stylised as required. || [[file:menu_bar_024.png|400px]]
+
| 24 || eCourse Search || No || Provides a large centred search button which can be heavily stylised as required. || [[file:menu_bar_024.png|400px]]
 
|-
 
|-
−
| 39 || Appointment diary current day view || || [[file:menu_bar_039.png|400px]]
+
| 39 || Appointment diary current day view || Yes - Diary Id ||  || [[file:menu_bar_039.png|400px]]
 
|-
 
|-
 
|}
 
|}
 +
 +
  
 
== Footer Bars ==
 
== Footer Bars ==
Line 200: Line 225:
  
 
{| class="wikitable"
 
{| class="wikitable"
−
! style="width:50px;" | Number
+
! style="width:50px;" | &hash;
 
! style="width:150px;" | Title
 
! style="width:150px;" | Title
−
! style="width:200px;" | Description
+
! style="width:50px;" | Params
 +
! style="width:150px;" | Description / Link
 
! style="width:400px;" | Image
 
! style="width:400px;" | Image
 
|-
 
|-
−
| 5 || Footer Bar || || [[file:menu_bar_005.png|400px]]
+
| 5 || Footer Bar || No || || [[file:menu_bar_005.png|400px]]
 
|-
 
|-
−
| 6 || Standards Bar || || [[file:menu_bar_006.png|400px]]
+
| 6 || Standards Bar || No || || [[file:menu_bar_006.png|400px]]
 
|-
 
|-
−
| 9 || Boundary Bottom || || [[file:menu_bar_009.png|400px]]
+
| 9 || Boundary Bottom || No || || [[file:menu_bar_009.png|400px]]
 
|-
 
|-
 
|}
 
|}
Line 222: Line 248:
  
 
{| class="wikitable"
 
{| class="wikitable"
−
! style="width:50px;" | Number
+
! style="width:50px;" | &hash;
 
! style="width:150px;" | Title
 
! style="width:150px;" | Title
−
! style="width:200px;" | Description
+
! style="width:50px;" | Params
 +
! style="width:150px;" | Description / Link
 
! style="width:400px;" | Image
 
! style="width:400px;" | Image
 
|-
 
|-
−
| 7 ||  Power Bar || [[PowerBar]] || [[file:menu_bar_007.png|400px]]
+
| 7 ||  Power Bar || No || [[PowerBar]] || [[file:menu_bar_007.png|400px]]
 
|-
 
|-
−
| 16 || Work list tool bar ||16-x [[Bxp_-_Worklists]] || Custom by worklist
+
| 16 || Work list tool bar || Yes - Customised Group Id || [[Bxp_-_Worklists]] || Custom by worklist
 
|-
 
|-
−
| 17 ||  Turn off main menu || Hides original Main Menu, must be used before 4 || [[file:original_mainmenu_001.png|400px]] Original Main Menu
+
| 17 ||  Turn off main menu ||  No || Hides original Main Menu, must be used before 4 || [[file:original_mainmenu_001.png|400px]] Original Main Menu
 
|-
 
|-
−
| 18 || Information Centre || Full width information centre message bar || [[file:menu_bar_018.png|400px]]
+
| 18 || Information Centre ||  No || Full width information centre message bar || [[file:menu_bar_018.png|400px]]
 
|-
 
|-
−
| 20 || Appointment Diary || Shows a calendar when the user first logs in || [[file:menu_bar_020.png|400px]]
+
| 20 || Appointment Diary || Yes - Diary Id || Shows a calendar when the user first logs in || [[file:menu_bar_020.png|400px]]
 
|-
 
|-
 
|}
 
|}
 +
 +
  
 
=== Demo System Bars ===
 
=== Demo System Bars ===
Line 243: Line 272:
  
 
{| class="wikitable"
 
{| class="wikitable"
−
! style="width:50px;" | Number
+
! style="width:50px;" | &hash;
 
! style="width:150px;" | Title
 
! style="width:150px;" | Title
−
! style="width:200px;" | Description
+
! style="width:50px;" | Params
 +
! style="width:150px;" | Description / Link
 
! style="width:400px;" | Image
 
! style="width:400px;" | Image
 
|-
 
|-
−
| 28 || Demo Engine Main Menu || A custom main menu for the demo system [[Interface_Bars_-_Start_Here]] || [[file:menu_bar_028.png|400px]]
+
| 28 || Demo Engine Main Menu || Yes - Menu Id || A custom main menu for the demo system [[Interface_Bars_-_Start_Here]] || [[file:menu_bar_028.png|400px]]
 
|-
 
|-
−
| 29 || Demonstration Support Bar || This bar is primarily used in the demonstration of bxp.  For more info [[Demonstration]] || [[file:menu_bar_029.png|400px]]
+
| 29 || Demonstration Support Bar || No || This bar is primarily used in the demonstration of bxp.  For more info [[Demonstration]] || [[file:menu_bar_029.png|400px]]
 
|-
 
|-
 
|}
 
|}
 +
 +
  
 
= Prevented Usage =
 
= Prevented Usage =

Revision as of 01:25, 17 January 2016

1 Overview

Interface bars are horizontal elements which can be turned on and off on every page. These allow for structural customisation of systems.


A detailed description of how the bxp interface is constructed can be found from the whitepaper on the subject. File:Whitepaper - We are BEautiful v1-0.pdf


2 Archetypes

There are four page types within BE

  • Login
  • Main Menu
  • Section Menu
  • Page


On each of these pages can be a number of combinations of bars. Each bar has a unique number. The key number is 4. 4 is the content bar for that page. 4 MUST appear in the listing.


3 How to use the bars

3.1 System Level

To setup or change these options go to system settings in System Access Management.

Main Menu > System Access Management > System Management > System Settings


PrimaryInterfaceOptions 002.png


This will change them at a system level.


3.2 User Level

It is also possible to change them on a user by user basis.


4 Bars - Reference Details

4.1 Header Bars

4.1.1 Top bars

&hash; Title Params Description / Link Image
0 Logo Bar No Includes logo.jpg Default_bxp_system_images menu bar 000.png
8 Boundary Top - All No menu bar 008.png
15 Boundary Top - No Name No menu bar 015.png
22 Boundary Top - Clear No Background is transparent menu bar 022.png
32 Logout Button No Background is transparent. cssMaster_Button styled menu bar 032.png


4.1.2 Title bars

&hash; Title Params Description / Link Image
1 Banner Bar No Includes banner.jpg Default_bxp_system_images menu bar 001.png
21 Control Bar Title No Set in Control Bar Settings menu bar 021.png
33 Custom Page Banner No Default image preset. Change with JavaScript menu bar 033.png


4.2 Navigation Bars

4.2.1 General

&hash; Title Params Description / Link Image
3 Navigation Bar No Placeable bread crumb bar menu bar 003.png
19 I Want To - Full No The_I_Want_To_bar IWantToBar.png
31 I Want To - Collapsible No The I Want To bar as collapsible menus menu bar 031.png
35 Hides the breadcrumb No The_Breadcrumb No relevant image


4.2.2 System Access Management based

These bars change dynamically with the module access of the user as set in the System Access Management module.


&hash; Title Params Description / Link Image
12 IconGrid No Large icon buttons for each module. (160x160) menu bar 012.png
13 IconBar No Apple style bar for the modules you have access to. (32x32) menu bar 013.png
34 Win8 Style Icon Bar No Similar to IconBar but taller icons menu bar 034.png


4.2.3 Control Bar based

These bars change dynamically with the Public and Private links set up in the Control Bar module.


&hash; Title Params Description / Link Image
2 Control Bar - Drop Down No Drop down system menu Module_-_Control_Bar menu bar 002.png
14 Control Bar - Icons No Icon version of drop down menus. menu bar 014.png
38 Control Bar - Big buttons No Control_Bar_Big_Buttons menu bar 038.png
10 Compressed menu bar No Currently disabled No image


4.3 Content Bars

4.3.1 General

&hash; Title Params Description / Link Image
4 Content No The primary body of the page Varies by page
25 Custom HTML Header No Any amount of custom HTML added through the System Access Management > System Settings module Varies by content
26 Custom HTML Footer No Any amount of custom HTML added through the System Access Management > System Settings module Varies by content
27 No Security Forms No For forms that are public to all users to fill in. menu bar 027.png
37 Did You Know No Useful facts and tips about bxp. Didyouknow 001.png


4.3.2 Module Specific

&hash; Title Params Description / Link Image
11 Voting Bar No Module_-_Voting_Management menu bar 011.png
23 eCourse Asset Yes - Asset Id Used with a - notation allows an eCourse asset to be drawn. so 23-123 will draw asset 123 Varies by asset
24 eCourse Search No Provides a large centred search button which can be heavily stylised as required. menu bar 024.png
39 Appointment diary current day view Yes - Diary Id menu bar 039.png


4.4 Footer Bars

&hash; Title Params Description / Link Image
5 Footer Bar No menu bar 005.png
6 Standards Bar No menu bar 006.png
9 Boundary Bottom No menu bar 009.png


4.5 Page Specific usage

4.5.1 General Main Menu Bars

&hash; Title Params Description / Link Image
7 Power Bar No PowerBar menu bar 007.png
16 Work list tool bar Yes - Customised Group Id Bxp_-_Worklists Custom by worklist
17 Turn off main menu No Hides original Main Menu, must be used before 4 original mainmenu 001.png Original Main Menu
18 Information Centre No Full width information centre message bar menu bar 018.png
20 Appointment Diary Yes - Diary Id Shows a calendar when the user first logs in menu bar 020.png


4.5.2 Demo System Bars

&hash; Title Params Description / Link Image
28 Demo Engine Main Menu Yes - Menu Id A custom main menu for the demo system Interface_Bars_-_Start_Here menu bar 028.png
29 Demonstration Support Bar No This bar is primarily used in the demonstration of bxp. For more info Demonstration menu bar 029.png


5 Prevented Usage

On certain page types, certain interface bars cannot be used and will be actively stopped by the system.

Login 3, 7, 11, 12, 13, 14, 19
Main Menu 3
Section Menu 7
Page 7


6 PreBuilt Combinations

6.1 bxp software Release 7

The defaults for the system are as follows.

Login 0,1,4,5,6,9
Main Menu 0,1,2,3,7,4,5,9
Section Menu 0,1,3,4,5,9
Page 0,1,3,4,5,9


6.2 bxp software Release 8

The defaults for the system are as follows.

Login 25,4,5,26
Main Menu 17,22,25,2,7,4,18,13,19,5,26
Section Menu 22,25,4,13,19,5,26
Page 22,25,4,13,19,5,26


6.3 bxp software Release 9

The defaults for the system are as follows.

Login 25,4,5,26
Main Menu 17,22,25,2,7,37,4,18,13,19,5,26
Section Menu 22,25,4,13,19,5,26
Page 22,25,4,13,19,5,26


6.4 Common Combinations

To try out a different combo for yourself, edit your system settings and use the following combo in each of the boxes

  • 8,11,3,4,5,9


Another combo to remove bread crumbs and logout option

  • 15,11,4,5,13,9
Retrieved from ‘https://www.bxpsoftware.com/wixi/index.php?title=Interface_Bars&oldid=6400’