RELEASE_NOTES

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