diff --git a/doc/source/index.rst b/doc/source/index.rst index b4cf129..d8b275e 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -13,6 +13,7 @@ Contents: about install + timegenerators audiogenerators eventfilters audiogenerators-write diff --git a/doc/source/timegenerators.rst b/doc/source/timegenerators.rst new file mode 100644 index 0000000..55f256c --- /dev/null +++ b/doc/source/timegenerators.rst @@ -0,0 +1,31 @@ +Timegenerators +=============== + +A "timegenerator" is something that describe _when_ you want to do something. + +There are 3 kinds of timegenerators in larigira: + + +single +------------ + +With single, you just set a single time the event should happen. + +frequency +-------------- + +Sometimes you have something happening very regularly. For example you might want a jingle every 30minutes, or +a specific show every friday at 8PM. + +cron +---------- + +Sometimes your specification is very complex. + +For example, you might want a specific message to be sent at 10:00, 13:00, 15:00 and 18:00, but only during +working days. That would be hard to do with a single `frequency` event, so you could use a cron + + 0 10,13,15,18 * * 1-5 + +I know, that's very difficult, but is still a possibility you have. If you want to learn how to write crons, +check `this helpful site `_.