diff options
author | Hugo Hörnquist <hugo@lysator.liu.se> | 2021-01-06 01:16:11 +0100 |
---|---|---|
committer | Hugo Hörnquist <hugo@lysator.liu.se> | 2021-01-06 01:16:11 +0100 |
commit | 34c12d524d3a9238e174864220ab04adaf0cd7d1 (patch) | |
tree | 3b6caad16f7488f72ce4d57610ba5affc00eba2b /doc/ref/javascript/types.texi | |
parent | Start on propper documentation (of js so far). (diff) | |
download | calp-34c12d524d3a9238e174864220ab04adaf0cd7d1.tar.gz calp-34c12d524d3a9238e174864220ab04adaf0cd7d1.tar.xz |
Split javascript doc into multiple files.
Diffstat (limited to 'doc/ref/javascript/types.texi')
-rw-r--r-- | doc/ref/javascript/types.texi | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/doc/ref/javascript/types.texi b/doc/ref/javascript/types.texi new file mode 100644 index 00000000..e57af4a2 --- /dev/null +++ b/doc/ref/javascript/types.texi @@ -0,0 +1,39 @@ +@node types +@section types.js + +Collection of type information for calendar data. + +@defvar all_types +Name of all valid icalendar types. + + text, uri, binary, float, integer, date-time, date, duration, + period, utc-offset, cal-address, recur, boolean, +@end defvar + +@defvar property_names +All known names properties (top level keys) can have. +Such as ``calscale'', ``dtstart'', ... +@end defvar + +@defvar valid_fields +Which property fields each component can hold. + +@verbatim +{ 'VCALENDAR': ['PRODID', 'VERSION', 'CALSCALE', 'METHOD'], + ... +} +@end verbatim +@end defvar + +@defvar valid_input_types +Which types are valid to store under each property. +If multiple values are an option for that property, then +the list of possibilities will contain a sub-list (see example). + +@verbatim +{ 'DTSTART': ['date', 'date-time'], + 'CATEGORIES': [['text']], + ... +} +@end verbatim +@end defvar |