Merge remote-tracking branch 'kc/new/bug_5449' into kcmaster
[wip/koha-chris_n.git] / misc / release_notes / release_notes_30005.txt
1 ==============================================================================
2 RELEASE NOTES FOR KOHA 3.0.5
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.5 from the following URL:
8
9 http://download.koha.org/koha-3.00.05.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 Enriched content web services, such as those offered by Amazon.com, Baker and
79 Taylor's Content Cafe, and the Google Book API can be enabled to enrich
80 bibliographic content with jacket covers, professional reviews, ratings and
81 comments from users, as well as point to 'Similar Items' within the catalog.
82 OCLC's xISBN, and LibraryThing's ThingISBN an likewise be enabled to provide
83 an 'Editions' tab, pulling together all the formats, languages, and editions
84 of a work into the item detail pages. New with Koha 3 is service throttling
85 for these services, to keep within subscription limits.
86
87 4. Cross-platform, multi-RDBMS, Web-server agnostic - Run Koha on the platform
88 of your choice: Linux, Windows, Mac OS X, FreeBSD, Solaris. Koha 3 also
89 includes better support for multi-RDBMS (MySQL 5.0 and PostgreSQL), and runs
90 under Apache2, IIS, or the web server of your choosing.
91
92 5. Multi-lingual support - Koha was designed from the ground up for multilingual
93 libraries. Koha 3 can handle Chinese, Japanese, and even right-to-left languages
94 such as Arabic and Hebrew with ease (BiDi).
95
96 Koha's index engine (Zebra) can handle record formats containing any UNICODE
97 compliant script, such as Arabic, Chinese, Hebrew, Japanese and Korean. Zebra
98 has this support via the ICU libraries created and maintained by IBM.
99
100 You can translate Koha into your language using the built-in translation tools,
101 or by visiting http://translate.koha.org.
102
103 6. New templates - Koha's staff and patron interfaces are developed with a
104 template system that's easy to theme. The default templates are composed of 100%
105 valid XHTML and CSS. Koha aims to meet or exceed U.S. Government Section 508 and
106 W3C's WAI-AA standards for sight and motor impaired individuals. All 
107 Javascript usage comes with fallback modes that work in any web browser.
108
109 7. Koha 3 has quite a few new modules, as well as enhancements to existing
110 modules, including: news writer, label creator, calendar, OPAC comments, MARC
111 staging and overlay, notices, transaction logs, guided reports with a data
112 dictionary and task scheduler, classification sources/filing rules, and more!
113
114 ==============================================================================
115 REVISION CONTROL
116 ==============================================================================
117
118 With Koha 3, we've started using a new distributed revision control system
119 called Git; it's the same system in use by many other projects, including the
120 Linux Kernel. To learn more about how to develop Koha using Git, please see
121 the Wiki page:
122
123 http://wiki.koha.org/doku.php?id=en:development:git_usage
124
125 ==============================================================================
126 VERSION NUMBERING
127 ==============================================================================
128
129 With Koha 3, version numbering has been changed to use a method similar to
130 Perl's:
131
132 major.minor[.revision[.build]]
133
134   * major:    one digit
135   * minor:    two-digit
136   * revision: two-digit
137   * build:    three-digit
138
139 This release of Koha 3.00.05 is versioned 3.00.05.03. Every database change
140 or significant enough code change requires an update to the 'build' number,
141 and developers will be able to easily upgrade their systems using the built-in
142 updater.
143
144 Koha 3.0.5 Release :
145
146 This release of Koha 3.0.5 includes about 100 patches with bug fixes and translations:
147
148 Bug 3730: Portuguese code was incorrect
149 Bug 3824: Item modif doesn't select default value in combo list
150 Bug 3863 AmazonReviews not showing up
151 MT2432 : Do not show "place hold" link when there's no items
152 (bug #3173) revert non-working code
153 (bug #3898) Followup : fixing Hold Policies implementation
154 3.0.x : intranet results Removing missing features
155 Dates : dates without beginning 0 are considered valid
156 (bug #3819) variable name typo
157 (bug #3819) still fixing holds policies
158 Bug 3827: Impossible to set a subfield mandatory in biblio framework
159 Bug 3784: Don't fail on opac-detail.pl with invalid biblionumber
160 MT 2415 : tablesorter for shelves
161 (bug #3823) on hold items in opac
162 MT 2360 : Adds address, city and zipcode to overdues csv export
163 (bug #3348) another order receive fix
164 (bug #3825) improve waiting holds
165 (bug #3826) improve modrequest.pl
166 MT 2110 : adds title, due date and issue date to csv overdues export
167 Bug 3818 Allow 10 characters in bookfund id input
168 Bug 3806 - Holidays improperly sorted by date
169 Bug 3805 Suppress display of basket level invoice no
170 Bug 3805 Suppress basket invoice number display
171 (bug #3801) fix itemtype administration
172 Bug 3800 - Misplaced IF was causing the no permission message never to be displayed
173 Bug 3813: SIP2, Bad Patron Information Response to Message 64
174 (bug #3816) differenciate reserved and on loan items
175 (bug #3819) hold policies implementation
176 (bug #3819) hold policies doesn't work
177 (bug #3822) fix returning document in transfert
178 (bug #3798) fix changing request branch
179 Removing es-VE at request of translators
180 [3.0.x][followup](bug #3348) orderreceive problems
181 Bug 3754: Follow-up patch
182 (bug #3791) overduerules and numeric categorycodes
183 (bug #3786) fix items edition menu
184 (MT 1970) fix javascript
185 (bug #3783) fix marcurls
186 (bug #3734) Fix previous patch of isbd view
187 [followup](bug #3779) fix tmpl_if
188 [followup](bug #3760) delete some warn
189 (bug #3760) fix and improve some reports
190 (bug #3761) fix virtualshelf ordering
191 (bug #3762) fix warnings in GetCoinsBiblio
192 (bug #3771) delete multiple holds
193 (bug #3772) show place hold button in isbd view
194 [followup](bug #3550) fix opensearch with subtitle
195 (bug #3778) GetBranchesLoop and searchMyLibraryFirst
196 (bug #3779) overdues csv fix
197 Subscription add Updating Online Help file
198 Translation fix : opac-recentacquisitions
199 Adding Support for $9 and $3 on authority hierarchy
200 Followup : d31ac1 reintroducing submit buttons
201 [followup] (bug #3710) all itemtypes if none selected
202 (recent acquisitions)
203 (bug #3734) another isbd view for opac
204 (bug #3754) fix language choose
205 Fixing translation stopped on acqui-search-result.tmpl
206 Admin/categorie.pl _get_bref_messaging_pref missing
207 (bug #3745) fix deletion of borrowers rights detection
208 [3.0.x](bug #3753) returning a document always needs transfert
209 Updating INSTALL.ubuntu
210 Fix 3741 : Amazon cover image not displayed
211 (bug #3558) fix build_browser_and_cloud
212 Bug Fixing : holds management Adding GetBranchItemRule
213 followup TransformhtmltoXML
214 Fix normal opac view
215 Followup bfffa5 TransformHTMLToXML bug fix
216 Reintroducing submit buttons in translations
217 Bug Fix MT2104 : Edit authorities problem on multiple field
218 (bug #3281) change the way to parse item's summary
219
220 This release is bugfix only release, and doesnot include new
221 features.
222 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.
223
224
225 Note that Windows is not supported for this version as there are blockers.
226
227 Note that this version is still supporting only MySQL.
228 Support for PostgreSQL is still very experimental.
229
230 New features which have deep impact on code will be available in Koha 3.2 
231 and subsequent releases.
232
233 ==============================================================================
234 UPGRADING FROM A PREVIOUS VERSION OF KOHA
235 ==============================================================================
236
237 The upgrade process from a previous version of Koha is documented on the Wiki
238 at the following page:
239
240 Upgrading from 2.2 or earlier version:
241
242 http://wiki.koha.org/doku.php?id=22_to_30
243
244 Upgrading from a previous version of 3.0:
245
246 Please consult INSTALL files for details on how to upgrade
247
248 ==============================================================================
249 TEMPLATES
250 ==============================================================================
251
252 You may have heard that the templates for Koha 3 have been re-skinned; there
253 is also the start of a template style guide on the Wiki:
254
255 http://wiki.koha.org/doku.php?id=en:documentation:templates_style_guide
256
257 Kudos to Owen Leonard and the Nelsonville Public Library for their
258 contributions!
259
260 ==============================================================================
261 TRANSLATIONS
262 ==============================================================================
263
264 Koha 3.0.5 (this release) currently has complete translations for the following
265 languages:
266
267 OPAC: ar-Arab (Arabic), da-DK (Danish), de-DE (German), el-GR (Greek), es-ES (Spanish), en (English), 
268    en-NZ (New Zealand English), fr-FR (French),
269    hu-HU (Hungarian), it-IT (Italian), nn-NO - Norwegian Nynorsk, nb-NO Norwegian (Bokmål),
270    nl-NL (Dutch), pt-PT (Portuguese), tr-TR (Turkish),
271    ru-RU (Russian), uk-UA (Ukranian)
272    
273
274 Staff Client: de-DE (German), el-EL (Greek), fr-FR (French), en (English),
275    es-ES (Spanish), it-IT (Italian), uk-UA (Ukranian),
276    
277
278 Additionally, Koha 3.0.5 (this release) has partial translations for the following
279 languages:
280
281 OPAC: am-Ethi (Amharic), bg-Cyrl (Bulgarian), fa-Arab (Persian), fi-FI (Finnish)
282    gl (Galician), he-Hebr (Hebrew), hr-HR (Croatian), hu-HU (Hungarian), id-ID (Indonesian), 
283    ja-Japn (Japanese), kn-Knda (kannada), ko-Kore (Korean), lo-Laoo (Laoo), 
284    mi-NZ (Maori), pl-PL (Polish), sv-SE (Swedish),
285    tet (Tetum), zh-Hans-CN (Simplified Chinese in China), zh-Hans-TW (Simplified Chinese in Taiwan)
286
287 Staff Client: ar-Arab (Arabic), es-ES (Spanish), hu-HU (Hungarian),
288     hy-Armn (Armenian), ja-Japn (Japanese), nn-NO - Norwegian Nynorsk, nb-NO Norwegian (Bokmål),
289     pt-PT (Portuguese), ru-RU (Russian), tr-TR (Turkish), Hindi, Greek, Italian, Polish,
290     zh-Hans-CN (Simplified Chinese in China), zh-Hans-TW (Simplified Chinese in Taiwan)
291
292 The Koha Team welcomes additional translations; please see
293 http://www.kohadocs.org/usersguide/apb.html for information about
294 translating Koha, and join the koha-translate list to volunteer:
295
296 http://lists.koha.org/mailman/listinfo/koha-translate
297
298 You can find latest uptodate translations on Pootle : http://translate.koha.org/languages/
299 You can also ask for translation rights if you need.
300 Thank you for your patience and your work, translators.
301
302 ==============================================================================
303 DOCUMENTATION
304 ==============================================================================
305
306 User-contributed documentation for Koha 3 is available on the Koha Wiki
307 (http://wiki.koha.org). The Koha Team welcomes documentation contributions;
308 please join the Koha-devel list to volunteer:
309
310 http://lists.koha.org/mailman/listinfo/koha-devel
311
312 ==============================================================================
313 KNOWN ISSUES
314 ==============================================================================
315
316 Known bugs are documented on the Koha wiki: http://bugs.koha.org and at the
317 3.0 RM's QA notes Wiki page:
318
319 http://wiki.koha.org/doku.php?id=en:development:qanotes3.0