The Natural Skin Plugin

Description

Powered by WikiRing Consultants

This is the supplemental plugin for the NatSkin. Its main purpose is to supply "skin states" to control different styles and variations to be switched dynamically while you are online.

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

Syntax: %CURREV%

returns the current topic revision

see also: NATMAXREV, NATREVISIONS PREVREV,

FORMBUTTON

Syntax: %FORMBUTTON{";lt;format>"}%

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

Syntax: %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) DefaultPreferences or SitePreferences

KNOWNSTYLES

Syntax: %KNOWNSTYLES%

returns a list of all known skin styles.

KNOWNVARIATIONS

Syntax: %KNOWNVARIATIONS%

returns a list of all known styles variations.

NATFORMLIST

Syntax: %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

NATMAXREV

Syntax: %NATMAXREV%

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

NATREVISIONS

Syntax: %NATREVISIONS%

substitute for the %REVISIONS% tag which only works on the PatternSkin.

NATWEBLOGO

Syntax: %NATWEBLOGO{format="..."}%

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 'Foswiki' otherwise

Given you want to have the string Atomikos 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 SitePreferences:

  * 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 SitePreferences:

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

PREVREV

Syntax: %PREVREV%

returns the previous topic revision taking NumberOfRevisions into account

USERACTIONS

Syntax: %USERACTIONS{"<format>" ...}%

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
• restrictedactions="...": list of user actions that are disabled if the user has got no write access to the current topic
• help="...": help topic used for $help, defaults to UsersGuide (see below)

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
• $help: link to a help page
• $login: link to log in
• $logout: link to log out
• $more: link to more dialog
• $move: link to move dialog
• $pdf: link to export pdf using the GenPDFAddOn
• $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

Syntax: %WEBCOMPONENT{"name" web="<name>" lineprefix="<prefix>" multiple=""}%

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. WebMyComponent in the current web,
2. SiteMyComponent in the Main web,
3. SiteMyComponent in the System web and
4. WebMyComponent in the System web.

The WEBCOMPONENT tag will retrieve the component where it was found first. Thereby the component can be customize for each web separately if required. If it is not defined locally a predefined component will be returned. Components can be predefined in the Main and the System where the name of the component is prefix with "Site" to distinguish them from the local web components that may already be present in the Main and the System. As a last resort the local components of the System are used.

By default the NatSkin comes with predefined components

• SiteBottomBar: page bottom
• SiteButtons: horizontal navigation
• SiteLinks: link section inside sidebar component
• SiteSideBar: sidebar navigation
• SiteRightBar: right sidebar navigation, used in three columns layout (stylesidebar = both)
• SiteTopicActions: topic actions
• SiteHtmlHead (deprecated)

see also: MYSIDEBAR

WEBLINK

Syntax: %WEBLINK{web="..." name="..."}%

display a link to a web with the its name and add the SITEMAPUSEDTO description to to the hover balloon. The web name is stripped down to its distinguishing tail, removing all parent web names.

Arguments:

• web: name of the web to link to
• name: name to display instead of the web name
• format: format string for the web link
• marker: string to be added to inserted into the format string if the web link points to the current web

The following variables can be used in the format string:

• $web: full qualified name of the web, defaults to current web
• $topic: name of the topic to link to, defaults to WebHome
• $name: name of the web, all prefixes but its basename being stripped off
• $url: url for the link
• $marker: the marker set to the "marker" string if the link points to the current web
• $tooltip: tooltip for the link, mostly used in a title argument of an anchor

Installation Instructions

See NatSkin

Dependencies

Name	Version	Description
Foswiki::Contrib::FamFamFamContrib	>=2075	Required.
Foswiki::Plugins::BreadCrumbsPlugin	>=4318	Required
Foswiki::Plugins::FilterPlugin	>=3491	Required
Foswiki::Plugins::FlexWebListPlugin	>=3493	Required
Foswiki::Plugins::IfDefinedPlugin	>=3637	Required
Foswiki::Plugins::SetVariablePlugin	>=4287	Required
Foswiki::Plugins::UploadPlugin	>=1340	Required
Foswiki::Plugins::NatEditPlugin	>=1993	Required
Foswiki::Plugins::JQueryPlugin	>=3740	Required

Plugin Info