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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head>
<title>sameday.so module reference</title>
<style type="text/css">
body {
font-family: sans-serif;
font-size: small;
}
pre {
background-color: #eeeeff;
border: solid 1px #000000;
padding: 15px;
}
a {
text-decoration: none;
font-weight: bold;
color: #1A419D;
}
</style>
</head>
<body>
<p><a href="index.html">Back to index</a></p>
<h1>sameday.so module reference</h1>
<h2>Author</h2>
<p>Tomaz Solc, <a href="mailto:tomaz.solc@siol.net">tomaz.solc@siol.net</a></p><h2>Credits</h2><p><p>
Ideas taken from a patch for Tablix 0.0.3 by
Jaume Obrador <obrador@espaiweb.net></p>
</p>
<h2>Module groups</h2>
<p>This module belongs to the following groups:</p>
<ul>
<li>School scheduling</li>
</ul>
<h2>Description</h2>
<p>
Adds a weight if a class or a teacher (as specified by the "resourcetype"
module option) has the same subject more than N
times in a day.</p>
<p>Default for N is 1. Default value can be changed with the module option
"default". Default value for N can also be overridden for individual
teachers, classes and events with various restrictions.</p>
<h2>Required resource types</h2>
<p>Configuration file must define the following resource types
in order to use this module:</p>
<ul>
<li>time</li>
</ul>
<h2>Defined resource restrictions</h2>
<h3>ignore-sameday (all resource types)</h3><pre><resourcetype type="class">
<resource name="example-class">
<restriction type="ignore-sameday"/>
</resource>
</resourcetype></pre>
<p>Set this restriction to a class or a teacher that you don't want to be
checked for multiple occurrences of the same subject in a day.</p>
<p>This module then ignores classes that have this restriction, however this
setting can be overridden for individual events if "set-sameday" restriction
is used on an event for this class or teacher.</p>
<h3>set-sameday (all resource types)</h3><pre><resourcetype type="class">
<resource name="example-class">
<restriction type="set-sameday">2</restriction>
</resource>
</resourcetype></pre>
<p>With this restriction you can set a maximum number of equal events a class
or a teacher can have in a day. This setting can be overridden for
individual events if "set-sameday" event restriction is used on an event
for this class or teacher.</p>
<h2>Defined tuple restrictions</h2>
<h3>consecutive</h3>
<p>This is an alias for "ignore-sameday" restriction. It is defined for
convenience when this module is used together with <a href="consecutive.html">consecutive.so</a> module.</p>
<h3>ignore-sameday</h3>
<p>Set this restriction to all events that you do not want to be checked for
multiple occurences per day.</p>
<p>This retriction overrides the default setting and settings made by
any resource restrictions.</p>
<h3>periods-per-block</h3>
<p>This is an alias for "set-sameday-blocksize" restriction. It is defined for
convenience when this module is used together with <a href="consecutive.html">consecutive.so</a> module.</p>
<h3>set-sameday</h3>
<pre><event name="example repeats="5">
...
<restriction type="set-sameday">2</restriction>
</resourcetype></pre>
<p>With this restriction you can set a maximum number of events of type type
that a class or a teacher can have in a day.</p>
<p>This retriction overrides the default setting and settings made by
any resource restrictions.</p>
<h3>set-sameday-blocksize</h3>
<p>With this restriction you can tell this module that the current event
will be scheduled in blocks of this number of equal consecutive events.</p>
<p>Module will then consider a block of events as a single event when checking
for multiple occurences per day.</p>
<p>Default block size is 1.</p>
<h2>Supported module options</h2>
<h3>default</h3>
<p>Use this option to set the default number of equal events classes or
teachers can have in day.</p>
<h3>resourcetype</h3>
<p>Use this option to specify one or more constant resource types. Specified
resource types will have their timetables checked by this module.</p>
<p>Use option</p>
<pre><option name="resourcetype">class</option></pre>
<p>to get the same behaviour as this module had before Tablix version 0.3.1.</p>
<p><a href="index.html">Back to index</a></p>
</body>
</html>
|
