Merge remote-tracking branch 'kc/new/bug_5449' into kcmaster
[wip/koha-chris_n.git] / misc / release_notes / release_notes_220.txt
1 RELEASE NOTES
2 =============
3
4 Koha is the 1st Open-Source Integrated Library System.
5 Released at first in New zealand, in 2000 januaray, it is maintained by a team of volunteers from around the globe, the Koha system is a full catalogue, opac, circulation and acquisitions system.
6
7 Koha 2.2 is more than 247 000 lines of code, developped by more than 30 differents developpers (excluding translators).
8
9 With the 2.2 version, Koha is now a mature product, with a lot of nice features. It's used in more than 50 libraries, from all kinds (public, schools, search, religious...), of all size (from 1 to 8 branches, from 1000 to 300 000 items).
10
11 ========
12 WARNINGS
13 ========
14 * the librarian interface is tested only with mozilla/firefox. Should work (partially) with IE. OPAC should work fine with any navigator.
15 * Any 2.1.x install must be uninstalled before installing 2.2.0 No update is provided for 2.1.0.
16
17 =======
18 DIFFS
19 =======
20
21 Diff 2.2RC5 => 2.2.0
22 ********************
23 BUGFIXES
24
25 ***** Critical
26 * rolling back lock_tables_privs = 'Y' during install stage (too many problems) The option is shown in bulkmacimport instead.
27 * bugfix for the search on a MARC detail, when you clic on the magnifying glass (caused an internal server error)
28
29 ***** Minor
30 * error in authority => biblio 'jumper' that make the jump fail (was a remaining ')
31 * when modifying a biblio, on a repeated field with many subfields, the test to show empty subfields in X>1 was wrong : the missing subfields of the 1st field were repeated.
32 Example :
33 606 has $a$x$z
34 1st is 606$a (so $x$z empty)
35 2nd is 606$a$x
36 The marc editor in the 2nd field showed before this fix :
37 606 $a a_value
38    $x another_value
39    $x
40    $z
41 (the 2nd $x being useless)
42 * Authorities : Minor changes in summary "exploding" (the 3 digits AFTER the subfield were not on the right place).
43 * partial support of the "linkage" MARC feature : if you enter a "link" on a MARC subfield, the magnifying glass won't search on the field, but on the linked field. I agree it's a partial support. Will be improved, but I need to investigate MARC21 & UNIMARC diffs on this topic.
44 IMPROVEMENTS
45
46 ***** Major
47 * New systempref parameter : opacstylesheet If this parameter is set to a stylesheet URL, this stylesheet will be used instead of the opactheme one. With this parameter, you can have your own stylesheet for OPAC, that will be used and kept when you update your version of Koha. The systempref must be a complete URL (http://www.koha.org/stylesheet/somestylesheet.css for example)
48 * improvements in shelves management in OPAC (synch'ing with librarian interface) : the user can modify a bookshelf, add a book into a bookshelf from the biblio, create a bookshelf "on the fly", from the bookshelf popup.
49 * new directory migration_tools in $KOHA/misc Will store various migration tools. bulkmarcimport has been moved here.
50
51 **** Minor
52 * minor change in MARCdetail : when a field is repeated, the field header is not repeated but replaced by a nice little empty space.
53
54 Diff 2.2RC4 => 2.2RC5
55 *********************
56
57 BUGFIXES
58
59 ***** Critical
60 * limiting the number of search term to 8. There was no limit before, but 8 words seems to be the upper limit mySQL can deal with (in less than a second. tested on a DB with 13 000 items) In 2.4, a new DB structure will highly speed things and this limit will be removed. FindDuplicate is activated again.
61 * bugfixes in french translation (that made cataloguing in french impossible)
62 * set lock_tables_privs = 'Y' during install stage. Note this requires a mysql version not too old.
63
64 ***** Minor
65 * during update, if the user enter a different directory for backup than the default one, the updater does not obey and stores in default directory anyway !
66 * minor (spelling) fix for adding an organization
67 * member search (bug 851) : stripping out comma and apostrophe from search terms
68 * various methods to split subjects (depending on OS, a <CR> / <CR><LF> problem)
69
70 IMPROVEMENTS
71
72 ***** Major
73 * circulation / issue : adding a button to cancel an issue when a confirmation is required (bug #858)
74 * circulation / issue : adding a checkbox to confirm reserve cancel when a reserved book is issued by someone else (bug #858)
75 * virtual shelves : adding feature to create a virtual shelf on the fly, when adding a biblio, and feature to modify a virtual shelf name/status
76 * catalogue : adding a systempref to define default view in OPAC (either normal, MARC or ISBD). Created automatically during install or update. Check that you have a Koha >> parameters >> systempreferences >> BiblioDefaultView, Variable type : Choice, Variable options : normal|marc|isbd
77
78 **** Minor
79 * an improvement has been done in DB calls that needs a new index. It's automatically added in fresh installs, but for updates, run the following SQL command :
80 ALTER TABLE `marc_subfield_structure` ADD INDEX ( `kohafield` ) 
81 * adding a systempref to define default view in OPAC (either normal, MARC or ISBD). Created automatically during install or update. Check that you have a Koha >> parameters >> systempreferences >> BiblioDefaultView, Variable type : Choice, Variable options : normal|marc|isbd
82 * the list of authorities types is now ordered by authtypetext. Thus you can use the "space trick" : if you add a space before an authtype text, it's shown first. Useful when you have an authority type that you use more often than others.
83 * authoritiy list shown in authtypetext order (so authtypetext with a space appear first, hint used everywhere else for lists)
84 * some minor html changes (like changing "images" numbers in "text" numbers for result list page numbers.
85
86 Diff 2.2RC3 => 2.2RC4
87 *********************
88 BUGFIXES
89
90 ***** Critical
91 1 CRITICAL bug in acquisition (another one...) : when MARC=ON, and an order line is created from an existing biblio (to buy another item), the MARC biblio is lost and replaced by the non marc one (that has a lot less informations...). To solve the problem, the biblio can no more be modified after the order has been placed. Less feature, but more reliable ! (not simple solution to solve this problem. Would imply to rewrite the MARC biblio from the non marc datas, and no API is provided for this yet)
92 2 CRITICAL bugfix in Biblio.pm, removing &branches declaration (was due to an untested cvs rollback, opac-search.pl was crashing)
93 3 CRITICAL bugfix in Biblio.pm when MARC=OFF. subjects were stored and immediatly deleted. And not stored correctly in MARC part of the biblio. (thanks to Waylon Robertson)
94
95 ***** Minor
96 1 bugfix in updatedatabase (auth_header creation table). Don't affect previous install of 2.2, only upgrades 2.0 => 2.2
97 2 reading rec : Fixing link to toggle between full and limited display
98 3 bugfix for moremember.pl that no longer outputed item type for issues
99 4 defaulting actual cost to estimated cost (was 0 by default)
100 5 bugfix : in biblio search, - and other signs where not properly managed. Leroy-Beaulieu could not be found
101 6 the popup of the 210c plugin closes when a collection is choosed
102 7 bugfix : could not select a biblio in subscription creation if the book was not for loan
103 8 minor fixes in spelling in subscription
104 9 adding acquisition in default userflags. This flag can be set for librarians that have access to acquisition
105 10 in subscription enddate calculation, bugfix when subscription based on number of issues (worked when based on subscription length)
106 11 in subscription next issue date calculation, bugfix when subscription frequency is 1/quarter.
107 12 datelastseen is updated when the book is returned
108 13 moredetail.pl shows incorrect date, incorrectly formatted (bug #689)
109 14 DuplicateFinder has been disabled : sometimes goes into a looonnnggg lasting loop.
110 15 when a query returns only one result, adding it to basket did not work.
111 16 deletion of a suggestion was buggy. Now fixed
112 17 for installation of Koha under Windows there is a bug with subject splitting. Now fixed. (thanks to Waylon Robertson)
113
114 IMPROVEMENTS
115 ***** Major
116 1 a lot in book shelves
117 2 Submitting with no barcode in issues should clear for next patron (bug #865)
118 3 screen added to see late issues from a given bookseller
119 4 Koha should now work under mod_perl (Release Manager don't use mod_perl. fixes comes from A. Tarallo, Argentina, that ensure Koha works fine with mod_perl with the patches applied)
120
121 **** Minor
122 1 show also item tags into marc list of fields (in librarian search interface)
123 2 email sent basket : the sender can give it's name, in case the basket is sent to a friend, not to itself
124 3 removing useless string in isbd view
125 4 cataloguing, in isbnsearch, after searching a title/ISBN, the librarian can choose the framework (+ it's a cataloguing screen, not an acquisition one)
126 5 serials : in issues management, the waited/late issues bloc is before the collection state bloc.
127 6 serials : the intranet note has been removed, it's useless
128 7 after an authority is added/modified, go to this fresh authority (instead of authority-home)
129 8 search option in auth-top
130 9 in OPAC, the itemcallnumber search is a "start by" search (was a contains)
131 10 opac note is defaulted to '' (was 0, that means nothing)
132 11 adding blank to relshiploop (altrelationship) loop (Bug ???)
133 12 when deleting an itemtype, don't check issuingrules, but delete them too
134 13 For MARC=OFF installation, Waylon submitted a script to rebuild MARC part of the catalogue. It's in misc/updatemarc_subjects.pl (thanks to Waylon Robertson)
135
136 Diff 2.2RC2 => 2.2RC3
137 *********************
138 * CRITICAL bug in acquisition : biblio badly stored in MARC part of Koha, deleting another biblio...
139 * CRITICAL problem : the duplicate finder (when adding a biblio) has performances problems under certains circumstances.
140 * bug #862 fixed : Upgrade does not work (from 2.2RC1 to 2.2RC2)
141 * bugfix in acquisition, when a line is modified, aqorderbreakdown was duplicated. (Seems it was a mysql return value depending on mysql version)
142 * bugfix in setting user permissions (they were stored, but not shown correctly after)
143 * bugfix in translation error for basket sent in OPAC
144 * bugfix in 225a plugin (editor chooser)
145 * adding itemcallnumber entry in systempreferences during install
146 * error in biblio detail showing when MARC=ON (bug from RC2, did not exist before)
147 * bug in acceptorreject OPAC suggestion (bug from RC2, did not exist before)
148 * Not really a bug but : stopword must not be empty. If it's empty, the search fail.
149 * During install, the user can load french and english stopwords if he want.
150 * French librarian interface seems OK
151 * addbook (1st page when MARC=ON) is a catalogue screen, not an acquisition one
152 * The barcode is shown in the list of books issued by a borrower in opac-user page.
153
154 Diff 2.2RC1 => 2.2RC2
155 *********************
156 * bugfix for import in reservoir : title and isbn where not extracted.
157 * bugfix in OPAC : it was possible to reserve books that where "notforloan"
158 * bugfix in circulation : no warning when a reserve was made on a book that you try to issue to someone else. 
159 * bugfix & improvement for catalogue management behaviour when MARC=OFF
160 * bugfix in bookshelves (in CVS, probably not in official tar.gz)
161 * bugfix in online help (in CVS, probably not in official tar.gz)
162
163 =============
164 INSTALLATION
165 =============
166 * Download the package
167 * tar xvfz koha-version.tar.gz
168 * cd koha-version
169 * ./installer.pl
170 * READ and FOLLOW the instructions
171
172 READING what is on screen during installation is VERY important. Some decisions you make during install stage are very hard to reproduce after.
173
174
175 UPGRADE from previous 2.0.0preX or RCx version
176 *******
177 * Download the package
178 * tar xvfz koha-version.tar.gz
179 * cd koha-version
180 * ./koha.upgrade
181 * Follow the instructions
182
183 UPGRADE from previous 1.2.x version :
184 ********
185 UPGRADE TO A 2.0.0 version before upgrading
186
187 UPGRADE from a 2.1.x version is NOT AVAILABLE. Don't install 2.2 on a 2.1.x test database. A lot of DB changes have been done since 2.1.x & cannot be handled by the DB updater.
188
189 =============
190 NEW FEATURES
191 =============
192 Koha 2.2 has, of course, all the previous features from Koha (acquisition, cataloguing, circulation, members modules, OPAC, complete MARC support...) plus the following new ones :
193
194 General :
195 *********
196 * (almost) complete rewrite of librarian GUI : now Koha uses CSS, and is easier to use. However, users of Koha 2.0.0 won't be lost, as the general organisation of the product has not changed.
197 * Online Help : an online help is available everywhere in the librarian interface. It's complete in the parameters section of Koha and for new features. It will be completed for the rest of the product.
198 * Better LDAP suport : Koha 2.2 can be "connected" to a LDAP server and get all borrower informations from there (including borrower category where applicable). However, to avoid problems for libraries without LDAP server, the LDAP features have been stored in modules/C4/Auth_with_ldap.pm file. The standard Auth.pm don't use it. If you want LDAP, just perldoc Auth_with_ldap.pm and manually tune your Auth package !
199 * Auto installer : if you install koha with ./install -i /path/to/auto_install_file, then Koha will be installed almost without question. A very usefull feature for developpers that want to install/uninstall Koha quite often. A sample of auto_install_file is provided in misc/auto_install_file.
200 * Uninstaller : run misc/uninstall.pl, provide the mysql root password. that's all. Koha is completely deleted and can be reinstalled. With the previous feature, it's a very nice solution for test platform.
201 * mod_perl : Koha should now work under mod_perl, that gives a big performance boost (Release Manager don't use mod_perl. fixes comes from A. Tarallo, Argentina, that ensure Koha works fine with mod_perl with the patches applied)
202 * Nelsonville have shared their templates. They are available as NPL theme.
203 * Language : in this version, only english and french versions are fully functionnal. Spanish and chinese are provided, but not fully functionnal. Polish, German, Arabic, Hebrew, and many other languages have volunteers and should be here in a future 2.2.x
204
205
206 BE CAREFUL with uninstaller : 
207 1- This script does not ask for confirmation after mysql root password.
208 2- This script uses /etc/koha.conf. If you have more than 1 koha on your server, use /etc/koha.conf for a "deletable-test" one.
209
210 Acquisition :
211 *************
212 * suggestion : borrowers can suggest items to buy in OPAC. Then, the librarian can manage (accept or refuse) and order them.
213 * possibility to close a basket, he can't be modified then
214 * order a basket by publisher or by bookfund/publisher
215 * search order history
216
217 Cataloguing :
218 *************
219 * Cataloguing frameworks : you can define as many frameworks as you want. A framework describes how a material is catalogued (which fields, subfields, which constraints on them...)
220 * MARC authorities : Koha now supports authorities in MARC. You can define the MARC structure for authorities like for biblios.
221 * New contraints can be set for subfields :
222   - subfield is hidden : appears in MARC editor, but not in OPAC.
223   - subfield is an URL : the field can be cliqued
224   - related fields : a search made on a subfield also uses other subfields automatically. Using this feature, a search on "title" can search title, but also subtitle, uniform title,...
225 * Item location can now be done on 3 levels : the branch, the location (room), the callnumber.
226 * The callnumber can now be calculated from the LC, the dewey, or be freely (and manually) entered.
227 * Duplicate finder : this powerful feature help your cataloguers avoiding duplicate biblios.
228 * ISBD view : in librarian interface as well as in OPAC biblios can be shown in standard (default) presentation, in MARC (human readable) or ISBD. The ISBD view can be tuned by the librarian team. There is also a systempref to define default view in OPAC (either normal, MARC or ISBD). Created automatically during install or update. Check that you have a Koha >> parameters >> systempreferences >> BiblioDefaultView, Variable type : Choice, Variable options : normal|marc|isbd
229 * UNIMARC plugin for every 1xx fields : ESNMP have developped all the plugins for UNIMARC fields 1xx. Those fields are coded fields.
230
231 Serial cataloguing :
232 ********************
233 Koha 2.2 manage serial subscriptions and issuing of those subscriptions. (Only a few words to describe a very important & complete module !)
234
235 Catalogue search :
236 ******************
237 * Search in OPAC and librarian interface has been improved. They now are exactly the same.
238 * Spelling suggestion : before sending a request, the user can ask for spelling suggestion. This shows other forms of words entered that would give results. Give poor results for instance, the Koha team is thinking to a true spellchecking.
239 * The user can select the order of the results and the number of results shown.
240
241 Members :
242 *********
243 * The borrowernote field is shown on issue and transfer.
244 * The textmessaging field appears in OPAC when the user logs in.
245
246 Circulation :
247 *************
248 * New issuing rules : Issuing can be set for branch / borrower type / item category, by number of days and number of items available.
249 * "joker" issuing rules : the library can set issuing rules for "any branch" or "any borrower type", or "any item category".
250 Both issuing rules are cumulative : a library can set issuing rules to 10 books, 5 CD, but 12 total (books or CD).
251
252 OPAC :
253 ******
254 In Koha 2.2, koha has :
255 * baskets. A basket can be printed or sent by mail to the borrower
256 * virtual shelves : a virtual shelf can be created and filled by any logged borrower. A given virtual shelf can be private or public. Or even free-for-all.
257 * language chooser : the borrower can change the language on the fly. The default language being still choosen by the library
258 * complete CSS definition. With a new systempref parameter : opacstylesheet. If this parameter is set to a stylesheet URL, this stylesheet will be used instead of the opactheme one. With this parameter, you can have your own stylesheet for OPAC, that will be used and kept when you update your version of Koha. The systempref must be a complete URL (http://www.koha.org/stylesheet/somestylesheet.css for example)
259
260 Barcode printing :
261 ******************
262 A new module has been added to the parameters section : barcode printing. It requires the PDF::Api2 Perl package and can print barcode on 
263
264 ============
265 Koha Future
266 ============
267 The future of Koha is being discussed on mailing lists and on koha wiki : http://www.saas.nsw.edu.au/koha_wiki/index.php?page=KohaRoadmap2.2.x