cvsimport
[moodle.git] / README.txt
1 ///////////////////////////////////////////////////////////////////////////
2 //                                                                       //
3 // NOTICE OF COPYRIGHT                                                   //
4 //                                                                       //
5 // Moodle - Modular Object-Oriented Dynamic Learning Environment         //
6 //          http://moodle.org                                            //
7 //                                                                       //
8 // Copyright (C) 1999-2004  Martin Dougiamas  http://dougiamas.com       //
9 //                                                                       //
10 ///////////////////////////////////////////////////////////////////////////
11 //                                                                       //
12 // Book module original code                                             //
13 // Copyright (C) 2004  Petr Skoda (info@skodak.org)                      //
14 //                                                                       //
15 ///////////////////////////////////////////////////////////////////////////
16 //                                                                       //
17 // This program is free software; you can redistribute it and/or modify  //
18 // it under the terms of the GNU General Public License as published by  //
19 // the Free Software Foundation; either version 2 of the License, or     //
20 // (at your option) any later version.                                   //
21 //                                                                       //
22 // This program is distributed in the hope that it will be useful,       //
23 // but WITHOUT ANY WARRANTY; without even the implied warranty of        //
24 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         //
25 // GNU General Public License for more details:                          //
26 //                                                                       //
27 //          http://www.gnu.org/copyleft/gpl.html                         //
28 //                                                                       //
29 ///////////////////////////////////////////////////////////////////////////
31 Book module for Moodle - version 1.5 (stable release)
32 ===============================================================================
33 Created by:
34       Petr Skoda (skodak) - most of the coding & design
35       Mojmir Volf         - CSS formatted printer friendly format
37 Developed for Technical University of Liberec (Czech Republic).
38 Many ideas and code were taken from other Moodle modules and Moodle itself;-)
40 Installation:
41     * see http://docs.moodle.org/en/Installing_contributed_modules_or_plugins
43 List of features - version 1.5:
45     * easy to use - new teachers can quickly create multipage study materials
46     * two levels - only chapters and subchapters
47     * possible automatic chapter numbering
48     * chapters authored in build-in HTML editor (html stored in database,
49       images in course data)
50     * printing support - all chapters can be displayed on one CSS formatted page
51     * backup/restore with internal link preservation
52     * support for global searching in study materials (see contrib/search)
53     * import from html files (relinking of images, flash, Java applets and
54       relative links)
55     * works with MySQL and PostgreSQL databases
56     * no need to move language packs any more
59 Intentionally omitted features:
61     * more chapter levels - it would encourage teachers to write too much
62       complex and long books, better use standard standalone HTML editor and
63       import it as Resource. DocBook format is another suitable solution.
64     * TOC hiding in normal view - instead use printer friendly view
65     * PDF export - there is no elegant way AFAIK to convert HTML to PDF,
66       use virtual PDF printer or better use DocBook format for authoring
67     * detailed student tracking (postponed till officially supported)
68     * export as zipped set of HTML pages - instead use browser command
69       Save page as... in print view
71 Future:
72     * I like eXe editor, I would like to improve Book in this direction ... ;-)
74 CHANGELOG:
75 == 1.1RC1 - 2004/11/15 =======================================================
76     * compatible ONLY with 1.4.2 and later !!!
77     * added sesskey for enhanced security
78     * navigation links do not enter hidden chapters
79     * import - correct linking when slasharguments are off
80     * removed coursefiles.php
81 == 1.1    - 2005/01/01 =======================================================
82     * compatible ONLY with 1.4.3 and later!
83     * removed some unused searching stuff
84     * fixed headers in print.php
85 == 1.2RC - 2005/07/13 ==========================================================
86     * compatible with 1.5.1 + only
87     * improved restore
88     * fixed selection of directories for import
89     * html editor for summary
90     * fixed postgresql upgrade
91     * no need to move language packs
92 == 1.2 - 2006/03/11 ==========================================================
93     * removed 64kB page content limit in mysql
94     * exit button now goes to course section anchor
95     * chater title now in browser title bar
96     * added translations be and sv
97     * during import chapters with names "*_sub.htm?" are imported as subchapters
98     * deleting in import selection windows now works
99     * last version before transition to 1.6
100 == 1.3alpha - 2006/03/12 ======================================================
101     * compatible with 1.6dev only, use previous version for 1.5.x
102     * unicode upgrade supported - not much tested
103     * backup fixes - from Penny Leach, thanks!
104     * all languages converted to utf-8
105     * moved to contrib/book_16 directory
106     * added proper content encoding conversion during import
107 == 1.4alpha - 2007/05/20 ====================================================
108     * compatible with 1.8
109     * export link enabled - thanks Eloy!
110     * no new features
111 == 1.5beta - 2008/08/14 ====================================================
112     * compatible with 1.9.1 and above
113     * xhtml strict and css improvements
114     * formslib conversion
115     * capabilities implemented
116     * no new features
117 == 1.5 2009/11/11 ============================================================
118     * minor cleanup
119     * new Slovenian language pack - thanks Mitja Podreka
120     * updated German Language pack - thanks Ralf Hilgenstock 
122 skodak