Changes

Interface Bars

5,275 bytes added, 12:03, 18 March 2018
m
Reference Table
There are four page types within BEbxp
* Login
* Main Menu
= Bars - Reference Details =
 
== Header Bars ==
{| class="wikitable"
! style="width:50px;" | NumberNo.
! style="width:150px;" | Title
! style="width:200px50px;" | Params! style="width:150px;" | Description/ Link
! style="width:400px;" | Image
|-
| 0 || Logo Bar || Displays the client No || Includes logo .jpg [[Default_bxp_system_images]] || [[file:menu_bar_000.png|400px]]
|-
| 8 || Boundary Top - All || No || || [[file:menu_bar_008.png|400px]]
|-
| 15 || Turns off logout and username display 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 No || Background is transparent || [[file:menu_bar_022.png|400px]]
|-
| 32 || Logout Button || No || Background is transparent. cssMaster_Button styled || [[file:menu_bar_032.png|400px]]
|-
|}
 
 
=== Title bars ===
 
{| class="wikitable"
! style="width:50px;" | NumberNo.
! style="width:150px;" | Title
! style="width:200px50px;" | Params! style="width:150px;" | Description/ Link
! style="width:400px;" | Image
|-
| 1 || Banner Bar || No || Includes banner.jpg [[Default_bxp_system_images]] || [[file:menu_bar_001.png|400px]]
|-
| 21 || Control Bar Title bar with no links || No || Set in Control Bar Settings || [[file:menu_bar_021.png|400px]]
|-
| 33 || Custom Page Banner || No || Default image preset. Change with JavaScript || [[file:menu_bar_033.png|400px]]
|-
|}
 
 
== Navigation Bars ==
{| class="wikitable"
! style="width:50px;" | NumberNo.
! style="width:150px;" | Title
! style="width:200px50px;" | Params! style="width:150px;" | Description/ Link
! style="width:400px;" | Image
|-
| 3 || Navigation Bar || No || Placeable bread crumb bar || [[file:menu_bar_003.png|400px]]
|-
| 19 || I Want To - Full || No || [[The_I_Want_To_bar]] || [[File:IWantToBar.png|400px]]
|-
| 31 || I Want To Control Bar - Collapsible || No || The I Want To bar as collapsible menus || [[file:menu_bar_031.png|400px]]
|-
| 35 || Hides the breadcrumb || No || [[The_Breadcrumb]] || No relevant image
|-
|}
 
 
=== 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"
! style="width:50px;" | NumberNo.
! style="width:150px;" | Title
! style="width:200px50px;" | Params! style="width:150px;" | Description/ Link
! style="width:400px;" | Image
|-
| 12 || IconGrid || No || Large icon buttons for each module. (160x160) || [[file:menu_bar_012.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 || No || Similar to IconBar but taller icons || [[file:menu_bar_034.png|400px]]
|-
|}
=== Control Bar based ===
 
 
These bars change dynamically with the Public and Private links set up in the Control Bar module.
{| class="wikitable"
! style="width:50px;" | NumberNo.
! style="width:150px;" | Title
! style="width:200px50px;" | Params! style="width:150px;" | Description/ Link
! style="width:400px;" | Image
|-
| 2 || Control Bar - Drop Down || No || Drop down system menu [[Module_-_Control_Bar]] || [[file:menu_bar_002.png|400px]]
|-
| 10 14 || Compressed menu bar Control Bar - Icons || Currently disabled No || No imageIcon version of drop down menus. || [[file:menu_bar_014.png|400px]]
|-
| 14 38 || Icon Control Bar || Larger button options customised for specific tasks. || [[file:menu_bar_014.png|400px]]|-| 38 Big buttons || Control Bar Big buttons No || [[Control_Bar_Big_Buttons]] || [[file:menu_bar_038.png|400px]]
|-
|}
 
 
== Content Bars ==
{| class="wikitable"
! style="width:50px;" | NumberNo.
! style="width:150px;" | Title
! style="width:200px50px;" | Params! style="width:150px;" | Description/ Link
! style="width:400px;" | Image
|-
| 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 No || See [[Customising_bxp_-_Custom_HTML]] || Varies by content
|-
| 26 || Custom HTML Footer || Any amount of custom HTML added through the System Access Management > System Settings module No || See [[Customising_bxp_-_Custom_HTML]] || Varies by content
|-
| 27 || No Security Public Forms button || For forms that are public to all users to fill in. No || See [[Public_Forms]] || [[file:menu_bar_027.png|400px]]
|-
| 37 || Did You Know || Useful facts and tips about bxp. No || See [[Did_You_Know]] || [[file:Didyouknow 001.png|400px]]|-| 40 || Lister Bar || No || See [[Lister]] || [[file:menu_bar_040.png|400px]]|-| 45 || Reminder Bar || No || See [[Reminders]] || [[file:menu_bar_045.png|400px]]|-| 46 || Presence || No || See [[Presence in bxp]] || [[File:presence_001.png|400px]] 
|-
|}
 
 
=== Module Specific ===
{| class="wikitable"
! style="width:50px;" | NumberNo.
! style="width:150px;" | Title
! style="width:200px50px;" | Params! style="width:150px;" | Description/ Link
! style="width:400px;" | Image
|-
| 10 || FrontDesk Bar || No || [[Module_-_FrontDesk]] || [[file:menu_bar_010.png|400px]]|-| 11 || Voting Bar || No || [[Module_-_Voting_Management]] || [[file:menu_bar_011.png|400px]]|-| 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. || [[file:menu_bar_024.png|400px]]|-| 47 || eCourse Dynamic Search || No || eCourse search using LiveSearch and scrollable div || [[File:Interface_Bar.png|400px]]
|-
| 23 39 || eCourse Asset Appointment Diary - Today - All || Used with a Yes - notation allows an eCourse asset to be drawn. so 23Diary Id || See [[Module_-123 will draw asset 123 _Appointment_Management]] || Varies by asset[[file:menu_bar_039.png|400px]]
|-
| 24 41 || eCourse Search Appointment Diary - Today - My || Provides a large centred search button which can be heavily stylised as required. Yes - Diary Id || See [[Module_-_Appointment_Management]] || [[file:menu_bar_024menu_bar_041.png|400px]]
|-
| 39 42 || Appointment diary current day view Gamification - Scores || Yes - Scheme Id || See [[Gamification_-_Scores_Program]] || [[file:menu_bar_039menu_bar_042.png|400px]]
|-
|}
{| class="wikitable"
! style="width:50px;" | NumberNo.
! style="width:150px;" | Title
! style="width:200px50px;" | Params! style="width:150px;" | Description/ Link
! style="width:400px;" | Image
|-
| 5 || Footer Bar || No || || [[file:menu_bar_005.png|400px]]
|-
| 6 || Standards Bar || No || || [[file:menu_bar_006.png|400px]]
|-
| 9 || Boundary Bottom || No || || [[file:menu_bar_009.png|400px]]
|-
|}
{| class="wikitable"
! style="width:50px;" | NumberNo.
! style="width:150px;" | Title
! style="width:200px50px;" | Params! style="width:150px;" | Description/ Link
! style="width:400px;" | Image
|-
| 7 || Power Bar || No || [[PowerBar]] || [[file:menu_bar_007.png|400px]]
|-
| 16 || Work list tool bar ||16Yes -x Customised Group Id || [[Bxp_-_Worklists]] || Custom by worklist
|-
| 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 || No || Full width information centre message bar || [[file:menu_bar_018.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 ===
{| class="wikitable"
! style="width:50px;" | NumberNo.
! style="width:150px;" | Title
! style="width:200px50px;" | Params! style="width:150px;" | Description/ Link
! style="width:400px;" | Image
|-
| 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 || No || This bar is primarily used in the demonstration of bxp. For more info [[Demonstration]] || [[file:menu_bar_029.png|400px]]
|-
|}
 
 
= Prevented Usage =
{| class="wikitable"
! style="width:30%" | Archetype
! style="width:70%" | Combination
|-
| Login || 3, 7, 11, 12, 13, 14, 19
|-
| Page || 7
|}
 
= PreBuilt Combinations =
The defaults for the system are as follows.
{| class="wikitable"
! style="width:30%" | Archetype
! style="width:70%" | Combination
|-
| Login || 0,1,4,5,6,9
|-
The defaults for the system are as follows.
{| class="wikitable"
! style="width:30%" | Archetype
! style="width:70%" | Combination
|-
| Login || 25,4,5,26
|-
The defaults for the system are as follows.
{| class="wikitable"
! style="width:30%" | Archetype
! style="width:70%" | Combination
|-
| Login || 25,4,5,26
|-
* 15,11,4,5,13,9
 
Useful Main Menu combo
* 17,22,25,2,38,10,4,18,13,19,5,26
 
 
 
= Reference Table =
 
 
{| class="wikitable" style="width:100%;"
! style="width:10%;text-align:center;" | Id
! style="width:30%;text-align:center;" | Name
! style="width:60%;text-align:center;" | Section
|-
| 0 || Logo Bar || [[Interface_Bars#Header_Bars]]
|-
| 1 || Banner Bar || [[Interface_Bars#Title_bars]]
|-
| 2 || Control Bar - Drop Down || [[Interface_Bars#Control_Bar_based]]
|-
| 3 || Navigation Bar || [[Interface_Bars#General]]
|-
| 4 || Content || [[Interface_Bars#General_2]]
|-
| 5 || Footer Bar || [[Interface_Bars#Footer_Bars]]
|-
| 6 || Standards Bar || [[Interface_Bars#Footer_Bars]]
|-
| 7 || Power Bar || [[Interface_Bars#General_Main_Menu_Bars]]
|-
| 8 || Boundary Top - All || [[Interface_Bars#Header_Bars]]
|-
| 9 || Boundary Bottom || [[Interface_Bars#Footer_Bars]]
|-
| 10 || FrontDesk Bar || [[Interface_Bars#Module_Specific]]
|-
| 11 || Voting Bar || [[Interface_Bars#Module_Specific]]
|-
| 12 || IconGrid || [[Interface_Bars#System_Access_Management_based]]
|-
| 13 || IconBar || [[Interface_Bars#System_Access_Management_based]]
|-
| 14 || Control Bar - Icons || [[Interface_Bars#Control_Bar_based]]
|-
| 15 || Boundary Top - No Name || [[Interface_Bars#Header_Bars]]
|-
| 16 || Work list tool bar || [[Interface_Bars#General_Main_Menu_Bars]]
|-
| 17 || Turn off main menu || [[Interface_Bars#General_Main_Menu_Bars]]
|-
| 18 || Information Centre || [[Interface_Bars#General_Main_Menu_Bars]]
|-
| 19 || I Want To - Full || [[Interface_Bars#General]]
|-
| 20 || Appointment Diary || [[Interface_Bars#General_Main_Menu_Bars]]
|-
| 21 || Control Bar Title || [[Interface_Bars#Title_bars]]
|-
| 22 || Boundary Top - Clear || [[Interface_Bars#Header_Bars]]
|-
| 23 || eCourse Asset || [[Interface_Bars#Module_Specific]]
|-
| 24 || eCourse Search || [[Interface_Bars#Module_Specific]]
|-
| 25 || Custom HTML Header || [[Interface_Bars#General_2]]
|-
| 26 || Custom HTML Footer || [[Interface_Bars#General_2]]
|-
| 27 || Public Forms button || [[Interface_Bars#General_2]]
|-
| 28 || Demo Engine Main Menu || [[Interface_Bars#Demo_System_Bars]]
|-
| 29 || Demonstration Support Bar || [[Interface_Bars#Demo_System_Bars]]
|-
| 31 || I Want To - Collapsible || [[Interface_Bars#General]]
|-
| 32 || Logout Button || [[Interface_Bars#Header_Bars]]
|-
| 33 || Custom Page Banner || [[Interface_Bars#Title_bars]]
|-
| 34 || Win8 Style Icon Bar || [[Interface_Bars#System_Access_Management_based]]
|-
| 35 || Hides the breadcrumb || [[Interface_Bars#General]]
|-
| 37 || Did You Know || [[Interface_Bars#General_2]]
|-
| 38 || Control Bar - Big buttons || [[Interface_Bars#Control_Bar_based]]
|-
| 39 || Appointment Diary - Today - All || [[Interface_Bars#Module_Specific]]
|-
| 40 || Lister Bar || [[Interface_Bars#General_2]]
|-
| 41 || Appointment Diary - Today - My || [[Interface_Bars#Module_Specific]]
|-
| 42 || Gamification - Scores || [[Interface_Bars#Module_Specific]]
|-
| 45 || Reminder Bar || [[Interface_Bars#General_2]]
|-
| 46 || Presence || [[Interface_Bars#General_2]]
|-
| 47 || eCourse Dynamic Search || [[Interface_Bars#Module_Specific]]
|-
|}
 
 
Not listed are 30, 36, 43 and 44 as they are no longer functional as options having been replaced with better / newer options.
7,528
edits