@database scheduler

@node main "Scheduler - Kurze Beschreibung"

@{b}Scheduler 1.9 (23.10.2000)@{ub}

Dieses Dokument beinhaltet die folgenden Kapitel:

  @{" Einführung    " link intro   } Was ist es? Und wozu brauche ich es?
  @{" Installation  " link install }
  @{" Konfiguration " link config  }
  @{" Terminplan    " link schedule} Wie erstelle ich einen Terminplan?
  @{" Bedienung     " link use     }
  @{" Autor         " link author  } Mit Kontaktadresse
  @{" Urheberrecht  " link distr   } Rechtliches & Hinweise zur Distribution
  @{" Danksagungen  " link credits }
  @{" History       " link history }

Außerdem enthält es zusätzlich die zumindest teilweise (Hilfe und
Korrekturen erbeten) Übersetzung obiger Texte in:
  @{" English " link e_main}  @{" Italiano " link i_main}  @{" Français " link f_main}


Copyright ©1999-2000 pinc Software. Alle Rechte vorbehalten.

@endnode


@node intro "Scheduler - Einführung"
Der "Scheduler" ist ein einfaches kleines Programm, daß Terminpläne
anzeigt bzw. verwaltet und Sie optisch und akustisch an Ihre Termine
erinnern kann.

Es ist als Commodity gestaltet und öffnet ein Fenster auf der
Workbench in dem es die Termine in einer Wochenübersicht darstellt.

Dabei können auch Geburtstage und sonstige Termine markiert und/oder
schon Wochen oder Tage vorher und nachher dargestellt werden.
Auch wöchentlich oder in einer bestimmten Periode wieder erscheinende
@{"Termine" link schedule} können auf einfache Weise erstellt werden oder Shell-Kommandos
zu bestimmten Zeitpunkten ausgeführt werden.

Der Scheduler wird über ToolTypes und eine Textdatei, in der die
Termine stehen, konfiguriert.

Das Programm ist nun auch in einer BeOS-Version verfügbar.

@endnode


@node install "Scheduler - Installation"
Zur Installation wird das Programm einfach z.B. in den Ordner WBStartup
oder ähnliches kopiert - es ist durchaus sinnvoll, das Programm bei jedem
Systemstart ebenfalls starten zu lassen.

Falls eine andere Sprache als Englisch für die Programmsteuerung benutzt
werden soll, muß man noch die Datei "Scheduler.catalog" in das entsprechende
Verzeichnis kopieren (z.B. "LOCALE:Catalogs/deutsch/").

Die von @{"Ihnen erstellte Datei" link schedule} mit Ihren Terminen wird standardmäßig
unter "ENV:schedule" gesucht, sie darf aber auch @{"an jedem anderen Ort" link config} liegen,
sofern sie bei Systemstart verfügbar ist.

Wird diese Datei von Ihnen während der Laufzeit des Schedulers geändert,
bemerkt er das und lädt sie automatisch neu ein.

"Scheduler" setzt mindestens OS 3.0 voraus, funktioniert aber natürlich
auch mit höheren Versionen (getestet bis einschließlich OS 3.5).

@endnode


@node config "Scheduler - Konfiguration"
Scheduler wird über ToolTypes konfiguriert. Dafür stehen einige Möglichkeiten
zur Wahl:

  @{b}WINDOW@{ub}      Damit bestimmen Sie die Position und (maximale) Größe
              des Fensters (z.B. WINDOW=0/10/300/200).
              Dabei müssen sämtliche Koordinaten angegeben werden.
              Das Fenster paßt sich automatisch seinem Inhalt an,
              wird aber maximal nicht größer als in dieser Angabe
              festgelegt.
              Wird noch ein "/FIX" oder auch "/fixed" angehängt,
              paßt sich das Fenster nicht mehr seinem Inhalt an,
              sondern füllt grundsätzlich den gesamten Bereich aus.
              In diesem Fall wird BOUND nicht mehr ausgewertet.

  @{b}FILE@{ub}        Damit können Sie eine alternative Terminplan-Datei
              angeben. Voreinstellung ist "ENV:schedule".

  @{b}RANGE@{ub}       Die normale Spannweite der Übersicht. Voreingestellt
              sind 7 Tage; wenn man diese Zahl erhöht werden wöchentliche
              Termine nur @{b}einmal@{ub} dargestellt!

  @{b}BOUND@{ub}       Da sich die Fenstergröße automatisch dem Inhalt anpaßt,
              kann man hier angeben, wo der Bezugspunkt innerhalb des
              bei WINDOW festgelegten Bereiches liegt. Mögliche Werte
              sind (r)ight, (l)eft, (t)op, (b)ottom.
              Wird dieses ToolType nicht angegeben, ist die Position
              des Bereiches auf dem Bildschirm ausschlaggebend.
              Wird bei WINDOW die Option /fix benutzt, wird dieses ToolType
              nicht ausgewertet.

  @{b}CLOSEAFTER@{ub}  Wird hier ein Wert ungleich Null gesetzt, schließt sich
              das Fenster automatisch nach der Anzahl der abgelaufenen
              Sekunden (mindestens 5).
              Falls keine Termine gefunden wurden, oder eine vorhandene
              Datei leer ist, wird das Fenster immer nach 2 Sekunden
              geschlossen, unabhängig von dieser Angabe.
              Nach der Voreinstellung bleibt das Fenster offen.

  @{b}FONT@{ub}        Damit können Sie einen alternativen Zeichensatz aus-
              wählen (z.B. FONT=helvetica.font/9). Das font-Suffix muß
              dabei angegeben werden.
              Voreingestellt ist die Benutzung des Bildschirmfonts.

  @{b}COMMAND@{ub}     Mit einem Doppelklick auf das Fenster wird das hier
              angegebene Kommando ausgeführt. Damit kann man z.B. seinen
              bevorzugten Editor mit der Termindatei starten.
              In der Voreinstellung ist kein Kommando angegeben.

  @{b}OUTPUT@{ub}      Benötigt das mit COMMAND festgelegte Kommando Ausgaben
              in einer Shell, kann hiermit eine bestimmte vorgegeben
              werden.
              Voreingestellt ist "CON:0/40/300/100/Scheduler Output/AUTO/CLOSE/WAIT".

  @{b}SOUND@{ub}       Bei einem mit @{"'t'" link schedule} markiertem Eintrag wird bei Angabe dieses
              Argumentes der Sound über die DataTypes abgespielt, dessen
              Dateiname angegeben wird.
              Voreingestellt ist kein Sound.

  @{b}PUBSCREEN@{ub}   Falls der Terminkalender nicht auf dem voreingestellten öffentlichen
              Bildschirm (üblicherweise der Workbench) sondern auf einem
              anderen sein soll, können Sie das hier angeben.

