BrushedTemplate is compatible with JSPWiki up to and including version v2.4. Please check the download tab to see which template versions match with which JSPWiki version.

Starting from JSPWiki v2.6, major parts of the BrushedTemplate have been included in the default template of JSPWiki. Therefore there is no need for further development of the BrushedTemplate. Please note that due to some changes inside the JSPWiki APIs, the BrushedTemplate is not compatible with v2.6 or later.
--DF, 20 July 2008

Brushed Template#

Please put your bugs, comments, questions, suggestions in BrushedTemplateDiscussion


The name of this WikiTemplate refers to the background I used initially for headers and editor screens. (brushed metal look & feel, similar to a safari browser and other os-x stuff)

The look and feel can easily be configured via Skins in the UserPreferences or CSS. Look at the Screenshots to see what you can expect.

Many features of the template rely on advanced javascript, so you'll need a modern browser. But page view and printout will keep readable, even wen js is turned off.

Brief summary of features. (more in the features tab)#

Some of the features made it into the standard JSPWiki v2.4: the attachment viewer, editor Find & Replace functions, and the MyFavorites

Other features include keyboard shortcuts, quick section links, AJAX driven find page, an easy way to clone a page and Pic/new.png rendering of typographic characters. The editor has direct section edit links and a metadata editor. The edit toolbar provides quick edit buttons,

Following JSPWikiStyles were added also to the standard v2.4 JSPWiki: zebra tables, horizontal and vertical bar charts (with Pic/new.png extra‘s in latest BrushedTemplate), tabbed sections, collapsable lists, collapsable text boxes, sortable tables.

But even more JSPWikiStyles are included: AJAX driven wiki categories, boxes with rounded corners, table filters, images with Pic/new.pngreflection effect, Pic/new.pngaccordion sections with smooth transition effects, Pic/new.pngmulticolumn styles for newspaper layouts. Pic/new.pngslimbox attachment viewer. Pic/new.pngfancy floating Tips.

Hope it can be useful to you.

More screenshots here.

Installation Instructions#

The brushed template consists of a self-contained zip, which is easy to install.

  1. Download the latest zip.
    Make sure to check the version of your wiki with the version of the template - they should match! Read the change-log to see the actual version numbers.
  2. Unzip the file: you will see a directory /brushed
  3. Copy /brushed to your jspwiki installation as /templates/brushed
  4. Edit /WEB-INF/ to refer to the template directory
    jspwiki.templateDir = brushed
  5. Restart your jspwiki app
  6. Point your browser to jspwiki, and off you go.
    In case you would see a strange screen, make sure to clear your browsers cookie

One more thing: this template also refers to a few specific wiki pages you may want to add to your wiki :

Good luck !

Hidden features#

Some adtional stuff is hidden in the template. To activate them, you need to make changes to the JSP pages and install some addtional plugins.

Overwrite version
I often save wiki pages, and get annoyed by the many versions created by JSPWiki. See for the solution I normally use.
To turn the feature on, you need to make some changes to the top-level ’‘Edit.jsp’’ and remove the comments from ’‘plain.jsp’’

Page Info shows some metadata
The version-history table in the ’’PageInfo.jsp’’ page has some additional column to show, for each version, the value of some metadata. This requires the wiki-engine to walk through all listed page-versions and retrieve the value of the metadata. This may have some performance penalty, but I have not noticed big issues with this.
To turn the feature on, change the ’’InfoTab.jsp’’. (commented section)

Page Info shows overview of Attachment Links and External Links
Next to the tabs of Incoming Links and Outgoing Links, the brushed template also has tabs for ’‘External Links’’ and ’‘Attachment Links’’. These tabs require you to install the ’‘original’’ ReferredPagesPlugin since the standard plugin doesn’t support these functions.
To tun this on, change the ’’InfoTab.jsp’’. (commented section)


v2.4.x features#

The latest update of the template is still in an early stage.

Mootools has become the base javascript framework instead of prototype. Mootools contains full support for AJAX, JSON as well as advanced visual effects and is extremely small. A revamp of the BrushedTemplate is ongoing, gradually introducing advanced features and visual effects.

The new features include fade effects on the quick search drop-down and %%category popups, slide in/out effects on collapsable list and boxes, reflection effect, accordions, image slideshow, popup Tips.

Major parts of the BrushedTemplate have been included as JSPWiki's default template. Therefore, further development of the BrushedTemplate as separate template will be abondoned. --DF, 20 Jul 2008

v.2.2.x-v2.4.x features#

I started with the refactoring of the brushed template because the dropdown menus, which were extensively used in the previous version, showed some instabilities (mainly ie was not happy). I also did a major rework of the javascript to clean up the namespaces and have a clean treatment of the page-onload handlers. (lots of .js was removed) The template now is completely DIVved and SPANned, most of the things can be changed through .css and thus by simply selecting another skin. Finally, I choose to have a template package which is self-contained. I.o.w. there should be no need to make any changes to your standard wiki installation - just drop in files in your templates directory. This is why some additional java was crammed into the JSP, while it would be better off elsewhere.

As of v2.4.x, AJAX technology has beend added based on the Prototype Javascript Library. In v2.6.x, Mootools will be used.

The main look&feel of the brushed template is now based on Page Tabs. This allows to put more info on a page without overloading it. You also get immediate access to the attachment list and additional page info, consistent across all screens, including view, edit, upload, etc. Fast navigation is possible via alt/ctrl-key shortcuts

The LeftMenu (now in Favorites.jsp) includes personalized favorites, a (blog) calendar (when set in UserPreferences tab), LeftMenu, LeftMenuFooter.

The main Page content can be divided into several sections with fast navigation buttons for top and bottom of the page, previous and next sections and section edit

