diff options
author | Hugo Hörnquist <hugo@lysator.liu.se> | 2023-09-13 00:10:35 +0200 |
---|---|---|
committer | Hugo Hörnquist <hugo@lysator.liu.se> | 2023-09-13 00:10:35 +0200 |
commit | 310ee19bfa2815e2cba82593ccf60c558f4a3172 (patch) | |
tree | 4dc5888a128e38e62cadcdad95da89bbfa0559be /doc/ref/vcomponent | |
parent | Merge branch 'next' into datarewrite-structures (diff) | |
download | calp-310ee19bfa2815e2cba82593ccf60c558f4a3172.tar.gz calp-310ee19bfa2815e2cba82593ccf60c558f4a3172.tar.xz |
Repair texinfo files after merge.
Diffstat (limited to '')
-rw-r--r-- | doc/ref/vcomponent.texi | 157 | ||||
-rw-r--r-- | doc/ref/vcomponent/create.texi | 38 | ||||
-rw-r--r-- | doc/ref/vcomponent/general.texi | 119 |
3 files changed, 159 insertions, 155 deletions
diff --git a/doc/ref/vcomponent.texi b/doc/ref/vcomponent.texi index d0e032b3..76acf6c3 100644 --- a/doc/ref/vcomponent.texi +++ b/doc/ref/vcomponent.texi @@ -8,158 +8,5 @@ the generialization of VCALENDAR, VEVENT, ... Some of these values are still Calp specific. -@defvr {Configuration Variable} calendar-files -List of filepaths -@end defvr - -@defvr {Configuration Variable} default-calendar -@end defvr - -@c ===== Concepts ===== - -@c - internal fields -@c DATA layout -@c how does multiple value work? - -@c ===== BASE ===== - -@deftp {Record Type} <vline> - -@c - key -@c - value -@c - parameters -@c - source - -@defun make-vline key value [ht=(make-hash-table)] -@var{ht} is the hash table storing the parameters, can be explicitly -given if need for optimizations arrises. -@end defun - -@defun vline? x -@end defun - -@defun vline-key vline -@end defun - -@deffn {Slot} vline-source vline -@end deffn - -@deffn {Slot} value vline -@end deffn - -@deffn {Slot} param vline key -@end deffn - -@defun delete-parameter! vline key -@end defun - -@defun parameters vline -Key a list of all parameters -@example -((key value) ...) -@end example -@end defun - -@end deftp - - -@deftp {Record Type} <vcomponent> - -@defun vcomponent? x -@end defun - -@defun make-vcomponent [type='VIRTUAL] -@end defun - -@defun children vcomponent -Returns all direct children of vcomponent, as a list of vcomponents. -@end defun - -@deffn {Slot} parent vcomonent -@end deffn - -@defun type vcomponent -Returns the type of this vcomponent, as a symbol. Probably one of -@code{VCALENDAR}, @code{VEVENT}, ... -@end defun - -@defun add-child! parent child -Adds child to the parents child list, but also updates the child to -have parent in its parent slot -@end defun - -@deffn {Prop} prop* vcomponent key -@deffnx {Prop} prop vcomponent key -@var{prop*} return the vline object, while @var{prop} is equivalent to -@lisp -(value (prop* vcomponent key)) -@end lisp -@end deffn - -@defun {(extract field)} vcomponent -@defunx {(extract* field)} vcomponent -Curried version of @var{prop}. -@end defun - -@defun delete-property! component key -@end defun - -@defun properties comopnent -@example -((key . value) ...) -@end example -@end defun - -@end deftp - -@defun copy-vcomponent vcomponent -Creates a shallow copy of @var{vcomponent}. If the source object has a -parent, then than parent adopts the new event also. -@end defun - - -@defun x-property? symb -Does symbol start with ``X-''? -@end defun - -@defun internal-field? symb [prefix="-"] -@end defun - -@node VComponent Create -@section (vcomponent create) - -Procedures for declarativly creating components (instead of the -primitive procedural API). - -@defun vcomponent type [key: prop] ... children -Creates a new vcomponent of @var{type}. Each kv-pair should contain a -keyword @var{key}, and a value which is either a direct value, or the -return value of @code{with-parameters} or -@code{as-list}. @var{children} should be a list of other vcomponent's. -@end defun - -@defun vcalendar -@defunx vevent -@defunx vtimezone -@defunx standard -@defunx daylight -Calls @code{vcomponent}, with type set to the procedure name (but -up-cased). -@end defun - -@defun with-parameters [key: param] ... value -Allows setting parameters for a property as created by @code{vcomponent}. - -@var{value} follows the same rules as in @code{vcomponent}. Multiple -@var{key}, @var{value} pairs can be given, where each key must be a keyword. -@end defun - -@defun as-list lst -Allows setting list values when using @code{vcomponent}. - -Without this a list value would be stored as a single value, while -with this a list of values is instead stored (as, for example, in EXDATE). - -A list of list types could be hard-coded, but even then this procedure -is needed since custom types might need it. -@end defun +@include vcomponent/general.texi +@include vcomponent/create.texi diff --git a/doc/ref/vcomponent/create.texi b/doc/ref/vcomponent/create.texi new file mode 100644 index 00000000..88c83e03 --- /dev/null +++ b/doc/ref/vcomponent/create.texi @@ -0,0 +1,38 @@ +@node VComponent Create +@section Vcomponent Create + +Procedures for declarativly creating components (instead of the +primitive procedural API). + +@defun vcomponent type [key: prop] ... children +Creates a new vcomponent of @var{type}. Each kv-pair should contain a +keyword @var{key}, and a value which is either a direct value, or the +return value of @code{with-parameters} or +@code{as-list}. @var{children} should be a list of other vcomponent's. +@end defun + +@defun vcalendar +@defunx vevent +@defunx vtimezone +@defunx standard +@defunx daylight +Calls @code{vcomponent}, with type set to the procedure name (but +up-cased). +@end defun + +@defun with-parameters [key: param] ... value +Allows setting parameters for a property as created by @code{vcomponent}. + +@var{value} follows the same rules as in @code{vcomponent}. Multiple +@var{key}, @var{value} pairs can be given, where each key must be a keyword. +@end defun + +@defun as-list lst +Allows setting list values when using @code{vcomponent}. + +Without this a list value would be stored as a single value, while +with this a list of values is instead stored (as, for example, in EXDATE). + +A list of list types could be hard-coded, but even then this procedure +is needed since custom types might need it. +@end defun diff --git a/doc/ref/vcomponent/general.texi b/doc/ref/vcomponent/general.texi new file mode 100644 index 00000000..4a02bd48 --- /dev/null +++ b/doc/ref/vcomponent/general.texi @@ -0,0 +1,119 @@ +@node General VComponent Utilities +@section General Utilities + + +@defvr {Configuration Variable} calendar-files +List of filepaths +@end defvr + +@defvr {Configuration Variable} default-calendar +@end defvr + +@c ===== Concepts ===== + +@c - internal fields +@c DATA layout +@c how does multiple value work? + +@c ===== BASE ===== + +@deftp {Record Type} <vline> + +@c - key +@c - value +@c - parameters +@c - source + +@defun make-vline key value [ht=(make-hash-table)] +@var{ht} is the hash table storing the parameters, can be explicitly +given if need for optimizations arrises. +@end defun + +@defun vline? x +@end defun + +@defun vline-key vline +@end defun + +@deffn {Slot} vline-source vline +@end deffn + +@deffn {Slot} value vline +@end deffn + +@deffn {Slot} param vline key +@end deffn + +@defun delete-parameter! vline key +@end defun + +@defun parameters vline +Key a list of all parameters +@example +((key value) ...) +@end example +@end defun + +@end deftp + + +@deftp {Record Type} <vcomponent> + +@defun vcomponent? x +@end defun + +@defun make-vcomponent [type='VIRTUAL] +@end defun + +@defun children vcomponent +Returns all direct children of vcomponent, as a list of vcomponents. +@end defun + +@deffn {Slot} parent vcomonent +@end deffn + +@defun type vcomponent +Returns the type of this vcomponent, as a symbol. Probably one of +@code{VCALENDAR}, @code{VEVENT}, ... +@end defun + +@defun add-child! parent child +Adds child to the parents child list, but also updates the child to +have parent in its parent slot +@end defun + +@deffn {Prop} prop* vcomponent key +@deffnx {Prop} prop vcomponent key +@var{prop*} return the vline object, while @var{prop} is equivalent to +@lisp +(value (prop* vcomponent key)) +@end lisp +@end deffn + +@defun {(extract field)} vcomponent +@defunx {(extract* field)} vcomponent +Curried version of @var{prop}. +@end defun + +@defun delete-property! component key +@end defun + +@defun properties comopnent +@example +((key . value) ...) +@end example +@end defun + +@end deftp + +@defun copy-vcomponent vcomponent +Creates a shallow copy of @var{vcomponent}. If the source object has a +parent, then than parent adopts the new event also. +@end defun + +@defun x-property? symb +Does symbol start with ``X-''? +@end defun + +@defun internal-field? symb [prefix="-"] +@end defun |