summaryrefslogtreecommitdiff
path: root/TWiki/GnuSkinPlugin.mdwn
blob: 86a4f3ea1ec5d4e358bd931f4d38f3c5fbb24e38 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
* Description
  * Set SHORTDESCRIPTION = A complete bare bones skin theme template for TWiki

* 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...

## <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