Page Actions links are available at the top and bottom of the page. (configurable through css) They contain links to the Home page, PageIndex, RecentChanges, Preferences and LogIn/Out screens.

Page Footer contains a CopyrightNotice page. (now part of standard JSPWiki)

The Edit mode has support for direct editing of a particular section. This goes hand in hand with quick links. Also a Find&Replace toolbar is available, with regular expressions and undo functionality. (now part of standard JSPWiki) All Help info is in one tab, grouping all help on edit, find&replace, JSPWikiStyles, main plugins. Finally, all submit buttons (such as the save button) are automatically disabled after clicking; to prevent from double submits.

Many JSPWikiStyles are available, (most are included in the standard JSPWiki):

  • %%small … %% for Small text
  • %%sup … %% for Superscript text
  • %%sub … %% for Subscript text
  • %%strike … %% for Striketrough text

User Preferences allow setting/resetting certain user options. These preferences are stored in a cookie ’‘UserPreferences’’ on the client browser.

  • Skins: switch between different look & feels without restarting the webapp server. See JSPWikiSkinDesign and JSPWiki Stylesheet Design in case you want to write your own skins.
  • Preferred time&date format, which determines how time & data info is presented in all other pages.
  • TimeZone : Client-timezone is selectable.
  • Language : FFS
  • Edit textarea size: default textarea size can be changed
  • Typograpghy

The template has extensive Search with AJAX support.

  • The quick search at the top of the screen has a dropdown with a list of the 10 most recent search commands. It has immediate preview of the top-20 search-results.
  • The quick search menu has commands to quickly View, Edit, Clone or Find a page.
  • The extended findpage shows the search score by means of horizontal colored bars. You can use these bars in your pages too : see BrushedTemplateGraphBars. Search results are paginated. Adtional search details can be requested. Quick search links to Google and Wikipedia are available.

Other stuff, now part of the standard JSPWiki distribution: FAVICON, Table Of Contents and odd/even table coloring

Browsers Support #

Since several of the templates’ features rely on advanced javascript capabilities, they may suffer somewhat from browser incompatibilities. Anyway, most modern browsers, Firefox, IE, Safari should be ok.

The latest version v2.4.x (end 2006) was tested ok on Firefox, Safari(1.3+, 2.0+) and IE6.x. Opera and Camino to be checed.

IE7 was reported as not ok. (currently i dont have access to ie7, help is appreciated)

Please report any incompatibilities.


  • v2.2.x-v2.4.x (latest - stable) -- Use BrushedTemplate/
    • Change log
    • See feature tab for contents.
    • Major update of the template based on v2.2.x. –DF, May - Aug 05
    • Major update of the template, compatible with v2.4.2. The Quick-Search and Find page are now AJAX driven. mid 2006

Does not work with Author Workflow editor.

--AnonymousCoward, 12-Jun-2007

The Collapse doen´t work right with Microsoft Internet Explorer 6.0. The collapsed pages are not hidden, so you can still see them. Thats quiet ugly :((

--AnonymousCoward, 27-Jul-2007

Please post your questions in BrushedTemplateDiscussion. It would also be really helpful if you could post some IE6 screenshot about the problem. --DF

Add new attachment

Only authorized users are allowed to upload new attachments.

List of attachments

Kind Attachment Name Size Version Date Modified Author Change note
BrushedScreenshotCollapse.jpg 137.7 kB 1 14-Jun-2004 23:55 DirkFrederickx
BrushedScreenshotEdit.jpg 132.9 kB 3 14-Jun-2004 23:53 DirkFrederickx
BrushedScreenshotFind.jpg 118.3 kB 2 14-Jun-2004 23:56 DirkFrederickx
BrushedScreenshotPrefMenu.jpg 135.9 kB 1 14-Jun-2004 23:58 DirkFrederickx
BrushedScreenshotView.jpg 134.6 kB 2 14-Jun-2004 23:53 DirkFrederickx
BrushedScreenshotViewTOC.jpg 107.6 kB 2 14-Jun-2004 23:54 DirkFrederickx
zip 812.6 kB 3 21-Jun-2004 22:56 DirkFrederickx
zip 76.2 kB 2 19-Mar-2004 18:40
zip 154.1 kB 9 28-Nov-2005 22:10 DirkFrederickx
zip 243.6 kB 1 25-Jan-2006 21:33 DirkFrederickx
zip 259.5 kB 1 18-Apr-2006 23:01 Dirk Frederickx
zip 201.5 kB 1 03-Jan-2006 23:17 Dirk Frederickx
zip 240.1 kB 1 06-Jan-2006 17:38 Dirk Frederickx
zip 204.7 kB 3 04-Dec-2005 15:55 DirkFrederickx
zip 292.9 kB 1 26-Jul-2006 23:45 Dirk Frederickx
zip 286.8 kB 2 28-Jun-2006 22:18 Dirk Frederickx
zip 294.6 kB 1 03-Aug-2006 23:46 Dirk Frederickx
zip 285.9 kB 1 08-Jul-2006 23:55 Dirk Frederickx
zip 260.9 kB 3 06-Jun-2006 21:43
zip 320.6 kB 6 26-Nov-2006 22:27 DirkFrederickx Fixed several IE issues
zip 327.9 kB 2 15-Apr-2007 15:54 DirkFrederickx 2nd upload 15 April 07 - stability fixes
brushedmetal.jpg 6.3 kB 1 14-Jun-2004 23:49 DirkFrederickx
jspwiki-favicon.ico 4.3 kB 1 14-Jun-2004 23:50 DirkFrederickx
uconstr.gif 3.6 kB 1 22-Sep-2005 23:03 DirkFrederickx
uconstr.jpg 6.1 kB 1 22-Sep-2005 23:12 DirkFrederickx
« This page (revision-206) was last changed on 14-Jul-2010 16:58 by