RELEASE_NOTES

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