|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
The Natural Skin PluginDescription
SyntaxCURREVSyntax:%CURREV%
returns the current topic revision (compatible among all TWiki engines)
see also:
NATMAXREV,
NATREVISIONS
PREVREV,
FORMBUTTONSyntax:%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
%lt;format> string may contain the following variables
%FORMBUTTON{"| $1"}% will generate a pipe and the formbutton
if possible. See the edit.nat.tmpl template file of the NatSkin.
GETSKINSTYLESyntax:%GETSKINSTYLE%
get the current skin style; the priority is
IFSKINSTATESyntax:%IFSKINSTATE{<tests> then="..." else="..."}%
conditionally returns content depending on the current skin state;
<tests> can be
Sectional IFSKINSTATETHENSyntax:
%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.
KNOWNSTYLESSyntax:%KNOWNSTYLES%
returns a list of all known skin styles.
KNOWNVARIATIONSSyntax:%KNOWNVARIATIONS%
returns a list of all known styles variations.
NATFORMLISTSyntax:%NATFORMLIST{...}%
returns a formatted list of forms that can be attached to a topic. typically used
in the changeform skin template.
paramters:
NATLOGINURLSyntax: =%NATLOGINURL% returns an url to a login depending on the current scheme. This will be a link to
NATLOGOUTURLSyntax:%NATLOGOUT%
returns an url to a logout depending on the current login scheme. This
will be a link to
NATMAXREVSyntax:%NATMAXREV%
substitute for %MAXREV% which differes all too much on Beijing, Cairo
and Dakar. This version grants to behave the same.
NATREVISIONSSyntax:%NATREVISIONS%
substitute for the %REVISIONS% tag which only works on
the TWiki:Plugins/PatternSkin.
NATWEBLOGOSyntax:%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:
...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.gifIf 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 PREVREVSyntax:%PREVREV%
returns the previous topic revision taking NumberOfRevisions into account
SETSKINSTATESyntax: =%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:
USERACTIONSSyntax:%USERACTIONS{"<format>" ...}%
display separate sets of actions for anonymous or authenticated users.
WEBCOMPONENTSyntax:%WEBCOMPONENT{"name" web="<name>" lineprefix="<prefix>" multiple="
Arguments: ==
WEBLINKSyntax:%WEBLINK{web="..." name="..."}%
display a link to a WebHome with the given name and add the SITEMAPUSEDTO description to
to the hover balloon
WIKIRELEASENAMESyntax:%WIKIRELEASENAME%
returns "beijing", "cairo" or "dakar" depending on the TWiki engine this plugin is installed on
Installation Instructions
Plugin Info
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Copyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors. Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.NatSkinPlugin