source: trunk/Changes @ 864

Last change on this file since 864 was 864, checked in by Dominic Hargreaves, 15 years ago

Add UPGRADING (closes #95)

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 28.2 KB
1"#" items refer to tickets. See <> for details.
20.58    ?? September 2006
3        Tidy up some minor bugs in the new features.
4        Add RDF autodiscovery link to nodes' <head> section.
5        Add UPGRADING file which summarises inmportant information for people
6        upgrading.
80.57    12 September 2006
9        New interfaces:
10        * Admin interface.
11        * Show nodes missing metadata.
12        * Moderate edits (based on Wiki::Toolkit moderation).
13        NOTE: these functions should be considered unstable, and may change
14          over future releases.
16        Lots more Atom and RSS feeds, including for searching.
17        Four new config file options: moderation_requires_password,
18          enable_node_image, enable_common_categories, enable_common_locales
19        Search::InvertedIndex support is deprecated as of this release.
20          Please upgrade to Plucene if you are still using it.
21        Tidy up some template bits
230.56    14 June 2006
24        Fixed bug introduced in feed formatting where Atom feeds would be
25          produced when asked for RSS and vice versa.
270.55    13 June 2006
28        Versioned dependency on Wiki::Toolkit to avoid development
29          versions.
30        Support generating feeds of a node's version listing, in addition
31          to feeds of the recent changes. For more information on OpenGuides
32          feeds, see
340.54_02 8 June 2006
35        Pass the feed_listing (currently just recent_changes) through all
36          the feed related code, rather than assuming it'll only ever be
37          recent changes. Will allow other listings of nodes to be handled
38          in the future.
400.54_01 16 May 2006
41        Support for Atom feeds for RecentChanges.
42        #118 Use Wiki::Toolkit. NOTE this is a development snapshot and is
43          not suitable for production use. It may eat your data! Tests on
44          development mirrors of live data are highly welcomed; the underlying
45          database schema provided by Wiki::Toolkit has changed and the upgrade
46          process needs some rigorous testing.
480.54    21 April 2006
49        #112 Fixed website display bug introduced in 0.53.
510.53    20 April 2006
52        Miscellanous fixes for mod_perl.
53        #42 New "About" screen. Try action=about and action=about;format=rdf.
54        #97 Use "summary" metadata to generate HTML meta descriptions.
55        New OpenGuides::Feed module to handle feed generation (code was
56          previously in OpenGuides::RDF).
57        Generate URIs for locales and contributors in RDF output.
58        #107 Don't display partial http:// URL in preview.
59        #93 Upgrade to new Google Maps API (for smaller javascript download)
60        #103 Fixed empty Category/Locale list bug.
61        #54 Fixed RSS redirection for backwards compatibility.
62        #79 Partial fix to help combat HTML spam
63        #56 Added licence config variables
650.52    5 March 2006
66        IMPORTANT CHANGE: "supersearch.cgi" is now simply "search.cgi". If you
67          have customisations to your templates, you may need to make changes
68          to reflect this.
69        Renamed OpenGuides::SuperSearch to OpenGuides::Search.
70        Use corrent content-type (application/rdf+xml) for all RDF output.
71        Things with opening hours are marked as geospatial in RDF.
72        Fixed missing bracket in
73        Added custom_node template just below main content in
74        Google Maps support! There is a new index type,
75          wiki.cgi?action=index;format=map, and maps appear in the node listings
76          (the latter feature is user-configurable).
77        Fixed <link> in RSS to point to RecentChanges page, not the feed itself.
78        #67 Default website for a page is now http://
79        Fixed mod_perl redirect bug.
80        Fixed test failure with 3.16.
81        #87 Edit on mirrored pages now goes to source site
82        #66 Locales in RDF now use dc:title, not foaf:name
840.51    15 November 2005
85        Important changes:
86          * The preferred way to get RecentChanges is now to pass the CGI the
87            parameter "action=rc", rather than just using the page name
88            "RecentChanges". However, this method will still work for the time
89            being. Similarly, the URL parameter for the RecentChanges RSS feed
90            has changed from "action=rss" to "action=rc;format=rss". Requests
91            for the former will be redirected to the latter.
93        New features:
94          * When trying to view a non-existent node, you will now be presented
95            with a message asking if you want to create that node, rather than
96            a blank page.
97          * New "summary" metadata field for one-line summaries of nodes:
98            - Added summary field to RDF as dc:description.
99            - Show node summary in search results.
100          * New "format=raw" option for outputting wiki text of a node.
101          * RSS feed now contains DOAP ( metadata.
103        RDF bugfixes:
104          * Locales, address and summary fields now XML-escaped properly.
105          * Added "address" field that was missing from the RDF node view.
106          * Update URL for Dublin Core elements in RDF index view.
107          * Fixed URL in the RSS <channel> element to point to the RSS URL,
108            not the RecentChanges page URL.
110        Search bugfixes:
111          * Fixed bug that was breaking coordinate entry fields on search page if
112            lat/lon was being used.
113          * Fixed bug in OpenGuides::SuperSearch that wasn't passing "latitude"
114            and "longitude" values to the search template when a distance
115            search was being done.
117        Minor improvements:
118          * Replace underscores in node names in "redirected from" message
119            with spaces.
120          * "Redirected from" message now links to a rendered version of
121            the old page rather than the editing view.
123        Miscellaneous bugfixes:
124          * Fixed problem with newer Text::Wikiformat and blank nodes.
125          * Fixed bug in navbar template that caused warnings in the tests.
1270.50    2 October 2005
128        Remove rogue ampersand that had crept into the RSS feed.
1300.49    24 July 2005
131        Added updated prerequisite on CGI::Wiki::Plugin::RSS::ModWiki (fixes
132          a test failure).
1340.48    24 July 2005
135        RDF enhancements:
136          * Removed redundant "id" parameter specification from dc:source in
137            rdf:Description in RDF node listings.
138          * Fixed bug that was causing all nodes to be flagged as a
139            geo:SpatialThing whether they were or not.
140          * Ensured that ampersands and greater/less than symbols were properly
141            escaped so as not to be XML-toxic.
142          * Added geo:lat, geo:long and RSS link attributes to items in
143            category/locale listings to facilitate integration with mapping
144            applications.
145          * Added owl:sameAs property to RDF output for nodes that are redirects
146            to other nodes.
147          * RSS feed now has correct timestamp (matching most recent item) and
148            matching Last-Modified HTTP header.
149        Reorder navigation bar to provide more logical groupings.
150        Added "format=plain" option for all-nodes index listing and associated
151          template
152        New message to appear on pages when you have been redirected
153          informing you of the fact.
154        Stop showing potentially very long map URLs in metadata section of
155          node display.
156        Replace ugly obliques in display of categories and locales with more
157          natural commas; change "locale" to "locales" in label.
158        Replace <label> tags in with <span
159          class="metadata_label">.
160        Wanted pages listing now displays, and sorts by, the number of nodes
161          pointing to each node.
162        Prevent redirect loops.
163        Added _ to the list of forbidden characters in node names.
1650.47    15 January 2005
166        Fixed bug with list_all_versions for nodes with only one version.
167        Extended config changes to examples/ (thanks jimbo).
168        Now require CGI::Wiki 0.62 to fix bug with deleting versions.
169        Try to ensure that a .htaccess file protecting wiki.conf is installed.
170        Allow for external URLs for Text Formatting help.
171        Home node recent changes box now flags new entries.
172        Made default city and country be blank; specify them if you want them.
173        Missing PREREQUISITE on Plucene added.
174        Added CSS id "maincontent" to exclude the navbar and footer. Misc
175          template tidying including removing old layout tables.
1770.46    21 December 2004
178        Minor bug fixes: remove bogus edit link on index listings,
179          added missing default behaviour for geolocation.
180        Update supersearch help text URL.
181        Added nofollow to robots meta tag.
182        Added new CSS class "node_name" for inline non-hyperlink references
183          to node names - see README.CSS for details.
184        Fixed bug with diff display on nodes containing macros.
185        Fixed distance search paging bug.
186        Fixed bug that allowed autocreation of locales and categories with
187          trailing spaces in the name.
188        Config management refactoring. This should not result in any
189          user-visible changes, apart from introducing a new dependency on
190          Class::Accessor.
191        Make it clearer in documentation that overriding factory templates
192          is a risky activity.
193        Update feedback details and include URL of RT queue.
194        Added missing tests to MANIFEST so they are included with the
195          distribution.
1970.45    1 December 2004
198        Made the geolocation stuff work worldwide.  Squeeeeeee!
199        You can now choose between doing your distance calculations with
200          the British National Grid, the Irish National Grid, or a UTM
201          ellipsoid.  If you wish to use anything other than the British
202          National Grid and you have pre-existing location data then you
203          will need to save an edit of each node with location data before
204          distance searches will work.
205        In less exciting news:
206          Fixed bug relating to lat/long representation.
207          Removed debugging warn accidentally left in last release.
208          Fixed some HTML validation errors.
2100.44    17 November 2004
211        Remove all traces of display_categories, which was obsoleted but
212          not completely removed before.
213        Improved the efficiency of the search.
214        Fixed a couple of minor bugs in the search - note that
215          and have changed.
216        Change the default indexer for new installs to Plucene.   
217        Only run certain search-related tests if Plucene is installed.
2190.43    21 October 2004
220        Fixed broken navbar changes that crept into last release.
2220.42    20 October 2004
223        Handle distance searching with OpenGuides::Supersearch instead of
224          find_within_distance action.
225        Fixed bug with paging on distance-only search (reported by Bob Walker).
226        Improved encapsulation in OpenGuides::Supersearch - accessors.
227        *INCOMPATIBLE CHANGE* Custom templates are now stored in
228          user-definable path, and their names are prefixed with custom_.
229          This only affects you if you have used the custom template support
230          introduced in 0.41.
231        Replace use of CGI::Wiki::Plugin::Geocache with improved
2330.41    21 September 2004
234        Added backlinks link to navbar.
235        Added some anti-robot tags to certain pages.
236        Fixed bug in install procedure - blank script_name should now get
237          installed as index.cgi
238        Added option of munging in custom lib paths on install.
239        Added option of custom templates for footer, license warning
240          on edit form, banner at top of page (see CUSTOMISATION file
241          for details).
242        Added new macro - used as eg @INDEX_LIST [[Locale Fulham]]
243        Also fixed the RSS reader macro - use this as eg
244          @RSS;username=Kake
245        More semantic markup for metadata display - see README.CSS.
2470.40    18 September 2004
248        Recent Changes now shows changes in the past 24 hours, past week,
249          past fortnight, and past 30 days.
250        New preferences option to allow Recent Changes visit tracking.
251        Preferences now has an option for when your prefs expire.
252        Navbar added to diff and history pages.
253        The "omit help links" preference now actually works.
254        Set some pages to non-editable and non-deletable that should have been.
255        Recent Changes RSS fixed so "wiki:importance" is set correctly.
256        New "ignore_minor_edits" option for Recent Changes RSS.
257        Added RSS feeds for contributors, locales and categories.
2590.39    15 September 2004
260        Split commit_node out into in preparation for spam filter
261        Added option of using Plucene for searching.  If you want to do this
262          (and it is recommended over the default of Search::InvertedIndex)
263          you will need to do two things:
264            - either delete your old indexes (they're just files in the index
265              directory) or use a different index directory
266            - reindex your entire wiki (see in the examples/
267              directory of this distribution)
2690.38    26 July 2004
270        Major improvements to the search result ordering (thanks to
271          Steve Jolly, Bob Walker and Billy Abbott for test cases).
2730.37    23 July 2004
274        Fixed bug in diff view - the versions are the right way round now...
275        Fixed bug with links in historic view.  Require 2.92 to
276          avoid escapeHTML bug.
2780.36    13 July 2004
279        Added diff link to node template.
280        Fixed case sensitivity bug in index node autocreation.
281        Fixed bug with node history comments not being HTML-escaped.
2830.35    25 June 2004
284        Forgot to add version prerequisite on CGI::Wiki.  Don't use 0.34,
285          use this.
2870.34    25 June 2004
288        Added facility to delete only certain revisions of a page - access
289          this from the node history page.
2910.33    20 June 2004
292        Improve node history page to allow diffing between each version and
293          the previous one or the current one.
294        Test overhauls - you don't need to run the configuration step in
295          order to run the tests now, but you do need to have DBD::SQLite
296          for most of them.
297        Fixed template bug in that was stopping map
298          links being displayed for nodes with no address data (spotted
299          by Steve Jolly).
300        Removed inline style from You will need to add
301          the styles table#recentchanges, td.recentchanges_meta,
302          td.recentchanges_user, td.recentchanges_node_name and
303          td.recentchanges_comment to your stylesheets.
304          td#map changed to td#map_link in
305        Added searching by distance from an arbitrary point (click on
306          Advanced Search).
307        Internal rejigging - extracted some methods from wiki.cgi to
309        Added new preference for default edit type.
310        Reinstate apparently lost change from 0.26 to show IP rather than
311          "Anonymous" in RecentChanges.
312        More informative <title> tags for non-node (e.g. node version
313          history) pages.
3150.32    7 June 2004
316        Change auto-creating behaviour of index nodes (categories and
317          locales): instead of being created on access they are created
318          when the referring node is committed. This fixes compliance with
319          RFC 2616 section 9.1.1 and prevents corrupted index nodes being
320          created accidentally.
3220.31    09 May 2004
323        Created a new macro to allow the embedding of RSS feeds into
324          pages, using CGI::Wiki::Plugin::RSS::Reader. This allows you
325          to do this to produce a list of up to ten hyperlinks:
326            @RSS []
328        Numerous template tweaks to comply with the W3C's Web Content
329          Accessibility Guidelines (
330          - summaries for all HTML tables
331          - labels for all form input elements and some textual additions
332            to templates, such as '/' separators between navbar items,
333            because the guidelines specify links should not only be
334            separated by whitespace. If you don't want these to appear,
335            put the following in your stylesheet and they'll be hidden by
336            CSS (but will still appear for people using textual browsers or
337            screen readers): ".hidden { display: none }".
338          - the "lang" element (a two-letter code identifying the language
339            you're writing pages in) will now be added to the <html> tag on
340            all pages; a new question has been added to the configuration
341            script to ask for it and it will be stored in wiki.conf.
342            ***         YOU WILL NEED TO RUN BUILD.PL AGAIN.          ***
343            *** Remember to keep a backup copy of your old wiki.conf! ***   
345        Improved navigation for search results (next and previous n hits).
346          Removed underscores from page names in search results.
348        Overhauled RDF output. Changes:
349          - everything is no longer classified as a restaurant(!)
350          - empty tags are no longer generated
351          - show categories, locales and OS x/y coords in invididual
352            node RDF view
353          - switch to W3C contact namespace for addressing data
354          - move homepage tag out of wiki metadata
355          - remove nonexistent "gs:" namespace from category indices
356          - logical structure improvements (subjects of pages are now
357            identified as spatial things if they are, or are RDF
358            descriptions if they're not, instead of being anonymous
359            FOAF topics)
360          - include city and country in RDF only for spatial things.
362        Fixed bug that prevented automatic database initialization on
363          SQLite databases.
364        Doc fix for private installations.
365        Removed the following characters from the list of forbidden ones in
366          node names in newpage.cgi (a restriction which dates from all the way
367          back when we were using UseModWiki): " ! $ ^ ~ @ [ ] { }
368        Removed newlines from output of search box macro.
369        Reimplemented diffing using CGI::Wiki::Plugin::Diff as it seems the
370          change in 0.30 got lost. Removed as we should not
371          be distributing it.
3730.30    29 December 2003
374        Added method to allow admins to delete nodes.  You will need to
375          explicitly enable this option in your wiki.conf, since it brings
376          with it the risk of accidental data loss.
378        Major overhaul of templates - added numerous style hooks.  See
379          examples/ for two stylesheet designs that take advantage of these.
380          Added new banner template for page headers. Also ensured presence
381          of navigation bar is consistent.
382          *** INCOMPATIBLE CHANGE: *** The navbar class in the stylesheet
383          has been renamed to, unsurprisingly, "navbar", for consistency
384          (from "toolbar"). *** YOU WILL NEED TO REWRITE YOUR STYLESHEET. ***
385          You are advised to create a duplicate wiki.cgi that reads its data
386          from your database but its stylesheet and templates from the new
387          ones in order to test them *before* deploying them.
389        Added "FAQ", "How To Get Started" and "Wiki Etiquette" to the
390          navigation, under "Help" - these won't exist unless you create them
391          on your site, so at first the links serve as examples of
392          documentation you can provide.
393        Modified preferences.cgi so that all the help links in the navbar
394          can be hidden, not just the text formatting link.
395        Fixed some HTML validation bugs.
396        Added multiple install and pretty URL notes to INSTALL.
397        Removed pubcrawl stuff from distro for now - it doesn't really work.
398        Changed to use CGI::Wiki::Plugin::Diff instead of OpenGuides::Diff.
4000.29    8 November 2003
401        Expanded section in TROUBLESHOOTING about permissions problems.
402 now absorbs trailing punctuation and spaces into words
403          it is diffing (to give less blocky results).
404 change NOT to use '-' instead of '!'.
4060.28    1 November 2003
407        Allow running sites on SQLite databases.
408        Fixed bug with navbar prompt in Build.PL (CPAN RT #3894).
409        Junked OpenGuides::Config completely to avoid database password
410          leakage, and easier install (CPAN RT #3916).
4120.27    1 November 2003
413        Fixed bug with category/locale indexing - no longer case-sensitive.
414        Fixed bug that had the supersearch results page offering an edit link.
415        Revamp of search syntax to make the SuperSearch UI much more like
416          Google and Alta Vista. See the POD of for details.
4180.26    9 October 2003
419        Modified TROUBLESHOOTING to reflect the correct invocation for
420          Module::Build to install into a private directory.
421        Show IP address for anonymous edits.
422        Changed version dependency for Dom (CPAN bug #3895).
423        Added check to OpenGuides::SuperSearch to stop it trying to
424          retrieve a nonexistent node when the search indexes have screwed up.
4260.25    23 September 2003
427        Applied recent changes fix to front page feed as well.
428        Search box now searches categories and locales as well as title and
429          body - so for example a search on "holborn & pubs" will DTRT.
430        NOT and phrase search tests were passing even though they shouldn't
431          have been - skip them for now.
4330.24    8 September 2003
434        Fixed Recent Changes so minor changes don't mask major ones.
435        Fixed supersearch.cgi to use a template instead of to avoid
436          weird errors, also turned it into a module and added tests.
437        Strip whitespace from OS co-ords before storing in database.
4390.23    4 August 2003
440        Removed the "POST_CHOMP" option as it was messing up textareas, added
441          a test to make sure this doesn't reoccur.
4430.22    4 August 2003
444        Fixed bug with usernames containing spaces in recent changes/userstats.
445        Try out create_makefile_pl => "passthrough" in Build.PL
446        Minor fixes to tests to make them work with newest UseMod formatter.
447        Prevented "Edit this page" from showing up on category indexes.
448        Set TT "POST_CHOMP" option to strip unnecessary newlines from HTML.
449        Fixed CPAN bug #3085 - quotes in change summary box.
450        Added openguides_version template variable and added it to page
451        footer (CPAN request 3110).
4530.21    17 July 2003
454        We no longer autogenerate a Makefile.PL, since it doesn't pick up
455          all the questions that need to be asked.  Sorry.  Use Module::Build
456          as detailed in INSTALL, since you won't be able to get the right
457          version of Text::WikiFormat installed without it in any case.
458        Added version number to prereq as Alex McLintock hit a
459          version that didn't have unescape.
460        Added a link on RecentChanges to the RSS version, and put an
461          autodiscovery tag for the RSS in the head section.
462        Changed diff feature to hide checksums, which aren't necessary for
463          the user to see. Fixed a minor bug in the node history template so
464          that the diff links compare the selected version against the previous
465          one, not the original one every time.
4670.20    10 July 2003
468        Fixed all the email addresses to
4700.19    10 July 2003
471        Extra checks that script_url ends in a '/'.
472        Fixed small bug with edit conflict form - map link field was missing.
473        Moved "content" div in a couple of templates to fix incorrect nesting.
474        @INDEX_LINK macros now have optional title text like so:
475          @INDEX_LINK [[Category Pubs|Pubs]]
476        Added preferences option for including or excluding text formatting
477          rules link in navbar.  Enable this by setting text_formatting_node
478          in your config file.
479        Added config option for including the navbar on the home page.
480        Implemented minor edits.
481        Fixed cookie to persist beyond session.
4830.18    16 June 2003
484        Added a Makefile.PL as well as a Build.PL, for users.
4860.17    15 June 2003
487        Fixed OpenGuides::Utils to take note of dbhost.
488        Added example stylesheet provided by the OxfordGuide team.
4900.16    26 May 2003
491        Ivor fixed OpenGuides::Diff to diff by word instead of by character.
492        Fixed edit conflict up so it works nicely when you click the
493          Save button as well as the Preview one.
494        Added preferences option of displaying lat/long as deg-min-sec
495          instead of decimal (requested by James).
4970.15    18 May 2003
498        Added Algorithm::Diff version dependency to prereqs, fixed bug
499          with preferences.cgi and blank script_name, fixed REDIRECT bug.
5010.14    17 May 2003
502        Added "Wanted Pages" link to navbar, thanks to Simon Cozens for
503          the idea.
504        Fixed many bugs noticed by Dominic Hargreaves and other Oxonians.
505          Many thanks to Dominic for making an Oxford OpenGuides install for
506          us to find bugs in.
5080.13    17 May 2003
509        Added some more stylesheet hooks.
510        Tweaked OpenGuides::Diff to make it testable, added a start at tests.
511        Lat and long now stored to only 6dp instead of millions.
512        Added edit field for map link.
5140.12    14 May 2003
515        Added OpenGuides::CGI to manage cookies and things, used this to
516          do more code tidying.  Added edit box position option to preferences.
5180.11    14 May 2003
519        Added newpage.cgi for an easy way to create new pages.
520        Took loads of repeated code (for extracting and packaging metadata
521          variables) out of wiki.cgi into OpenGuides::Template.
5230.10    11 May 2003
524        Added OpenGuides::Diff to provide nice diff output between
525          node versions.
526        Added OpenGuides::Template to handle Template Toolkit stuff in a
527          more testable and reusable way than just bunging it in wiki.cgi.
5290.09    10 May 2003
530        Added OpenGuides::UK::PubCrawl and pubcrawl.cgi as a start at a
531          pub crawl generator.
532        Added OpenGuides::Utils to make it easier to write little standalone
533          scripts like supersearch.cgi, pubcrawl. cgi, etc.  Made wiki.cgi and
534          supersearch.cgi use it, and lost loads of duplicated code in the
535          process, hurrah.
5370.08    3 May 2003
538        Added fuzzy matching capability -
539          action=index;index_type=fuzzy_title_match;index_value=hollborne
540          Someone needs to write a nice search box interface for this.
541        Fixed edit_conflict template and preview method to cope with stale
542          checksum - passes through all the metadata properly now and offers
543          a side by side comparison of what you input and what is stored.
544        RDF output for node is now encoding-agnostic (used to have UTF-8
545          hardcoded).  Also is now called as wiki.cgi?id=Node_Name;format=rdf
5470.07    3 May 2003
548        Require CGI::Wiki 0.32 to avoid bug (again a Bob find!) where
549          committing a node with metadata but no content would die.
550        Auto-created category/locale stub pages now added to Category Category
551          or Category Locales as appropriate.
552        Added a couple of extra allowed HTML tags to cater for existing
553          grubstreet data.
554        Fixed bug in OpenGuides::RDF - it used to die if called on a
555          nonexistent node, now it returns stuff with a wiki:version of 0.
5570.06    2 May 2003
558        Fixed supersearch.cgi so it works with MySQL as well as Postgres
559          (thanks again to Bob for finding the bug).
5610.05    2 May 2003
562        Redid the script and template installation so the script does
563          actually get called what you said it should be (code copied
564          somewhat from Siesta::Build).
565        Fixed the support for non-local databases/IDENT authentication.
566          I think.
567        Fixed the hardcoded 'wiki.cgi' in some of the templates (thanks Bob).
5690.04    29 April 2003
570        First public release.
Note: See TracBrowser for help on using the repository browser.