File: tablix2_output.1

package info (click to toggle)
tablix2 0.3.3-1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 9,816 kB
  • ctags: 2,970
  • sloc: ansic: 21,647; xml: 12,230; sh: 9,879; makefile: 762; perl: 564; yacc: 288
file content (136 lines) | stat: -rw-r--r-- 5,073 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
.\" These macros were copied from MPlayer manpage, written by Gabucino, 
.\" Diego Biurrun and Jonas Jermann. 
..
.\" default indentation is 7, don't change!
.nr IN 7
.\" define indentation for suboptions
.nr SS 5
.\" add new suboption
.de IPs
.IP "\\$1" \n(SS
..
.\" begin of first level suboptions, end with .RE
.de RSs
.RS \n(IN+3
..
.TH TABLIX 1 2006-02-04 "Tomaz Solc" "Tablix User's Manual"
.SH NAME
tablix2_output \- Tablix data export utility
.SH SYNOPSIS
.B tablix2_output [ -o 
.I file
.B ] [ 
.I options
.B ]
.I format
.I file
.SH 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.
.P
.B tablix2_output
reads a timetable description in a XML format produced by Tablix from
.I 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.
.SH OPTIONS
.TP
.B \-o FILE
Write output to file
.B FILE
instead of the standard output. 
.TP
.B \-s OPTIONS
Set export module options. 
.B OPTIONS
is a comma separated string of 
.I option=value 
pairs. Some options can only be enabled and do not accept a value. You can ommit the 
.I =value
part with those (specifying the option alone will enable it). Supported options depend on the export format used.  
.TP
.B \-d LEVEL
Set the verbosity level, where LEVEL is one of the following:
.RSs
.IPs 0
(only fatal error messages are shown),
.IPs 1
(fatal and non-fatal errors),
.IPs 2
(all errors),
.IPs 3
(all of the above plus some informational messages) or
.IPs 4
(all of the above plus debug messages).
.RE
.TP
.B \-r FILE
Use timetable information from a saved Tablix session in
.B 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).
.TP
.B \-h
Shows a brief help message.
.TP
.B \-v
Shows compile time options and copyright information.
.SH FORMATS
.TP
.B 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
.B css
option to specify an alternative stylesheet (if no stylesheet is specified, a default stylesheet is used). 

Use the 
.B namedays
option (without a value) to enable day names. 
.TP
.B 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
.B css
option to specify an alternative stylesheet (if no stylesheet is specified, a default stylesheet is used). 

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

The 
.B 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
.B htmlcss
module).

With the
.B 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.

.TP
.B csv
General "comma separated values" format in UTF-8 encoding suitable for import into spreadsheet programs and further processing.
.TP
.B 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:
.RSs
.IPs 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").
.IPs length
Length of each event in the timetable in minutes (for example "40")
.IPs restype
Type of resource for which to export the timetable. Use "teacher" for teachers and "class" for student classes.
.IPs resource
Name of the resource for which to export the timetable.
.RE

.SH BUGS
None currently known.
.SH AUTHOR
Tomaz Solc (tomaz.solc@siol.net)
.SH SEE ALSO
.BR tablix2 (1),
Tablix User's Manual,
Tablix modules HOWTO,
Tablix on Morphix HOWTO