<--

   PLEASE DO NOT EDIT THIS TOPIC

   It is automatically generated from the subversion repository, and any changes
   you make will simply be overwritten the next time a release is generated.

   Instead, you could check your fix in, raise a bug in the Bugs web, or mail the author(s).
-->

The Natural Skin Plugin

Description

Powered by WikiRing Consultants

The documentation of the NatSkinPlugin only covers the additional tags that have been implemented. Have a look at the NatSkin topic for more information.

Syntax

CURREV

returns the current topic revision (compatible among all TWiki engines)

see also: NATMAXREV, NATREVISIONS PREVREV,

FORMBUTTON

returns a link on to add or change the form attached to a topic. This will be shown on the edit screen depending on WEBFORMs being defined or not. More precisely FORMBUTTON returns

• an empty string if there are no WEBFORMS defined
• or an "Add form" link if there are but no form is attached yet
• or a "Change form" link to change the current form

The optional %lt;format> string may contain the following variables

• $url: the url of the link
• $action: the link text
• $1: the complete anchor including the link and the text

For example %FORMBUTTON{"| $1"}% will generate a pipe and the formbutton if possible. See the edit.nat.tmpl template file of the NatSkin.

GETSKINSTYLE

get the current skin style; the priority is

1. urlparam style=<name>,
2. value of the session variable NATSKIN_STYLE and
3. preference value SKINSTYLE set in (a) the user preferences (b) the WebPreferences or (c) TWikiPreferences

IFSKINSTATE

conditionally returns content depending on the current skin state; <tests> can be

• style="<name>": test if the current style is <name>
• variation="<name>": test if the style variation is <name>
• border="on,off,thin": test if the current border is on, off or "thin"
• buttons="on,off": test if the web buttons are currently on or off
• sidebar="left,right,off": test if the sidebar is currently on the right, left or off
• searchbox="top,pos1,pos2,pos3,off": test if the searchbox is currently on given position or off
• release="beijing,cairo,dakar": test if the twiki release this plugin is installed on is Beijing, Cairo or Dakar
• action="view,edit,preview,...": test the current topic action
• glue="on,off": control wether to eat surrounding whitespaces or not
• final="<name>": test if a skin state variable called <name> is set to be changeable or not using the the FINALPREFERENCES setting; known names are are "style", "sidebar", "buttons", "border", "variation" or "searchbox"; "all" tests wether you can vary the skin at all; "switches" tests of you can change at least one of "sidebar", "buttons", "border" or "searchbox"

The tag will render the "then" content if all tests evaluate to true and the "else" content otherwise. Tested strings can be regular expressions.

Sectional IFSKINSTATETHEN

%IFSKINSTATETHEN{<tests>}% 
  <then content> 
[%ELSIFSKINSTATE{<tests>}% 
  <elsif content>]* 
[%ELSESKINSTATE% 
  <else content>]?
%FISKINSTATE%

This is the multi-line version of IFSKINSTATE that uses the same tests as above but takes the content from between the sections; thus, arbitrary TWikiML might be rendered conditionaly. IFSKINSTATETHEN expressions can be nested safely. Within a single IFSKINSTATETHEN the ELSIFSKINSTATE parts can be repeated arbitrarily. Before rendering the <then|elsif|else condition> any $nop string will be removed first. Thereby nested TWikiML expressions can be prevented from being expanded in advance.

KNOWNSTYLES

returns a list of all known skin styles.

KNOWNVARIATIONS

returns a list of all known styles variations.

NATFORMLIST

returns a formatted list of forms that can be attached to a topic. typically used in the changeform skin template. paramters:

• header
• format
• footer
• separator
• selected
• web
• topic

NATLOGINURL

returns an url to a login depending on the current scheme. This will be a link to

• natlogon on any legacy twiki releases or in case the LoginManager is set to "none"
• login on using dakar's TemplateLogin
• viewauth using ApacheLogin

NATLOGOUTURL

returns an url to a logout depending on the current login scheme. This will be a link to

