The Natural Skin Plugin

Support plugin for NatSkin

Description

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, PREVREV,

MESSAGEBOX

Syntax: %MESSAGEBOX{"<text>" type="..." showicon="on/off" sticky="on/off" translate="on/off"}%

This renders a DIV html element with the appropriate style. See the examples here.

• text is the content within the message box
• showicon toggles the icon of message box types that come with one by default
• type is one of success, info, error, warning, help, tip, message or alt
• sticky if switched on will keep the message box sticky to the top while scrolling passed it
• translate if switched on the text will be translated using MultiLingualPlugin

NATFORMBUTTON

Syntax: %NATFORMBUTTON{"<format>"}%

returns a link 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 NATFORMBUTTON 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 %NATFORMBUTTON{"| $1"}% will generate a pipe and the formbutton if possible.

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.

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 %NATSKIN_LOGO% if defined
2. return %WIKILOGOIMG% if defined
3. return %WEBLOGOIMG% if defined
4. return %WIKITOOLNAME% if defined
5. or return the string 'Foswiki' otherwise

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 NATSKIN_LOGO = /path/to/your/natskinlogo.gif
  * Set WIKILOGOIMG = /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)
• unique="on/off": actions are rendered only once; if an action has already been rendered in the format string, it will not be rendered in the menu again (default)

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 one of GenPDF...Plugins (weasyprint, prince-xml or wkhtmltopdf)
• $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
• SiteMenu: 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

see also: MYSIDEBAR

Installation Instructions

See NatSkin

Dependencies

Name	Version	Description
Foswiki::Contrib::CopyContrib	>=2.0	Required
Foswiki::Contrib::FamFamFamContrib	>=2075	Required
Foswiki::Contrib::JQSelect2Contrib	>1.01	Required
Foswiki::Contrib::JQAjaxFormContrib	>=0	Required
Foswiki::Contrib::WebFontsContrib	>=1	Required
Foswiki::Plugins::AutoTemplatePlugin	>=2.01	Required
Foswiki::Plugins::BreadCrumbsPlugin	>=4318	Required
Foswiki::Plugins::CaptchaPlugin	>=2.0.0	Optional
Foswiki::Plugins::DBCachePlugin	>=12	Required
Foswiki::Plugins::DiffPlugin	>=2.0	Required.
Foswiki::Plugins::FilterPlugin	>=3491	Required
Foswiki::Plugins::FlexFormPlugin	>=5.3	Required
Foswiki::Plugins::FlexWebListPlugin	>=3493	Required
Foswiki::Plugins::GridLayoutPlugin	>=1.00	Required
Foswiki::Plugins::ImagePlugin	>=2.40	Required
Foswiki::Plugins::JQueryPlugin	>=7.00	Required
Foswiki::Plugins::ListyPlugin	>=1	Required
Foswiki::Plugins::MetaCommentPlugin	>=2.80	Optional
Foswiki::Plugins::MimeIconPlugin	>=1	Required
Foswiki::Plugins::MoreFormfieldsPlugin	>=4.00	Required
Foswiki::Plugins::MultiLingualPlugin	>=2.00	Required
Foswiki::Plugins::NatEditPlugin	>=8.00	Required
Foswiki::Plugins::RedDotPlugin	>=1	Required
Foswiki::Plugins::RenderPlugin	>=6.00	Required
Foswiki::Plugins::SecurityHeadersPlugin	>=2.00	Optional
Foswiki::Plugins::PixabayPlugin	>=0	Optional
Foswiki::Plugins::TopicInteractionPlugin	>=1340	Required
Foswiki::Plugins::WebLinkPlugin	>=2.1	Required
Foswiki::Plugins::WebCreatorPlugin	>=1	Required
Foswiki::Plugins::ZonePlugin	>=3.1	Required. required for Foswiki < 1.1
Foswiki::Plugins::TopicTitlePlugin	>1.00	Required for Foswiki < 2.2

Change History

27 Jan 2025:	new major release
11 Aug 2023:	added %MESSAGEBOX macro; moved some of the basic HTML optimizations from PageOptimizerPlugin into here; support for darkmode feature; improved topic restore feature
12 Feb 2019:	major release for NatSkin 6.0
23 Jan 2017:	better handing of revision infos being attached to a h1; removed detection of old Internet Explorers as well as warning for unsupported browsers; better support for Foswiki:Extensions/DiffPlugin; hide "New" button based on web, not on topic access rights
25 Feb 2016:	improved support for pdf printouts; removed secure headers as that's a plugin of its own now
17 Jul 2015:	better integration with Foswiki:Extensions/AutoTemplatePlugin; better detection of Internet Explorer versions; added edit_raw action; added support for Foswiki-2.0; properly searching for WebComponents in the web holding the local SitePreferences ... which not necessarily is the user web
27 Feb 2015:	finally 4.00
29 Aug 2014:	third beta
28 Mar 2013:	second beta
14 Mar 2013:	first beta of new release
16 Mar 2005:	Initial version