$Id: README.txt,v 1.12 2005/01/01 23:18:04 skodak Exp $

///////////////////////////////////////////////////////////////////////////
//                                                                       //
// NOTICE OF COPYRIGHT                                                   //
//                                                                       //
// Moodle - Modular Object-Oriented Dynamic Learning Environment         //
//          http://moodle.org                                            //
//                                                                       //
// Copyright (C) 1999-2004  Martin Dougiamas  http://dougiamas.com       //
//                                                                       //
///////////////////////////////////////////////////////////////////////////
//                                                                       //
// Book module original code                                             //
// Copyright (C) 2004  Petr Skoda (petr.skoda@vslib.cz)                  //
//                                                                       //
///////////////////////////////////////////////////////////////////////////
//                                                                       //
// This program is free software; you can redistribute it and/or modify  //
// it under the terms of the GNU General Public License as published by  //
// the Free Software Foundation; either version 2 of the License, or     //
// (at your option) any later version.                                   //
//                                                                       //
// This program is distributed in the hope that it will be useful,       //
// but WITHOUT ANY WARRANTY; without even the implied warranty of        //
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         //
// GNU General Public License for more details:                          //
//                                                                       //
//          http://www.gnu.org/copyleft/gpl.html                         //
//                                                                       //
///////////////////////////////////////////////////////////////////////////

Book module for Moodle - version 1.1 (stable release)
===============================================================================
Created by:
      Petr Skoda (skodak) - most of the coding & design
      Mojmir Volf         - CSS formatted printer friendly format

Developed for Technical University of Liberec (Czech Republic).
Many ideas and code were taken from other Moodle modules and Moodle itself;-)

Installation:
    1/ upgrade your Moodle installation to version 1.4.3 or later
       (you are advised to install latest official stable 1.4.3+ branch)
    2/ download book.zip to your moodle/mod directory and unzip it there
    3/ move moodle/mod/book/lang to moodle/lang
    3/ go to http://yoursite.com/admin - all necessary tables will be created


List of features - version 1.0:

    * easy to use - new teachers can quickly create multipage study materials
    * two levels - only chapters and subchapters
    * possible automatic chapter numbering
    * chapters authored in build-in HTML editor (html stored in database,
      images in course data)
    * printing support - all chapters can be displayed on one CSS formatted page
    * backup/restore with internal link preservation
    * support for global searching in study materials (see contrib/search)
    * import from html files (relinking of images, flash, Java applets and
      relative links)
    * works with MySQL and PostgreSQL databases


Intentionally omitted features:

    * more chapter levels - it would encourage teachers to write too much
      complex and long books, better use standard standalone HTML editor and
      import it as Resource. DocBook format is another suitable solution.
    * TOC hiding in normal view - instead use printer friendly view
    * PDF export - there is no elegant way AFAIK to convert HTML to PDF,
      use virtual PDF printer or better use DocBook format for authoring
    * detailed student tracking (postponed till officially supported)
    * export as zipped set of HTML pages - instead use browser command
      Save page as... in print view


Preliminary plans for version 2.0:

    * IMS/SCORM packaging for export
    * internal structure change
    * layout templates
    * collapsible toc


CHANGELOG:
== 1.1    - 2005/01/01 =======================================================
    * compatible ONLY with 1.4.3 and later!
    * removed some unused searching stuff
    * fixed headers in print.php
== 1.1RC1 - 2004/11/15 =======================================================
    * compatible ONLY with 1.4.2 and later !!!
    * added sesskey for enhanced security
    * navigation links do not enter hidden chapters
    * import - correct linking when slasharguments are off
    * removed coursefiles.php


skodak
