Updated RELEASE_NOTES.
[gruta.git] / RELEASE_NOTES
blob11e5a1b7e65341366002e98cdbf259e9397e5a0b
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  * New argument `hard_top_ten_limit' to Gruta::Source::FS, to set
26    the maximum number of stories to be tested when generating the top
27    read stories index (previously hardcoded to 100).
28  * New argument `min_size_for_gzip' to Gruta::CGI, to set the minimum
29    size for the output body to be Gzip compressed (previously hardcoded
30    to 10000).
31  * If a story pointed by a story:// pseudo-url has a publication date
32    in the future, only the title is shown (i.e., it's not clickable).
33  * The Mbox source is officially deprecated.
34  * Artemus 4.1.2 is required.
36 2.1.1 "Calenzano"
37 -----------------
39  * Fixed a last time bug in the DBI schema generation.
41 2.1.0
42 -----
44  * On-the-fly Gzip compression (if browser accepts it).
45  * New special uris; `abstract', to paste a story's abstract, and `body',
46    to paste the full body of another one.
47  * A new renderer, Text, for plain text content.
48  * New Artemus variables to set HTML metadata; `html_title',
49    `html_description' and `html_keywords'.
50  * A new supertemplate called CSS, that returns the Cascading Style
51    Sheet instead of having it embedded in all output.
52  * A new supertemplate called SITEMAP (to be aliased to /sitemap.xml).
53  * If a story called `index' is present in a topic, the 'TOPIC' template
54    shows its body instead of the list of stories in it.
55  * Several new commands in the `gruta' command line tool; _new_story_ (to
56    create a new story from STDIN), _import_rss_ (to import an RSS file
57    into a topic), _update_story_ (to update a story from STDIN).
58  * Topics and stories now have a new field, `description', that is used
59    in the HTML description meta tag in `TOPIC' or `STORY'.
60  * Internal server errors set the HTTP status to 500.
61  * Some old function templates have been deleted and moved to Artemus.
62  * Many templates have been simplified with new Artemus keywords.
63  * The DBI driver is less verbose on errors.
64  * Those templates more prone to be changed when configuring a new
65    site have been renamed to have a prefix of 'cfg_'.
66  * Added POD documentation to some templates.
67  * Date formatting functions now accept `%w' to print the week day
68    as a number.
69  * New global argument `dummy_touch' to avoid updating the `hits' count
70    of each story.
71  * Several fixes to the Mbox driver.
72  * Don't generate empty 'about' and 'legal' links in 'meta_menu' if
73    they don't exist.
74  * Confirmation is requested when deleting a story.
75  * New global argument `static_urls', that forces some urls (mainly
76    links to topics and stories) to use a simplified, static-like look.
77    You *need* to have the following Apache's mod_rewrite keywords
78    for these urls to be re-converted to usable ones:
80  RewriteEngine On
81  RewriteRule /(img|download)/.* - [L]
82  RewriteRule ^/(.+)/index\.html$ /?t=TOPIC&topic=$1       [PT]
83  RewriteRule ^/(.+)/(.+)\.html$  /?t=STORY&topic=$1&id=$2 [PT]
84  RewriteRule ^/(.+)/$            /?t=TOPIC&topic=$1       [PT]
85  RewriteRule ^/rss\.xml$         /?t=RSS                  [PT]
86  RewriteRule ^/sitemap\.xml$     /?t=SITEMAP              [PT]