diff options
Diffstat (limited to 'TWiki/GnuSkinPlugin.mdwn')
| -rw-r--r-- | TWiki/GnuSkinPlugin.mdwn | 97 |
1 files changed, 13 insertions, 84 deletions
diff --git a/TWiki/GnuSkinPlugin.mdwn b/TWiki/GnuSkinPlugin.mdwn index 86a4f3ea..af18356d 100644 --- a/TWiki/GnuSkinPlugin.mdwn +++ b/TWiki/GnuSkinPlugin.mdwn @@ -1,97 +1,28 @@ -* Description - * Set SHORTDESCRIPTION = A complete bare bones skin theme template for TWiki +## <a name="Welcome_to_the_TOPIC_"> Welcome to the %TOPIC% </a> -* Debug plugin? Output can be viewed in data/debug.txt - * Set DEBUG = 0 - -The [[GnuSkin]] makes use of most the [[WebMenu]] concept, first introduced by the [[TigerSkin]]. See it in action on the [[Know/WebHome]]. - -Status: It's at beta stage. Now I only have to start ripping out allt the pieces that still say [[TigerSkin]] and are redundant before I start distributing this. - -Download: Send me an email if you want a snapshot. - -See the [[GnuSkinPluginDev]] for development talk, - --- [[Main/JoachimNilsson]] - 04 Jun 2002 - -## <a name="_TOPIC_"> %TOPIC% </a> - -The [[GnuSkin]] plugin is a rip off from the [[TigerSkinPlugin]]. The main intentions are to simplify the design enough to get a basic and yet useful environment suitable for production use by [GNU](http://www.gnu.org/) projects. - -See it in action on the Hurd Wiki web at vmlinux.org, <http://vmlinux.org/twiki/bin/view/Hurd/WebHome>. - -**_Primary goals include:_** - -Issues the current release, v1.0, will address. - -* Basic skin compatible with most browsers: Mozilla 4.xx-6.xx, Lynx, W3M, Links, (X)Emacs/W3 and maybe even Internet Explorer. -* Looks, "skin deep" design � la [The Hurd](http://hurd.gnu.org) web pages. -* User configurable everything, as far as possible. Therefore the TigerSkin's WebMenu parser is integrated. - -**_Secondary goals:_** - -These design goals will go into the v2.0 series of the Gnuskin. - -* Quicker. -* Lesser files. -* Smaller. -* Extended configurability - Edit **all** of the webmenu, change topmenu, etc. - -## <a name="Syntax_Rules"> Syntax Rules </a> - -* See the TigerSkin's WebMenu for example. -* More to to come... +This is the supplemental plugin for the [[GnuSkin]]. It provides a small Perl engine for handling dynamic, user configurable, content. For more information see the [[GnuSkin]] page. -## <a name="ToDo"> ToDo </a> +**_Installation:_** -* Release v1.0 -* Simplify, simplify, simplify! +See [[GnuSkinInstall]] for details of download and installation instructions. -## <a name="History"> History </a> +### <a name="_TOPIC_Default_Settings"> %TOPIC% Default Settings </a> -This is the [[TWiki/GnuSkin]] plugin. It's designed to more like a general [GNU](http://www.gnu.org) web page and less like the [[TWiki/TigerSkinPlugin]]. - -Lean & simple and yet still good looking and stylish. The [[GnuSkinPlugin]] is a rip-off from the [[TigerSkinPlugin]] with a lot of the useless stuff removed. It is designed to be simple and functional and yet stylish enough to be used in production like environments. - -The [[GnuSkin]] design is a rip-off [the Hurd website](http://hurd.gnu.org/), with a few bells and whistles from TWiki added. - -See the [[GnuSkinPlugin]] page for more information about the [[GnuSkin]] features. Or take a look at the [[Know/WebHome]] for a hint of how it looks and feels. - -## <a name="_TOPIC_Settings"> %TOPIC% Settings </a> - -Plugin settings are stored as preferences variables. To reference a plugin setting write <code>**%<plugin>\_<setting>%**</code>, i.e. <code>**%INTERWIKIPLUGIN\_SHORTDESCRIPTION%**</code> +Plugin settings are stored as preferences variables. To reference a plugin setting write <code>**%<plugin>\_<setting>%**</code>, i.e. <code>**%EMPTYPLUGIN\_SHORTDESCRIPTION%**</code> * One line description, is shown in the %TWIKIWEB%.TextFormattingRules topic: - * Set SHORTDESCRIPTION = A complete bare bones skin theme template plugin for TWiki + * Set SHORTDESCRIPTION = Supplements the bare bones [[GnuSkin]] theme for TWiki * Debug plugin: (See output in `data/debug.txt`) * Set DEBUG = 0 -## <a name="Plugin_Installation_Instructions"> Plugin Installation Instructions </a> +An example logo, named `logo.png`, is provided in the [[GnuSkin]] library. To provide your own web-specific logo, attach a file named `logo.png` to any [[WebPreferences]] page, or set the WEBLOGO variable on the same page to use a logo with a different name. -* Download the ZIP file from the Plugin web (see below) -* Unzip <code>**%TOPIC%.zip**</code> in your twiki installation directory. Content: <table border="1" cellpadding="1" cellspacing="0"> - <tr> - <th bgcolor="#99CCCC"><strong>File:</strong></th> - <th bgcolor="#99CCCC"><strong>Description:</strong></th> - </tr> - <tr> - <td><code><b>data/TWiki/%TOPIC%.txt</b></code></td> - <td> Plugin topic </td> - </tr> - <tr> - <td><code><b>data/TWiki/%TOPIC%.txt,v</b></code></td> - <td> Plugin topic repository </td> - </tr> - <tr> - <td><code><b>lib/TWiki/Plugins/%TOPIC%.pm</b></code></td> - <td> Plugin Perl module </td> - </tr> -</table> -* Check this topic here if the installation was successful -* Test if the plugin is correctly installed: - * Make sure the SKINHANDLER is set to Gnu and the - * SKIN variable is set to gnu. +> * <code>**Set WEBLOGO = %PUBURL%/%MAINWEB%/LogoTopic/my\_project\_logo.png**</code> + +For non-graphical user agents the `alt` attribute of the WEBLOGO is hard coded to be the ASCII representation of our favourite animal supplemented with the name of the currently displayed wiki web. + +* A configurable left hand menu bar - the contents can be set in an editable [[WebMenu]] topic - one for the %TWIKIWEB% web and optionally one for other webs. See [[WebMenuFormat]] for details. , supplied one cover TWiki, Main and Test Webs ## <a name="Plugin_Info"> Plugin Info </a> @@ -135,5 +66,3 @@ Plugin settings are stored as preferences variables. To reference a plugin setti </table> **_Related Topics:_** %TWIKIWEB%.TWikiPreferences, %TWIKIWEB%.TWikiPlugins - --- [[Main/JoachimNilsson]] - 28 May 2002 |