Line: 1 to 1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
TWiki Dashboard Add-OnRevision 32014-04-11 - TWikiContributor
Revision 22014-04-11 - TWikiContributor
Note: The popup (modal dialog box) depends on the TWiki:Plugins.ModalBoxAddOn.
Section
|
Parameter | Description | Default |
---|---|---|
title="" |
Box title, optional | (no title) |
width="" |
Width of box in pixels, optional. Note: This is the usable width of the box content, it does not include 32 pixel of box border and padding |
"300" |
height="" |
Box height in pixels, optional | "200" |
style="" |
CSS of outer box, optional | "border: solid #d0d0d0 1px; padding: 15px;" |
titlestyle="" |
CSS of title, optional | "text-align:center; font-size:19px; font-weight:bold; color: #333335; padding:0 0 12px 0; white-space: nowrap; overflow: hidden;" |
contentstyle="" |
CSS of content | "overflow:auto;" |
"box_end"
The "box_end"
section ends a box. It has no additional parameters.
"dashboard_end"
The "dashboard_end"
section ends a dashboard. It has no additional parameters.
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.
This example defines a simple dashboard. Write this:
%DASHBOARD{ section="dashboard_start" }% %DASHBOARD{ section="banner" image="%PUBURL%/%SYSTEMWEB%/TWikiDashboardImages/marin-headlands.jpg" title="Dashboard for %WIKIUSERNAME%" titlestyle="color:#800000;" button1="TWiki Help|%SYSTEMWEB%.WebHome" button2="TWiki Variables|%SYSTEMWEB%.TWikiVariables" button3="Popup Demo|Modal Popup Demo|This requires the TWiki:Plugins.ModalBoxAddOn|400" }% %DASHBOARD{ section="box_start" title="Box 1 title" }% Box 1 content %DASHBOARD{ section="box_end" }% %DASHBOARD{ section="box_start" title="Box 2 title" }% Box 2 content %DASHBOARD{ section="box_end" }% %DASHBOARD{ section="box_start" title="Box 3 title" }% Box 3 content %DASHBOARD{ section="box_end" }% %DASHBOARD{ section="box_start" title="Box 4 title" width="992" height="100" }% Box 4 content %DASHBOARD{ section="box_end" }% %DASHBOARD{ section="dashboard_end" }%
As documented earlier, an alternate syntax for %DASHBOARD{ section="..." ... }%
is %INCLUDE{ "TWikiDashboardAddOn" section="..." ... }%
.
This example generates the following dashboard:
This section defines the actual dashboard. View the raw text of this topic to look under the hood.
<--==================================================================================================================-->
<--==================================================================================================================-->
<--==================================================================================================================-->
<--========================================================= =========================================================-->
<--========================================================= =========================================================-->
Note: You do not need to install anything on the browser to use this add-on. The following instructions are for the administrator who installs the add-on on the TWiki server.
<--/twistyPlugin twikiMakeVisibleInline-->
TWikiDashboardAddOn.zip
in your twiki installation directory. Content: File: | Description: |
---|---|
data/TWiki/TWikiDashboardAddOn.txt | Add-on topic |
data/TWiki/VarDASHBOARD.txt.txt | DASHBOARD variable documentation topic |
data/TWiki/TWikiDashboardImages.txt | Topic with dashboard banner images |
lib/TWiki/Contrib/TWikiDashboardAddOn.pm | Add-on Perl module |
pub/TWiki/TWikiDashboardAddOn/*.png | Screenshots of dashboards |
pub/TWiki/TWikiDashboardImages/*.png | Dashboard banner images |
* %SYSTEMWEB%.TWikiDashboardAddOn variable, documented in %SYSTEMWEB%.VarDASHBOARD: * Set DASHBOARD = %INCLUDE{ "%SYSTEMWEB%.TWikiDashboardAddOn" section="%section%" %IF{ "'%height{ default="" }%'!=''" then="height=\"%height%\"" }% %IF{ "'%width{ default="" }%'!=''" then="width=\"%width%\"" }% %IF{ "'%ENCODE{ "%image{ default="" }%" type="entity" }%'!=''" then="image=\"%ENCODE{ "%image%" type="quote" }%\"" }% %IF{ "'%ENCODE{ "%title{ default="" }%" type="entity" }%'!=''" then="title=\"%ENCODE{ "%title%" type="quote" }%\"" }% %IF{ "'%ENCODE{ "%button1{ default="" }%" type="entity" }%'!=''" then="button1=\"%ENCODE{ "%button1%" type="quote" }%\"" }% %IF{ "'%ENCODE{ "%button2{ default="" }%" type="entity" }%'!=''" then="button2=\"%ENCODE{ "%button2%" type="quote" }%\"" }% %IF{ "'%ENCODE{ "%button3{ default="" }%" type="entity" }%'!=''" then="button3=\"%ENCODE{ "%button3%" type="quote" }%\"" }% %IF{ "'%ENCODE{ "%button4{ default="" }%" type="entity" }%'!=''" then="button4=\"%ENCODE{ "%button4%" type="quote" }%\"" }% %IF{ "'%ENCODE{ "%button5{ default="" }%" type="entity" }%'!=''" then="button5=\"%ENCODE{ "%button5%" type="quote" }%\"" }% %IF{ "'%ENCODE{ "%button6{ default="" }%" type="entity" }%'!=''" then="button6=\"%ENCODE{ "%button6%" type="quote" }%\"" }% %IF{ "'%ENCODE{ "%button7{ default="" }%" type="entity" }%'!=''" then="button7=\"%ENCODE{ "%button7%" type="quote" }%\"" }% %IF{ "'%ENCODE{ "%button8{ default="" }%" type="entity" }%'!=''" then="button8=\"%ENCODE{ "%button8%" type="quote" }%\"" }% %IF{ "'%ENCODE{ "%style{ default="" }%" type="entity" }%'!=''" then="style=\"%style%\"" }% %IF{ "'%ENCODE{ "%titlestyle{ default="" }%" type="entity" }%'!=''" then="titlestyle=\"%titlestyle%\"" }% %IF{ "'%ENCODE{ "%contentstyle{ default="" }%" type="entity" }%'!=''" then="contentstyle=\"%contentstyle%\"" }% }%
<--/twistyPlugin-->
Add-on Author: | TWiki:Main.PeterThoeny |
Copyright: | © 2012-2013, TWiki:Main.PeterThoeny, TWiki.org © 2012-2013 TWiki:TWiki.TWikiContributor |
License: | GPL (GNU General Public License) |
Add-on Version: | 2013-08-15 |
<--/twistyPlugin twikiMakeVisibleInline-->
2013-08-15: | TWikibug:Item7154: Updated nasa-airfield.jpg |
2013-07-15: | TWikibug:Item7154: Add a new banner image by Blackstation |
2013-04-06: | TWikibug:Item7154: Add 13 new banner images by Peter Thoeny, 1 by Google |
2013-04-22: | TWikibug:Item7151: Change CALC to CALCULATE in image library |
2013-04-06: | TWikibug:Item7154: Add 9 new banner images by Jeffrey Pang, Peter Thoeny, Romain Guy, Steve Dunleavy |
2013-02-13: | TWikibug:Item7041: Add 5 new banner images by Joi Ito, Jon Brack |
2013-02-04: | TWikibug:Item7041: Add 3 new banner images by Cindy Cornett Seigle, Danny Hope, Zsolt Andrasi |
2013-02-01: | TWikibug:Item7041: Add 9 new banner images by Dan Tentler, Jake Rome, Jim Crossley, Juhan Sonin, Matteo Leoni, Paul Downey, Steve Bowbrick, Tom Woodward |
2013-01-31: | TWikibug:Item7091: Use TWISTY in installation instructions and change history |
2013-01-31: | TWikibug:Item7041: Add 8 new banner images by Peter Thoeny |
2013-01-06: | TWikibug:Item7041: Add 4 new banner images by David Yu, Joi Ito |
2012-12-28: | TWikibug:Item7041: Add 7 new banner images by David Yu, ETH Zurich, Peter Thoeny |
2012-12-04: | TWikibug:Item7041: Add 10 new banner images by CERN |
2012-11-28: | TWikibug:Item7041: Add 12 new banner images by Andreas Schaefer, Angela Ju, David Yu, Jeff Keller, Martin Eckert, NASA, Paulo Ordoveza, Peter Thoeny, Sean Fitzgibbon |
2012-11-11: | TWikibug:Item7020: Categorize TWiki Variable DASHBOARD |
2012-11-05: | TWikibug:Item7021: Add 6 more banner images by David Yu, Diliff, Goro Kosaka, Jens Hausherr, Koppi2, Sbittante |
2012-10-13: | TWikibug:Item6972: Add TWikiDashboardAddOn to core distribution; multiple banner buttons with button1="" button2="" ... |
2012-10-12: | TWikibug:Item6981: Add 12 more dashboard banner images |
2012-10-06: | TWikibug:Item6954: Initial version |
<--/twistyPlugin-->
TWiki Dependency: | $TWiki::Plugins::VERSION 1.3 (TWiki-5.0) TWiki:Plugins.ScrollBoxAddOn TWiki:Plugins.SpreadSheetPlugin version 2012-04-04 TWiki:Plugins.ModalBoxAddOn required if popup buttons are used |
CPAN Dependencies: | none |
Other Dependencies: | none |
Perl Version: | 5.005 |
Add-on Home: | http://TWiki.org/cgi-bin/view/Plugins/TWikiDashboardAddOn |
Feedback: | http://TWiki.org/cgi-bin/view/Plugins/TWikiDashboardAddOnDev |
Appraisal: | http://TWiki.org/cgi-bin/view/Plugins/TWikiDashboardAddOnAppraisal |
Related Topics: VarDASHBOARD, TWikiDashboardImages, ScrollBoxAddOn, TWikiAddOns
META FILEATTACHMENT | attachment="dashboard-dimensions.png" attr="h" comment="" date="1349501922" name="dashboard-dimensions.png" path="dashboard-dimensions.png" size="171778" user="TWikiContributor" version="1" |
---|---|
META FILEATTACHMENT | attachment="dashboard-example.png" attr="h" comment="" date="1349511432" name="dashboard-example.png" path="dashboard-example.png" size="249069" user="TWikiContributor" version="1" |
META FILEATTACHMENT | attachment="dashboard-example-300.png" attr="h" comment="" date="1349511430" name="dashboard-example-300.png" path="dashboard-example-300.png" size="38797" user="TWikiContributor" version="1" |