Merge remote-tracking branch 'kc/new/bug_5449' into kcmaster
[wip/koha-chris_n.git] / misc / release_notes / release_notes_210.txt
1 RELEASE NOTES
2 =============
3 (HELP NEEDED chapter at the end of document)
4
5 ROADMAP : 
6 A roadmap for Koha 2.2 is available here :
7 http://www.saas.nsw.edu.au/koha_wiki/index.php?page=KohaRoadmap
8
9
10 This is the 1st UNSTABLE VERSION of the future Koha 2.2.
11 Please install this version only if you want to test and give some help to the team that develops this software.
12 NEVER, NEVER, NEVER use it on a production machine.
13
14 WARNING : 
15 * This version is ONLY available in ENGLISH. biblio frameworks are only available in UNIMARC - french.
16 * This version is tested only with mozilla. Should work (partially) with IE.
17 * NO waranty is given that the updater will work from 2.1.0 to 2.1.1 or later version. Only stable release can be updated.
18
19 INSTALLATION
20 * Download the package
21 * tar xvfz koha-version.tar.gz
22 * cd koha-version
23 * ./installer.pl
24 * Follow the instructions
25
26
27 UPGRADE from previous 2.0.0preX or RCx version
28 * Download the package
29 * tar xvfz koha-version.tar.gz
30 * cd koha-version
31 * ./koha.upgrade
32 * Follow the instructions
33
34
35 UPGRADE from previous 1.2.x version :
36 UPGRADE TO A 2.0.0 version before upgrading to 2.1.0
37 This will be mandatory for the 2.2 official release.
38
39 DEVELOPPERS :
40 * Paul POULAIN (2.2 release manager)
41 * Jean BARON
42 * Owen LEONARD
43 * Chris CORMACK
44
45 ============
46 WHAT'S NEW
47 ============
48 1 Auto installer
49 ****************
50 If you install koha with ./install -i /path/to/auto_install_file, then Koha will be installed almost without question.
51 A very usefull feature for developpers that want to install/uninstall Koha quite often.
52 A sample of auto_install_file is provided in misc/auto_install_file.
53
54 2 Uninstaller
55 *************
56 run misc/uninstall.pl, provide the mysql root password.
57 that's all. Koha is completely deleted and can be reinstalled.
58 With the previous feature, it's a very nice solution for test platform.
59 BE CAREFUL : 
60 1- This script does not ask for confirmation after mysql root password.
61 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.
62
63 3 biblio frameworks
64 *******************
65 You didn't know it, but Koha 2.0 had already 1 framework for cataloguing biblios...
66
67 It mean you could completly define the look of the MARC editor : which fields, where, and what they did (fields constraints)
68 In Koha 2.2 you will be able to have as many framework as wanted : 1 for simple monography, 1 for complete monography, 1 for multimedia document... you could even have "1 used by Mary, 1 used by John", even if this seems silly.
69
70 In this release, biblio frameworks works fine. pls test them.
71 In the installer, you will have the possibility to add frameworks for french UNIMARC : monographies, cdroms, old-text, serial, cartography.
72
73 4 MARC authorities
74 ******************
75 Authorities in 2.0 where really poor. In 2.2, Koha will provide a complete MARC support for authorities.
76 In 2.1.0 authorities are only in "alpha" state. You can define authority types, the structure of the authority, exactly like for biblios frameworks.
77 You can also add authorities, do some searches.
78 However, you still can't connect an authority to a biblio. Will be in 2.1.1
79
80 5 Call number
81 *************
82 A lot of american people requested this feature ;-)
83 Call number is now stored in the item.
84 There is also a new parameter in the systempref parameters, called "itemcallnumber".
85 you can enter here a field/subfield that will automatically be reported into the call number field of the item.
86 If you enter the dewey field, the call number will be dewey
87 If you enter the LoC field, the call number will be LoC
88 If you enter something else, the call number will be something else.
89 If you enter nothing, the call number will be empty.
90 Better, you alway can modify the default call number.
91
92 6 suggestions
93 *************
94 Suggestions are defined in the wiki : 
95 http://www.saas.nsw.edu.au/koha_wiki/index.php?page=SuggestionFeatures
96 In 2.1.0, a partial suggestion module is available in OPAC. Nothing yet in librarian interface.
97
98 7 circulation
99 *************
100 Circulation has been heavily rewritten...
101 * a new circulation rules table has been created : issuingrules. Issuingrules can be defined for each itemtype/borrowertype/borrowerbranch. Issuingrules define issuing length, issuing quantity and reservation constraints. You can define rules with *, meaning "anything". For example itemtype=*, borrowertype=student,borrowerbranch=A 10,10 means " a student can issue up to 10 any-item for up to 10 days". Such rules must be validated with more precise rule.
102 You can define rules like : "up to 2 CDROM, up to 10 books, max 10 items".
103 * circulation works now like this (internally) :
104 - get borrower cardnumber & item number
105 - check "can book be issued". This sub (canbookbeissued) checks everything. For each problem, 2 arrays can be set up : MUSTCONFIRM and IMPOSSIBLE. MUSTCONFIRM entries needs a librarian confirmation before effective issuing. IMPOSSIBLE entries makes the issue impossible. It's now very easy to alter issuing rules for a given library (with a developper), as every test is heavily documented & in  a single sub.
106 - if >=1 IMPOSSIBLE entry : issuing is impossible, show why.
107 - if >=1 MUSTCONFIRM : show problems, and ask for confirmation.
108 - if both are empty : issue.
109
110 8 online help
111 *************
112 An Online Help will be provided in 2.2 it will be available by clicking on "Help" button anywhere in Koha.
113 The problem is... to write help screen... help needed here, see below.
114
115 9 various views in OPAC & librarian interface
116 *********************************************
117 3 views are available in OPAC and in librarian interface.
118 * MARC view as in 2.0 (was not in OPAC). The view has been improved, with tabs on the left. Only tabs with something in will are shown.
119 * standard view, as in 2.0.
120 * ISBD view : the ISBD view is defined in the systempref parameters (field ISBD) The syntax of this view is the following :
121
122 Tag/subfields are enclosed by [] and can have up to 3 digits BEFORE, and up to 3 digits AFTER the subfield. For example [200a / ]["200f"]
123 You can add anything you want outside []. It will be let as it.
124 Note repeatable fields/subfields are poorly handled and this syntax could change in 2.1.1
125
126 10 new look in librarian interface
127 **********************************
128 Librarian interface is almost completly css'ed. Some minor improvements to get more valid & clean HTML.
129
130 11 code cleaning
131 ****************
132 Many useless things have been removed. This will continue as long as needed.
133
134 12 UNIMARC plugin for every 1xx fields
135 **************************************
136 ESNMP have developped all the plugins for UNIMARC fields 1xx. Those fields are coded fields.
137 Should be used for MARC21 with some work. We need volunteers here.
138
139 ==============
140 HELP NEEDED
141 ==============
142 We alway accept new developpers wanting to code or test features of the Roadmap.
143 We still can accept features not in the RoadMap if :
144 - strongly supported/coded by someone.
145 - compatible with other features.
146 - can be planned for end of 2004Q3.
147
148 IF YOU VOLUNTEER, PLEASE :
149 - subscribe koha-dev mailing list.
150 - announce in the list you are volunteer, and what you are volunteer for.
151
152 * writing online help
153 *********************
154 Writing online help can be done from Koha 2.0 and with the help of the wiki.
155 - When you surf on a page named : my.koha.server.org/cgi-bin/koha/path/to/script.pl?anyparameters=X&otherparameter=Y
156 - a help page must be written for path/to/script.pl
157 - That's as simple as this. The same page is used for every action on the same page. The page does not need HTML tags, they are automatically added. so, you can write simple text on the wiki : http://www.saas.nsw.edu.au/koha_wiki/index.php?page=OnlineHelp
158 See the ItemTypes sample in http://www.saas.nsw.edu.au/koha_wiki/index.php?page=AdminHelp.
159
160 volunteers : Nelsonville (USA) & Irma Birchall (AUS)
161 Once written, they will be translated.
162
163 * provide MARC21 frameworks.
164 Frameworks have to be defined to be choosable at installation stage. The idea being to have as many frameworks as possible to give the newbie a Koha as nice as possible with as little work as possible.
165
166 * provide MARC21 authority file.
167 Same as for MARC21 frameworks. Except we don't have authority structure for MARC21 (we have for UNIMARC in french, thanks to ENSMP)
168
169 * provide ISBD for MARC21 
170 (ISBD for UNIMARC is being done, thanks to doXulting)