aboutsummaryrefslogtreecommitdiff
path: root/doc/ref/guile.texi
diff options
context:
space:
mode:
Diffstat (limited to 'doc/ref/guile.texi')
-rw-r--r--doc/ref/guile.texi65
1 files changed, 62 insertions, 3 deletions
diff --git a/doc/ref/guile.texi b/doc/ref/guile.texi
index 67828b09..eb9e3bcc 100644
--- a/doc/ref/guile.texi
+++ b/doc/ref/guile.texi
@@ -1,10 +1,68 @@
@node Guile
@chapter Guile
+@include guile/datetime.texi
+@include guile/srfi-41.texi
@include guile/util.texi
@include guile/util-path.texi
+@include guile/util-config.texi
@include guile/vcomponent.texi
+@node Errors and Conditions
+@section Errors and Conditions
+
+@subsection ``Special'' Errors
+
+@deftp{Error type} return
+Thrown in some sub-mains to quickly return from the sub-function.
+Should possibly be replaced by an explicit return-continuation.
+@end deftp
+
+@deftp{Error type} warning fmt args
+Thrown when @code{warnings-are-errors} is true.
+@end deftp
+
+@deftp{Error type} max-page page-number
+@end deftp
+
+@subsection ``Regular'' Errors
+All below mentioned error types behave as expected, e.g., they are
+produced through @code{scm-error}.
+
+@deftp{Error Type} configuration-error
+Thrown by (calp util config), in some scenarios.
+@TODO{Better documentation}
+@end deftp
+
+@deftp{Error Type} c-parse-error
+Errors thrown by our make-shift C parser.
+@end deftp
+
+@deftp{Error Type} decoding-error
+thrown by base64 in some cases
+@end deftp
+
+@deftp{Error Type} parse-error
+Thrown by some things related to parsing, but not all.
+@TODO{normalize parsing errors further}
+@end deftp
+
+@deftp{Error Type} graph-error
+The first element of data is guaranteed to be the graph which caused
+the error.
+@end deftp
+
+@deftp{Error Type} missing-helper
+A helper program we wanted was missing, could be resolved by somehow
+downloading it into one of the searched locations.
+
+@example
+data : (program-name : string)
+ , (searched-locations : (list string))
+@end example
+@end deftp
+
+
@node Other
@section Other
@@ -43,8 +101,8 @@ type = 'BINARY | 'BOOLEAN | 'CAL-ADDRES | 'DATE | 'DATE-TIME
@subsubsection types
@defun escape-chars str
-Escape ``@verb{|,|}'', ``@verb{|;|}'' and ``@verb{|\|}'' with a
-backslash, and encode newlines as ``@verb{|\n|}''.
+Escape @code{,}, @code{;} and @code{\} with a
+backslash, and encode newlines as @code{\n}.
@end defun
@defun get-writer type
@@ -80,7 +138,7 @@ type = 'BINARY | 'BOOLEAN | 'CAL-ADDRES | 'DATE | 'DATE-TIME
@defun ns-wrap
@lisp
(define (ns-wrap sxml)
- `(icalendar (@ (xmlns "urn:ietf:params:xml:ns:icalendar-2.0"))
+ `(icalendar (@@ (xmlns "urn:ietf:params:xml:ns:icalendar-2.0"))
,sxml))
@end lisp
Where @var{sxml} is expected to be the output of @var{vcomponent->sxcal}.
@@ -121,3 +179,4 @@ Note that @var{body} is guarded through a dynamic-wind, meaning that
even non-local exits will restore @var{component} to its initial
state.
@end defmac
+