Zusätzlich stehen noch die für Commodities üblichen ToolTypes zur Auswahl;
eine Erläuterung dieser finden Sie in der Dokumentation zu Ihrem Computer:

  @{b}CX_PRIORITY@{ub} (Voreinstellung: 0),
  @{b}CX_POPKEY@{ub}   (Voreinstellung: ctrl alt t),
  @{b}CX_POPUP@{ub}    (Voreinstellung: YES)

Zu erwähnen ist vielleicht noch, daß der Scheduler, sofern CX_POPUP auf NO
steht, bei Änderungen des Terminplans nicht automatisch das Fenster öffnet,
falls es zu der Zeit geschlossen ist.


@{b}!!! Hinweis !!!@{ub}

Falls der Scheduler von einer Shell aus gestartet wird, können die ToolTypes
nicht ausgewertet werden! In diesem Fall können sie aber direkt als Parameter
angegeben werden. Z.B.:

  Scheduler FILE=Work:schedule

Werden Strings mit Leerzeichen angegeben, muß das gesamte Argument in
Anführungszeichen stehen. Aus

  CX_POPKEY=ctrl alt t

wird also

  "CX_POPKEY=ctrl alt t"

und nicht CX_POPKEY="..."!

@endnode


@node schedule "Scheduler - Terminplan"
Terminpläne sind Dateien, in denen Termine stehen - und zwar so, daß
der Scheduler etwas damit anfangen kann.

Nach der Voreinstellung sucht der Scheduler in "ENV:schedule" nach seinen
Daten, über @{"FILE" link config} kann das aber frei angegeben werden.

Wird eine solche Datei während der Laufzeit des Schedulers geändert, wird
sie automatisch neu geladen und ausgewertet. Falls das Fenster des Schedulers
zu der Zeit geschlossen ist, öffnet es sich, wenn @{"CX_POPUP=YES" link config} gesetzt ist.

Ein paar kleine Hinweise vorweg:
 · es gibt nur 5 Spalten, von denen die erste als Datum angesehen wird, die zweite
   als Zeitangabe, die vorletzte als Optionen und die letzte als Kommando

 · ein '#' am Anfang einer Zeile markiert diese als Kommentar

 · leere Zeilen werden überlesen

 · Spaltentrennzeichen ist '|'


Sehen wir uns eine Beispielzeile an:

@{b}4.2. | 12:15 | Gulaschsuppe läuft ab | m | RequestChoice "Mist" "So ein Ärger!" ok@{ub}

Dabei dient der Querstrich '|' als Spaltentrenner. Wirklich ausgewertet
werden lediglich die ersten beiden und die letzten beiden (4. & 5.) Spalten;
letztere dürfen aber auch weggelassen werden.

Kommen wir nun zu den einzelnen Spalten und ihren Besonderheiten:

@{b}1.@{ub} In der ersten Spalte wird ein Datum erwartet. Das kann z.B. folgende
   Struktur haben: t.m.j
   Dabei kann das Jahr auch weggelassen werden; in diesem Fall wird das
   aktuelle angenommen. Wird das Jahr nur zwei oder einstellig angegeben,
   1900 hinzuaddiert, wenn es nicht mehr als 75 Jahre in der Vergangenheit
   liegt, ansonsten werden solange noch jeweils 100 Jahre addiert.
   Läßt man auch noch den Monat weg, wird dieser durch den aktuellen bzw.
   den darauffolgenden Monat ersetzt.
   Zusätzlich können auch "dayX" oder "day=X", wobei X für eine Zahl zwischen
   1 und 7 steht, also für die Wochentage (nach OS-Logik von Sonntag bis Samstag),
   angegeben werden oder direkt "mo", "di", "mi", ... oder ihre englischen
   Pendants "mon", "tue", "wed", ... angegeben werden.
   Wird nur "day" angegeben, wird dieser Termin täglich neu erfaßt.
   Bei der Angabe eines Datums kann durch ein angehängtes ":x" eine alle x Tage
   wiederkehrende Periode bestimmt werden.
   Wird kein Datum erkannt, wird der Text direkt übernommen und als Datum das
   vom vorhergehenden Eintrag angenommen.

@{b}2.@{ub} In dieser Spalte sollten die Zeiten stehen; wenn diese im Format
   "hour:min" vorliegen, werden sie auch ausgewertet - es darf aber natürlich
   auch etwas anderes dort stehen. Diese Auswertung hat aber nur einen Effekt,
   wenn zusätzlich die Option "t" angegeben wird (siehe 4.).
   Im Fenster wird diese Spalte, falls vorhanden, zentriert dargestellt.

@{b}3.@{ub} In dieser Spalte steht der eigentliche Text, linksbündig dargestellt.
   Falls bei den Optionen "m" für "marked" angegeben wird, wird er in einer
   anderen Farbe gezeichnet.

