Updated TODO.
[gruta.git] / RELEASE_NOTES
blob7b853bf48bc6e75f348119777b092c64c25d6c66
1 Gruta Release Notes
2 ===================
4 2.2.0 "Osmannoro"
5 -----------------
7  * Story rendering is cached, resulting in faster page loading.
8  * An existing story can be copied to another topic from the story
9    edition form.
10  * The template `stories_by_date' has changed the order of their
11    output values; now they are topic_id, id and date.
12  * The RSS template now accepts an optional CGI argument `tag', to
13    get feeds on stories by tag.
14  * Multiple sources are no longer supported; it never really worked
15    well, made the code cumbersome and had no real advantage after
16    all. The cgi caller needs not to be changed, as the `sources'
17    argument is still supported (only the first one is used, though),
18    but the scalar `source' is preferred now.
19  * The file format in the FS source has changed; the `.META' extension
20    has been changed to `.M', and `.TAGS' to `.T'. Also, new files
21    appear in the `stories' directory with the `.A' and `.B' extensions,
22    holding the rendered abstract and story body, respectively. The
23    transition is made automatically on the first run, no manual
24    operation is needed.
25  * The Mbox source is officially deprecated.
27 2.1.1 "Calenzano"
28 -----------------
30  * Fixed a last time bug in the DBI schema generation.
32 2.1.0
33 -----
35  * On-the-fly Gzip compression (if browser accepts it).
36  * New special uris; `abstract', to paste a story's abstract, and `body',
37    to paste the full body of another one.
38  * A new renderer, Text, for plain text content.
39  * New Artemus variables to set HTML metadata; `html_title',
40    `html_description' and `html_keywords'.
41  * A new supertemplate called CSS, that returns the Cascading Style
42    Sheet instead of having it embedded in all output.
43  * A new supertemplate called SITEMAP (to be aliased to /sitemap.xml).
44  * If a story called `index' is present in a topic, the 'TOPIC' template
45    shows its body instead of the list of stories in it.
46  * Several new commands in the `gruta' command line tool; _new_story_ (to
47    create a new story from STDIN), _import_rss_ (to import an RSS file
48    into a topic), _update_story_ (to update a story from STDIN).
49  * Topics and stories now have a new field, `description', that is used
50    in the HTML description meta tag in `TOPIC' or `STORY'.
51  * Internal server errors set the HTTP status to 500.
52  * Some old function templates have been deleted and moved to Artemus.
53  * Many templates have been simplified with new Artemus keywords.
54  * The DBI driver is less verbose on errors.
55  * Those templates more prone to be changed when configuring a new
56    site have been renamed to have a prefix of 'cfg_'.
57  * Added POD documentation to some templates.
58  * Date formatting functions now accept `%w' to print the week day
59    as a number.
60  * New global argument `dummy_touch' to avoid updating the `hits' count
61    of each story.
62  * Several fixes to the Mbox driver.
63  * Don't generate empty 'about' and 'legal' links in 'meta_menu' if
64    they don't exist.
65  * Confirmation is requested when deleting a story.
66  * New global argument `static_urls', that forces some urls (mainly
67    links to topics and stories) to use a simplified, static-like look.
68    You *need* to have the following Apache's mod_rewrite keywords
69    for these urls to be re-converted to usable ones:
71  RewriteEngine On
72  RewriteRule /(img|download)/.* - [L]
73  RewriteRule ^/(.+)/index\.html$ /?t=TOPIC&topic=$1       [PT]
74  RewriteRule ^/(.+)/(.+)\.html$  /?t=STORY&topic=$1&id=$2 [PT]
75  RewriteRule ^/(.+)/$            /?t=TOPIC&topic=$1       [PT]
76  RewriteRule ^/rss\.xml$         /?t=RSS                  [PT]
77  RewriteRule ^/sitemap\.xml$     /?t=SITEMAP              [PT]