Anonymous, bureaucrat, administrator
7,528
edits
Changes
m
Interface bars are horizontal elements which can be turned on and off on every page. These allow for customisation of systems.= Overview =
== Overview ==Interface bars are horizontal elements which can be turned on and off on every page. These allow for structural customisation of systems.
=== General Header Bars ===
* 0 = Logo Bar* 1 = Banner Bar* 2 = Control Bar* 3 = Navigation Bar* 8 = Boundary Top* 11 = Voting Bar* 14 = Icon Control Bar. Larger button options customised for specific tasks.* 15 = Turns off logout and username display* 21 = Title bar with no links( control bar without links or buttons).* 22 based = Boundary Top - Clear. A clear top bar with the username and logout but is transparent* 25 = Custom HTML Header. Any amount of custom HTML added through the System Access Management > System Settings module* 28 = Start Here bar. [[Interface_Bars_-_Start_Here]]
=== General Content Bars ===
* 4 = Content
* 10 = Compressed menu bar
* 23 = eCourse Asset. Used with a - notation allows an eCourse asset to be drawn. so 23-123 will draw asset 123
* 24 = eCourse Search. Provides a large centred search button which can be heavily stylised as required.
=== General Footer Bars ===
* 5 = Footer Bar
* 6 = Standards Bar
* 9 = Boundary Bottom
* 13 = IconBar. Apple style bar for the modules you have access to.
* 19 = I Want To. A horizontal bar with the primary I Want To functionality
* 26 = Custom HTML Footer. Any amount of custom HTML added through the System Access Management > System Settings module
* 29 = Demonstration Support Bar. This bar is primarily used in the demonstration of bxp. For more info [[Demonstration]]
* {| class="wikitable"! style="width:50px;" | No.! style="width:150px;" | Title! style="width:50px;" | Params! style="width:150px;" | Description / Link! style="width:400px;" | Image|-| 7 = || Power Bar (these are only available on the main menu)|| No || [[PowerBar]] || [[file:menu_bar_007.png|400px]]* 12 = IconGrid|-* | 16 = || Work list tool bar. Work list is only available for the main menu. Multiple work lists accepted. Format 16|| Yes -x, where x is the Customised Group Id of the || [[Bxp_-_Worklists]] || Custom by worklist.* |-| 17 = || Turn off main menu. || Must be used in the No || Hides original Main Menu, must be used before the 4 bar|| [[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]]* 27 = No Security Forms. For forms that are public to all users to fill in.|-|}
On certain page types, certain interface bars cannot be {| class="wikitable"! style="width:50px;" | No.! style="width:150px;" | Title! style="width:50px;" | 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 and will be actively stopped by in the systemdemonstration of bxp. For more info [[Demonstration]] || [[file:menu_bar_029.png|400px]]|-|} = Prevented Usage =
* Login - 3, 7, 11, 12, 13, 14, 19
* Main Menu - 3
* Section Menu - 7
* Page - 7
== PreBuilt Combinations ==
=== bxp software Release 7 ===
* {| class="wikitable"! style="width:30%" | Archetype! style="width:70%" | Combination|-| 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|}
=== bxp software Release 8 ===
* {| class="wikitable"! style="width:30%" | Archetype! style="width:70%" | Combination|-| 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 |}
=== bxp software Release 9 ===
* {| class="wikitable"! style="width:30%" | Archetype! style="width:70%" | Combination|-| 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 |}
=== Common Combinations ===
→Reference Table
A detailed description of how the bxp interface is constructed can be found fromthe whitepaper on the subject. [[File:Whitepaper_-_We_are_BEautiful_v1-0.pdf]]
= Archetypes = There are four page types within BEbxp
* Login
* Main Menu
=How to use the bars = == System Level = Interface = To setup or change these options go to system settings in System Access Management. ''Main Menu > System Access Management > System Management > System Settings'' [[File:PrimaryInterfaceOptions_002.png|800px]] This will change them at a system level. == User Level == It is also possible to change them on a user by user basis. = Bars - Reference Details = == Header Bars == === Top bars === {| class="wikitable"! style="width:50px;" | No.! style="width:150px;" | Title! style="width:50px;" | Params! style="width:150px;" | Description / Link! style="width:400px;" | Image|-| 0 || Logo Bar || 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 || Boundary Top - No Name || No || || [[file:menu_bar_015.png|400px]]|-| 22 || Boundary Top - Clear || 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;" | No.! style="width:150px;" | Title! style="width:50px;" | 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 || 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 == === General === {| class="wikitable"! style="width:50px;" | No.! style="width:150px;" | Title! style="width:50px;" | 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 - 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;" | No.
! style="width:150px;" | Title
! style="width:50px;" | 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]]
|-
|}
These bars change dynamically with the Public and Private links set up in the Control Bar module.
{| class="wikitable"
! style="width:50px;" | No.
! style="width:150px;" | Title
! style="width:50px;" | 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]]
|-
| 14 || Control Bar - Icons || No || Icon version of drop down menus. || [[file:menu_bar_014.png|400px]]
|-
| 38 || Control Bar - Big buttons || No || [[Control_Bar_Big_Buttons]] || [[file:menu_bar_038.png|400px]]
|-
|}
== Content Bars ==
=== General ===
{| class="wikitable"! style= Interface bars "width:50px;" | No.! style="width:150px;" | Title! style="width:50px;" | 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 || No || See [[Customising_bxp_-_Custom_HTML]] || Varies by content|-| 26 || Custom HTML Footer || No || See [[Customising_bxp_-_Custom_HTML]] || Varies by content|-| 27 || Public Forms button || No || See [[Public_Forms]] || [[file:menu_bar_027.png|400px]]|-| 37 || Did You Know || 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;" | No.! style="width:150px;" | Title! style="width:50px;" | 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]]|-| 39 || Appointment Diary - Today - All || Yes - Diary Id || See [[Module_-_Appointment_Management]] || [[file:menu_bar_039.png|400px]]|-| 41 || Appointment Diary - Today - My || Yes - Diary Id || See [[Module_-_Appointment_Management]] || [[file:menu_bar_041.png|400px]]|-| 42 || Gamification - Scores || Yes - Scheme Id || See [[Gamification_-_Scores_Program]] || [[file:menu_bar_042.png|400px]]|-|} == Footer Bars == {| class="wikitable"! style="width:50px;" | No.! style="width:150px;" | Title! style="width:50px;" | 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]]|-|} == Page Specific usage ==
== Prevented Usage = Demo System Bars ===
On certain page types, certain interface bars cannot be used and will be actively stopped by the system.
{| class="wikitable"
! style="width:30%" | Archetype
! style="width:70%" | Combination
|-
| Login || 3, 7, 11, 12, 13, 14, 19
|-
| Main Menu || 3
|-
| Section Menu || 7
|-
| Page || 7
|}
The defaults for the system are as follows.
The defaults for the system are as follows.
The defaults for the system are as follows.
* 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.
[[Category:Topic:bxp Interface]]
[[Category:Topic:Style]]