From b858912f5f38af1bd0350409177aca6cedbf6edd Mon Sep 17 00:00:00 2001 From: Henri-Damien LAURENT Date: Mon, 2 Feb 2009 16:30:25 +0100 Subject: [PATCH] Adding release notes for 3.0.1 Signed-off-by: Henri-Damien LAURENT (cherry picked from commit 7ce704ad98ca3044a93cbd3556e598ed35cfac7e) Signed-off-by: Galen Charlton --- misc/release_notes/release_notes_30001.txt | 278 +++++++++++++++++++++ 1 file changed, 278 insertions(+) create mode 100644 misc/release_notes/release_notes_30001.txt diff --git a/misc/release_notes/release_notes_30001.txt b/misc/release_notes/release_notes_30001.txt new file mode 100644 index 0000000000..3bf61bea9e --- /dev/null +++ b/misc/release_notes/release_notes_30001.txt @@ -0,0 +1,278 @@ +============================================================================== +RELEASE NOTES FOR KOHA 3.0 +============================================================================== +Koha 3 is the next-generation release of the award-winning Koha open-source +integrated library system. + +You can obtain Koha 3.0 from the following URL: + +http://download.koha.org/koha-3.00.01.tar.gz + +These Release Notes cover What's New in Koha 3, information about the new +Revision control system (Git), and Version-release process, pointers to +Download, Installation, and Upgrade documentation, a brief introduction to the +new Templates, a call to Translation and Documentation writers, and finally, +Known Issues with this version. + +============================================================================== +WHAT'S NEW IN KOHA 3? +============================================================================== + +1. Zebra plugin - Zebra is a high-performance, general-purpose structured +text indexing and retrieval engine. It supports large data sets (tens of +millions of records) and includes support for SRU, Z39.50 and several query +languages: CCL, CQL, and PQF. For more information about Zebra, please see: + +http://indexdata.dk/zebra + +Koha's new search engine, built on top of Zebra, supports features such as +relevance ranking, field weighting, truncation, stemming, use of fuzzy +operators, language-specific indexing, sorting, etc. + +Indexes are updated in real-time with circulation transactions, enabling +limits by availability and statuses. + +Faceted refine-by limits are available from both staff and opac interfaces. + +For libraries that don't want the overhead of maintaing Zebra, Koha 3 ships +with a NoZebra option, in which bibliographic and authority data is indexed +in the RDBMS. + +2. New installer - based on the common Perl module ExtUtils::MakeMaker, the +new installer makes it a snap to get Koha running on just about any platform. + +The installer comes complete with a Developer's Toolkit target ('dev') that +can be used to get a development environment linked directly to revision +control, to support rapid prototyping and an agile development process. + +3. Standard APIs - Koha 3 supports a number of important library search and +retrieval standards and microformats, such as SRU/W, Z39.50 +(http://www.loc.gov/standards/sru/), UnAPI (http://unapi.info/) and +COinS/OpenURL +(http://ocoins.info; http://www.niso.org/committees/committee_ax.html). + +Also supported is the popular Internet standard: OpenSearch +(http://opensearch.a9.com/) created by Amazon's A9. + +Records are stored internally in an SGML-like format and can be retrieved in +MARCXML, Dublin Core, MODS, RSS, Atom, RDF-DC, SRW-DC, OAI-DC, and EndNote; +and the OPAC can be used by citation tools such as Zotero. Creating new +export formats is a trivial exercise in writing XSLT; records can be passed +through XSLT transformations either directly out of the index, or via a +separate parsing function. + +To retrieve and interact with Circulation and Patron data, Koha 3 includes +support for 3M's Standard Interchange Protocol (SIP2), using the OpenNCIP +libraries (http://openncip.org). + +There are also an ever-expanding set of native REST APIs to handle +interoperability with external tools such as third-party cataloging clients. +These APIs provide authentication as well as add/edit/delete control over +bibliographic data within a Koha system. For more information, see: + +http://wiki.koha.org/doku.php?id=en:development:web_services + +Koha 3 also includes pluggable authentication - easy integration with LDAP and +Active Directory via the Auth_with_ldap module. + +Enriched content web services, such as those offered by Amazon.com, Baker and +Taylor's Content Cafe, and the Google Book API can be enabled to enrich +bibliographic content with jacket covers, professional reviews, ratings and +comments from users, as well as point to 'Similar Items' within the catalog. +OCLC's xISBN, and LibraryThing's ThingISBN an likewise be enabled to provide +an 'Editions' tab, pulling together all the formats, languages, and editions +of a work into the item detail pages. New with Koha 3 is service throttling +for these services, to keep within subscription limits. + +4. Cross-platform, multi-RDBMS, Web-server agnostic - Run Koha on the platform +of your choice: Linux, Windows, Mac OS X, FreeBSD, Solaris. Koha 3 also +includes better support for multi-RDBMS (MySQL 5.0 and PostgreSQL), and runs +under Apache2, IIS, or the web server of your choosing. + +5. Multi-lingual support - Koha was designed from the ground up for multilingual +libraries. Koha 3 can handle Chinese, Japanese, and even right-to-left languages +such as Arabic and Hebrew with ease (BiDi). + +Koha's index engine (Zebra) can handle record formats containing any UNICODE +compliant script, such as Arabic, Chinese, Hebrew, Japanese and Korean. Zebra +has this support via the ICU libraries created and maintained by IBM. + +You can translate Koha into your language using the built-in translation tools, +or by visiting http://translate.koha.org. + +6. New templates - Koha's staff and patron interfaces are developed with a +template system that's easy to theme. The default templates are composed of 100% +valid XHTML and CSS. Koha aims to meet or exceed U.S. Government Section 508 and +W3C's WAI-AA standards for sight and motor impaired individuals. All +Javascript usage comes with fallback modes that work in any web browser. + +7. Koha 3 has quite a few new modules, as well as enhancements to existing +modules, including: news writer, label creator, calendar, OPAC comments, MARC +staging and overlay, notices, transaction logs, guided reports with a data +dictionary and task scheduler, classification sources/filing rules, and more! + +============================================================================== +REVISION CONTROL +============================================================================== + +With Koha 3, we've started using a new distributed revision control system +called Git; it's the same system in use by many other projects, including the +Linux Kernel. To learn more about how to develop Koha using Git, please see +the Wiki page: + +http://wiki.koha.org/doku.php?id=en:development:git_usage + +============================================================================== +VERSION NUMBERING +============================================================================== + +With Koha 3, version numbering has been changed to use a method similar to +Perl's: + +major.minor[.revision[.build]] + + * major: one digit + * minor: two-digit + * revision: two-digit + * build: three-digit + +This release of Koha 3.0 is versioned 3.00.00.107. Every database change +or significant enough code change requires an update to the 'build' number, +and developers will be able to easily upgrade their systems using the built-in +updater. + +Koha 3.0.1 Release Schedule: + +This release of Koha 3.0.1 includes the following general improvements over +the previous release: + + * General Bugfixing (over 150 bugs fixed since RC1!) + Authorities : + Authorities structure edition + Authorities edition with diacritics + merging authorities + Adding failover when null string searched + Cataloguing : + When editing an item, clearing a field. + OPAC : + tags Management improved + shelves browsing improved + improved COInS Support + Improved RSS support + Boolean search on Advanced Search page (more options) Added + Deletion of private list fix + General Output : + Improving concistency of strings + markup corrections + Adding some untranslated strings to translation files. + More consistency in dates display + UNIMARC + Adds the creation date of biblios to frameworks in order to improve Rss support + You have to launch the script ./maintenance/UNIMARC_sync_date_created_with_marc_biblio.pl + 995$2 as lost items management. + If you had a previous installation of Koha without 995$2 linked to items.lost then + you have to launch the script ./maintenance/sync_items_in_marc_bib.pl + and rebuild indexes with rebuild_zebra.pl (see wiki.koha.org or rebuild_zebra.pl -h for documentation) + Fines fixes + Some sorting problems on patron names and libraries fixed + js and update of strings for better coherence + CGI::Session::Serialize::yaml is now required and not only CGI::Session + Adding better display of links on conformance with MARC standards + Fixing POD for correctness + Preparing for debian packaging + Adding more SIP2 functions + Adding some information on reports + UTF8 support improved + Failover improved + Many performance improvements under the hood + * Adding a Subject cloud + * better UNIMARC version 5 compliance + * Improving diacritics management in zebra + * Additional translations + * Improving Quality Assurance with test suite + * Adding a Renew All button to OPAC + * options added to overdue_notices script + +Subsequent releases will be bugfix releases, and won't include new +features which would require some databas changes. + +New features will be available in Koha 3.2 and subsequent releases. + +============================================================================== +UPGRADING FROM A PREVIOUS VERSION OF KOHA +============================================================================== + +The upgrade process from a previous version of Koha is documented on the Wiki +at the following page: + +Upgrading from 2.2 or earlier version: + +http://wiki.koha.org/doku.php?id=22_to_30 + +Upgrading from a previous version of 3.0: + +Please consult INSTALL files for details on how to upgrade + +============================================================================== +TEMPLATES +============================================================================== + +You may have heard that the templates for Koha 3 have been re-skinned; there +is also the start of a template style guide on the Wiki: + +http://wiki.koha.org/doku.php?id=en:documentation:templates_style_guide + +Kudos to Owen Leonard and the Nelsonville Public Library for their +contributions! + +============================================================================== +TRANSLATIONS +============================================================================== + +Koha 3.0 (this release) currently has complete translations for the following +languages: + +OPAC: de-DE (German), el-GR (Greek), es-ES (Spanish), en (English), fr-FR (French) + hu-HU (Hungarian), it-IT (Italian), pt-PT (Portuguese), tr-TR (Turkish), + ru-RU (Russian), uk-UA (Ukranian) + zh-Hans-CN (Simplified Chinese in China), zh-Hans-TW (Simplified Chinese in Taiwan) + +Staff Client fr-FR (French), en (English), hy-Armn (Armenian), + ru-RU (Russian), uk-UA (Ukranian) + zh-Hans-CN (Simplified Chinese in China), zh-Hans-TW (Simplified Chinese in Taiwan) + +Additionally, Koha 3 (this release) has partial translations for the following +languages: + +OPAC: am-Ethi (Amharic), bg-Cyrl (Bulgarian), fa-Arab (Persian), fi-FI (Finnish) + gl (Galego), he-Hebr (Hebrew), id-ID (Indonesian), ja-Japn (Japanese), + kn-Knda (kannada), ko-Kore (Korean), mi-NZ (Maori), pl-PL (Polish), + tet (Tetum) + +Staff Client: de-DE (German), el-EL (Greek), es-ES (Spanish), hu-HU (Hungarian), + ja-Japn (Japanese), tr-TR (Turkish), + +The Koha Team welcomes additional translations; please see +http://www.kohadocs.org/usersguide/apb.html for information about +translating Koha, and join the koha-translate list to volunteer: + +http://lists.nongnu.org/mailman/listinfo/koha-translate + +============================================================================== +DOCUMENTATION +============================================================================== + +User-contributed documentation for Koha 3 is available on the Koha Wiki +(http://wiki.koha.org). The Koha Team welcomes documentation contributions; +please join the Koha-devel list to volunteer: + +http://lists.nongnu.org/mailman/listinfo/koha-devel + +============================================================================== +KNOWN ISSUES +============================================================================== + +Known bugs are documented on the Koha wiki: http://bugs.koha.org and at the +3.0 RM's QA notes Wiki page: + +http://wiki.koha.org/doku.php?id=en:development:qanotes3.0