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