@{b}4.@{ub} Diese Spalte hat wieder eine besondere Bedeutung: ist sie vorhanden, werden
   ihre Inhalte als Optionen aufgefaßt.
   Es gibt (bisher) die folgenden:

    @{b}m (marked)@{ub}     Termin markiert darstellen
    @{b}h (hold)@{ub}       Termin unabhängig von Datum immer darstellen. Wird
                   beim Termin kein Datum erkannt, wird ein solcher
                   Termin am Ende der Liste erscheinen.
    @{b}b (before)@{ub}     Der Termin wird angezeigt, wenn der Termin soweit
                   in der Zukunft liegt, daß er normalerweise noch
                   nicht dargestellt wird. Mit bX oder b=X mit 0<X<2^16
                   läßt sich dieser Zeitraum in Tagen festlegen
    @{b}a (after)@{ub}      Entsprechend @{b}before@{ub}, betrifft aber Termine
                   aus der Vergangenheit.
    @{b}s (separator)@{ub}  über diesem Eintrag wird eine Trennlinie dargestellt.
    @{b}t (time)@{ub}       Die Zeit-Spalte wird ausgewertet und sowohl optisch als
                   auch akustisch (lauter werdend, mittels @{"SOUND" link config}) ab X Minuten
                   vor dieser Zeit jede Minute wieder gemeldet (mit tX oder t=X).
    @{b}r (remember)@{ub}   Wird der Termin fällig, wird er mit einem hinterlegten
                   Ausrufezeichen pro abgelaufenem Tag markiert (max. 3).
    @{b}e (exactly)@{ub}    Der Termin wird nur eine Minute lang ab der angegebenen
                   Zeit gezeigt.
    @{b}o (once)@{ub}    Der Termin wird nur genau einen Tag angezeigt, unabhängig
                   von der eingestellten @{"RANGE" link config}.

@{b}5.@{ub} Der Inhalt dieser Spalte wird komplett als Shell-Kommando ausgeführt.
   Das funktioniert aber nur, wenn die Zeitangabe in der 2. Spalte korrekt ist.

Werfen Sie einen Blick in die Beispieldatei:

  @{"schedule" link schedule/main}

@endnode


@node use "Scheduler - Bedienung"
Es gibt folgende Möglichkeiten, den Scheduler zu bedienen:

 · Das Menü:

   @{b}Verstecken  (H)@{ub}  blendet das Programmfenster aus.
   @{b}Termine abhaken@{ub}  beendet die optische und akustische Meldung
                    aller aktuellen Termine.
   @{b}Über        (?)@{ub}  zeigt ein paar Programminformationen an.
   @{b}Quit        (Q)@{ub}  Beendet das Programm.

 · Ein Doppelklick im Fenster löst eine über den ToolType @{"COMMAND" link config}
   definierte Aktion aus (z.B. das Starten eines Editors).

 · Das "Commodity"-Tastaturkürzel:

   @{b}CTRL-ALT-T@{ub} das Terminfenster wird gezeigt, wenn es vorher geschlossen war.
              Das Kürzel ist über das CX_POPKEY @{"ToolType" link config} konfigurierbar.

 · Über Signale:

   @{b}CTRL-C@{ub}  Beendet das Programm
   @{b}CTRL-E@{ub}  Entspricht dem Menüpunkt "Termin abhaken"
   @{b}CTRL-F@{ub}  Veranlaßt das erneute Laden des Terminplanes

@endnode


@node author "Scheduler - Autor & Adresse"

Die Adresse für Bug-Reports, Ideen und andere Dinge:

@{b}Per Post:@{ub}
  pinc Software / Axel Dörfler
  Lange Straße 4a
  49080 Osnabrück
  Deutschland

@{b}eMail-Adresse:@{ub}
  axeld@pinc-software.de (Axel Dörfler)
  (adoerfle@uos.de)

@{b}WWW:@{ub}
  www.pinc-software.de/


Postkarten und andere Vergütungen sind natürlich erwünscht.

@endnode


@node distr "Scheduler - Urheberrecht & Distribution"
Das Urheberrecht an der Software und des gesamten Paketes liegt bei mir,
Axel Dörfler.

Zum jetzigen Zeitpunkt handelt es sich bei @{b}pinc Software@{ub} (siehe Info-Text)
nicht um eine juristische Person, sondern wird lediglich stellvertretend
genannt.

Die Software darf, solange kein kommerzielles Interesse gegeben ist und ihr dieses
Dokument beiliegt, frei kopiert und weitergegeben werden. Das schließt z.B. eine
Verbreitung über Aminet-CDs oder über das Internet ein.
Zuwiderhandlungen werden nach Inkenntnisnahme strafrechtlich verfolgt.

Für technische oder persönliche Probleme in Zusammenhang mit dem Scheduler kann ich
nicht haftbar gemacht werden. Sie benutzen das Programm auf ihr eigenes Risiko.

@endnode


@node credits "Scheduler - Danksagungen"

Vielen Dank an:

 · Marco Amadori für die italienische Übersetzung der Programmtexte und
   des Guides.

@endnode


@node history "Scheduler - History"

@{b}Version 1.0 (22.2.1999)@{ub}
 · erste Version


@{b}Version 1.1 (23.2.1999)@{ub}
 · Termine umgestaltet, Datum wird nun erkannt und gehandhabt.

 · neue Optionen: (a)fter, (b)efore, (s)eparator, (h)old.

 · Bei CTRL-F wird der Terminplan auch neu eingelesen.

 · In der "Datums"-spalte werden von gleichen hintereinanderfolgenden
   Einträgen nur noch der erste dargestellt.

 · Das ToolType WINDOW unterstützt nun die Option FIX[ED]


@{b}Version 1.2 (5.3.1999)@{ub}
 · Ein zusätzlicher Timer prüft nun alle 2 Minuten, ob ein neuer
   Tag begonnen hat.

 · Mit dem ToolType FONT kann man nun einen Zeichensatz für die
   Darstellung wählen.

 · Das Fenster wird nicht mehr aktiv, wenn es sich ohne Zutun des
   Benutzers öffnet.


