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