Create professional dashboards for intranet home, teams, knowledge bases and more

Introduction

A dashboard comes into play when users need to get an overview of their work and want to navigate quickly to relevant places. This TWiki application is designed to give administrators a tool to quickly create dashboards for intranet home, team homepages, project homepages and knowledge bases.

Usage

The add-on defines several sections that are used to create dashboards. This can be done either via DASHBOARD or INCLUDE variables. A dashboard is constructed using the following sections:

Dashboard screenshot (click to enlarge)

section "dashboard_start"

section "banner"

section "box_start"

Box 1 content

section "box_end"

section "box_start"

Box 2 content

section "box_end"

...etc...

section "dashboard_end"

Banner(s) and boxes fill the dashboard width, and are arranged left to right, top to bottom.

Section ="banner"

Banner image URL, optional. Attach your own image, default 1024x150 pixels, or use one of the TWikiDashboardImages. Example:"%ATTACHURL%/myteam.jpg"

URL of marin-headlands.jpg image

title=""

Banner title, optional. If you specify a TWiki link make sure to use Web.TopicName, not just TopicName.

(no title)

text=""

Banner text below title, optional

(no text)

width=""

Banner width in pixels, optional.Note: It should match the dashboard width and banner image width

"1024"

height=""

Banner height in pixels, optional

"150"

button1=""button2="" ... button8=""

Banner buttons, optional. Each button has elements separated by the pipe symbol ("|"). A button can either link to another page, or popup a modal box. A popup is shown if the button has 3 or more elements. Popup button elements: Button label, box title, box content, box width in pixels (optional, default 600), box height in pixels (optional, default 400). Link button elements: Button label, link. A link can be a Web.TopicName or a URL. If you specify a TWiki link make sure to use Web.TopicName, not just TopicName. Example: button1="Button label|Web.LinkTarget" button2="TWiki Help|TWiki.WebHome" button3="Popup Demo|Modal box demo title|Modal box content|600"

(none)

style=""

CSS of banner box, optional

"border: none 0;"

titlestyle=""

CSS of banner title, optional. Example: To show white title text for dark banner image:titlestyle="color: white;"

Section ="box_end"

The "box_end" section ends a box. It has no additional parameters.

Section ="dashboard_end"

The "dashboard_end" section ends a dashboard. It has no additional parameters.

Dashboard Dimensions

The default dashboard is 1024 pixels wide, which is just about the right size for laptop screens. The TWikiDashboardImages are designed for this width. By default, boxes are 300 pixels wide and 200 pixels high for a 3 column layout. The following screenshot shows the dimensions.

When designing custom dimensions keep in mind that banner(s) and boxes are arranged left to right, top to bottom.