@{b}Version 1.3 (21.3.1999)@{ub}
 · Das Fenster kann nun, wenn es offen ist, auch verschoben werden.

 · Ein Doppelklick auf das Fenster führt ein mit COMMAND festgelegtes
   Kommando mit der unter OUTPUT bestimmten Shell aus.

 · Kann die Termindatei nicht geöffnet werden, wird eine entsprechende
   Meldung ausgegeben.

 · Sind keine aktuellen Termine vorhanden, bleibt das Fenster nicht
   länger als Strich offen.


@{b}Version 1.4 (9.1.2000)@{ub}
 · Die Angabe des Monats bei einem Datum kann nun auch weggelassen werden
   (Vorschlag von Lance Neustaeter).

 · Mit ":x" kann man periodisch wiederkehrende @{"Termine" link schedule} angeben.


@{b}Version 1.5 (11.1.2000)@{ub}
 · Daten ohne ":x" wurden versehentlich falsch behandelt...


@{b}Version 1.6 (15.1.2000)@{ub}
 · neue Option "t", Zeiten werden nun nach Möglichkeit geparst.

 · neuer Tooltype SOUND um einen beliebigen Sound bei der Zeit-Benachrichtigung
   abzuspielen.

 · neuer Tooltype PUBSCREEN um jeden Public-Screen nutzen zu können.

 · Lokalisierung.

@{b}Version 1.7 (4.3.2000)@{ub}
 · neue Option "r" (remember) markiert einen Termin am Stichtag bzw. ab der
   angegebenen Zeit mit einem Symbol.

 · Option "a" (after) funktioniert nun auch im Zusammenhang mit periodischen
   wiederkehrenden Terminen.

 · Shell-Kommandos können bei erreichen eines Termines ausgeführt werden
   (von verschiedenen Personen vorgeschlagen).

 · neue Option "e" (exactly [once]) blendet einen Termin nur in der einen
   Minute ein, die bei ihm angegeben ist.

@{b}Version 1.8 (9.5.2000)@{ub}
 · Option "r" arbeitete nicht korrekt.

 · neue Option "o" (once) eingeführt.

 · Parsen der Wochentage optimiert.

@{b}Version 1.9 (28.10.2000)@{ub}
 · Neue "täglich" Datums-Option (wenn Datum "day" ist).

 · Der Alarm meldete sich nicht vor 0:00 mit z.B. t5.

 · Ein Zeichen lange Text-Spalten gingen verloren.

@endnode


@node e_main "Scheduler - Short Description"

@{b}Scheduler 1.9 (23.10.2000)@{ub}

Table of Contents:

  @{" Introduction     " link e_intro   } What's all about?
  @{" Installation     " link e_install }
  @{" Configuration    " link e_config  }
  @{" Schedule         " link e_schedule} How to make a schedule-file
  @{" Using Scheduler  " link e_use     }
  @{" Author           " link e_author  } with address
  @{" Copyright Notice " link e_distr   }
  @{" Credits          " link e_credits }
  @{" History          " link e_history }

This document contains furthermore the following partly completed
translations (help wanted) of the above:
  @{" Deutsch " link main}  @{" Italiano " link i_main}  @{" Français " link f_main}


Copyright ©1999-2000 pinc Software. All Rights Reserved.

@endnode


@node e_intro "Scheduler - Introduction"
The "Scheduler" is a simple and small programme which manages
and displays your schedule.

It's a commodity and has its window on the Workbench-Screen.
The window displays a whole week or another range of upcoming
dates.

You can mark birthdays and other "deadlines" and view them
weeks or days before they reach your weekly plans.
Even weekly dates like TV series and other stuff @{"can be created" link e_schedule}
very easily. Furthermore you can let Scheduler execute every
shell-command at a specified time.

The Scheduler can be configured via tooltypes and a text file,
the @{"schedule" link e_schedule} file.

This programme is now also available for the BeOS.

@endnode


@node e_install "Scheduler - Installation"
To install the programme you simply copy it in the drawer you want it
to have. It's quite useful to choose the "WBStartup"-drawer to let it
be started whenever you boot the Workbench.

If you want to use another language, the "Scheduler.catalog" must be
copied in the corresponding directory (e.g. "LOCALE:Catalogs/deutsch").

Your @{"self-created file" link e_schedule} including your dates should be in "ENV:schedule"
or at least it will be searched there, by default.
You may change this behaviour by changing the @{"configuration via ToolTypes" link e_config}.

If you change this file while the Scheduler is running, it will load and
analyze it automatically

The Scheduler requires OS 3.0 or higher (also tested with OS 3.5).

@endnode


@node e_config "Scheduler - Configuration"
The Scheduler will be configured via ToolTypes. You have the choice:

  @{b}WINDOW@{ub}      With this option you set the (maximal) window size
              (e.g. WINDOW=0/10/300/200).
              You have to give all four coordinates. The window size
              fits to its contents but will never be greater than
              this.
              If you add a "/FIX" or a "/fixed" the window size is
              constant. If you so, the ToolType BOUND won't be
              evaluated anymore.

  @{b}FILE@{ub}        This sets the schedule-file. Default is "ENV:schedule".

  @{b}RANGE@{ub}       With this you may set the range or period of the dates.
              Default is 7 which means that a whole week is viewed. If
              you increase this value, weekly dates are displayed only
              @{b}once@{ub}!

  @{b}BOUND@{ub}       Since the window size is not constant, you can set the
              origin from which the window sizes inbetween the box
              you set with WINDOW.
              Possible values are (r)ight, (l)eft, (t)op, (b)ottom.
              If you use the /fix option along with WINDOW, this
              ToolType is not evaluated.

  @{b}CLOSEAFTER@{ub}  If you set this to a value unequal to zero, the window
              closes automatically after the number of seconds you want (>5).
              If no dates could be found, the window will be closed in two
              seconds - independent to this setting.
              Default is zero, which means the window remains open.

  @{b}FONT@{ub}        You can set the window font using this tooltype.
              Please note that the font-suffix must be added (e.g.
              helvetica.font/9).
              Default is the screen font.

  @{b}COMMAND@{ub}     You can execute a command by double clicking on the
              window. Default is no command.

  @{b}OUTPUT@{ub}      If the command specified with COMMAND needs an ouput
              stream, you may specify it here.
              Defaults to "CON:0/40/300/100/Scheduler Output/AUTO/CLOSE/WAIT".

  @{b}SOUND@{ub}       The specified sound will be played (with datatypes) on a
              notification using the @{"'t'" link schedule} option.
              Default is no sound.

  @{b}PUBSCREEN@{ub}   If you want to choose another public screen than the default
              one (normally the Workbench) you can specify it here.

