NatSkinConfiguration

Theme configuration

The different NatSkin styles (themes) are controlled using TWiki preference variables and can be set

• per user (on the user's home topic),
• per web (in the WebPreferences),
• site wide (in theTWiki.TWikiPreferences) and
• on every request (using url parameters)

Use the NatSkinStyleBrowser to preview the known styles and settings. Note, that the selection made there will only last for the current session. You need to add the respective preference variables to your home topic or the WebPreferences or the TWikiPreferences to make the selection persistent.

This is the list of variables to configure the skin style:

Name (url param)	Values	Description	Default
SKINSTYLE (style)	Base, Clean, GeorgiaBlue, Gettysburg, Independence, Kubrick, Pattern, PlainJane, Rusty, SeaGreen, Squash, Stormy	select a predefined style	Clean
STYLEVARIATION (stylevariation)	BlueField, BlueTechCherry, Fire, Nuozek, OrangeTunnel, PinkPanther, PlasticLove, RedWoman, SepiaField, Subway, Water	select a style variation	none
STYLEBORDER (styleborder)	on, off, thin	change the border decoration; thin enables a blog-like page layout	off
STYLEBUTTONS (stylebuttons)	on, off	switch on/of the tab buttons above the topic area	off
STYLESIDEBAR (stylesidebar)	left, right, both, off	configure where the sidebar is to be displayed	left
STYLESEARCHBOX (stylesearchbox)	top, pos1, pos2, pos3, off	configure where the searchbox is to be displayed: in the topbar (top), at the top of the sidebar (pos1), in the middle of the sidebar (pos2), at the bottom of the sidebar (pos3) or off	top

There are a couple of special url parameters:

• togglesidebar: disable the sidebar for this request only.
• style=off: switch off any styles (simulating a non-css browser)
• style=reset: switch back to the user and server settings by reverting any session preferences
• switchstyle=next/prev: switch to the next/previous known style
• switchvariation=next/prev: switch to the next/previous known style variation

Example: To emulate the Kubrick style on the old BinaryBonsai (not the new K2 style) use

  * Set SKINSTYLE = Kubrick
  * Set STYLEBORDER = thin
  * Set STYLEBUTTONS = on
  * Set STYLESIDEBAR = right
  * Set STYLEVARIATION = none
  * Set STYLESEARCHBOX = pos1

There are some constraints build into the NatSkin templates that try guarantee a pleasant appearance when combining the different skin states:

• If the styleborder is "thin" the sidebar will be disabled for the edit, manage, rdiff, natsearch, changes and search topic actions.
• The web buttons will alternate with the sidebar so that they will not be displayed on the same side.
• If the web buttons are enabled the default WebSideBar will disable the redundant navigation to other webs.

Defining new Themes

The NatSkin can be themed using cascading styles attached to the TWiki.NatSkin or any other topic defined in the STYLEPATH preference variable. This variable is a list of topics that are consulted for css attachments. The default value is

  * Set STYLEPATH = TWiki.NatSkin

Styles are collected in the order specified. This allows to insert style contributions that are not part of the NatSkin. For example given you uploaded NatSkin css definitions to a topic Main.NatSkinThemesContrib you can activate them by setting the STYLEPATH to

  * Set STYLEPATH = Main.NatSkinThemesContrib, TWiki.NatSkin

Css files must obey the following naming scheme to be recognized

• <name>Style.css: basic style definitions for style <name>
• <name>Buttons.css: WebButton definitions for style <name>
• <name>Border.css: definitions for style <name> displayed using STYLEBORDER = on
• <name>Thin.css: definitions for style <name> displayed using STYLEBORDER = thin
• <name>Thin.css: definitions for style <name> displayed using STYLEBORDER = thin
• <name>Variation.css: style variations that can be applied to any base style; this can be used to vary a base style, e.g. to add header art or change some fonts and colours

Enabling the build-in Wikiwyg editor

There is an additional set of templates that can be used to replace the normal text editor with a javascript based "wikiwyg" editor that will ease to write TWikiMarkUp. To enable NatEdit add the following to your User.TWikiPreferences or to your HomeTopic:

  * Set SKIN = natedit, nat

Email Obfuscation

The standard TWiki engine tries to obfuscate email addresses by adding a phrase to the email url (like NOSPAM) to fool collecting web crawlers. But that is not adequate enough today as crawlers are aware of that. The solution to that is to remove every trace of a pattern that could be an email address from the html source code and regenerate them using javascript. Most likely, web crawlers will only parse the html and don't run a javascript interpreter beforehand. Nevertheless the obfuscation feature can be switched on and off by adding the OBFUSCATEEMAIL variable to your TWikiPreferences like

  * Set OBFUSCATEEMAIL = on

WysiwygPlugin support

When the TWiki:Plugins/WysiwygPlugin is installed on your TWiki installation the "Edit" topicaction can be enabled to start the Kupu wysiwyg html editor instead of the normal TWiki textarea by setting the USEWYSIWYG variable to "on" (in your TWikiGuest topic, WebPreferences or TWikiPreferences)

  * Set USEWYSIWYG = off

By default this value is set to "off"

Misc preference variables

There is a set of variables that can be used influence how NatSkin behaves or renders pages.

Name	Description
PAGETITLE	the <title>... of the html page; if no PAGETITLE is defined the NatSkin will check for some formfields (Headlines, TopicDescription) to be used as a html page title and back off to the topic name
METAAUTHOR	the value of this variable will be used to construct <meta name="author" ... /> in the html head
METADESCRIPTION	the value of this variable will be used to construct <meta name="description" ... /> in the html head
METAKEYWORDS	the value of this variable will be used to construct <meta name="keywords" ... /> in the html head
WHITEBOARD	possible values: on, off; if WHITEBOARD is set to only the topic form will be edited when clicking on "Edit"; note, that the textarea is still accessible and not hidden completely; this is flag is only there for convenience

Hint: Assign default meta data per web by adding

  * Set DEFAULT_METAKEYWORDS = keyword1, keyword2, keyword3
  * Set METAKEYWORDS = %DEFAULT_METAKEYWORDS%

to the WebPreferences and add extra keyword data per topic like this

  * Set METAKEYWORDS = %DEFAULT_METAKEYWORDS%, keyword4, keyword5, keyword6

Caution: don't add meta data to your home topic because it will override all other meta data preferences.

-- MichaelDaum^? - 25 Aug 2006