summaryrefslogtreecommitdiff
path: root/TWiki/GnuSkinPlugin.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'TWiki/GnuSkinPlugin.mdwn')
-rw-r--r--TWiki/GnuSkinPlugin.mdwn130
1 files changed, 126 insertions, 4 deletions
diff --git a/TWiki/GnuSkinPlugin.mdwn b/TWiki/GnuSkinPlugin.mdwn
index c48a3344..86a4f3ea 100644
--- a/TWiki/GnuSkinPlugin.mdwn
+++ b/TWiki/GnuSkinPlugin.mdwn
@@ -1,7 +1,3 @@
-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.
-
* Description
* Set SHORTDESCRIPTION = A complete bare bones skin theme template for TWiki
@@ -14,4 +10,130 @@ Status: It's at beta stage. Now I only have to start ripping out allt the pieces
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...
+
+## <a name="ToDo"> ToDo </a>
+
+* Release v1.0
+* Simplify, simplify, simplify!
+
+## <a name="History"> History </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 &amp; 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>**%&lt;plugin&gt;\_&lt;setting&gt;%**</code>, i.e. <code>**%INTERWIKIPLUGIN\_SHORTDESCRIPTION%**</code>
+
+* One line description, is shown in the %TWIKIWEB%.TextFormattingRules topic:
+ * Set SHORTDESCRIPTION = A complete bare bones skin theme template plugin for TWiki
+
+* Debug plugin: (See output in `data/debug.txt`)
+ * Set DEBUG = 0
+
+## <a name="Plugin_Installation_Instructions"> Plugin Installation Instructions </a>
+
+* 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.
+
+## <a name="Plugin_Info"> Plugin Info </a>
+
+<table border="1" cellpadding="1" cellspacing="0">
+ <tr>
+ <td align="center"> Plugin Author: </td>
+ <td><span style="background:"><font color="">Joachim Nilsson</font></span><a href="http://LOCATIONMain/JoachimNilsson">?</a></td>
+ </tr>
+ <tr>
+ <td align="center"> Plugin Version: </td>
+ <td> 28 May 2002 </td>
+ </tr>
+ <tr>
+ <td align="center"> Change History: </td>
+ <td>  </td>
+ </tr>
+ <tr>
+ <td align="center"> 28 May 2002: </td>
+ <td> Project started </td>
+ </tr>
+ <tr>
+ <td align="center"> CPAN Dependencies: </td>
+ <td> none </td>
+ </tr>
+ <tr>
+ <td align="right"> Other Dependencies: </td>
+ <td> none </td>
+ </tr>
+ <tr>
+ <td align="center"> Perl Version: </td>
+ <td> 5.005 </td>
+ </tr>
+ <tr>
+ <td align="center"> Plugin Home: </td>
+ <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%</a></td>
+ </tr>
+ <tr>
+ <td align="center"> Feedback: </td>
+ <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev</a></td>
+ </tr>
+</table>
+
+**_Related Topics:_** %TWIKIWEB%.TWikiPreferences, %TWIKIWEB%.TWikiPlugins
+
+-- [[Main/JoachimNilsson]] - 28 May 2002