Update release notes for 3.12-alpha2 release

[koha.git] / misc / release_notes / release_notes_30005.txt

==============================================================================
RELEASE NOTES FOR KOHA 3.0.5
==============================================================================
Koha 3 is the next-generation release of the award-winning Koha open-source
integrated library system.

You can obtain Koha 3.0.5 from the following URL:

http://download.koha.org/koha-3.00.05.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.00.05 is versioned 3.00.05.03. 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.5 Release :

This release of Koha 3.0.5 includes about 100 patches with bug fixes and translations:

Bug 3730: Portuguese code was incorrect
Bug 3824: Item modif doesn't select default value in combo list
Bug 3863 AmazonReviews not showing up
MT2432 : Do not show "place hold" link when there's no items
(bug #3173) revert non-working code
(bug #3898) Followup : fixing Hold Policies implementation
3.0.x : intranet results Removing missing features
Dates : dates without beginning 0 are considered valid
(bug #3819) variable name typo
(bug #3819) still fixing holds policies
Bug 3827: Impossible to set a subfield mandatory in biblio framework
Bug 3784: Don't fail on opac-detail.pl with invalid biblionumber
MT 2415 : tablesorter for shelves
(bug #3823) on hold items in opac
MT 2360 : Adds address, city and zipcode to overdues csv export
(bug #3348) another order receive fix
(bug #3825) improve waiting holds
(bug #3826) improve modrequest.pl
MT 2110 : adds title, due date and issue date to csv overdues export
Bug 3818 Allow 10 characters in bookfund id input
Bug 3806 - Holidays improperly sorted by date
Bug 3805 Suppress display of basket level invoice no
Bug 3805 Suppress basket invoice number display
(bug #3801) fix itemtype administration
Bug 3800 - Misplaced IF was causing the no permission message never to be displayed
Bug 3813: SIP2, Bad Patron Information Response to Message 64
(bug #3816) differenciate reserved and on loan items
(bug #3819) hold policies implementation
(bug #3819) hold policies doesn't work
(bug #3822) fix returning document in transfert
(bug #3798) fix changing request branch
Removing es-VE at request of translators
[3.0.x][followup](bug #3348) orderreceive problems
Bug 3754: Follow-up patch
(bug #3791) overduerules and numeric categorycodes
(bug #3786) fix items edition menu
(MT 1970) fix javascript
(bug #3783) fix marcurls
(bug #3734) Fix previous patch of isbd view
[followup](bug #3779) fix tmpl_if
[followup](bug #3760) delete some warn
(bug #3760) fix and improve some reports
(bug #3761) fix virtualshelf ordering
(bug #3762) fix warnings in GetCoinsBiblio
(bug #3771) delete multiple holds
(bug #3772) show place hold button in isbd view
[followup](bug #3550) fix opensearch with subtitle
(bug #3778) GetBranchesLoop and searchMyLibraryFirst
(bug #3779) overdues csv fix
Subscription add Updating Online Help file
Translation fix : opac-recentacquisitions
Adding Support for $9 and $3 on authority hierarchy
Followup : d31ac1 reintroducing submit buttons
[followup] (bug #3710) all itemtypes if none selected
(recent acquisitions)
(bug #3734) another isbd view for opac
(bug #3754) fix language choose
Fixing translation stopped on acqui-search-result.tmpl
Admin/categorie.pl _get_bref_messaging_pref missing
(bug #3745) fix deletion of borrowers rights detection
[3.0.x](bug #3753) returning a document always needs transfert
Updating INSTALL.ubuntu
Fix 3741 : Amazon cover image not displayed
(bug #3558) fix build_browser_and_cloud
Bug Fixing : holds management Adding GetBranchItemRule
followup TransformhtmltoXML
Fix normal opac view
Followup bfffa5 TransformHTMLToXML bug fix
Reintroducing submit buttons in translations
Bug Fix MT2104 : Edit authorities problem on multiple field
(bug #3281) change the way to parse item's summary

This release is bugfix only release, and doesnot include new
features.
It adds 3 changes in database, which adds some new tables required for some partial features ports from 3.2 due to the previous release and updates languages tag for portuguese and updates Calendar SystemPreference.


Note that Windows is not supported for this version as there are blockers.

Note that this version is still supporting only MySQL.
Support for PostgreSQL is still very experimental.

New features which have deep impact on code 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.5 (this release) currently has complete translations for the following
languages:

OPAC: ar-Arab (Arabic), da-DK (Danish), de-DE (German), el-GR (Greek), es-ES (Spanish), en (English), 
   en-NZ (New Zealand English), fr-FR (French),
   hu-HU (Hungarian), it-IT (Italian), nn-NO - Norwegian Nynorsk, nb-NO Norwegian (Bokmål),
   nl-NL (Dutch), pt-PT (Portuguese), tr-TR (Turkish),
   ru-RU (Russian), uk-UA (Ukranian)
   

Staff Client: de-DE (German), el-EL (Greek), fr-FR (French), en (English),
   es-ES (Spanish), it-IT (Italian), uk-UA (Ukranian),
   

Additionally, Koha 3.0.5 (this release) has partial translations for the following
languages:

OPAC: am-Ethi (Amharic), bg-Cyrl (Bulgarian), fa-Arab (Persian), fi-FI (Finnish)
   gl (Galician), he-Hebr (Hebrew), hr-HR (Croatian), hu-HU (Hungarian), id-ID (Indonesian), 
   ja-Japn (Japanese), kn-Knda (kannada), ko-Kore (Korean), lo-Laoo (Laoo), 
   mi-NZ (Maori), pl-PL (Polish), sv-SE (Swedish),
   tet (Tetum), zh-Hans-CN (Simplified Chinese in China), zh-Hans-TW (Simplified Chinese in Taiwan)

Staff Client: ar-Arab (Arabic), es-ES (Spanish), hu-HU (Hungarian),
    hy-Armn (Armenian), ja-Japn (Japanese), nn-NO - Norwegian Nynorsk, nb-NO Norwegian (Bokmål),
    pt-PT (Portuguese), ru-RU (Russian), tr-TR (Turkish), Hindi, Greek, Italian, Polish,
    zh-Hans-CN (Simplified Chinese in China), zh-Hans-TW (Simplified Chinese in Taiwan)

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.koha.org/mailman/listinfo/koha-translate

You can find latest uptodate translations on Pootle : http://translate.koha.org/languages/
You can also ask for translation rights if you need.
Thank you for your patience and your work, translators.

==============================================================================
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.koha.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