]> Pileus Git - ~andy/aweather-web/blob - html.ct
Add user manual
[~andy/aweather-web] / html.ct
1 <% #include "html.h" %>
2
3 <% /* Global functions */ %>
4 <% void print_header(void) { %>
5 Content-Type: text/html; charset=UTF-8
6
7 <% } %>
8
9 <% void print_nav(const page_t *page, const page_t *cur) { %>
10         <% const char *class = page == cur ? " class=\"cur\"" : ""; %>
11         <a href="<%= page->link %>"<%= class %>><%= page->name %></a>
12 <% } %>
13
14 <% void print_screen(char *name) { %>
15         <a href="screens/<%= name %>.png">
16                 <img src="screens/<%= name %>_s.jpg" alt="<%= name %>" class="screen" />
17         </a>
18 <% } %>
19
20 <% void print_page(const page_t *page) { %>
21 <?xml version="1.0" encoding="UTF-8"?>
22 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
23 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
24         <head>
25                 <title>AWeather<% if (page->name) printf(" - %s", page->name); %></title>
26                 <link rel="shortcut icon" href="images/aweather.ico" />
27                 <link href="data/global.css" rel="stylesheet" type="text/css" />
28                 <meta http-equiv="X-UA-Compatible" content="IE=9" />
29                 <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
30                 <meta name="keywords" content="weather, radar, nexrad, level-ii, virtual globe, grits, rsl" />
31                 <% if (page->desc) { %>
32                 <meta name="description" content="<%= page->desc %>" />
33                 <% } %>
34                 <meta name="google-site-verification" content="-SZkTpNRWHrpESTGNZ8Pshnz4zKbwfKv54NoavUKK_Y" />
35                 <meta name="y_key" content="abe8287921b25151" />
36         </head>
37         <body>
38                 <div class="top">
39                         <a href="."><img class="logo" src="images/logo.png" alt="AWeather" /></a>
40                         <h1 class="title"><a href=".">AWeather</a></h1>
41                         <h2 class="nav">
42                                 <% for (int i = 0; header[i].link; i++) print_nav(&header[i], page); %>
43                                 <span class="sep"></span>
44                                 <% for (int i = 0; other[i].link;  i++) print_nav(&other[i],  page); %>
45                         </h2>
46                 </div>
47                 <div class="content">
48                         <!--
49                                 <p class="msg">This site is currently under construction.</p>
50                                 <p class="msg" style="font-size:8pt; font-weight:normal;">
51                                   If I had an animated GIF of a guy with a shovel, I would put it here.</p>
52                         -->
53                         <% page->print(); %>
54                         <div style="clear:both;"></div>
55                 </div>
56                 <p class="footer">
57                         Copyright © 2011 Andy Spencer
58                         <% for (int i = 0; footer[i].link; i++) { %>
59                                 | <% print_nav(&footer[i], page); %>
60                         <% } %>
61                 </p>
62         </body>
63 </html>
64 <% } %>
65
66 <% /* Normal Pages */ %>
67 <% void print_about(void) { %>
68         <p class="intro">
69                 AWeather is a free/open source application which has been
70                 designed to integrate and visualize high-quality meteorological
71                 data using an interactive Virtual Globe interface suitable for
72                 a wide range of users including weather enthusiasts, academics,
73                 and professionals.
74
75                 It is designed to provide more information than is typically
76                 available from weather widgets and simple desktop applications.
77                 At the same time, it strives to be simpler and easier to use
78                 than existing meteorological software packages such as GEMPAK
79                 and IDV.
80
81                 Currently AWeather only displays data provided by the United
82                 States National Weather Service.
83         </p>
84         <hr />
85
86         <h2>Features</h2>
87         <div class="col">
88                 <h3>Working</h3>
89                 <ul>
90                         <li>High quality data sources<ul>
91                                 <li>Level-II archives</li>
92                                 <li>Conus NEXRAD imagery</li>
93                                 <li>Volume display of dBZ iso surfaces</li>
94                                 <li>Storm based and county based<br/>
95                                     warning/watch/advisory displays</li>
96                         </ul></li>
97                         <li>Virtual Globe base rendering<ul>
98                                 <li>Including terrain, satellite, and map imagery</li>
99                         </ul></li>
100                         <li>Real-time and offline mode</li>
101                         <li>Auto-updating</li>
102                         <li>Fullscreen mode</li>
103                 </ul>
104         </div>
105         <div class="col">
106                 <h3>Planned</h3>
107                 <ul>
108                         <li>Additional data sources<ul>
109                                 <li>Watch/warning/advisory boxes</li>
110                                 <li>Surface data (temp., humidity, etc)</li>
111                         </ul></li>
112                         <li>Derived NEXRAD data<ul>
113                                 <li>Storm relative motion</li>
114                                 <li>Compost reflective</li>
115                                 <li>Echo tops</li>
116                         </ul></li>
117                         <li>Vertical cross sections</li>
118                         <li>Animation</li>
119                 </ul>
120         </div>
121
122         <div style="clear:both;"></div>
123         <h2>Licencing</h2>
124         <p>AWeather is free software licensed under the terms of the
125            <a href="http://www.gnu.org/licenses/gpl.html">GNU GPL</a>.
126            As such, it can be used by any individuals or organizations
127            without any license fees or royalties.</p>
128 <% } %>
129
130 <% void print_manual(void) { %>
131         <div class="asciidoc">
132                 <% print_file("manual.inc"); %>
133         </div>
134 <% } %>
135
136 <% void print_news(void) { %>
137         <!-- It's not really spring anymore :/ -->
138         <!-- <p class="quote">Now that it's spring again, progress on AWeather is continuing.</p> -->
139         <dl class="news">
140                 <dt>2011-11-25</dt>
141                 <dd>
142                         AWeather 0.6.1 released: <ul>
143                                 <li>Added a Radar menu to quickly jump to a NEXRAD/WSR-88D site</li>
144                                 <li>Fixed a bunch of 64-bit bugs</li>
145                         </ul>
146                 </dd>
147
148                 <dt>2011-11-03</dt>
149                 <dd>
150                         AWeather 0.6 released: <ul>
151                                 <li>Added "Alerts" plugin using the 
152                                     <a href="http://alerts.weather.gov/">NWS CAP</a> feed</li>
153                                 <li>Updated GTK+ libraries for Windows</li>
154                                 <li>Behind the scenes, mouse support in Grits
155                                     has been much improved</li>
156                         </ul>
157                         This release was a little bit faster than previous releases.
158                         Hopefully additional improvements to the alerts plugin
159                         can be made incrementally during the 0.x.x releases.
160                 </dd>
161
162                 <dt>2011-09-12</dt>
163                 <dd>
164                         AWeather 0.5.2 released: <ul>
165                                 <li>Added new desktop icons</li>
166                                 <li>Miscellaneous bug fixes</li>
167                         </ul>
168                         Improved organization of the <a href="<%= WIKI_INDEX %>">Wiki</a>
169                 </dd>
170
171                 <dt>2011-08-25</dt>
172                 <dd>
173                         AWeather 0.5.1 released: <ul>
174                                 <li>Bugfix release</li>
175                                 <li>Updated sat/map/elev to provide better data</li>
176                                 <li>First release with <a href="<%= DEBIAN_HOME %>">Debian</a>, 
177                                                    and <a href="<%= UBUNTU_HOME %>">Ubuntu</a> packages</li>
178                         </ul>
179                 </dd>
180
181                 <dt>2011-06-19</dt>
182                 <dd>
183                         AWeather 0.5 released: <ul>
184                                 <li>Support for volume rendering (isosurfaces)</li>
185                                 <li>Automatic updating</li>
186                                 <li>Fullscreen mode</li>
187                                 <li>Dropped GtkGLExt</li>
188                         </ul>
189                         Forked RSL:<ul>
190                                 <li>Added additional radars</li>
191                                 <li>Fixed lots of bugs</li>
192                                 <li>General code cleanup</li>
193                                 <li>Available from <a href="files/">files</a> directory
194                                     and <a href="<%= GW_RSL %>">git</a></li>
195                         </ul>
196                         <b>Update:</b> AWeather 0.5 is also compatible with the
197                         newly released RSL v1.41
198                 </dd>
199
200                 <dt>2011-06-13</dt>
201                 <dd>Started work on this new website. Lots of progress in AWeather as well:<ul>
202                         <li>Merged support for isosurfaces to the main branch (Finally!)</li>
203                         <li>Added an option to automatically refresh after a timeout</li>
204                         <li>New fullscreen mode</li>
205                 </ul></dd>
206         </dl>
207         <p class="note">See also: <a href="oldnews">Older news</a>,
208                                   <a href="<%= GW_AWEATHER %>">gitweb</a></p>
209 <% } %>
210
211 <% void print_oldnews(void) { %>
212         &lt; <a href="news">News</a>
213         <dl class="news">
214                 <dt>2010-05-17</dt>
215                 <dd>AWeather 0.4.1:<ul>
216                         <li>Win32 fixes and improved debug support</li>
217                         <li>Fix bug with daylight savings time</li>
218                         <li>Function to clear old cache entries</li>
219                 </ul></dd>
220
221                 <dt>2010-05-14</dt>
222                 <dd>AWeather 0.4:<ul>
223                         <li>Conus radar images</li>
224                         <li>Multiple radars support</li>
225                         <li>Gentoo, Ubuntu, MS Windows and source packages are available</li>
226                 </ul></dd>
227
228                 <dt>2009-11-09</dt>
229                 <dd>AWeather 0.3.0 released, based on libgis but still rather
230                     buggy.</dd>
231
232                 <dt>2009-10-24</dt>
233                 <dd>AWeather 0.2.3 (maintenance release).<br/>
234                     Added a Application menu entry and a few build/runtime fixes.</dd>
235
236                 <dt>2009-09-02</dt>
237                 <dd>The source repository has been migrated to Git. A lot of
238                     progress is being made on libgis, which is now able to display
239                     a virtual globe using data from NASA servers.</dd>
240         </dl>
241 <% } %>
242
243 <% void print_screenshots(void) { %>
244         <p>
245                 AWeather provides a consistent user interface that allows the
246                 user to zoom in from a high level view of the entire Earth down
247                 to regional and mesoscale views.
248         </p>
249
250         <ul class="gallery">
251                 <li>
252                         <% print_screen("synop"); %>
253                         High level view using Grits
254                 </li>
255                 <li>
256                         <% print_screen("region"); %>
257                         Regional view over the midwest
258                 </li>
259                 <li>
260                         <% print_screen("meso"); %>
261                         Mesoscale view of a tornadic system
262                 </li>
263                 <li>
264                         <% print_screen("iso"); %>
265                         Close up showing a 52.5 dBZ isosurface
266                 </li>
267                 <li>
268                         <% print_screen("alert"); %>
269                         Current severe weather alerts for the CONUS
270                 </li>
271         </ul>
272 <% } %>
273
274 <% void print_download(void) { %>
275         <h2>Stable releases</h2>
276         <p class="note">
277                 While AWeather won't be considered stable until version 1.0,
278                 these are as close to stable as you can get until then
279         </p>
280         <ul>
281                 <li class="linux"><dl class="inline">
282                         <dt>Source code</dt>
283                         <dd>
284                         <a href="files/aweather-<%= VERSION %>.tar.gz">aweather-<%= VERSION %>.tar.gz</a>,
285                         <a href="../grits/grits-<%= VERSION_GRITS %>.tar.gz">grits-<%= VERSION_GRITS %>.tar.gz</a>,
286                         <a href="files/rsl-1.40.tar.gz">rsl-1.40.tar.gz</a>
287                         </dd>
288
289                         <dt>Gentoo</dt>
290                         <dd><span class="code">emerge sci-geosciences/aweather</span> from the sunrise overlay</dd>
291
292                         <dt>Debian</dt>
293                         <dd><span class="code">apt-get install aweather</span> from Debian sid</dd>
294
295                         <dt>Ubuntu</dt>
296                         <dd><span class="code">apt-get install aweather</span> from Ubuntu Oneiric,
297                             or the <a href="<%= UBUNTU_PPA %>">AWeather PPA</a></dd>
298                         <!--
299                                 (Arch packages still have bugs)
300                                 <dt>Arch</dt>
301                                 <dd>Available from the AUR</dd>
302                         -->
303                 </dl></li>
304                 <li class="windows"><dl class="inline">
305                         <dt>Windows</dt>
306                         <dd><a href="files/aweather-<%= VERSION_WIN32 %>-gtk.exe">aweather-<%= VERSION_WIN32 %>-gtk.exe</a>
307                                 (Use this unless you know what you're doing)</dd>
308
309                         <dt>Without GTK</dt>
310                         <dd><a href="files/aweather-<%= VERSION_WIN32 %>.exe">aweather-<%= VERSION_WIN32 %>.exe</a></dd>
311                 </dl></li>
312                 <li class="macos" style="padding-top: .8em; padding-bottom: .8em"><dl class="inline">
313                         <dt>Mac OS X</dt>
314                         <dd>Coming soon (Mac OS developer? <a href="/code/issues/1">Help out</a>)</dd>
315                 </dl></li>
316         </ul>
317
318         <h2>Unstable releases</h2>
319         <p class="note">Pre-releases, betas, and other hazardous software</p>
320         <div style="margin-left: 30px;">
321                 <p>Check out the <a href="files">files</a> directory for any potential updates</p>
322                 <p>Pre-releases are labeled with a -p0 and are mainly built for testing the Windows packages</p>
323         </div>
324
325         <h2>Development code</h2>
326         <p class="note">
327                 Development code is available from Git
328                 (and gitweb:
329                  <a href="<%= GW_AWEATHER %>">AWeather</a>,
330                  <a href="<%= GW_GRITS    %>">Grits</a>,
331                  <a href="<%= GW_RSL      %>">RSL</a>)
332         </p>
333         <div style="margin-left: 30px;">
334                 <div class="code">git clone <%= GIT_AWEATHER %></div>
335                 <div class="code">git clone <%= GIT_GRITS    %></div>
336                 <div class="code">git clone <%= GIT_RSL      %></div>
337         </div>
338 <% } %>
339
340 <% void print_development(void) { %>
341         <!-- Open source mumbo jumbo.. -->
342
343         <p class="note" style="clear: both;">
344                 The AWeather <a href="<%= WIKI_INDEX %>">development wiki</a>
345                 is the main resource for development material.
346         </p>
347
348         <h2>Bug report and feature requests</h2>
349         <div style="margin-left: 30px;">
350                 <p><a href="<%= BUG_LIST %>">List of current issues</a></p>
351                 <p><a href="<%= BUG_NEW  %>">Add a new issue</a></p>
352         </div>
353
354         <h2>How to contribute?</h2>
355         <ul>
356                 <li>Locate or host Meteorological and Geospatial data feeds</li>
357                 <li>Maintain a Mac OS, Windows, or Linux installer</li>
358                 <li>Test AWeather and submit bug reports</li>
359                 <li>Make better logo!</li>
360         </ul>
361
362         <h2>Architecture Overview</h2>
363         <ul>
364                 <li>Built on top of GObject and GTK+</li>
365                 <li>Uses the <a href="grits">Grits</a> "Virtual Globe" library<ul>
366                         <li>Handles most of the graphics work using OpenGL for rendering</li>
367                         <li>Provides some other generic functionality, such as data access</li>
368                         <li>Also provides the plugins API used by AWeather</li>
369                 </ul></li>
370                 <li>AWeather itself is a front-end for Grits along with a
371                     bundle of weather related plugins</li>
372         </ul>
373
374         <h2>Building AWeather</h2>
375         <p class="note">See the <a href="<%= WIKI_INSTALL %>">install</a>
376                 wiki page for more details</p>
377         <ul>
378                 <li>AWeather has direct dependencies on Grits, RSL, among other things</li>
379                 <li>Currently building and running AWeather requires the
380                     exact same version of Grits to be installed<br />
381                     (This may change in the near future as the software stabilizes)</li>
382         </ul>
383 <% } %>
384
385 <% void print_grits(void) { %>
386         <p>
387                 Grits is a Virtual Globe library developed along side AWeather,
388                 but desigend to be usable by other program as well.
389
390                 It is differentiated from other Virtual Globes such as Google
391                 Earth, NASA World Wind, and KDE Marble in that it is developed
392                 primairily as a library that is used by other programs, such as
393                 AWeather, rather than providing it's own user interface.
394         </p>
395
396         <ul class="gallery">
397                 <li>
398                         <% print_screen("grits"); %>
399                         Grits without any plugins
400
401                 </li>
402                 <li>
403                         <% print_screen("plugins"); %>
404                         Satellite and Environment plugins
405                 </li>
406                 <li>
407                         <% print_screen("terrain"); %>
408                         Elevation plugin showing a mountain
409                 </li>
410         </ul>
411 <% } %>
412
413 <% void print_rsl(void) { %>
414         <h2>Radar Software Library</h2>
415         AWeather has at times needed a custom version of the
416         <a href="<%= RSL_WEB %>">TRMM Radar Software Library</a>
417         for accessing Level-II radar files. However, most of the changes have
418         since been incorporated into RSL Version 1.41, which can also be used
419         with AWeather. Some remaining changes exist though and are mostly
420         related to code organization and compiler warnings.
421
422         <h2>Download</h2>
423         <div class="col">
424                 <h3>NASA/TRMM version</h3>
425                 <ul>
426                         <li><a href="<%= RSL_WEB %>">TRMM RSL Website</a></li>
427                         <li><a href="<%= RSL_FTP RSL_TAR %>"><%= RSL_TAR %></a></li>
428                 </ul>
429         </div>
430         <div class="col">
431                 <h3>AWeather's version</h3>
432                 <ul>
433                         <li><a href="files/rsl-1.40.tar.gz">rsl-1.40.tar.gz</a></li>
434                         <li><a href="<%= GW_RSL %>">Gitweb</a></li>
435                         <li><div class="code">git clone <%= GIT_RSL %></div></li>
436                 </ul>
437         </div>
438 <% } %>
439
440 <% /* Footer Pages */ %>
441 <% void print_contact(void) { %>
442         <h1>Contact</h1>
443         <p class="note">Questions? Comments? Trouble compiling AWeather?</p>
444         <dl class="inline small">
445                 <dt>Bugs</dt> <dd><a href="<%= BUG_LIST %>">Issue Tracker</a> (sign in to add a new issue)</dd>
446                 <dt>Email</dt><dd><a href="mailto:andy753421@gmail.com">Andy Spencer</a></dd>
447                 <dt>IRC</dt>  <dd>#rhlug@irc.freenode.net</dd>
448         </dl>
449 <% } %>
450
451 <% /* Special Pages */ %>
452 <% void print_index(void) { %>
453         <p class="intro">
454                 AWeather is a free real-time weather data viewer designed for weather enthusiasts.
455                 AWeather is not a weather widget/dockapp that displays a pre-computed forecast.
456                 It is designed to be an easy to use program that integrates a
457                 variety of meteorological data in simple unified interface;
458                 see the <a href="about">about</a> page for more details.
459         </p>
460         <hr />
461         <ul style="float: left;">
462                 <li>Detailed Level-II NEXRAD radar<ul>
463                         <li>3D volume rendering</li>
464                         <li>Dual-pole support</li>
465                 </ul></li>
466                 <li>Online and offline modes<ul>
467                         <li>Data caching</li>
468                         <li>Automatic updating</li>
469                 </ul></li>
470                 <li>Warning/Watch/Advisory display</li>
471                 <li>Surface and map overlays</li>
472                 <li>Terrain rendering</li>
473         </ul>
474         <div style="float: left; margin-left: 20px;">
475                 <% print_screen("stormbased"); %>
476                 <div style="text-align: center; margin-right: 25px;">
477                         AWeather showing storm based warnings<br />
478                         on top of Level-II radar imagery
479                 </div>
480         </div>
481         <a href="download" class="download" style="float: right;">
482                 <span>Download</span>
483                 <span>AWeather <%= VERSION %></span>
484                 <img src="images/dl-arrow.png" alt="Download" />
485         </a>
486         <p style="text-align: center;"><%= VERSION_DESC %></p>
487 <% } %>
488
489 <% void print_notfound(void) { %>
490         <h1>Error 404 - Page Not found!</h1>
491         <br />
492         <p>This page does not exist!
493         <p>If Andy screwed up, feel free to <a href="contact">tell him</a>,
494            otherwise, go away</p>
495 <% } %>
496
497 <% void print_sitemap(const page_t **pages) { %>
498 <?xml version='1.0' encoding='UTF-8'?>
499 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"
500         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
501         xsi:schemaLocation="http://www.sitemaps.org/schemas/sitemap/0.9
502                             http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd">
503         <% for (int i = 0; pages[i];         i++) { %>
504         <% for (int j = 0; pages[i][j].link; j++) { %>
505         <% if  (pages[i][j].prio >= 0) { %>
506         <url>
507                 <loc><%% "%s%s", PREFIX, pages[i][j].link %></loc>
508                 <priority><%% "%3.1f", pages[i][j].prio %></priority>
509         </url>
510         <% } } } %>
511 </urlset>
512 <% } %>