diff options
author | Hugo Hörnquist <hugo@lysator.liu.se> | 2023-09-05 11:41:46 +0200 |
---|---|---|
committer | Hugo Hörnquist <hugo@lysator.liu.se> | 2023-09-05 11:41:46 +0200 |
commit | f653a01328be3b8be6af35c0c96867623765ca5b (patch) | |
tree | aee9a5d3abfc39270f55defd7bc1a7e47920ffc3 /doc/ref/javascript/globals.texi | |
parent | Minor whitespace cleanup. (diff) | |
download | calp-f653a01328be3b8be6af35c0c96867623765ca5b.tar.gz calp-f653a01328be3b8be6af35c0c96867623765ca5b.tar.xz |
Move JS documentation into the JS-code.
Texinfo was a bad match for how TypeScript is structured. This also
allows generation of jsdoc pages, which can be nice.
Another large win is that this opens up for the texinfo pages to replace
the Guile heading with different subheadings, including
- external library
- internal library
- C library
- ...
Diffstat (limited to 'doc/ref/javascript/globals.texi')
-rw-r--r-- | doc/ref/javascript/globals.texi | 41 |
1 files changed, 0 insertions, 41 deletions
diff --git a/doc/ref/javascript/globals.texi b/doc/ref/javascript/globals.texi deleted file mode 100644 index 5ef7a43b..00000000 --- a/doc/ref/javascript/globals.texi +++ /dev/null @@ -1,41 +0,0 @@ -@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<uid, VEvent>} vcal_objects -All VEvent objects on current page, indexed by their unique identifiers. - -A global object store. -@end deftypevar - -@deftypevar {Map<uid, string>} 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<uid, VEvent>} 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 |