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