diff --git a/documentation/pages/framework/configuration/application.md b/documentation/pages/framework/configuration/application.md index ab99d9d1..ab598980 100644 --- a/documentation/pages/framework/configuration/application.md +++ b/documentation/pages/framework/configuration/application.md @@ -15,8 +15,13 @@ Authentication providers are also defined here under `auth.providers`. The defau }, "layout": { "mobile": { - "fixed": [["users", "NewjoinerDetector"]], + "fixed": [ + ["users", "NewjoinerDetector"], + ["users", "UserStatus"] + ], "office": [ + ["events", "UncompletedActions"], + ["events", "MyEvents"], ["quick-navigation", "QuickNav"], ["users", "UsersMapWidget", { "offices": ["global"] }], ["about", "AboutWidget", { "offices": ["berlin", "lisbon", "london"] }] @@ -50,39 +55,60 @@ Authentication providers are also defined here under `auth.providers`. The defau ``` -### Widget configuration - -``` -["users", "UsersMapWidget", { "offices": ["global"] }], -``` - -This configuration only shows widget `UsersMapWidget` from the `users` module in the office with id `global` - -``` -["news", "LatestNews"] -``` - -Widget `LatestNews` from module `news` is displayed in all hubs. +## Mobile -``` -["about", "AboutWidget", { "offices": ["berlin", "lisbon", "london"] }] +```json + "mobile": { + "fixed": [ + ["users", "NewjoinerDetector"], + ["users", "UserStatus"] + ], + "office": [ + ["events", "UncompletedActions"], + ["events", "MyEvents"], + ["quick-navigation", "QuickNav"], + ["users", "UsersMapWidget", { "offices": ["global"] }], + ["about", "AboutWidget", { "offices": ["berlin", "lisbon", "london"] }] + ], + "events": [["events", "UpcomingEvents"]], + "news": [["news", "LatestNews"]] + }, ``` -Widget `AboutWidget` from module `about` is displayed in `berlin`, `lisbon` and `london` hubs. +`fixed` - items above the call to action widget (Visit office, Book a Room, Invite a Guest) + +`office`, `events`, `news` tabs are configurable. + +
+mobile office + +mobile events + +mobile news + +
## Desktop -You can choose between 3 and 2 column layout. - -### 3 col layout - -Layout-3 - -In order to configure 3 columns populate "sidebar", "main" and "sidebarRight" with your configuration. - -E.g - -``` +```json "desktop": { "sidebar": [ ["quick-navigation", "QuickNav"], @@ -96,62 +122,56 @@ E.g { "offices": ["berlin", "lisbon", "london"] } ] ], - [["users", "UsersMapWidget", { "offices": ["global"] }]] - [["hub-map", "HubMap"]], - ], - "sidebarRight": [ + [["announcements", "Announcement"]], + [["users", "UsersMapWidget", { "offices": ["global"] }]], + [ ["events", "UpcomingEvents"], ["news", "LatestNews"] ] + ], + "sidebarRight": [ + ["events", "MyEvents"], + ["events", "UpcomingEvents"], + ["news", "LatestNews"] + ] } + ``` +desktop layout +You can choose between 3 and 2 column layout. + +### 3 col layout + +In order to configure 3 columns populate `sidebar`, `main` and `sidebarRight` with your configuration. + +Layout-3 + ### 2 col layout +For the 2 column layout populate `sidebar` and `main` only. Layout-2 -For the 2 column layout populate "sidebar" and "main" only. +### Widget configuration -E.g +``` +["users", "UsersMapWidget", { "offices": ["global"] }], +``` + +This configuration only shows widget `UsersMapWidget` from the `users` module in the office with id `global` ``` - "desktop": { - "sidebar": [ - ["quick-navigation", "QuickNav"], - ["about", "AboutWidget", { "offices": ["berlin", "lisbon", "london"] }] - ], - "main": [ - [ - [ - "office-visits", - "Actions", - { "offices": ["berlin", "lisbon", "london"] } - ] - ], - [["users", "UsersMapWidget", { "offices": ["global"] }]] - [["hub-map", "HubMap"]], - // the folllowing two modules will split the space between them under the HubMap - [ - ["events", "UpcomingEvents"], - ["news", "LatestNews"] - ] - ] - } +["news", "LatestNews"] ``` -## Mobile +Widget `LatestNews` from module `news` is displayed in all hubs. ``` -"mobile": { - "fixed": [["users", "NewjoinerDetector"]], - "office": [ - ["quick-navigation", "QuickNav"], - ["users", "UsersMapWidget", { "offices": ["global"] }], - ["about", "AboutWidget", { "offices": ["berlin", "lisbon", "london"] }] - ], - "events": [["events", "UpcomingEvents"]], - "news": [["news", "LatestNews"]] -}, +["about", "AboutWidget", { "offices": ["berlin", "lisbon", "london"] }] ``` -`office`, `events`, `news` are the 3 tabs in the mobile view. You can configure what to show for each of them. +Widget `AboutWidget` from module `about` is displayed in `berlin`, `lisbon` and `london` hubs. diff --git a/documentation/pages/modules/visits.md b/documentation/pages/modules/visits.md index e69de29b..411b1646 100644 --- a/documentation/pages/modules/visits.md +++ b/documentation/pages/modules/visits.md @@ -0,0 +1,11 @@ +# Visits module + +This module takes care of desk bookings. + +## Available Widgets + +This module provides functionality for desk booking but does not have specific desk booking widgets, as they are part of the booking flow, which start when user uses [Office vists module](./office-visits.md). + +### Who is in Office + +To enable - add `["visits", "WhoIsInOffice", { "offices": ["berlin", "lisbon", "london"] }]` in the [application.json](../framework/configuration/application.md) configuration. diff --git a/documentation/public/desktopLayout.png b/documentation/public/desktopLayout.png new file mode 100644 index 00000000..0a2fc18d Binary files /dev/null and b/documentation/public/desktopLayout.png differ diff --git a/documentation/public/mobileEvents.png b/documentation/public/mobileEvents.png new file mode 100644 index 00000000..7eaef66a Binary files /dev/null and b/documentation/public/mobileEvents.png differ diff --git a/documentation/public/mobileNews.png b/documentation/public/mobileNews.png new file mode 100644 index 00000000..13a2bd30 Binary files /dev/null and b/documentation/public/mobileNews.png differ diff --git a/documentation/public/mobileOffice.png b/documentation/public/mobileOffice.png new file mode 100644 index 00000000..d3e25b3c Binary files /dev/null and b/documentation/public/mobileOffice.png differ