tablix2_output

Langue: en

Version: 2006-02-04 (debian - 07/07/09)

Section: 1 (Commandes utilisateur)

NAME

tablix2_output - Tablix data export utility

SYNOPSIS

tablix2_output [ -o file ] [ options ] format file

DESCRIPTION

Tablix is a powerful free software kernel for solving general timetabling problems. It uses a coarse-grained parallel genetic algorithm in combination with other techniques to construct sensible timetables from XML formatted problem descriptions. Tablix can run on a single host as well as on a heterogeneous parallel virtual machine using PVM3.

tablix2_output reads a timetable description in a XML format produced by Tablix from file and converts it into a number of human or machine readable file formats. Alternatively, it can also read timetable information from a saved Tablix session.

OPTIONS

-o FILE
Write output to file FILE instead of the standard output.
-s OPTIONS
Set export module options. OPTIONS is a comma separated string of option=value pairs. Some options can only be enabled and do not accept a value. You can ommit the =value part with those (specifying the option alone will enable it). Supported options depend on the export format used.
-d LEVEL
Set the verbosity level, where LEVEL is one of the following:
0
(only fatal error messages are shown),
1
(fatal and non-fatal errors),
2
(all errors),
3
(all of the above plus some informational messages) or
4
(all of the above plus debug messages).
-r FILE
Use timetable information from a saved Tablix session in FILE (usually named save?.txt). Timetable with the lowest fitness value in the saved population is exported instead of any result stored in the XML file. If this option is used, the XML file does not need to contain a solution (i.e. the problem description file can be used).
-h
Shows a brief help message.
-v
Shows compile time options and copyright information.
-i PATH
Sets the path to export modules. By default the module path is set to the location where export modules were installed by make install command.

FORMATS

htmlcss
XHTML 1.1 output using CSS stylesheets and UTF-8 encoding for school scheduling. Creates one giant HTML file with all timetables (not recommended for large timetabling problems).

Use the css option to specify an alternative stylesheet (if no stylesheet is specified, a default stylesheet is used).

Use the namedays option (without a value) to enable day names.

htmlcss2
XHTML 1.1 output using CSS stylesheets and UTF-8 encoding for school scheduling. Creates a directory containing one HTML file per timetable. Also supports timetables that span multiple weeks. With this module you have to specify the name of the directory where files are to be saved (you can not use standard output).

Use the css option to specify an alternative stylesheet (if no stylesheet is specified, a default stylesheet is used).

Use the namedays option (without a value) to enable day names.

The footnotes option (without a value) changes the way events from conflicting resources are displayed. Without this option time slots occupied by events from conflicting resources are only marked. With this option some more information is displayed in the timetable (this is similar to timetables produced by the htmlcss module).

With the weeksize option you can specify the number of days in a week. This can be used to produce timetables that span multiple weeks. For example: If the timetable has 15 days (the width of the "time" matrix and weeksize is set to 5, timetable will be displayed as 3 separate weeks. Default week size is 5 days.

csv
General "comma separated values" format in UTF-8 encoding suitable for import into spreadsheet programs and further processing.
vcal
vCalendar 2.0 (also known as iCal or iCalendar) compatible output. Use this format to generate a list of events for one class or one teacher that is suitable for import into cell phones, calendaring applications, etc.

You have to specify all of the following options for this export module to work correctly:

starttime
Time and date of the first time slot in the timetable (a suitable time and date would for example be Monday, 4 September 2006, at 8:00 AM) written in basic ISO 8601 format (previous example in this format would be "20060904T080000").
length
Length of each event in the timetable in minutes (for example "40")
restype
Type of resource for which to export the timetable. Use "teacher" for teachers and "class" for student classes.
resource
Name of the resource for which to export the timetable.
gnutu
XML format suitable for import into Gnutu Student's Schedule (see http://gnutu.org).

This module can create a timetable for a single class of students or a directory with timetables for all defined classes. In the first case, specify the name of the class with the class option. If you do not specify this option all timetables will be generated. In this case you have to specify a name for the directory into which the timetables will be saved (use the -o option).

By default the first timeslot begins at 8:00, the second at 9:00 and so on. If you would like to change that, make a file with one time slot time per line. Then specify this file with the hours option.

BUGS

None currently known.

AUTHOR

Tomaz Solc (tomaz.solc@tablix.org)

SEE ALSO

tablix2(1), Tablix User's Manual, Tablix modules HOWTO, Tablix on Morphix HOWTO