Updated TODO.
[gruta.git] / RELEASE_NOTES
blob4fa049b86347cfba33114b2afeb099a37370b176
1 Gruta Release Notes
2 ===================
4 2.2.1 "Montecatini"
5 -------------------
7  * Templates are now stored inside source backends instead of
8    having a special directory of plain files. So, it's no
9    longer necessary to prepend the writable directory to
10    the template path in Gruta::Template::Artemus creation.
11  * The TT template toolkit has been officially deprecated.
12  * New global CGI variable `set_date', to force a date to
13    be assumed as today, to be used to take a look at how would
14    a page be shown in the given date. Only usable by a logged-in
15    admin user.
16  * A new script `gruta_mksite', to help in the creation of a
17    new site.
18  * A new command, `set_story_date', has been added to bin/gruta.
19  * The full set of `mod_rewrite' keywords to be used if `static_urls' 
20    is set has been expanded.
22  RewriteRule ^/([0-9]+)\.html$          /?t=INDEX&offset=$1             [PT,L]
23  RewriteRule ^/([0-9]+)-([0-9]+)\.html$ /?t=SEARCH_BY_DATE&from=$1&to=$2 [PT,L]
24  RewriteRule ^/tag/(.+)\.html$          /?t=SEARCH_BY_TAG&tag=$1        [PT,L]
25  RewriteRule ^/tag/$                    /?t=TAGS                        [PT,L]
26  RewriteRule ^/top/$                    /?t=TOP_TEN                     [PT,L]
27  RewriteRule ^/(.+)/$                   /?t=TOPIC&topic=$1              [PT,L]
28  RewriteRule ^/(.+)/index\.html$                /?t=TOPIC&topic=$1              [PT,L]
29  RewriteRule ^/(.+)/([0-9]+)\.html$     /?t=TOPIC&topic=$1&offset=$2    [PT,L]
30  RewriteRule ^/(.+)/(.+)\.html$         /?t=STORY&topic=$1&id=$2        [PT,L]
31  RewriteRule ^/rss\.xml$                        /?t=RSS                         [PT,L]
32  RewriteRule ^/sitemap\.xml$            /?t=SITEMAP                     [PT,L]
33  RewriteRule ^/style\.css$              /?t=CSS                         [PT,L]
36 2.2.0 "Osmannoro"
37 -----------------
39 Please note that version 4.1.2 of the Artemus template toolkit
40 is required for this release to work properly.
42  * Story rendering is cached, resulting in faster page loading.
43  * An existing story can be copied to another topic from the story
44    edition form.
45  * The template `stories_by_date' has changed the order of their
46    output values; now they are topic_id, id and date.
47  * The RSS template now accepts an optional CGI argument `tag', to
48    get feeds on stories by tag.
49  * Multiple sources are no longer supported; it never really worked
50    well, made the code cumbersome and had no real advantage after
51    all. The cgi caller needs not to be changed, as the `sources'
52    argument is still supported (only the first one is used, though),
53    but the scalar `source' is preferred now.
54  * The file format in the FS source has changed; the `.META' extension
55    has been changed to `.M', and `.TAGS' to `.T'. Also, new files
56    appear in the `stories' directory with the `.A' and `.B' extensions,
57    holding the rendered abstract and story body, respectively. The
58    transition is made automatically on the first run, no manual
59    operation is needed.
60  * New argument `hard_top_ten_limit' to Gruta::Source::FS, to set
61    the maximum number of stories to be tested when generating the top
62    read stories index (previously hardcoded to 100).
63  * New argument `min_size_for_gzip' to Gruta::CGI, to set the minimum
64    size for the output body to be Gzip compressed (previously hardcoded
65    to 10000).
66  * If a story pointed by a story:// pseudo-url has a publication date
67    in the future, only the title is shown (i.e., it's not clickable).
68  * The Mbox source is officially deprecated.
69  * Static URLs are also generated for the `CSS', `RSS' and `SITEMAP'
70    pages. The following `mod_rewrite' rule must be added to the ones
71    suggested in the previous version:
73  RewriteRule ^/style\.css$     /?t=CSS              [PT]
75 2.1.1 "Calenzano"
76 -----------------
78  * Fixed a last time bug in the DBI schema generation.
80 2.1.0
81 -----
83  * On-the-fly Gzip compression (if browser accepts it).
84  * New special uris; `abstract', to paste a story's abstract, and `body',
85    to paste the full body of another one.
86  * A new renderer, Text, for plain text content.
87  * New Artemus variables to set HTML metadata; `html_title',
88    `html_description' and `html_keywords'.
89  * A new supertemplate called CSS, that returns the Cascading Style
90    Sheet instead of having it embedded in all output.
91  * A new supertemplate called SITEMAP (to be aliased to /sitemap.xml).
92  * If a story called `index' is present in a topic, the 'TOPIC' template
93    shows its body instead of the list of stories in it.
94  * Several new commands in the `gruta' command line tool; _new_story_ (to
95    create a new story from STDIN), _import_rss_ (to import an RSS file
96    into a topic), _update_story_ (to update a story from STDIN).
97  * Topics and stories now have a new field, `description', that is used
98    in the HTML description meta tag in `TOPIC' or `STORY'.
99  * Internal server errors set the HTTP status to 500.
100  * Some old function templates have been deleted and moved to Artemus.
101  * Many templates have been simplified with new Artemus keywords.
102  * The DBI driver is less verbose on errors.
103  * Those templates more prone to be changed when configuring a new
104    site have been renamed to have a prefix of 'cfg_'.
105  * Added POD documentation to some templates.
106  * Date formatting functions now accept `%w' to print the week day
107    as a number.
108  * New global argument `dummy_touch' to avoid updating the `hits' count
109    of each story.
110  * Several fixes to the Mbox driver.
111  * Don't generate empty 'about' and 'legal' links in 'meta_menu' if
112    they don't exist.
113  * Confirmation is requested when deleting a story.
114  * New global argument `static_urls', that forces some urls (mainly
115    links to topics and stories) to use a simplified, static-like look.
116    You *need* to have the following Apache's mod_rewrite keywords
117    for these urls to be re-converted to usable ones:
119  RewriteEngine On
120  RewriteRule /(img|download)/.* - [L]
121  RewriteRule ^/(.+)/index\.html$ /?t=TOPIC&topic=$1       [PT]
122  RewriteRule ^/(.+)/(.+)\.html$  /?t=STORY&topic=$1&id=$2 [PT]
123  RewriteRule ^/(.+)/$            /?t=TOPIC&topic=$1       [PT]
124  RewriteRule ^/rss\.xml$         /?t=RSS                  [PT]
125  RewriteRule ^/sitemap\.xml$     /?t=SITEMAP              [PT]