Merge remote-tracking branch 'kc/new/bug_5449' into kcmaster
[wip/koha-chris_n.git] / misc / release_notes / release_notes_30000stableRC1.txt
1 ==============================================================================
2 RELEASE NOTES FOR KOHA 3.0 RC1 
3 ==============================================================================
4 Koha 3 is the next-generation release of the award-winning Koha open-source
5 integrated library system.
6
7 You can obtain Koha 3.0 RC1 from the following URL:
8
9 http://download.koha.org/koha-3.00.00-stableRC1.tar.gz
10
11 These Release Notes cover What's New in Koha 3, information about the new
12 Revision control system (Git), and Version-release process, pointers to
13 Download, Installation, and Upgrade documentation, a brief introduction to the
14 new Templates, a call to Translation and Documentation writers, and finally, 
15 Known Issues with this version.
16
17 ==============================================================================
18 WHAT'S NEW IN KOHA 3?
19 ==============================================================================
20
21 1. Zebra plugin - Zebra is a high-performance, general-purpose structured
22 text indexing and retrieval engine. It supports large data sets (tens of
23 millions of records) and includes support for SRU, Z39.50 and several query
24 languages: CCL, CQL, and PQF. For more information about Zebra, please see:
25
26 http://indexdata.dk/zebra
27
28 Koha's new search engine, built on top of Zebra, supports features such as
29 relevance ranking, field weighting, truncation, stemming, use of fuzzy
30 operators, language-specific indexing, sorting, etc.
31
32 Indexes are updated in real-time with circulation transactions, enabling
33 limits by availability and statuses.
34
35 Faceted refine-by limits are available from both staff and opac interfaces.
36
37 For libraries that don't want the overhead of maintaing Zebra, Koha 3 ships
38 with a NoZebra option, in which bibliographic and authority data is indexed
39 in the RDBMS.
40
41 2. New installer - based on the common Perl module ExtUtils::MakeMaker, the
42 new installer makes it a snap to get Koha running on just about any platform.
43
44 The installer comes complete with a Developer's Toolkit target ('dev') that
45 can be used to get a development environment linked directly to revision
46 control, to support rapid prototyping and an agile development process.
47
48 3. Standard APIs - Koha 3 supports a number of important library search and
49 retrieval standards and microformats, such as SRU/W, Z39.50
50 (http://www.loc.gov/standards/sru/), UnAPI (http://unapi.info/) and
51 COinS/OpenURL
52 (http://ocoins.info; http://www.niso.org/committees/committee_ax.html).
53
54 Also supported is the popular Internet standard: OpenSearch
55 (http://opensearch.a9.com/) created by Amazon's A9.
56
57 Records are stored internally in an SGML-like format and can be retrieved in
58 MARCXML, Dublin Core, MODS, RSS, Atom, RDF-DC, SRW-DC, OAI-DC, and EndNote;
59 and the OPAC can be used by citation tools such as Zotero. Creating new 
60 export formats is a trivial exercise in writing XSLT; records can be passed
61 through XSLT transformations either directly out of the index, or via a
62 separate parsing function.
63
64 To retrieve and interact with Circulation and Patron data, Koha 3 includes
65 support for 3M's Standard Interchange Protocol (SIP2), using the OpenNCIP
66 libraries (http://openncip.org).
67
68 There are also an ever-expanding set of native REST APIs to handle
69 interoperability with external tools such as third-party cataloging clients.
70 These APIs provide authentication as well as add/edit/delete control over
71 bibliographic data within a Koha system. For more information, see:
72
73 http://wiki.koha.org/doku.php?id=en:development:web_services
74
75 Koha 3 also includes pluggable authentication - easy integration with LDAP and 
76 Active Directory via the Auth_with_ldap module.
77
78 The Amazon.com module can be enabled to enrich bibliographic data with jacket
79 covers, professional reviews, ratings and comments from Amazon users, as well
80 as point to 'Similar Items' within the catalog. OCLC's xISBN, and
81 LibraryThing's ThingISBN can likewise be enabled to provide an 'Editions' tab
82 on item detail pages. New with Koha 3 is service throttling for these services,
83 to keep within subscription limits.
84
85 4. Cross-platform, multi-RDBMS, Web-server agnostic - Run Koha on the platform
86 of your choice: Linux, Windows, Mac OS X, FreeBSD, Solaris. Koha 3 also
87 includes better support for multi-RDBMS (MySQL 5.0 and PostgreSQL), and runs
88 under Apache2, IIS, or the web server of your choosing.
89
90 5. Multi-lingual support - Koha was designed from the ground up for multilingual
91 libraries. Koha 3 can handle Chinese, Japanese, and even right-to-left languages
92 such as Arabic and Hebrew with ease (BiDi).
93
94 Koha's index engine (Zebra) can handle record formats containing any UNICODE
95 compliant script, such as Arabic, Chinese, Hebrew, Japanese and Korean. Zebra
96 has this support via the ICU libraries created and maintained by IBM.
97
98 You can translate Koha into your language using the built-in translation tools,
99 or by visiting http://translate.koha.org.
100
101 6. New templates - Koha's staff and patron interfaces are developed with a
102 template system that's easy to theme. The default templates are composed of 100%
103 valid XHTML and CSS. Koha aims to meet or exceed U.S. Government Section 508 and
104 W3C's WAI-AA standards for sight and motor impaired individuals. All 
105 Javascript usage comes with fallback modes that work in any web browser.
106
107 7. Koha 3 has quite a few new modules, as well as enhancements to existing
108 modules, including: news writer, label creator, calendar, OPAC comments, MARC
109 staging and overlay, notices, transaction logs, guided reports with a data
110 dictionary and task scheduler, classification sources/filing rules.
111
112 ==============================================================================
113 REVISION CONTROL
114 ==============================================================================
115
116 With Koha 3, we've started using a new distributed revision control system
117 called Git; it's the same system in use by many other projects, including the
118 Linux Kernel. To learn more about how to develop Koha using Git, please see
119 the Wiki page:
120
121 http://wiki.koha.org/doku.php?id=en:development:git_usage
122
123 ==============================================================================
124 VERSION NUMBERING
125 ==============================================================================
126
127 With Koha 3, version numbering has been changed to use a method similar to
128 Perl's:
129
130 major.minor[.revision[.build]]
131
132   * major:    one digit
133   * minor:    two-digit
134   * revision: two-digit
135   * build:    three-digit
136
137 This release of Koha 3.0 is versioned 3.00.00.094. Every database change
138 or significant enough code change requires an update to the 'build' number,
139 and developers will be able to easily upgrade their systems using the built-in
140 updater.
141
142 Koha 3.0 Release Schedule:
143
144 This release of Koha 3.0 includes the following general improvements over
145 the beta release:
146
147   * General Bugfixing (everyone)
148   * New messaging enhancements (acmoore)
149   * Lots of nomenclature cleanup
150   * New testing suite (acmoore and gmcharlt)
151   * SIP2 and LDAP fixes (atz)
152   * Improved I18N/L10N, lang detection (kados)
153   * Additional translations
154   * Lots more, consult git.koha.org for the complete changelog
155
156 This release candidate of Koha 3.0 will be followed by a stable release.
157 Subsequent releases of 3.0 will be bugfix releases, and won't include any new
158 features.
159
160 New features will be available in Koha 3.2 and subsequent releases.
161
162 ==============================================================================
163 UPGRADING FROM A PREVIOUS VERSION OF KOHA
164 ==============================================================================
165
166 The upgrade process from a previous version of Koha is documented on the Wiki
167 at the following page:
168
169 Upgrading from 2.2 or earlier version:
170
171 http://wiki.koha.org/doku.php?id=22_to_30
172
173 Upgrading from a previous version of 3.0:
174
175 Please consult INSTALL files for details on how to upgrade
176
177 ==============================================================================
178 TEMPLATES
179 ==============================================================================
180
181 You may have heard that the templates for Koha 3 have been re-skinned; there
182 is also the start of a template style guide on the Wiki:
183
184 http://wiki.koha.org/doku.php?id=en:documentation:templates_style_guide
185
186 Kudos to Owen Leonard and the Nelsonville Public Library for their
187 contributions!
188
189 ==============================================================================
190 TRANSLATIONS
191 ==============================================================================
192
193 Koha 3.0 (this release) currently has complete translations for the following
194 languages:
195
196 OPAC: de-DE (German), el-GR (Greek), es-ES (Spanish), en (English), fr-FR (French)
197    hu-HU (Hungarian), it-IT (Italian), pt-PT (Portuguese), tr-TR (Turkish),
198    ru-RU (Russian), uk-UA (Ukranian)
199    zh-Hans-CN (Simplified Chinese in China), zh-Hans-TW (Simplified Chinese in Taiwan)
200
201 Staff Client fr-FR (French), en (English), hy-Armn (Armenian),
202    ru-RU (Russian), uk-UA (Ukranian)
203    zh-Hans-CN (Simplified Chinese in China), zh-Hans-TW (Simplified Chinese in Taiwan)
204
205 Additionally, Koha 3 (this release) has partial translations for the following
206 languages:
207
208 OPAC: am-Ethi (Amharic), bg-Cyrl (Bulgarian), fa-Arab (Persian), fi-FI (Finnish)
209    gl (Galego), he-Hebr (Hebrew), id-ID (Indonesian), ja-Japn (Japanese),
210    kn-Knda (kannada), ko-Kore (Korean), mi-NZ (Maori), pl-PL (Polish),
211    tet (Tetum)
212
213 Staff Client: de-DE (German), el-EL (Greek), es-ES (Spanish), hu-HU (Hungarian),
214    ja-Japn (Japanese), tr-TR (Turkish), 
215
216 The Koha Team welcomes additional translations; please see
217 http://www.kohadocs.org/usersguide/apb.html for information about
218 translating Koha, and join the koha-translate list to volunteer:
219
220 http://lists.nongnu.org/mailman/listinfo/koha-translate
221
222 ==============================================================================
223 DOCUMENTATION
224 ==============================================================================
225
226 User-contributed documentation for Koha 3 is available on the Koha Wiki
227 (http://wiki.koha.org). The Koha Team welcomes documentation contributions;
228 please join the Koha-devel list to volunteer:
229
230 http://lists.nongnu.org/mailman/listinfo/koha-devel
231
232 ==============================================================================
233 KNOWN ISSUES
234 ==============================================================================
235
236 Known bugs are documented on the Koha wiki: http://bugs.koha.org and at the
237 3.0 RM's QA notes Wiki page:
238
239 http://wiki.koha.org/doku.php?id=en:development:qanotes3.0