CONTRIB-22 removed outdated installation instructions
[moodle.git] / README.txt
1 $Id: README.txt,v 1.4 2008/07/22 14:56:49 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.1 (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 List of features - version 1.2:
44     * easy to use - new teachers can quickly create multipage study materials
45     * two levels - only chapters and subchapters
46     * possible automatic chapter numbering
47     * chapters authored in build-in HTML editor (html stored in database,
48       images in course data)
49     * printing support - all chapters can be displayed on one CSS formatted page
50     * backup/restore with internal link preservation
51     * support for global searching in study materials (see contrib/search)
52     * import from html files (relinking of images, flash, Java applets and
53       relative links)
54     * works with MySQL and PostgreSQL databases
55     * no need to move language packs any more
58 Intentionally omitted features:
60     * more chapter levels - it would encourage teachers to write too much
61       complex and long books, better use standard standalone HTML editor and
62       import it as Resource. DocBook format is another suitable solution.
63     * TOC hiding in normal view - instead use printer friendly view
64     * PDF export - there is no elegant way AFAIK to convert HTML to PDF,
65       use virtual PDF printer or better use DocBook format for authoring
66     * detailed student tracking (postponed till officially supported)
67     * export as zipped set of HTML pages - instead use browser command
68       Save page as... in print view
70 Future:
71     * I like eXe editor, I would like to improve Book in this direction ... ;-)
73 CHANGELOG:
74 == 1.1RC1 - 2004/11/15 =======================================================
75     * compatible ONLY with 1.4.2 and later !!!
76     * added sesskey for enhanced security
77     * navigation links do not enter hidden chapters
78     * import - correct linking when slasharguments are off
79     * removed coursefiles.php
80 == 1.1    - 2005/01/01 =======================================================
81     * compatible ONLY with 1.4.3 and later!
82     * removed some unused searching stuff
83     * fixed headers in print.php
84 == 1.2RC - 2005/07/13 ==========================================================
85     * compatible with 1.5.1 + only
86     * improved restore
87     * fixed selection of directories for import
88     * html editor for summary
89     * fixed postgresql upgrade
90     * no need to move language packs
91 == 1.2 - 2006/03/11 ==========================================================
92     * removed 64kB page content limit in mysql
93     * exit button now goes to course section anchor
94     * chater title now in browser title bar
95     * added translations be and sv
96     * during import chapters with names "*_sub.htm?" are imported as subchapters
97     * deleting in import selection windows now works
98     * last version before transition to 1.6
99 == 1.3alpha - 2006/03/12 ======================================================
100     * compatible with 1.6dev only, use previous version for 1.5.x
101     * unicode upgrade supported - not much tested
102     * backup fixes - from Penny Leach, thanks!
103     * all languages converted to utf-8
104     * moved to contrib/book_16 directory
105     * added proper content encoding conversion during import
106 == 1.4alpha - 2007/05/20 ====================================================
107     * compatible with 1.8
108     * export link enabled - thanks Eloy!
109     * no new features
111 skodak