/
ExampleHeaderArtContrib.txt
57 lines (40 loc) · 2.19 KB
/
ExampleHeaderArtContrib.txt
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
---+!! ExampleHeaderArtContrib Package
%SHORTDESCRIPTION%
<!--
* Set HEADERART = %IF{ "defined filename" then="%ATTACHURL%/%URLPARAM{"filename"}%" }%
-->
%ICON{"hand"}% Click on an image thumbnail to preview the header art on this page. To use this image for a web, updates its =HEADERART= variable in the web's <nop>WebPreferences like so:
<tt>
<nop>* Set <nop>HEADERART = %<nop>ATTACHURLPATH%/%<nop>SYSTEMWEB%/%TOPIC%/%URLPARAM{"filename" default="pictureName.jpg" }%
</tt>
%ICON{"tip"}% You can also use this header art on a topic-by-topic basis by adding the preference to individual topics.
%IMAGEGALLERY{ columns="1" size="350x350" }%
---++ Settings
Settings are stored as preferences variables. To reference a setting write ==%<nop><plugin>_<setting>%==, e.g. ==%<nop>EXAMPLEHEADERARTCONTRIB_STUB%==
* One line description:
* Set SHORTDESCRIPTION = Some random images from my travels
* Name of the perl package
* Set STUB = TWiki::Contrib::ExampleHeaderArtContrib
---++ Installation Instructions
* Download the ZIP file from the Plugin web (see below)
* Unzip ==%TOPIC%.zip== in your twiki installation directory. Content:
| *File:* | *Description:* |
%$MANIFEST%
* Run ==%TOPIC%_installer== to automatically check and install other modules that this module depends on. You can also do this step manually. Dependencies:
None
* Test if the installation was successful:
* __enter sample here__
* see also [[Sandbox.PluginTest%TOPIC%]]
---++ Contrib Info
| Author: | TWiki:Main/WillNorris |
| Copyright ©: | <!-- e.g. "2004, SlobSoft Gmbh, All Rights Reserved" --> |
| License: | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) |
| Dependencies: | %$DEPENDENCIES% |
| Version: | %$VERSION% |
| Change History: | <!-- versions below in reverse order --> |
| %DATE%: | Initial version |
| Home: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC% |
| Feedback: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev |
| Appraisal: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal |
__Related Topics:__ %SYSTEMWEB%.DefaultPreferences, %USERSWEB%.SitePreferences
-- TWiki:Main/WillNorris - %DATE%