Merge remote-tracking branch 'kc/new/bug_5449' into kcmaster
[wip/koha-chris_n.git] / misc / release_notes / release_notes_30002.txt
1 ==============================================================================
2 RELEASE NOTES FOR KOHA 3.0.2
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.2 from the following URL:
8
9 http://download.koha.org/koha-3.00.02.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.02 is versioned 3.00.02.012. 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.2 Release :
145
146 This release of Koha 3.0.2 includes the following general improvements over
147 the previous release:
148
149 xslt support for UNIMARC added
150 UNIMARC support for search available items only and weight field
151 better IE7 support for intranet
152 Show Summary in opac results
153 opac-browser
154 Serial subscription report
155 translations improved
156
157
158 Complete list follows :
159 Fixes Bug 3043: Followup.
160 Bug 3245: advancedMARCeditor syspref not returning to cataloguing tab
161 Bug 2266: Could not uncollapse a tag if you turn on advancedMARCeditor.
162 BUG FIXING : opac-browser wouldnot display anything.
163 Bug 3162 Fix only for [3.0.x]
164 bug 2908 followup - use "list", not "shelf"
165 (bug #3080) fix the acqui/spent.pl
166 (bug #3079) show summary in opac results
167 (bug #1578) fix a little error in code
168 bug 988 followup - tweak wording
169 bugfix stickyduedate more sticky - couple more forms in circulation.tmpl
170 bugfix stickyduedate more sticky - also patron search in quick search block
171 Bugfix 3176 - Browser selected languages are not use by OPAC
172 (bug #3196) fix itemlost.pl
173 Bug 1984 - added Javascript in the header to open, print, and close the slip window
174 bug 1907 Partial fix: prevent bad records from truncating output.
175 bug 3212: MARC21 bib leader plugin sets Leader/09 to 'a'
176 bug 3211: fix XHTML validation errors in MAR21 bib leader plugin
177 bug 3209: add 'p' (mixed materials) to MARC21 Leader/06 dropdown
178 (bug #3198) fix serial receive with autobarcode
179 Bug 3213 - UNIMARC/MARC21 selection
180 Bug 3213 - Add UNIMARC XSLT stylesheet
181 More fixes for Bug 2704, 440 Display Issues
182 bug 3195 : Item Transfers and Holds disrupted.
183 Revert "(bug #3025) multiple check-in of a multiple times reserved item go wrong"
184 (bug #3190) allow right truncation in lot of records
185 (bug #3174) show the member name in reports
186 bug 2287: handle case where autoMemberNum is off
187 Allow autogenerated cardnumbers again to solve http://bugs.koha.org/cgi-bin/bugzilla3/show_bug.cgi?id=2287
188 (bug #3183) fix the SetMarcUnicodeFlag function
189 Add system preference search to administration home page (Bug 3181)
190 Bugfix 3199 - batchRebuildBiblioTables.pl failed due to missing argument [3.0.x]
191 Bug 2944 fix courtesy of Amr Denni
192 (bug #3197) Subfield code box was not present on new subfield tab in Admin/Authority
193 Bug 3081 - The category code in the patron personal details page in opac showed the category code and not the description. This patch makes the description appear instead. Looking at both opac-userupdate.pl and opac-userupdate.tmpl, the actual value of this text box is not retrieved for any purpose.
194 (bug #3193) fix the comtd value in acqui-home.pl
195 Bug 3157: IE compatibility for label display
196 (bug #2750) Cannot return to another branch if the independantbranch option is set as ON
197 bug 2687 followup: Increase maxlength attribute to support 64 characters
198 Bug 3177 - haspermission offers bogus option
199 bug 3141: use quoted printable encoding in cart/list emails
200 bug 2908 followup - use "list", not "shelf"
201 Corrected: fix for Bug 3112, Emailed list contains too much whitespace
202 (bug #3187) authority search pagination doesn't work
203 (bug #3058) show items that are excluded of loan in search results
204 (bug #3057) mandatory subfield edition
205 (bug #3053) extract ISBD view generator, and permit to display valuecode in ISBD view
206 (bug #3051) bad support of pagination in auth_finder
207 (bug #3025) multiple check-in of a multiple times reserved item go wrong
208 (bug #3011) csv export doesn't fill all the fields
209 (bug #2939) delete a warning
210 (bug #2938) add a serials subscriptions report
211 (bug #2908) adding send shelf by e-mail feature
212 Bug fix to OPAC shelf browsing query statement
213 Adding warnings, fixing a bug that meant the title of an item that had a fine was never printed
214 Bug #2974 Adding category code to BorrowerMandatoryField produced a "The following fields are mandatory: categorycode"
215 (bug #3174) fill borrower number, and show author and creation date in saved reports
216 minPasswordLength not returning user back to systempreferences.pl?tab=Patrons. Incorrect reference MinPasswordLength fixed. Could not find bug report.
217 Bug 3126: remove comma for IE7
218 Bug 2505 adding warnings to opac-authorities-home and fixing warnings generated
219 Bugs 2822, 2551, 3163 fixes to XSLT
220 (bug #2750) Cannot return to another branch if the independantbranch option is set as ON
221 (bug #2961) change the workflow of the new issue
222 bug 2915 followup - small efficiency improvement
223 Bug 3114 - IE7 spacing needs width: 100% to avoid line collapse.
224 bug 3161: don't display blank language chooser
225 bug 2505: fix more warnings in opac-search.pl
226 Bug 2505 Adding use warnings, and fixing the warnings generated
227 Bug 2776 : emailPurchaseSuggestions syspref deprecated
228 BUG-3160: fixes 'itemlost' check on item return.
229 bug 3159: allow editing child patron that has no valid guarantor
230 bug 2505 followup: restored correct item type image display
231 Bug 2505: adding warnings to opac-detail.pl
232 Bug 3152 OPAC reading history column headers don't line up with text
233 Bug 3128 - followup and correction
234 Bug 3128: IE7 tweak
235 bug 1546 - replacing REPLACE statements
236 Bug 3118: Remove comment that perturbs IE
237 IE bugs 3124 and 3115: z3950 search and guided_reports
238 Fix for Bug 3119: Add due date to the patron circulation history window
239 Fix for Bug 1877, Link to patron record from manage suggestions
240 Bug #3101 - Changed the Print and Confirm button
241 Bug 2847 - Added url escaping for categorie.tmpl
242 Bug 2847 - Fix html escaping in categorie.tmpl (more needed)
243 Fix Bug #2925
244 Partial fix for Bug #3139
245 Modification on Bug # 3102 - "Location" instead of "Localization"
246 Update for bug 1545 allowing for the title to be edited
247 Change typo Localisation to Localization for Bug # 3102
248 Bug 3013 Fix for 007 value builder to include all material types
249 Allowing users to edit saved sql in guided reports. Bug 1545
250 Bug 3132: Reformatting guarantor entry based on C vs. P patron types
251 Bug 3133 - correct typos
252 Removing duplicate email form field. Fixes Bug 3010.
253 bug 2958: fix search results navigation for CCL, CQL, and PQF queries
254 bug 3100: increase width of alternate postal code
255 Multi-bug fix - SetMarcUnicodeFlag for records coming from Koha
256 bug: unescaped single-quote in french sys. prefs. sql file
257 bug 3110 - Move Serial Preferences to Serials Tab
258 bug 3049: display correct due date of renewed loans
259 Bug 2919 -- fix value_builder plugins for dateaccessioned, barcode
260 Partial fix for Bug 2655, "Items waiting on the hold shelf display as 'Available' in OPAC"
261 Bug 3090 - Add perldoc details
262 Fix for Bug 3095, Add to lists page doesn't redirect with no javascript
263 Another try at fixing Bug 2949.
264 Bug 3066 - Overhaul guided reports
265 Corrected: Hiding renew link in the OPAC for items which cannot be renewed. Fixes bug 3083.
266 (bug #3084) in baskets, change the isbn of column
267 Adding details to OPAC search results RSS, described in Bug 2973.
268 bug 3088: fix crash in opac-ISBDdetail.pl
269 Bug #3071 - Z39.50 search result highlights are mixed
270 BUG-1503: fixes broken matching for 'hidden' values.
271 (bug #3063) fix unimarc 4xx plugin with cloned field
272 Bug #3036 Avoid command-line installer blocking on opensolaris plateform
273 Minor bug fix Documentation update : 3039
274 Hiding labels for add to list options when user isn't logged in or options don't exist. Fixes Bug 3043.
275 quietens a noisy debug pop-up, when debugging
276 Bug 2958 - notforloan (8008) is a numeric field.
277 Second patch to address LL Bug 367 Titles without ISBNs display "no cover image available" while titles with ISBNS that don't match a Syndetics cover display nothing
278 Fix for LL bug 367 Titles without ISBNs display "no cover image available"
279 Bug Fix : weight field was broken in UNIMARC
280 bug 3028: remove reservefix.pl cronjob
281 Correcting delete patron button to use TMPL_VAR instead of DOM query. Fixes Bug 3014, Can't delete restricted patron from circulation screen.
282 Fix for Bug 3015: Check-in screen displays branch name inconsistently
283 Bug 2617: Add strict (and warnings), partial fix.
284 (bug #2863) add the borrowers branchcodes in suggestion list
285 (bug #2811)[3.2] fix opac-renew.pl part
286 bug 2904: fix display of URLs in UNIMARC
287 corrected patch for bug 2951
288 bug 2772: bad image location
289 Bug 2883 - longoverdue cronjob fails to implement required functionality.
290 Kohabug 2500 Fiction Call Number Splitting Enhancement/Bugfix
291 bug 2924 fixed rebuild_zebra.pl to work when export is skipped
292 bug 1546 - REPLACE statements
293 Fix for Bug 2984, Error when generating CSV output from "Generate labels for Batch" button
294 bug 2870, fixes non-populating of guarantor fields
295 Formatting changes for OPAC xslt and staff client catalog detail pages. Fixes Bug 2704, 440 Display Issues.
296 bug 2856 followup: remove unconditional warn
297 Bug 2868: fixing typo in NoZebraIndexes setting in sysprefs
298 bug 2860: allow setting of a syspref value to '0'
299 bug 2505: turn on warnings in admin/systemprefernces.pl
300 bug 2867 [1/2]: Move basic editing to main system preferences screen
301 bug 2505: enable warnings for opac/sco/sco-main.pl
302 bug 2857: fix UTF-8 conversion issues in web services
303 bug 2613: allow web self-check to accept patron ID
304 Some minor markup corrections to opac authorities pages. Some fixes to address Bug 2620.
305 Fixing a couple of bugs in the package
306 Revert "Fix the guided report export, bad check of errors(bug #2672)"
307 (bug #1758) change the position of GetCOinSBiblio()
308 (bug #2948) change the aqbudgetid column type
309 (bug #2938)[follow previous] Add new report in menus
310 (bug #2933) change popup names containing space chars
311 (bug #2929) permit to define "fine days" in issuing rules
312 (bug #2915) C4::Biblio::DelBiblio delete the serials
313 (bug #2856) Activate the duplicate patrons detection and check birthdate only if one is set
314 Fix the guided report export, bad check of errors(bug #2672)
315 bug 2540: allow download of report
316 (bug #2881) preselect default sorting
317 (bug #2996) update unimarc 105 plugin to the actual norm
318 (bug #2961) be xhtml valid
319 bug 2986: tweak authtype index for MARC21 (GRS-1)
320 (bug #3004) fix the opac authority search
321 (bug #2998) fix search sorting containing "="
322 (bug #2996) fix and improve 100 and 105 unimarc plugins
323 (bug #2995) Set a default encoding for e-mails
324 bug 2992: don't display MARC codes in search results
325 (bug #2978) fix differents bugs in marc editor
326 bug itemtype icons interfere with location text
327 bug 2971: Fixed leak by removing drop shadow instead of hiding it.
328 Bug 2968 - SIP ACS_STATUS message (98) misreported config.
329 URLs checker enhancement (bug #2959)
330 (bug #2962) escape searchbox, and change the search from tag clouds
331 (bug #2961) add a button to add manually the next issue
332 bug 2126: reduce round-off errors in fine balance
333 (bug #2957) import Date_to_Days
334 (bug #2956) fix 4xx plugin pagination
335
336 This release is bugfix only release, and doesnot include new
337 features which would require some database changes.
338 It does add some databases changes though but only to FIX bugs.
339
340
341
342 Note that Windows is not supported for this version as there are blockers.
343
344 Note that this version is still supporting only MySQL.
345 Support for PostgreSQL is still very experimental.
346
347 New features which have deep impact on code will be available in Koha 3.2 
348 and subsequent releases.
349
350 ==============================================================================
351 UPGRADING FROM A PREVIOUS VERSION OF KOHA
352 ==============================================================================
353
354 The upgrade process from a previous version of Koha is documented on the Wiki
355 at the following page:
356
357 Upgrading from 2.2 or earlier version:
358
359 http://wiki.koha.org/doku.php?id=22_to_30
360
361 Upgrading from a previous version of 3.0:
362
363 Please consult INSTALL files for details on how to upgrade
364
365 ==============================================================================
366 TEMPLATES
367 ==============================================================================
368
369 You may have heard that the templates for Koha 3 have been re-skinned; there
370 is also the start of a template style guide on the Wiki:
371
372 http://wiki.koha.org/doku.php?id=en:documentation:templates_style_guide
373
374 Kudos to Owen Leonard and the Nelsonville Public Library for their
375 contributions!
376
377 ==============================================================================
378 TRANSLATIONS
379 ==============================================================================
380
381 Koha 3.0.2 (this release) currently has complete translations for the following
382 languages:
383
384 OPAC: ar-Arab (Arabic), da-DK (Danish), de-DE (German), el-GR (Greek), es-ES (Spanish), en (English), 
385    en-NZ (New Zealand English), fr-FR (French),
386    hu-HU (Hungarian), it-IT (Italian), nn-NO - Norwegian Nynorsk, nb-NO Norwegian (Bokmål),
387    nl-NL (Dutch), pt-PT (Portuguese), tr-TR (Turkish),
388    ru-RU (Russian), uk-UA (Ukranian)
389    
390
391 Staff Client: de-DE (German), el-EL (Greek), fr-FR (French), en (English),
392    es-ES (Spanish), it-IT (Italian), uk-UA (Ukranian),
393    
394
395 Additionally, Koha 3.0.2 (this release) has partial translations for the following
396 languages:
397
398 OPAC: am-Ethi (Amharic), bg-Cyrl (Bulgarian), fa-Arab (Persian), fi-FI (Finnish)
399    gl (Galician), he-Hebr (Hebrew), hr-HR (Croatian), hu-HU (Hungarian), id-ID (Indonesian), 
400    ja-Japn (Japanese), kn-Knda (kannada), ko-Kore (Korean), lo-Laoo (Laoo), 
401    mi-NZ (Maori), pl-PL (Polish), pt-PT (Portuguese), sv-SE (Swedish),
402    tet (Tetum), zh-Hans-CN (Simplified Chinese in China), zh-Hans-TW (Simplified Chinese in Taiwan)
403
404 Staff Client: ar-Arab (Arabic), es-ES (Spanish), hu-HU (Hungarian),
405     hy-Armn (Armenian), ja-Japn (Japanese), nn-NO - Norwegian Nynorsk, nb-NO Norwegian (Bokmål),
406     ru-RU (Russian), tr-TR (Turkish), 
407     zh-Hans-CN (Simplified Chinese in China), zh-Hans-TW (Simplified Chinese in Taiwan)
408
409 The Koha Team welcomes additional translations; please see
410 http://www.kohadocs.org/usersguide/apb.html for information about
411 translating Koha, and join the koha-translate list to volunteer:
412
413 http://lists.koha.org/mailman/listinfo/koha-translate
414
415 Note that I chose to release even though some words are still missing.
416 I apologize to translators.
417 I had proclaimed string freeze, but some strings were still untranslated.
418 You can find latest uptodate translations on Pootle : http://translate.koha.org/languages/
419 You can also ask for translation rights if you need.
420 Thank you for your patience and your work, translators.
421
422 ==============================================================================
423 DOCUMENTATION
424 ==============================================================================
425
426 User-contributed documentation for Koha 3 is available on the Koha Wiki
427 (http://wiki.koha.org). The Koha Team welcomes documentation contributions;
428 please join the Koha-devel list to volunteer:
429
430 http://lists.nongnu.org/mailman/listinfo/koha-devel
431
432 ==============================================================================
433 KNOWN ISSUES
434 ==============================================================================
435
436 Known bugs are documented on the Koha wiki: http://bugs.koha.org and at the
437 3.0 RM's QA notes Wiki page:
438
439 http://wiki.koha.org/doku.php?id=en:development:qanotes3.0