• natlogon on any legacy twiki releases or in case the LoginManager is set to "none"
• view...?logout=1 on using dakar's TemplateLogin
• the empty string in case you are using ApacheLogin (you can't logout explicitely)

NATMAXREV

substitute for %MAXREV% which differes all too much on Beijing, Cairo and Dakar. This version grants to behave the same.

NATREVISIONS

substitute for the %REVISIONS% tag which only works on the TWiki:Plugins/PatternSkin.

NATWEBLOGO

returns either a textual or a graphical a logo to be used in the header bar depending on a set of preference variables.

NATWEBLOGO will check for a couple of preference variables in the following order:

1. return %NATWEBLOGONAME% if defined
2. return %NATWEBLOGOIMG% if defined
3. return %WEBLOGOIMG% if defined
4. return %WIKITOOLNAME% if defined
5. or return the string 'TWiki' otherwise

The ...IMG% cases will return a full <img src="..." ... /> tag whereas the ...NAME% cases will return the string only.

So given you want to have the string TWiki in the logo position when using NatSkin but not so when using a different skin on the same site. Then add the following to the TWikiPreferences:

  * Set NATWEBLOGONAME = %WIKITOOLNAME%
  * Set WEBLOGOIMG = /path/to/your/defaultlogo.gif

If you want to have a different logo using NatSkin than using another skin on the same site then add the following to the TWikiPreferences:

  * Set NATWEBLOGOIMG = /path/to/your/natskinlogo.gif
  * Set WEBLOGOIMG = /path/to/your/defaultlogo.gif

PREVREV

returns the previous topic revision taking NumberOfRevisions into account

SETSKINSTATE

set the skin state using TWiki markup. This is different from using topic preference variables in three respects: (1) you can set the skin state at any place now, i.e. INCLUDEing another topic where that topic's preference variables are not evaluated. (2) SETSKINSTATE "may come to late" in the rendering pipeline so that it does not take effect throughly; topic preferences are fetched before rendering starts. (3) it is not checked if the resulting skinstate is "valid" when you use SETSKINSTATE; this is the case if you use preferences values

The following arguments are known and can be used in any combination:

• buttons="..."
• sidebar="..."
• variation="..."
• style="..."
• searchbox="..."
• border="..."

USERACTIONS

display separate sets of actions for anonymous or authenticated users.

• sep="<span> class="natSep">|</span>": separator between actions
• guest="$login$sep$register$sep$print": format string of actions for guests
• format="$user$sep$logout$sep$print<br />$edit$sep$attach$sep$move$sep$raw$sep$diff$sep$more": format string of actions for authenticated users

The "guest" and "format" format strings can use the following variables

• $attach: link to "attach" topic action
• $diff: link to diff
• $edit: link to edit
• $login: link to log in
• $logout: link to log out
• $more: link to more dialog
• $move: link to move dialog
• $print: link to print action
• $raw: link to display topic in raw format
• $register: link to registration
• $sep: separator string
• $user: name of current authenticated user

WEBCOMPONENT

Arguments: ==

• name: The name of the WebComponent topic.
• web="<name>": The web to fetch the component from. Default to the current web.
• lineprefix="<prefix>": A prefix to be added to each line of the web component topic before inclusion. Typically three space characters.
• multiple : If defined WEBCOMPONENT will allow for multiple inclusions of the same web component topic.

display a web component. A web component "MyComponent" is searched looking for

1. MyComponent in the current web,
2. TWikiMyComponent in the Main web,
3. TWikiMyComponent in the TWiki web and
4. MyComponent in the TWiki web.

The WEBCOMPONENT tag will retrieve the component where it was found first. Thereby every web can define a component of its own but if it is not defined locally a predefined component will be returned. Components can be predefined in the Main and the TWiki where the name of the component is prefix with "TWiki" to distinguish them from the local web components that may be present in the Main and the TWiki. As a last resort the local components of the TWiki are used.

By default the NatSkin comes with predefined components

• TWiki.TWikiWebSideBar
• TWiki.TWikiWebButtons
• TWiki.TWikiWebLinks
• TWiki.TWikiWebTopicActions
• TWiki.TWikiWebCss

Example:

• use %WEBCOMPONENT{"WebSideBar"}% to display a the sidebar component
• use %WEBCOMPONENT{"WebButtons"}% to display the WebButtons

see also: MYSIDEBAR

WEBLINK

display a link to a WebHome with the given name and add the SITEMAPUSEDTO description to to the hover balloon

WIKIRELEASENAME

returns "beijing", "cairo" or "dakar" depending on the TWiki engine this plugin is installed on

Installation Instructions

• Download the ZIP file
• Unzip it in your twiki installation directory. Content:

  File:	Description:
  bin/natsearch
  data/TWiki/NatSkinPlugin.txt
  lib/TWiki/Plugins/NatSkinPlugin/DEPENDENCIES
  lib/TWiki/Plugins/NatSkinPlugin/Search.pm
  lib/TWiki/Plugins/NatSkinPlugin/build.pl
  lib/TWiki/Plugins/NatSkinPlugin.pm

• Optionally, run NatSkinPlugin_installer to automatically check and install other TWiki modules that this module depends on. You can also do this step manually.
• Alternatively, manually make sure the dependencies listed in the table below are resolved.

• Optionally install the TWiki:Plugins/RedDotPlugin to ease editing the sidebar navigation
• Visit configure in your TWiki installation, and enable the plugin in the {Plugins} section.
• Edit TWiki.TWikiPreferences and change the SKIN variable to "nat"; customize the default style adding the variables SKINSTYLE, STYLEBORDER, STYLEBUTTONS and STYLESIDEBAR (see NatSkin)
• If you have set up ssl for your server add the following variable to your TWikiPreferences:

   * Set HTTPSLOGON = on 

  This will prevent passwords being sent in clear-text over a possibly insecure net.
• To enable ssl as soon as you logged in use the following rewrite rules in bin/.htaccess:

   RewriteEngine On
   RewriteCond %{SERVER_PORT} !443
   RewriteCond %{QUERY_STRING} template=oopslogon
   RewriteRule ^(.*)$ https://%{HTTP_HOST}/bin/$1 [R,L]
  

  Note, that you might need to accommodate the /bin url path above to your installation!

Plugin Info

<-- provided for compatibility only 

 Set SHORTDESCRIPTION = Supplements the bare bones NatSkin theme for TWiki
 
-->

<-- versions below in reverse order -->

-- TWiki:Main/MichaelDaum - 13 Nov 2007