aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHugo Hörnquist <hugo@lysator.liu.se>2023-09-13 00:10:35 +0200
committerHugo Hörnquist <hugo@lysator.liu.se>2023-09-13 00:10:35 +0200
commit310ee19bfa2815e2cba82593ccf60c558f4a3172 (patch)
tree4dc5888a128e38e62cadcdad95da89bbfa0559be
parentMerge branch 'next' into datarewrite-structures (diff)
downloadcalp-310ee19bfa2815e2cba82593ccf60c558f4a3172.tar.gz
calp-310ee19bfa2815e2cba82593ccf60c558f4a3172.tar.xz
Repair texinfo files after merge.
-rw-r--r--doc/ref/general.texi1
-rw-r--r--doc/ref/general/data-formats.texi1
-rw-r--r--doc/ref/general/lens.texi3
-rw-r--r--doc/ref/introspection.texi2
-rw-r--r--doc/ref/vcomponent.texi157
-rw-r--r--doc/ref/vcomponent/create.texi38
-rw-r--r--doc/ref/vcomponent/general.texi119
7 files changed, 163 insertions, 158 deletions
diff --git a/doc/ref/general.texi b/doc/ref/general.texi
index b97dece0..a6fce4e7 100644
--- a/doc/ref/general.texi
+++ b/doc/ref/general.texi
@@ -29,3 +29,4 @@ of these should be generally useful in any project.
@include general/data-formats.texi
@include general/data-stores.texi
@include general/webdav.texi
+@include general/sxml.texi
diff --git a/doc/ref/general/data-formats.texi b/doc/ref/general/data-formats.texi
index 037d3ae7..592b3085 100644
--- a/doc/ref/general/data-formats.texi
+++ b/doc/ref/general/data-formats.texi
@@ -1,5 +1,6 @@
@node Data Formats
@section Data Formats
+
A data format is some way that an individual event may get serialized
to disk. The default is iCalendar (TODO reference RFC 5545), but
others might be available (TODO footnote and reference xcal).
diff --git a/doc/ref/general/lens.texi b/doc/ref/general/lens.texi
index eeddd6ca..e59b5d72 100644
--- a/doc/ref/general/lens.texi
+++ b/doc/ref/general/lens.texi
@@ -38,10 +38,9 @@ Focuses the element at index @var{idx} in a list.
@end deftp
@deftp {Scheme Lens} car*
-@deftp {Scheme Lens} cdr*
+@deftpx {Scheme Lens} cdr*
Focuses the first or second element of a pair.
@end deftp
@defun each object lens proc
@end defun
-
diff --git a/doc/ref/introspection.texi b/doc/ref/introspection.texi
index 9c8387d2..3ac31d11 100644
--- a/doc/ref/introspection.texi
+++ b/doc/ref/introspection.texi
@@ -57,7 +57,7 @@ whose end in @var{extension}.
@defun all-modules-under-directory directory
Finds all ``.scm'' files under @var{directory}, and then read them to
-find a module declaration @pref{find-module-declaration}. Returns both
+find a module declaration (@pxref{find-module-declaration}). Returns both
the list of all the files, as well as all modules found, as a list of
module lists, each one suitable to be sent to
@code{reslove-interface}.
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