Add initial activate-blosxom-include and globalise-config-variables scripts.
[matthijs/upstream/blosxom-plugins.git] / README
1 Blosxom Plugins README
2 ======================
3
4 This is a collection of plugins for blosxom version 2.x. 
5
6 Installation
7 ------------
8
9 The traditional install method is to unpack this collection 
10 somewhere temporary and then to copy the individual plugins you 
11 are interested in to your blosxom.cgi $plugin_dir directory (or
12 symlink on platforms that support it).
13
14 If you are using a blosxom newer than 2.0.2, you also have the
15 option of installing the entire collection in your $plugin_dir
16 directory (or another directory in your $plugin_path), and 
17 selecting the plugins to activate by using a blosxom.cgi 
18 $plugin_list file (a simple list of plugins, one per line).
19
20
21 Configuration
22 -------------
23
24 You should also check the top of the plugins you use for a 
25 configuration section, and configure to taste.
26
27 Configuration has traditionally involved updating any 
28 configuration variables within the plugin itself. In addition,
29 there are a couple of methods that allow you to configure 
30 plugins externally to the plugin itself, which simplifies
31 upgrades.
32
33 External configuration options:
34
35 1. If configuration variables are global/package variables, 
36 they can be configured outside of the plugin in 'blosxom.conf',
37 or in 'config' or 'prefs' files if using those plugins, using
38 fully-qualified variable names. For example, to configure the
39 'atomfeed' plugin, you might add the following variables to 
40 your blosxom.conf:
41
42   $atomfeed::default_author = "author@example.com";
43   $atomfeed::feed_yr = 2005;
44
45 If you want to use this configuration method you should run
46 the 'scripts/globalise-config-variables' script within your 
47 plugins directory, which will update all your plugins to be 
48 compatible with this method.
49
50
51 2. Alternatively, you can install the Blosxom::Include perl
52 module from CPAN, which does not require that configuration
53 variables are globals. It looks for per-plugin configuration 
54 files in your blosxom.conf directory, and includes those files
55 after the standard configuration section. So for example, to
56 configure the 'atomfeed' plugin you would create an 'atomfeed'
57 configuration file in your /etc/blosxom directory (or whatever)
58 containing your customised configuration entries from the 
59 plugin e.g.
60
61   # In /etc/blosxom/atomfeed, for example
62   $default_author = "author@example.com";
63   $feed_yr = 2005;
64
65 If you want to use this configuration method you should run 
66 the 'scripts/activate-blosxom-include' script from your plugins 
67 directory, which will add the necessary 'use Blosxom::Include' 
68 instruction to the top of all your plugins.
69
70
71
72