Furthermore, the well-known Commodities-ToolTypes will be recognised.

  @{b}CX_PRIORITY@{ub} (Defaults to 0),
  @{b}CX_POPKEY@{ub}   (Defaults to: ctrl alt t),
  @{b}CX_POPUP@{ub}    (Default: YES)

If you set CX_POPUP to NO and changes the schedule-file, the window does not
pop up - vice versa, if you set it to YES it will pop up if it is closed at
this time.


@{b}!!! Attention !!!@{ub}

If you run the Scheduler from a shell (not from WB), the ToolTypes cannot
be evaluated. But you may wrote them as arguments in this case, e.g.:

  Scheduler FILE=Work:schedule

If you have strings this blanks, you have to qoute the whole argument.
The ToolType

  CX_POPKEY=ctrl alt t

morphes to

  "CX_POPKEY=ctrl alt t"

but not to CX_POPKEY="..."!

@endnode


@node e_schedule "Scheduler - Making a Schedule-file"
All dates and other things you want the "Scheduler" to view are listed
in a schedule file, in a special way which lets the Scheduler may work
with it.

The default schedule-file is "ENV:schedule" but you can change this via
the @{"ToolType FILE" link e_config}.

If you change such a file during runtime of the Scheduler, it will load
and evaluate it automatically. If its window is closed at this time, it
will open if @{"CX_POPUP" link e_config} is set to YES.

A few notes:
 · there are 5 columns, the first one is considered as a date, the 2nd as
   a time, the 4th as options and the last one as a shell command

 · a '#' at the beginning of a line marks as a commentary

 · empty lines are over-read

 · use '|' to separate the columns


--

Let's have a look at an example line:

@{b}4.2. | 12:15 | Pizza is getting cold | m | RequestChoice "Request" "Sorry!" Ok@{ub}

The '|' separates the different columns. Only the 3rd one has no special meaning,
the last two columns are optional.

So let me describe the different columns and its special qualities:

@{b}1.@{ub} This is considered as a date like: d.m.y
   You don't have to write the year - the current will be chosen in this
   case. If you only use 2 digits to represent the year, it will
   automatically be completed (add 1900 or 2000, if it is >75 years in
   the past).
   You also can omit the month - in this case it will be set to the current
   month or the one after this one; depending on wether it is already in
   the future or not.
   Furthermore, you may write "dayX" or "day=X" with 0 < X < 8, every week-day
   beginning with sunday. Alternatively, you can write its abbreviations
   "sun", "mon", "tue", ... or its German pendants ("mo", "di", ...).
   If you set this field to "day", it's considered to be a daily item.
   It's possible to set a period right after a date: ":x" means a date
   every x days.
   If no date can be recognised, the text will be displayed directly and the
   date of the entry above will be taken.

@{b}2.@{ub} You should use this row for times, but it is up to you. If you
   enter a time which fits in "hour:min" it will be parsed and used if you
   select the "t" option below (no a.m./p.m., 24 hours per day).
   If this row exists, its content will be displayed centered.

@{b}3.@{ub} Use this row for the text itself. If you use "m" as an option,
   it will be rendered in another colour.

@{b}4.@{ub} This row has a special meaning, its contents will be regarded
   as options.
   As I wrote this, there exist the following:

    @{b}m (marked)@{ub}     mark a date
    @{b}h (hold)@{ub}       show entry independent from its date. If such an
                   item has no valid date, it will be shown at the end of the
                   list.
    @{b}b (before)@{ub}     this lets you see entries which are dated beyond the specified
                   range. With bX or b=X with 0 < X < 65536 you may set the maximum
                   days between today and then.
    @{b}a (after)@{ub}      like @{b}before@{ub}, but this is for entries of
                   the past.
    @{b}s (separator)@{ub}  a line will be rendered above this entry.
    @{b}t (time)@{ub}       notifies you X minutes before the given time is reached
                   and every following minute (with tX or t=X). If a sound
                   is specified it will be played louder and louder.
    @{b}r (remember)@{ub}   if the date expires it will be marked with an exclamation
                   mark for every day (max. 3).
    @{b}e (exactly)@{ub}    the date will be shown exactly in the specified minute
                   and no longer.
    @{b}o (once)@{ub}    the date will be visible for one day only.

@{b}5.@{ub} The whole column will be interpreted as a shell command which is executed
   at the specified time (2nd column) as long as this one is correct.

Have a look at the example file:

  @{"schedule" link schedule/main}

@endnode


@node e_use "Scheduler - Using Scheduler"
There are several ways to contact the Scheduler:

 · The Menu:

   @{b}Hide              (H)@{ub}  hides the programme window
   @{b}Notification received@{ub}  interrupts the optical and acoustical notification of
                          all current dates
   @{b}About             (?)@{ub}  shows some informations about the programme
   @{b}Quit              (Q)@{ub}  quits the programme.

 · Use the ToolType @{"COMMAND" link config} to invoke a certain action
   with a double-click (e.g. starting an editor).

 · The commodity keyboard shortcut:

   @{b}CTRL-ALT-T@{ub} lets window pop up, the shortcut can be set via the
              CX_POPKEY @{"tooltype" link e_config}.

 · With Signals:

   @{b}CTRL-C@{ub}  quits the programme
   @{b}CTRL-E@{ub}  equals the "Termine abhaken" menu item
   @{b}CTRL-F@{ub}  causes the schedule file to be reloaded

