Remove GraphicsContextGLOpenGL::setRenderbufferStorageFromDrawable declaration
[WebKit-https.git] / planet / INSTALL
1 Installing Planet
2 -----------------
3
4 You'll need at least Python 2.1 installed on your system, we recommend
5 Python 2.3 though as there may be bugs with the earlier libraries.
6
7 Everything Pythonesque Planet needs should be included in the
8 distribution.
9
10  i.
11     First you'll need to extract the files into a folder somewhere.
12     I expect you've already done this, after all, you're reading this
13     file.  You can place this wherever you like, ~/planet is a good
14     choice, but so's anywhere else you prefer.
15
16  ii.
17     Make a copy of the files in the 'examples' subdirectory, and either
18     the 'basic' or 'fancy' subdirectory of it and put them wherever
19     you like; I like to use the Planet's name (so ~/planet/debian), but
20     it's really up to you.
21
22     The 'basic' index.html and associated config.ini are pretty plain
23     and boring, if you're after less documentation and more instant
24     gratification you may wish to use the 'fancy' ones instead.  You'll
25     want the stylesheet and images from the 'output' directory if you
26     use it.
27
28  iii.
29     Edit the config.ini file in this directory to taste, it's pretty
30     well documented so you shouldn't have any problems here.  Pay
31     particular attention to the 'output_dir' option, which should be
32     readable by your web server and especially the 'template_files'
33     option where you'll want to change "examples" to wherever you just
34     placed your copies.
35
36  iv.
37     Edit the various template (*.tmpl) files to taste, a complete list
38     of available variables is at the bottom of this file.
39
40  v.
41     Run it: planet.py pathto/config.ini
42
43     You'll want to add this to cron, make sure you run it from the
44     right directory.
45
46  vi.
47     Tell us about it! We'd love to link to you on planetplanet.org :-)
48
49
50 Template files
51 --------------
52
53 The template files used are given as a space separated list in the
54 'template_files' option in config.ini.  They are named ending in '.tmpl'
55 which is removed to form the name of the file placed in the output
56 directory.
57
58 Reading through the example templates is recommended, they're designed to
59 pretty much drop straight into your site with little modification
60 anyway.
61
62 Inside these template files, <TMPL_VAR xxx> is replaced with the content
63 of the 'xxx' variable.  The variables available are:
64
65         name    ....    } the value of the equivalent options
66         link    ....    } from the [Planet] section of your
67         owner_name .    } Planet's config.ini file
68         owner_email     }
69
70         url     ....    link with the output filename appended
71         generator ..    version of planet being used
72
73         date    ....                             { your date format
74         date_iso ...    current date and time in { ISO date format
75         date_822 ...                             { RFC822 date format
76
77
78 There are also two loops, 'Items' and 'Channels'.  All of the lines of
79 the template and variable substitutions are available for each item or
80 channel.  Loops are created using <TMPL_LOOP LoopName>...</TMPL_LOOP>
81 and may be used as many times as you wish.
82
83 The 'Channels' loop iterates all of the channels (feeds) defined in the
84 configuration file, within it the following variables are available:
85
86         name    ....    value of the 'name' option in config.ini, or title
87         title   ....    title retreived from the channel's feed
88         tagline ....    description retreived from the channel's feed
89         link    ....    link for the human-readable content (from the feed)
90         url     ....    url of the channel's feed itself
91
92         Additionally the value of any other option specified in config.ini
93         for the feed, or in the [DEFAULT] section, is available as a
94         variable of the same name.
95
96         Depending on the feed, there may be a huge variety of other
97         variables may be available; the best way to find out what you
98         have is using the 'planet-cache' tool to examine your cache files.
99
100 The 'Items' loop iterates all of the blog entries from all of the channels,
101 you do not place it inside a 'Channels' loop.  Within it, the following
102 variables are available:
103
104         id      ....    unique id for this entry (sometimes just the link)
105         link    ....    link to a human-readable version at the origin site
106
107         title   ....    title of the entry
108         summary ....    a short "first page" summary
109         content ....    the full content of the entry
110
111         date    ....                                  { your date format
112         date_iso ...    date and time of the entry in { ISO date format
113         date_822 ...                                  { RFC822 date format
114
115         If the entry takes place on a date that has no prior entry has
116         taken place on, the 'new_date' variable is set to that date.
117         This allows you to break up the page by day.
118
119         If the entry is from a different channel to the previous entry,
120         or is the first entry from this channel on this day
121         the 'new_channel' variable is set to the same value as the
122         'channel_url' variable.  This allows you to collate multiple
123         entries from the same person under the same banner.
124         
125         Additionally the value of any variable that would be defined
126         for the channel is available, with 'channel_' prepended to the
127         name (e.g. 'channel_name' and 'channel_link').
128
129         Depending on the feed, there may be a huge variety of other
130         variables may be available; the best way to find out what you
131         have is using the 'planet-cache' tool to examine your cache files.
132
133
134 There are also a couple of other special things you can do in a template.
135
136  -  If you want HTML escaping applied to the value of a variable, use the
137     <TMPL_VAR xxx ESCAPE="HTML"> form.
138
139  -  If you want URI escaping applied to the value of a variable, use the
140     <TMPL_VAR xxx ESCAPE="URI"> form.
141
142  -  To only include a section of the template if the variable has a
143     non-empty value, you can use <TMPL_IF xxx>....</TMPL_IF>.  e.g.
144
145     <TMPL_IF new_date>
146     <h1><TMPL_VAR new_date></h1>
147     </TMPL_IF>
148
149     You may place a <TMPL_ELSE> within this block to specify an
150     alternative, or may use <TMPL_UNLESS xxx>...</TMPL_UNLESS> to
151     perform the opposite.