aboutsummaryrefslogtreecommitdiffstats
path: root/doc/devel/calendar/alarm-generation.sgml
blob: 60bc78343e183d6cb0b06c60143ad3fe3119daf6 (plain) (blame)
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
  <chapter id="calendar-alarm-generation">
    <title>How the Wombat generates alarm instances</title>

    <para>
      This chapter describes the algorithm that the &Wombat; uses
      internally to generate instances of a calendar component's
      alarms.  You do not need to read this chapter if you are simply
      using the client-side functions.
    </para>

    <sect1 id="what-makes-up-an-alarm-trigger">
      <title>What makes up an alarm trigger</title>

      <para>
    VTODO and VEVENT calendar components can have any number of
    alarms defined for them.  Each alarm has a trigger
    specification, an alarm type (display, audio, email, or
    procedure), and data corresponding to the alarm type.  The
    Wombat side of things is interested only in the trigger
    specification, since this is all that the Wombat needs to
    produce alarm instances.
      </para>

      <para>
    An alarm trigger can be relative or absolute.  Relative
    triggers occur a certain time before or after the start or end
    of a calendar component's occurrence.  For example, you could
    configure a trigger to notify you 15 minutes before an
    appointment starts, so that you can get to its location on
    time; or another one to notify you 5 minutes after another
    person's meeting has ended, so that you can call that person
    on the phone after the meeting and not disturb him while
    there.  Absolute triggers occur at a specific point in time;
    you can configure an alarm to trigger exactly at a particular
    date and time that has no relation to the component's
    occurrences at all.
      </para>
    </sect1>

    <sect1 id="generating-trigger-instances">
      <title>Generating trigger instances</title>

      <para>
    
      </para>
    </sect1>
  </chapter>

<!--
Local variables:
mode: sgml
sgml-parent-document: ("../evolution-devel-guide.sgml" "book" "part" "")
End:
-->