@endnode


@node e_author "Scheduler - Author & Address"

The Address for bug-reports, ideas and other hopefully useful things:

@{b}Via snail-mail:@{ub}
  pinc Software / Axel Dörfler
  Lange Straße 4a
  49080 Osnabrück
  Germany

@{b}eMail-Address:@{ub}
  axeld@pinc-software.de (Axel Dörfler)
  (adoerfle@uos.de)

@{b}WWW:@{ub}
  www.pinc-software.de


If you want to send small donations or cards - be welcome :)

@endnode


@node e_distr "Scheduler - Copyright Notice & Distribution"
The package is ©1999-2000 by Axel Dörfler. All rights reserved.

At the time I wrote this, @{b}pinc Software@{ub} (see Info-Requester) is
not an existing juristical person; it stands representively for me and
no other person.

You are allowed to copy it to BBS, Aminet and other free
shareware-pools as long as this documentation is included and
you are not following any commercial interest.

The usage of Scheduler is at your own risk - I am not liable
for any problems you might have with it.

If you aren't sure what I try to tell you, please refer to the @{"German" link distr} part.

@endnode


@node e_credits "Scheduler - Credits"

Thanks to:

 · Marco Amadori for creating the Italian translation of the Guide and
   the programme texts.

@endnode


@node e_history "Scheduler - History"

@{b}Version 1.0 (22.2.1999)@{ub}
 · initial version


@{b}Version 1.1 (23.2.1999)@{ub}
 · added SIGBREAKF_CTRL_F to reload schedule

 · added parsing of every entry's date (dd.mm.[[yy]yy], day1-7, so-sa, sun-sat)

 · added flags: (h)old, (b)efore, (a)fter, (s)eparator

 · only changes are drawn in the "day"-row

 · option fix[ed] added to tooltype WINDOW


@{b}Version 1.2 (5.3.1999)@{ub}
 · added daily timer (checks all 2 minutes)

 · new tooltype FONT sets window font

 · the window becomes no longer active if it pops up without user
   invocation.


@{b}Version 1.3 (21.3.1999)@{ub}
 · if no dates are displayed, the window remains no longer open.

 · if the schedule file couldn't be open a corresponding message is
   shown.

 · the window can now be moved.

 · a double click on the window now invokes a configurable command
   (tooltype COMMAND) with a configurable output (tooltype OUTPUT).


@{b}Version 1.4 (9.1.2000)@{ub}
 · You can now omit the month in a date (suggested by Lance Neustaeter).

 · It's now possible to set a period and a start date, see @{"Schedule" link e_schedule}.


@{b}Version 1.5 (11.1.2000)@{ub}
 · Dates without a period have been handled incorrectly...


@{b}Version 1.6 (15.1.2000)@{ub}
 · new option "t", the time column is now parsed.

 · new tooltype SOUND to play a sound at the time-notification.

 · new tooltype PUBSCREEN to let the window open on any public screen.

 · supports locale.

@{b}Version 1.7 (4.3.2000)@{ub}
 · add flag (r)emember which shows an exclamation mark at the specified time.

 · option (a)fter now works for dates with a period.

 · shell commands can now be executed at a given date/time (as proposed by several people).

 · add flag (e)xactly [once].

@{b}Version 1.8 (9.5.2000)@{ub}
 · flag "r" did not work correctly.

 · new option (o)nce added.

 · optimized parsing of weekdays

@{b}Version 1.9 (28.10.2000)@{ub}
 · new daily option (set date to "day")

 · alarm at 0:00 did not warn before midnight (e.g. with t5), fixed.

 · one letter text columns got lost.

@endnode


@node i_main "Scheduler - Breve Descrizione"

@{b}Scheduler 1.9 (28.10.2000)@{ub}

Indice:

  @{" Introduzione      " link i_intro   } Di che si tratta?
  @{" Installazione     " link i_install }
  @{" Configurazione    " link i_config  }
  @{" Eventi            " link i_schedule} Come creare un file eventi.
  @{" Uso di Scheduler  " link i_use     }
  @{" Autore            " link i_author  } con indirizzo.
  @{" Note di Copyright " link i_distr   }
  @{" Ringraziamento    " link e_credits }
  @{" Cronologia        " link e_history }

Questo documento contiene inoltre le seguenti traduzioni parziali
di questa guida (gli aiuti sono incoraggiati):
  @{" Deutsch " link main}  @{"English" link e_main}  @{" Français " link f_main}


Copyright ©1999-2000 pinc Software. All Rights Reserved.

@endnode


@node i_intro "Scheduler - Introduzione"
"Scheduler" è un piccolo e semplice programma per gestire e
mostrare i vostri appuntamenti o eventi.

È una commodity che apre la sua finestra sullo schermo del
Workbench. La finestra mostra un intera settimana o un'altro
periodo configurabile dei vostri appuntamenti/eventi.

Si possono segnare compleanni e altre scadenze e farsele
mostrare in anticipo di giorni o settimane.
Possono essere @{"create" link i_schedule} anche date settimanali ricorrenti come i
programmi per la TV o altro in maniera molto semplice.
Inoltre potete fare in modo che Scheduler esegua un qualsiasi
comando shell in un momento specificato.

Scheduler può essere configurato tramite tooltypes e un file di
testo, il file @{"eventi" link i_schedule}.

@endnode


@node i_install "Scheduler - Installazione"
Per installare il programma basta copiarlo nel cassetto dove
preferite che stia. È molto comodo scegliere a questo scopo il
cassetto "WBStartup" in modo che Scheduler venga lanciato
automaticamente ad ogni riavvio del Workbench.

Se volete usare un'altra lingua oltre all'inglese dovete anche
copiare il file "Scheduler.catalog" nel cassetto corrispondente
alla lingua scelta (es: "LOCALE:Catalogs/italiano").

