--------------------------------------------------
                   XLML eXtended Logical Markup Language Version 1.2
                           Patch for ILIAS open source 2.3.6
                       Works also with XLML 1.1 generated courses
                   --------------------------------------------------

INSTALLATION
------------

1. 
Make a backup of your ILIAS installation directory and of your ILIAS database.

2. 
Copy the contents of the ilias-patch directory to your ILIAS installation
directory (overwrite existing files). 

Note: The web server needs only read permissions on the copied files.

3. 
Change to the ILIAS installation directory and execute the following command
to modify the ILIAS database.

* To install the patch for the first time:

mysql ilias < sql/template/ilias.database-xlml.sql 

* To upgrade from the patch for XLML 1.0:

mysql ilias < sql/template/ilias.database-xlml-upgrade.sql 


Note: You may need to specify the full path for the mysql command, use
another database than ilias or add parameters for username and passwords
according to your ilias installation.

To upgrade from ILIAS 2.2.2 with XLML 1.0: 
- first upgrade to ILIAS 2.3.6 
- then apply this patch with ilias.database-xlml-upgrade.sql.

To upgrade from ILIAS 2.2.2 - ILIAS 2.3.5 with XLML 1.1: 
- first upgrade to ILIAS 2.3.6
- then apply this patch without database modification.


PREPARE ILIAS
-------------
(This is not needed if you upgraded from an earlier XLML patch.)

1.
Create a directory "xlml-demo" directly under your web server's DOCUMENT_ROOT
and give the web server write permissions to that directory.

This directory is called the "project directory". An XLML project is a set of 
courses that link each other. You can use several projects within an ilias
installation, each having an own project directory in the web server's 
DOCUMENT_ROOT. 

2.
On the ILIAS administration page, choose the templates for learning modules 
and activate the templates "xlmlframe" and "xlmlframe2".

3.
Create a closed user group with purpose for learning modules and remember the 
ID of that group. The first user group (after the sys groups) normally has
the ID 5. You can see the group ID in the URL of the group functions (e.g.
g_id=5).

4.
On the ILIAS administration page, choose "XLML Courses". Then choose "Project
list" and "Add new project". Enter at least the project name (= project
directory) and set the correct owner group ID as defined in 3.


PREPARE A COURSE
----------------

For the use in ILIAS an XLML course must satisfy the following requirements:

1.
The first page must be a single flow, containing only a <TableOfContens>. This
page will be replaced by the dynamic table of contents in ILIAS.

2.
When you create the course on Windows, take care with the names of linked
files. Special characters or wrong cases may fail on UNIX servers. You should
activate the config parameter "fileRefPattern" in xlmlgen.ini, to enable 
checking of filenames by XlmlGen.

3.
The normal (offline) version of the course should be generated without errors.  

4.
The version for ILIAS must be generated with special configuration options set
by 
	config\xlmlgen-ilias.ini 

in the XLML installation directory. To generate a course with this config file,
copy the config\skel\make-ilias.bat (or .sh) to your course directory and 
execute it. XlmlGen now creates an ILIAS-prepared ZIP file in your course 
directory while the content folder of your course remains untouched.  

Note1:
You need to adapt the xlmlgen-ilias.ini file if you haven't used the default 
values at your ILIAS installation and preparation:

- Replace all occurrences of "ilias" with the URL path of your ILIAS directory.
- Replace all occurrences of "xlml-demo" with the desired project directory.
- Replace www.xlml-demo.com with your web server running ILIAS.

Note2:
The URL checker will report errors for the ILIAS-prepared links, but these can
be ignored if the offline version is created without errors. However, on some 
Windows platforms the generation for ILIAS will abort with an error reporting 
that the lower and upper case of a temporary path is invalid. In such a case 
please set the environment variable TMP in correct case to a valid path
that should not contain any space or special char, e.g.:

SET TMP=C:\WINNT\Temp

You may do this at the beginning of the xlml.bat in the XLML installation 
directory, e.g. c:\xlml\xlml.bat.


IMPORT A COURSE
---------------

On the ILIAS administration page, choose "XLML Courses", then "Import Course".
Select the project and enter the name of your course. Select the created ZIP
file and click on "Import".

After the course is correctly imported, it appears on the XLML "Course list".
Click the title of the course to view it. Click "Options" to change the
courses meta data and other settings, especially the discipline for which
the course should be listed. Please note that the ILIAS editor can't be used 
to change the course's content. 

You can also reload or delete a course (see below).


RELOAD A COURSE 
---------------

An XLML course can be changed externally and reloaded as long as the
page/sections structure remains exactly the same i.e. no chapters or pages are
included, deleted or moved. Yet, corrections in the text, exchange of linked
filed or even renaming of chapters are possible. If you need to make more
changes, delete the course and import it again. Then, however, all learners'
notes will be lost.

To reload a course, click "Reload" in the list of XLML courses and choose the
newly generated ZIP file.


DELETE A COURSE
---------------

To delete a course, click "Reload" in the list of XLML courses. Please note 
that the course will completely be removed from the system and can't be 
recovered. Also all users' notes are finally deleted.


-----------------------------------------------
Last update: 2003-07-01
-----------------------------------------------
Fred Neumann   fred.neumann@fim.uni-erlangen.de
FIM NewLearning  http://www.fim.uni-erlangen.de
-----------------------------------------------