From 5e4aa8e9aba34bb101923685c23f0f6681a12812 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Hugo=20H=C3=B6rnquist?= Date: Sun, 12 Dec 2021 23:29:06 +0100 Subject: Add documenttation for javascript rewrite. --- doc/ref/javascript/globals.texi | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 doc/ref/javascript/globals.texi (limited to 'doc/ref/javascript/globals.texi') diff --git a/doc/ref/javascript/globals.texi b/doc/ref/javascript/globals.texi new file mode 100644 index 00000000..5ef7a43b --- /dev/null +++ b/doc/ref/javascript/globals.texi @@ -0,0 +1,41 @@ +@node globals +@subsection globals.ts + +Different variables and values which for different reasons needs to be +global. Window Value's are those that are bound to the @code{window} +context in JavaScript, so is really always available, no opt out. + +@deftypevar {Map} vcal_objects +All VEvent objects on current page, indexed by their unique identifiers. + +A global object store. +@end deftypevar + +@deftypevar {Map} event_calendar_mapping +Mapping from VEvent unique identifier, to name of its calendar. Should +probably not be global, so refrain from using it. +@end deftypevar + +@deftypevr {Window Value} {Map} vcal_objects +The exact same object store as the regular variable of the same +name. Mostly here for human debugability. +@end deftypevr + +@deftypevr {Window Value} {@code{'month'} | @code{'string'}} VIEW +How the calendar is currently formatted. Should be set by the backend +through a simple @code{script}-tag. +@end deftypevr + +@deftypevr {Window Value} {boolean} EDIT_MODE +However editing of events is enabled or not. +Should be set by the backend through a simple @code{script}-tag. +@end deftypevr + +@deftypevr {Window Value} {string} default_calendar +Name of the calendar to assume when creating new events. +Should be set by the backend through a simple @code{script}-tag. +@end deftypevr + +@c TODO addNewEvent +@c @deftypevr {Window Value} {string} default_calendar +@c @end deftypevr -- cgit v1.2.3