Il file di eventi che avete @{"creato" link i_schedule} va messo in ENV:schedule, o
almeno è qui che viene cercato di default.
Si può cambiare questa impostazione cambiandola tramite
@{"ToolTypes" link i_config} per scegliere qualsiasi altra locazione.

Se cambiate questo file mentre sta girando Scheduler, verrà
caricato e analizzato automaticamente.

Scheduler richiede il SO 3.0 o superiore (è testato anche per il
3.5).

@endnode


@node i_config "Scheduler - Configurazione"
Scheduler viene configurato tramite i ToolTypes. Potete cambiare:

  @{b}WINDOW@{ub}      Con questa opzione cambiate la dimensione  massima della
              finestra. (es: WINDOW=0/10/300/200).
              Dovete specificare tutti e quattro i campi.
              La dimensione della finestra si adatta al contenuto ma non sarà
              mai maggiore di quanto specificato.
              Se aggiungete "/FIX" o "/fixed" la dimensione sarà costante.
              Se lo settate il ToolType BOUND non sarà preso in considerazione.

  @{b}FILE@{ub}        Setta il file eventi. Per default è "ENV:schedule"


  @{b}RANGE@{ub}       Con questo si imposta il periodo di visualizzazione
              degli appuntamenti. Il default è 7 che significa un intera
              settimana mostrata. Se si aumenta questo valore, gli eventi
              settimanali verrano fortunatamente mostrati @{b}solo una volta@{ub}!

  @{b}BOUND@{ub}       Siccome la dimensione della finestra non è costante, si
              possono impostare le origini dalle quali viene dimensionata
              entro i valori specificati in WINDOW.
              I valori ammessi sono @{b}r@{ub} (destra), @{b}l@{ub} (sinistra), @{b}t@{ub} (alto), @{b}b@{ub} (basso).
              Se viene impostato /fix insieme a WINDOW, questo ToolType non
              viene valutato.

  @{b}CLOSEAFTER@{ub}  Se diverso da zero, la finestra viene chiusa
              automaticamente dopo il numero di secondi specificato (>5).
              Se non vengono trovati eventi, la finestra verrà chiusa in due
              secondi, indipendentemente da questa impostazione.
              Il default è zero, cioè la finestra rimane aperta.

  @{b}FONT@{ub}        Imposta il carattere della finestra, notare che bisogna
              anche specificare il suffisso (es: helvetica.font/9).
              Il default è il carattere dello schermo.

  @{b}COMMAND@{ub}     Il comando che viene eseguito con un doppio click sulla
              finestra. (es: COMMAND=ed ENV:schedule).
              Il default è nessun comando.

  @{b}OUTPUT@{ub}      Se il comando impostato necessita di output, si può
              specificarlo qui.
              Il defaults è "CON:0/40/300/100/Scheduler Output/AUTO/CLOSE/WAIT".

  @{b}SOUND@{ub}       Il suono specificato viene suonato (tramite datatypes)
              sulle notifiche specificate con l'opzione @{"t" link i_schedule}.
              Il default è nessun suono.

  @{b}PUBSCREEN@{ub}   Specifica un diverso schermo pubblico invece di quello
              di default (normalmente il Workbench).

Inoltre sono riconosciuti i soliti ToolTypes delle Commodities.

  @{b}CX_PRIORITY@{ub} (Default: 0),
  @{b}CX_POPKEY@{ub}   (Default: ctrl alt t),
  @{b}CX_POPUP@{ub}    (Default: YES)

Se impostate CX_POPUP a NO e cambiate il file eventi, la finestra non apparirà,
viceversa apparirà se chiusa con CX_POPUP a YES.


@{b}!!! Attenzione !!!@{ub}

Se lanciate Scheduler da una schell (non dal WB), i ToolTypes non verranno
valutati. Ma potete impostarli come argomenti, es:

  Scheduler FILE=Work:schedule

Se avete stringhe con spazi, dovete racchiudere l'intero argomento tra
virgolette.

Il ToolType

  CX_POPKEY=ctrl alt t

si trasforma in

  "CX_POPKEY=ctrl alt t"

non in CX_POPKEY="..."!

@endnode


@node i_schedule "Scheduler - Creazione di un file eventi"
Tutti gli appuntamenti, date, ricorrenze, eventi e le altre cose che
volete che "Scheduler" vi mostri sono elencate nel file eventi, in
maniera che Scheduler riesca a comprendere.

Il file evento di default è ENV:schedule, ma può essere cambiato
tramite il @{"ToolType FILE" link i_config}.

Se questo file viene modificato mentre Scheduler sta girando, verrà
caricato ed esaminato automaticamente. Se la finestra di
visualizzazione al momento non sarà visibile lo diventarà se @{"CX_POPUP" link i_config} è
impostato a YES.


Qualche nota:

 · Ci sono 5 colonne, la prima è considerata una data, la seconda
   l'ora, la quarta sono opzioni e l'ultima un comando shell.

 · una linea che inzia con '#' è calcolata come un commento.

 · le linee vuote sono ignorate.

 · Il carattere '|' separa le colonne.


--

Esempio di linea:

@{b}4.2. | 12:15 | La pizza si raffredda. | m | RequestChoice "Richiesta" "Scusa!" Ok@{ub}

Il carattere '|' separa le colonne, solo la terza non ha nessun
significato particolare. Le ultime due sono opzionali.

Significato delle colonne:

