TWiki/GnuSkinInstall.mdwn


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
140

## <a name="GnuSkin_Download_amp_Installatio"> GnuSkin Download &amp; Installation Instructions </a>

Visit <http://twiki.org/cgi-bin/view/Plugins/GnuSkinInstall> on <http://twiki.org> for the latest and greatest. Both updated installation instructions and the latest ZIP files.

**_Briefly:_**

* Download the ZIP file from the Plugin web (see below)
* Unzip <code>**GnuSkin-1.0.0.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/GnuSkin.txt</b></code></td>
    <td> Skin description </td>
  </tr>
  <tr>
    <td><code><b>data/TWiki/GnuSkinPlugin.txt</b></code></td>
    <td> Plugin description </td>
  </tr>
  <tr>
    <td><code><b>data/TWiki/GnuSkinPluginDev.txt</b></code></td>
    <td> Development notes &amp;amp; discus </td>
  </tr>
  <tr>
    <td><code><b>data/TWiki/GnuSkinInstall.txt</b></code></td>
    <td> Installation notes </td>
  </tr>
  <tr>
    <td><code><b>lib/TWiki/Plugins/GnuSkinPlugin.pm</b></code></td>
    <td> Plugin Perl module </td>
  </tr>
  <tr>
    <td><code><b>pub/TWiki/GnuSkin/add-attachment.png</b></code></td>
    <td> Attachment icon </td>
  </tr>
  <tr>
    <td><code><b>pub/TWiki/GnuSkin/bubble-LL.png</b></code></td>
    <td> Lower left round edege icon </td>
  </tr>
  <tr>
    <td><code><b>pub/TWiki/GnuSkin/bubble-LR.png</b></code></td>
    <td> Lower right round edege icon </td>
  </tr>
  <tr>
    <td><code><b>pub/TWiki/GnuSkin/bubble-UL.png</b></code></td>
    <td> Upper left round edege icon </td>
  </tr>
  <tr>
    <td><code><b>pub/TWiki/GnuSkin/bubble-UR.png</b></code></td>
    <td> Upper right round edege icon </td>
  </tr>
  <tr>
    <td><code><b>pub/TWiki/GnuSkin/edit.png</b></code></td>
    <td> Edit topic icon </td>
  </tr>
  <tr>
    <td><code><b>pub/TWiki/GnuSkin/folder.png</b></code></td>
    <td> Folder (more) icon </td>
  </tr>
  <tr>
    <td><code><b>pub/TWiki/GnuSkin/logo.png</b></code></td>
    <td> Default web logotype icon </td>
  </tr>
  <tr>
    <td><code><b>pub/TWiki/GnuSkin/page.png</b></code></td>
    <td> View topic icon </td>
  </tr>
  <tr>
    <td><code><b>pub/TWiki/GnuSkin/print.png</b></code></td>
    <td> View printable icon </td>
  </tr>
  <tr>
    <td><code><b>pub/TWiki/GnuSkin/rcs_diff.png</b></code></td>
    <td> View diffs icon </td>
  </tr>
  <tr>
    <td><code><b>pub/TWiki/GnuSkin/search.png</b></code></td>
    <td> Search topics icon </td>
  </tr>
  <tr>
    <td><code><b>pub/TWiki/GnuSkin/twiki.css</b></code></td>
    <td> Style Sheet, blue </td>
  </tr>
  <tr>
    <td><code><b>pub/TWiki/GnuSkin/twikiblue.css</b></code></td>
    <td> Default style </td>
  </tr>
  <tr>
    <td><code><b>pub/TWiki/GnuSkin/twikigreen.css</b></code></td>
    <td> Green style </td>
  </tr>
  <tr>
    <td><code><b>templates/edit.gnu.tmpl</b></code></td>
    <td> Edit topic template </td>
  </tr>
  <tr>
    <td><code><b>templates/preview.gnu.tmpl</b></code></td>
    <td> Topic preview template </td>
  </tr>
  <tr>
    <td><code><b>templates/rdiff.gnu.tmpl</b></code></td>
    <td> Topic diffs template </td>
  </tr>
  <tr>
    <td><code><b>templates/twiki.gnu.tmpl</b></code></td>
    <td> Snippets for genric templates </td>
  </tr>
  <tr>
    <td><code><b>templates/view.gnu.tmpl</b></code></td>
    <td> View topic template </td>
  </tr>
</table>

* Check any of the topics, e.g., the [[GnuSkin]] topic to verify installation.
* Test if the plugin is correctly installed:
  * Make sure the SKINHANDLER is set to Gnu and the
  * SKIN variable is set to gnu.

**_Comprehensively:_**

* Download the [[GnuSkin]]-X.Y.Z.zip, or gnuskin-X.Y.Z.tgz, archive from the list of attachments at the bottom of this page. (X.Y.Z is the version number).

* Unpack the archive inside your TWiki installation directory. (All the [[GnuSkin]] files have a Gnu substring embedded to ensure you do not overwrite any of TWik's original files.)

* In case you do not have the [[TigerSkin]] installed you also need to download and install the [[WebMenu]] package in the same directory. The [[GnuSkin]] and the [[TigerSkin]] shares the [[WebMenu]] format.(The WebMenu format is unlikely to change, and even if it does it will require a major version upgrade.)

* Edit the %TWIKIWEB%.WebMenu topic to set the contents of the menu bar. See the %TWIKIWEB%.WebMenuFormat for details.

* Add the following line to %TWIKIWEB%.TWikiPreferences or to any [[WebPreferences]] topic. Remember, six spaces an asterisk and the <code>**Set**</code> keyword to specify an option.

          * Set SKIN = gnu

* If using multiple skin handlers then the following line needs to be included in %TWIKIWEB%.TWikiPreferences to set the TWiki wide default or in a specific [[WebPreferences]] topic to use the Gnu Skin handler only for that Web.

          * Set SKINHANDLER = Gnu

* **Note:** If this is the first (and only) skin handler the TWiki skin handler defaults to procssing the SKIN unless SKINHANDLER is set to some value besides Gnu.