buildrelease
[openafs-wiki.git] / TWiki / TipsContrib.mdwn
1 # <a name="Tips Contrib Package"></a><a name=" Tips Contrib Package"></a> Tips Contrib Package
2
3 Displays a rotating "TWiki Tip of the Day" to help familiarize new users with TWiki features. Includes an application for creating custom tips for local installation.
4
5 <div>
6   <ul>
7     <li><a href="#Summary of Contents"> Summary of Contents</a></li>
8     <li><a href="#Detailed Documentation"> Detailed Documentation</a></li>
9     <li><a href="#Settings"> Settings</a></li>
10     <li><a href="#CSS used by _TipsContrib"> CSS used by TipsContrib</a></li>
11     <li><a href="#Installation Instructions"> Installation Instructions</a></li>
12     <li><a href="#Contrib Info"> Contrib Info</a></li>
13   </ul>
14 </div>
15
16 ## <a name="Summary of Contents"></a> Summary of Contents
17
18 - Set on `TWikiTip` topics providing brief lessons on TWiki features. See [[TWikiTips]].
19 - Set of topics for creating and managing `TWikiTipXXX` topics. See [[TWikiTipsOfTheDayAdmin]].
20
21 ## <a name="Detailed Documentation"></a> Detailed Documentation
22
23 - See [[TWikiTipsOfTheDayAdmin]] for instructions on managing and displaying tips.
24 - See [[TWikiTipsOfTheDayAddNew]] for instructions for adding new custom tips.
25
26 ## <a name="Settings"></a> Settings
27
28 This extension requires no settings. See [[TWikiTipsOfTheDayAdmin]] for administration details.
29
30 - One line description:
31 - Set SHORTDESCRIPTION = Displays rotating list of "TWiki Tip-of-the-day"
32
33 ## <a name="CSS used by _TipsContrib"></a> CSS used by TipsContrib
34
35 - .tipsOfTheDay - overall container
36 - .tipsOfTheDayContents - container for tipsOfTheDayHeader and tipsOfTheDayText
37 - strong.tipsOfTheDayHeader - header that says "TWiki Tip of the Day"
38 - .tipsOfTheDayText - the tip; contains title and tip summary and link "Read on"
39 - .tipsOfTheDayTitle - title of the tip; the link to the tip topic
40
41 ## <a name="Installation Instructions"></a> Installation Instructions
42
43 **_Note:_** You do not need to install anything on the browser to use this contrib package. The following instructions are for the administrator who installs the package on the server where TWiki is running.
44
45 - Download the ZIP file from the Plugin web (see below)
46 - Unzip <code>**%TOPIC%.zip**</code> in your twiki installation directory. Content: <table border="1" cellpadding="0" cellspacing="0">
47   <tr>
48     <th bgcolor="#99CCCC"><strong> File: </strong></th>
49     <th bgcolor="#99CCCC"><strong> Description: </strong></th>
50   </tr>
51   <tr>
52     <td><code><b>lib/TWiki/Contrib/TipsContrib.pm</b></code></td>
53     <td>   </td>
54   </tr>
55   <tr>
56     <td><code><b>data/TWiki/TipsContrib.txt</b></code></td>
57     <td>   </td>
58   </tr>
59   <tr>
60     <td><code><b>data/TWiki/TWikiTip001.txt</b></code></td>
61     <td>   </td>
62   </tr>
63   <tr>
64     <td><code><b>data/TWiki/TWikiTip002.txt</b></code></td>
65     <td>   </td>
66   </tr>
67   <tr>
68     <td><code><b>data/TWiki/TWikiTip003.txt</b></code></td>
69     <td>   </td>
70   </tr>
71   <tr>
72     <td><code><b>data/TWiki/TWikiTip004.txt</b></code></td>
73     <td>   </td>
74   </tr>
75   <tr>
76     <td><code><b>data/TWiki/TWikiTip005.txt</b></code></td>
77     <td>   </td>
78   </tr>
79   <tr>
80     <td><code><b>data/TWiki/TWikiTip006.txt</b></code></td>
81     <td>   </td>
82   </tr>
83   <tr>
84     <td><code><b>data/TWiki/TWikiTip007.txt</b></code></td>
85     <td>   </td>
86   </tr>
87   <tr>
88     <td><code><b>data/TWiki/TWikiTip008.txt</b></code></td>
89     <td>   </td>
90   </tr>
91   <tr>
92     <td><code><b>data/TWiki/TWikiTip009.txt</b></code></td>
93     <td>   </td>
94   </tr>
95   <tr>
96     <td><code><b>data/TWiki/TWikiTip010.txt</b></code></td>
97     <td>   </td>
98   </tr>
99   <tr>
100     <td><code><b>data/TWiki/TWikiTip011.txt</b></code></td>
101     <td>   </td>
102   </tr>
103   <tr>
104     <td><code><b>data/TWiki/TWikiTip012.txt</b></code></td>
105     <td>   </td>
106   </tr>
107   <tr>
108     <td><code><b>data/TWiki/TWikiTip013.txt</b></code></td>
109     <td>   </td>
110   </tr>
111   <tr>
112     <td><code><b>data/TWiki/TWikiTip014.txt</b></code></td>
113     <td>   </td>
114   </tr>
115   <tr>
116     <td><code><b>data/TWiki/TWikiTip015.txt</b></code></td>
117     <td>   </td>
118   </tr>
119   <tr>
120     <td><code><b>data/TWiki/TWikiTip016.txt</b></code></td>
121     <td>   </td>
122   </tr>
123   <tr>
124     <td><code><b>data/TWiki/TWikiTip017.txt</b></code></td>
125     <td>   </td>
126   </tr>
127   <tr>
128     <td><code><b>data/TWiki/TWikiTip018.txt</b></code></td>
129     <td>   </td>
130   </tr>
131   <tr>
132     <td><code><b>data/TWiki/TWikiTip019.txt</b></code></td>
133     <td>   </td>
134   </tr>
135   <tr>
136     <td><code><b>data/TWiki/TWikiTip020.txt</b></code></td>
137     <td>   </td>
138   </tr>
139   <tr>
140     <td><code><b>data/TWiki/TWikiTip021.txt</b></code></td>
141     <td>   </td>
142   </tr>
143   <tr>
144     <td><code><b>data/TWiki/TWikiTip022.txt</b></code></td>
145     <td>   </td>
146   </tr>
147   <tr>
148     <td><code><b>data/TWiki/TWikiTip023.txt</b></code></td>
149     <td>   </td>
150   </tr>
151   <tr>
152     <td><code><b>data/TWiki/TWikiTip024.txt</b></code></td>
153     <td>   </td>
154   </tr>
155   <tr>
156     <td><code><b>data/TWiki/TWikiTip025.txt</b></code></td>
157     <td>   </td>
158   </tr>
159   <tr>
160     <td><code><b>data/TWiki/TWikiTip026.txt</b></code></td>
161     <td>   </td>
162   </tr>
163   <tr>
164     <td><code><b>data/TWiki/TWikiTip027.txt</b></code></td>
165     <td>   </td>
166   </tr>
167   <tr>
168     <td><code><b>data/TWiki/TWikiTip028.txt</b></code></td>
169     <td>   </td>
170   </tr>
171   <tr>
172     <td><code><b>data/TWiki/TWikiTip029.txt</b></code></td>
173     <td>   </td>
174   </tr>
175   <tr>
176     <td><code><b>data/TWiki/TWikiTips.txt</b></code></td>
177     <td>   </td>
178   </tr>
179   <tr>
180     <td><code><b>data/TWiki/TWikiTipsOfTheDay.txt</b></code></td>
181     <td>   </td>
182   </tr>
183   <tr>
184     <td><code><b>data/TWiki/TWikiTipsOfTheDayAddNew.txt</b></code></td>
185     <td>   </td>
186   </tr>
187   <tr>
188     <td><code><b>data/TWiki/TWikiTipsOfTheDayAdmin.txt</b></code></td>
189     <td>   </td>
190   </tr>
191   <tr>
192     <td><code><b>data/TWiki/TWikiTipsOfTheDayInclude.txt</b></code></td>
193     <td>   </td>
194   </tr>
195   <tr>
196     <td><code><b>data/TWiki/TWikiTipsOfTheDayTemplate.txt</b></code></td>
197     <td>   </td>
198   </tr>
199 </table>
200
201 ## <a name="Contrib Info"></a> Contrib Info
202
203 <table border="1" cellpadding="0" cellspacing="0">
204   <tr>
205     <td align="right"> Author: </td>
206     <td> TWiki:Main.PeterThoeny </td>
207   </tr>
208   <tr>
209     <td align="right"> Copyright ©: </td>
210     <td> Copyright 2005 Peter Thoeny. All Rights Reserved. </td>
211   </tr>
212   <tr>
213     <td align="right"> License: </td>
214     <td> GPL (<a href="http://www.gnu.org/copyleft/gpl.html" target="_top">GNU General Public License</a>) </td>
215   </tr>
216   <tr>
217     <td align="right"> Dependencies: </td>
218     <td> none </td>
219   </tr>
220   <tr>
221     <td align="right"> Version: </td>
222     <td> 8515 </td>
223   </tr>
224   <tr>
225     <td align="right"> Change History: </td>
226     <td>  </td>
227   </tr>
228   <tr>
229     <td align="right"> 10 Oct 2005: </td>
230     <td> Initial version - Packaging by TWiki:Main.LynnwoodBrown </td>
231   </tr>
232   <tr>
233     <td align="right"> Home: </td>
234     <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%</a></td>
235   </tr>
236   <tr>
237     <td align="right"> Feedback: </td>
238     <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>
239   </tr>
240   <tr>
241     <td align="right"> Appraisal: </td>
242     <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal</a></td>
243   </tr>
244 </table>
245
246 **_Related Topics:_** [[TWikiPreferences]]
247
248 -- TWiki:Main.LynnwoodBrown - 21:45:10 31 March 2006