@{b}1.@{ub} Questa viene considerata una data secondo la convenzione:
   giorno.mese.anno. Non è necessario scrivere l'anno, verrà scelto
   l'anno corrente caso d'omissione. Si possono utilizzare due cifre
   per indicare l'anno, verrà automaticamente completato (aggiungete
   1900 o 2000, se è >75 anni nel passato).

   Si può anche omettere il mese, in questo caso verrà impostato al
   mese corrente o quello sucessivo, dipende se la data appartiene al
   futuro o meno.
   Inoltre, si può scrivere "dayX" o "day=X" dove 0<X<8, dove X è un
   giorno della settimana (inizia con domenica). Alternativamente, si
   può scrivere l'abbreviazione in inglese (sun = domenica, mon =
   lunedì) o in tedesco ("mo", "di",... ).

   Si può mettere un periodo subito a destra della data, ":x" significa
   "ogni x giorni dalla data". Se nessuna data viene riconosciuta il testo
   verrà stampato direttamente con la data della riga precedente.

@{b}2.@{ub} Dovreste usare questa colonna per l'ora, ma a vostra scelta. Se
   inserite un orario che corrisponda a "ore:minuti" verrà analizzato e
   utilizzato se impostata l'opzione t (vedi sotto), il formato non accetta
   a.m/p.m. solo 24 ore/giorno.
   Se questa colonna esiste, il suo contenuto verrà visualizzato centrato.

@{b}3.@{ub} Il testo dell'evento. Se utilizzate l'opzione m, verrà stampato
   in un altro colore.

@{b}4.@{ub} Colonna delle opzioni.
   Per ora esistono le seguenti opzioni:

    @{b}m (marked)@{ub}     Evidenzia una data.
    @{b}h (hold)@{ub}       Mostra la riga indipendentemente dalla data, se
                   questa non ha una data valida, verrà mostrata alla fine
                   della lista.
    @{b}b (before)@{ub}     Serve per vedere date future. Con bX o b=X con
                   0<X<2^32, si può impostare il numero massimo di giorni
                   tra oggi e l'evento da ricordare.
    @{b}a (after)@{ub}      Come @{b}b@{ub}, ma è per gli eventi nel passato.
    @{b}s (separator)@{ub}  Lascia una linea vuota dopo questo evento.
    @{b}t (time)@{ub}       Richiama l'avvenimento X minuti prima che
                    accada, e ogni minuto seguente (con tX o t=X).
                    Se viene specificato un suono, verrà suonato sempre a
                    più alto volume.
    @{b}r (remember)@{ub}   Se l'evento scade, verrà stampato con un punto
                    esclamativo in più per ogni giorno (max 3).
    @{b}e (exactly)@{ub}    L'evento verrà mostrato esattamente quando
                    accade (o scade) e mai più.
    @{b}o (once)@{ub}

@{b}5.@{ub} L'intera colonna verrà interpretata come un comando shell.
   che verrà eseguito al momento specificato (seconda colonna) solo se
   quest'ultima è valida.

Consultate il file eventi d'esempio:

  @{"schedule" link schedule/main}

@endnode


@node i_use "Scheduler - Uso di Scheduler"
Ci sono vari modi per utilizzare Scheduler:

 · Il Menu:

   @{b}Nascondi          (H)@{ub}  Nasconde la finestra del programma.
   @{b}Notifica ricevuta    @{ub}  Interrompe la notifica visiva e sonora
                          di tutti gli eventi correnti.
   @{b}Informazioni      (?)@{ub}  Mostra alcune informazioni sul programma.
   @{b}Esci              (Q)@{ub}  Esce dal programma.

 · Usare il ToolType @{"COMMAND" link i_config} per far eseguire un'azione
   con un doppio click sulla finestra, come far partire un editor.

 · Con i segnali:

   @{b}CTRL-C@{ub}  Esce dal programma.
   @{b}CTRL-E@{ub}  Come la voce del menu "Esci".
   @{b}CTRL-F@{ub}  Ricarica il file eventi.

@endnode


@node i_author "Scheduler - Autore e indirizzi"

L'indirizzo per bug-report, idee e altre cose, si spera, utili:

@{b}Posta normale:@{ub}
  pinc Software / Axel Dörfler
  Lange Straße 4a
  49080 Osnabrück
  Germany

@{b}Indirizzo eMail:@{ub}
  axeld@pinc-software.de (Axel Dörfler)
  (adoerfle@uos.de)

@{b}WWW:@{ub}
  www.pinc-software.de/


Se volete inviare piccole donazioni o cartoline, siete i benvenuti :)

@endnode


@node i_distr "Scheduler - Note di Copyright e distribuzione"
The package is ©1999-2000 by Axel Dörfler. All rights reserved.

Al momento in cui scrivo, @{b}pinc Software@{ub} (vedi Menu/Informazioni)
non è una persona giuridica esistente, rappresenta me e nessun altro.

Avete il permesso di copiarlo su BBS, Aminet e altre distribuzioni finché
venga inclusa nella distribuzione questo documento e non ne ricaviate alcun
interesse economico.

L'uso di Scheduler è a vostro rischio, non sono responsabile di qualsiasi
danno o problema possiate avere dal suo utilizzo.

Se non siete sicuri di quello che state leggendo, riferitevi alla
documentazione @{"tedesca" link distr}.

@endnode


@node f_main "Scheduler - une Description brève"

@{b}Scheduler 1.9 (28.10.2000)@{ub}

Ce document comprend les chapitres suivants:

  @{" Introduction   " link e_intro   } Qu'est-ce que c'est? Et pourquoi j'en a besoin?
  @{" Installation   " link e_install }
  @{" Configuration  " link e_config  }
  @{" Agenda         " link e_schedule} Comment est-ce que je fais un agenda?
  @{" Auteur         " link e_author  } Avec l'adresse
  @{" Droit d'auteur " link e_distr   } Et l'indication de distribution
  @{" Remerciement   " link e_credits }
  @{" Histoire       " link e_history }

Il y a aussi une traduction complete à cettes langues:
  @{" English " link e_main}  @{" Deutsch " link main}  @{" Italiano " link i_main}

C'est tous... Si tu sais quelqu'un qui voudrait traduire cette
document, tu le demanderas à faire cela? Ce serait très bien.

Axel Dörfler.

Copyright ©1999-2000 pinc Software. Alle Rechte vorbehalten.

@endnode