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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head>
<title>recurrence.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>recurrence.so module reference</h1>
<h2>Description</h2>
<p>This module enables you to specify how should Tablix distribute
the recurrences of an event throughout a multiweek timetable.</p>
<p>This module only affects resource domains, so the weight and mandatory
values are ignored.</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>
<h2>Defined tuple restrictions</h2>
<h3>recurrence</h3>
<p>This restriction specifies two recurrence parameters: The week when the
recurrence starts and how many times per week should this event appear.</p>
<p>Consider the following example:</p>
<pre><event name="Lecture" repeats="24">
<resource type="teacher" name="A"/>
<resource type="class" name="B"/>
<restriction type="recurrence">2 3</restriction>
</event></pre>
<p>This means that events named 'Lecture' will appear for 8 consecutive weeks
(24 repeats divided by 3 recurrences per week) starting on the third week
(week are numbered starting from 0) with 3 events per week.</p>
<h2>Supported module options</h2>
<h3>days-per-week</h3>
<p>This option specifies the number of work days per week. If this option is
not specified a default number of 5 is used.</p>
<p>Example:</p>
<pre><module name="<a href="recurrence.html">recurrence.so</a>" weight="60" mandatory="yes">
<option name="days-per-week">6</option>
</module>
.
.
.
<resourcetype type="time">
<matrix width="30" height="5"/>
</resourcetype></pre>
<p>This combination of options would result in a timetable that is 6 weeks long
(30 weeks long divided by 6 days per week).</p>
<p>Please note that if you changed the default number of days per week you will
also have to give this option to the 'htmlcss2' export module to get the
expected result.</p>
<h2>Module groups</h2>
<p>This module belongs to the following groups:</p>
<ul>
<li>Multiweek scheduling</li>
</ul>
<h2>Author</h2>
<p>Tomaz Solc, <a href="mailto:tomaz.solc@tablix.org">tomaz.solc@tablix.org</a></p> <p><a href="index.html">Back to index</a></p>
</body>
</html>
|
