|
...discover TWiki details, and how to start your own site.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
The Natural Skin PluginThis is the supplemental plugin for the NatSkin. Its main purpose is to supply "skin states" to control different styles and variants to be switched dynamically while you are online. But see the below for a full list of all provided features. This plugin tries to be maximal compatible with all past, current and upcoming TWiki releases, namely beijing, cairo and dakar (aka TWiki-4.x). Therefore some mechanisms have been internalized that are only available since TWiki-4.0. The plugin tries to be interface-compatible to all engines using theFunc.pm API. In those cases where this is not possible, because needed
functions are not part of the Func.pm API, access functions have been added
to address the different implementations and incompatibilities (e.g. access to
topic meta data). In the future a sensible part of that will be moved over to
the DakarContrib package and be used by the NatSkinPlugin and similar.
This plugin is inspired by the TWiki:Plugins/GnuSkin by
TWiki:Main/JoachimNilsson and the TWiki:Plugins/PhotonSkin by
TWiki:Main/EstebanManchado (PhotonSearch) renamed to natsearch .
Current Features
Syntax RulesCURREVSyntax:%CURREV%
returns the current topic revision (compatible among all TWiki engines)
see also:
NATMAXREV,
NATREVISIONS
PREVREV,
GETSKINSTYLESyntax:%GETSKINSTYLE%
get the current skin style; the priority is
IFACCESSSyntax:
%IFACCESS{"<topic>"
action="..."
then="..."
else="..."
mode="..."
[then_]args="..."
else_args="..."}%
display the then or else argument depending on the access rights of the current user
to the topic <topic>.
action can be view, change or rename
specifying the requested access mode;
mode can be text or include where text conditionally renders the text in
the then and else arguments and text includes the topic in then or else;
if then is not specified in include mode then <topic> is included if access
is granted;
Example: %IFACCESS{"AdminSideBar" mode="include"}% includes the
AdminSideBar if the current user has view access to this topic
IFSKINSTATESyntax:%IFSKINSTATE{<tests> then="..." else="..."}%
conditionally returns content depending on the current skin state;
<tests> can be
IFSKINSTATETHEN, ELSIFSKINSTATE, ELSESKINSTATE, FISKINSTATESyntax:
%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.
KNOWNSKINSTYLESSyntax:%KNOWNSKINSTYLES%
render a list of all known skin styles being attachted to the NatSkin topic
KNOWNVARIATIONSSyntax:%KNOWNVARIATIONS%
render a list of all known styles variations being attachted to the NatSkin topic
MYSIDEBARSyntax:%MYSIDEBAR%
display a personalized WebSideBar for the user currently logged in. This is
TWikiGuestSideBar? for you now. Use the MySideBar to create a new
sidebar based on the MySideBarTemplate.
see also: WEBCOMPONENT
NATLOGONSyntax:%NATLOGON%
displays Logon|Register for TWikiGuest, and
TWikiGuest|Logout otherewise
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.
PREVREVSyntax:%PREVREV%
returns the previous topic revision taking NumberOfRevisions into account
USERACTIONSSyntax:%USERACTIONS%
display Edit|Attach|Move|Raw|Diffs|More when
logged in and an empty string for TWikiGuest
WEBCOMPONENTSyntax:%WEBCOMPONENT{"name"}%
display a web component found in the current web or, if not present, in the
TWiki, e.g. use %WEBCOMPONENT{"WebSideBar"}% to replace the
deprecated %WEBSIDEBAR% tag; use %WEBCOMPONENT{"WebButtons"}% to
display the WebButtons respectively
see also:
MYSIDEBAR
WEBSIDEBARSyntax:%WEBSIDEBAR%
displays the left navigation menu using the WebSideBar topic (deprecated, use
WEBCOMPONENT)
see also:
MYSIDEBAR,
WEBCOMPONENT
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
About NatSearchThis is a cgi-script that is heavily based on the PhotonSearch of the TWiki:Plugins/PhotonSkin. Sonatsearch is basically a fork of that including fixes to similar security flaws that
hit the WebSearch those days also.
NatSearch can be further reduced to certain webs and topics by setting WebPreferences.
Besides the NOSEARCHALL feature of every web that excludes a web from search the following variables
restrict the hit set:
NATSEARCHTEMPLATE can be set to a template topic that
is used instead of the skin's search template. This can be used in TWikiApplications to
define a customized look of search results.
Please see the TWiki:Plugins/PhotonSkin for an explanation of the possible search parameters
(TODO: maby move that stuff in here).
About the WebSideBarThe WebSideBar is used to generate a navigation appearing next to the main topic area. Each web in your AVR32 Linux might optionaly have a separate WebSideBar. The default TWiki.WebSideBar can be used to add a default section common to all WebSideBars. If the WebSideBar isn't defined the default TWiki.WebSideBar is used. Each user might define a personalized WebSideBar called%WIKINAME%SideBar that is
appended to the WebSideBar. The TWiki:Plugins/RedDotPlugin is used to make customizing the WebSideBar
easier appended to the different parts that make up the complete sidebar. These are hidden if
you don't have write access to the respective topic fragments.
About the WebButtonsThe WebButtons are used to render the button toolbar at the top of the page when theSTYLEBUTTONS
setting is set to "on".
The WebButtons are an unordered list of
those links that should be visible there. There exists one WebButtons topic by default in the
TWiki web. You can define a WebButtons topic per web overwriting the settings in the
TWiki.WebButtons topic. If you do not define a WebButtons topic in a web then the
default one will be used displaying a set of links to all public webs in your AVR32 Linux
installation.
About Logon & LogoutLOGONTOPIC
Plugin SettingsBelow are the settings which affect the behavior of the NatSkin.
Skin state configurationThe skin state is controlled by a set of variables that are configured on the user's home topic, the WebPreferences or the TWiki.TWikiPreferences and are then loaded into the current session of the user. So every setting can be changed by an url parameter to take effect for the duration of the user session. The default values are given below
togglesidebar that disables the sidebar for this request
only.
To emulate the Kubrick style on the old
BinaryBonsai (not the new K2 style) then copy-paste this
Style support for the TablePluginThese attributes will be loaded into your session and thereby overwriting any default settings on the TablePlugin topic. Depending on the skin style you are currently using these settings will be changed accordingly.
Email ObfuscationThe 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 theOBFUSCATEEMAIL variable
to your TWikiPreferences like
WysiwygPlugin supportWhen the TWiki:Plugins/WysiwygPlugin is installed on your AVR32 Linux 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)
Plugin Installation Instructions
Plugin Info
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Copyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Linux® is the registered trademark of Linus Torvalds in the U.S. and other countries.
Atmel®, AVR® and others are registered trademarks or trademarks of Atmel Corporation or its subsidiaries.
All other trademarks are the property of their respective owners.
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.NatSkinPlugin
Linux® is the registered trademark of Linus Torvalds in the U.S. and other countries.
Atmel®, AVR® and others are registered trademarks or trademarks of Atmel Corporation or its subsidiaries.
All other trademarks are the property of their respective owners.
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.NatSkinPlugin
Powered by TWiki/Dakar
Wed, 08 Feb 2006 build 8740