RELEASE_NOTES

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