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