aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHugo Hörnquist <hugo@lysator.liu.se>2023-09-12 10:35:37 +0200
committerHugo Hörnquist <hugo@lysator.liu.se>2023-09-12 10:35:37 +0200
commita3675c13336afb0b37e0f211c649813f4f291224 (patch)
tree53c480199fe2ce625af575188740fa4d12507712
parentRework file tree structure for info files. (diff)
downloadcalp-a3675c13336afb0b37e0f211c649813f4f291224.tar.gz
calp-a3675c13336afb0b37e0f211c649813f4f291224.tar.xz
Further doc work.
-rw-r--r--doc/ref/general.texi3
-rw-r--r--doc/ref/general/io.texi2
-rw-r--r--doc/ref/general/util-path.texi7
-rw-r--r--doc/ref/general/util.texi3
-rw-r--r--doc/ref/vcomponent.texi7
-rw-r--r--doc/ref/web.texi4
-rw-r--r--doc/ref/web/query.texi9
-rw-r--r--doc/ref/web/routes.texi (renamed from doc/ref/web/web.texi)23
-rw-r--r--doc/ref/web/uri-query.texi7
9 files changed, 41 insertions, 24 deletions
diff --git a/doc/ref/general.texi b/doc/ref/general.texi
index be68fca6..f42b90f3 100644
--- a/doc/ref/general.texi
+++ b/doc/ref/general.texi
@@ -1,6 +1,9 @@
@node Generally Useful Utilities
@chapter Generally Useful Utilities
+These are all general utilitios with no direct relation to Calp. Many
+of these should be generally useful in any project.
+
@include general/datetime.texi
@include general/zic.texi
@include general/srfi-41.texi
diff --git a/doc/ref/general/io.texi b/doc/ref/general/io.texi
index 8c83ddcf..3f67700b 100644
--- a/doc/ref/general/io.texi
+++ b/doc/ref/general/io.texi
@@ -1,5 +1,5 @@
@node IO operations
-@section IO
+@section IO operations
Provided by module @code{(hnh util io)}.
diff --git a/doc/ref/general/util-path.texi b/doc/ref/general/util-path.texi
index 384915ef..9c1da19b 100644
--- a/doc/ref/general/util-path.texi
+++ b/doc/ref/general/util-path.texi
@@ -1,8 +1,13 @@
@node Path Utilities
@section Path Utilities
-Provided by the module @code{(hnh util path)}.
+An extended path library for Guile. This library builds upon the path
+utilities provided by @xref{File System,,,guile}, but adds
+manipulation procedures. These procedures should work no matter what
+the systems directory delimiter is, even though this documentation
+uses ``/'' for its examples.
+Provided by the module @code{(hnh util path)}.
@defun path-absolute? string
Alias of @code{absolute-file-name?} from Guile.
diff --git a/doc/ref/general/util.texi b/doc/ref/general/util.texi
index bae19987..a85ff661 100644
--- a/doc/ref/general/util.texi
+++ b/doc/ref/general/util.texi
@@ -1,6 +1,9 @@
@node Miscellaneous utilities
@section Miscellaneous utilities
+A kitchen sink utility library. Note should be taken that some core
+procedures and forms are replaced, but all in compatible ways.
+
Provided by the module @code{(hnh util)}.
@defmac define-syntax [stx]
diff --git a/doc/ref/vcomponent.texi b/doc/ref/vcomponent.texi
index 983a75e2..dac47348 100644
--- a/doc/ref/vcomponent.texi
+++ b/doc/ref/vcomponent.texi
@@ -1,6 +1,13 @@
@node VComponents
@chapter VComponents
+Procedures for manipulating VComponents.
+VComponents are the general container type as specified by RFC5545
+(iCalendar). The term VComponent isn't from the standard, but rather
+the generialization of VCALENDAR, VEVENT, ...
+
+Some of these values are still Calp specific.
+
@defvr {Configuration Variable} calendar-files
List of filepaths
@end defvr
diff --git a/doc/ref/web.texi b/doc/ref/web.texi
index e3c73f44..8574e166 100644
--- a/doc/ref/web.texi
+++ b/doc/ref/web.texi
@@ -1,4 +1,6 @@
@node Webservers and -Clients
@chapter Webservers and -Clients
-@include web/web.texi
+@include web/query.texi
+@include web/uri-query.texi
+@include web/routes.texi
diff --git a/doc/ref/web/query.texi b/doc/ref/web/query.texi
new file mode 100644
index 00000000..df3ba953
--- /dev/null
+++ b/doc/ref/web/query.texi
@@ -0,0 +1,9 @@
+@node Web Query
+@section (web query)
+
+@defun parse-query query-string [encoding=''UTF-8'']
+Given a string like ``?key=value&other=something'', returns
+@code{(key: "value" other: "something")}. Performs uri-decoding of
+both key and value. A key without a value decodes to that key, with
+itself as its value
+@end defun
diff --git a/doc/ref/web/web.texi b/doc/ref/web/routes.texi
index 69ab726f..a2249c7a 100644
--- a/doc/ref/web/web.texi
+++ b/doc/ref/web/routes.texi
@@ -1,24 +1,5 @@
-@node Web Stuff
-@section Web Stuff
-
-@subsection (web query)
-
-@defun parse-query query-string [encoding=''UTF-8'']
-Given a string like ``?key=value&other=something'', returns
-@code{(key: "value" other: "something")}. Performs uri-decoding of
-both key and value. A key without a value decodes to that key, with
-itself as its value
-@end defun
-
-
-@subsection (web uri-query)
-
-@defun encode-query-parameters parameters
-Given the association list @var{parameter}, encode it into a query
-string on the form ``key=value&...''.
-@end defun
-
-@subsection (web http make-routes)
+@node HTTP Routes
+@section (web http make-routes)
@defun parse-endpoint-string str
Only really public for tests.
diff --git a/doc/ref/web/uri-query.texi b/doc/ref/web/uri-query.texi
new file mode 100644
index 00000000..d3df3a70
--- /dev/null
+++ b/doc/ref/web/uri-query.texi
@@ -0,0 +1,7 @@
+@node URI Query
+@section (web uri-query)
+
+@defun encode-query-parameters parameters
+Given the association list @var{parameter}, encode it into a query
+string on the form ``key=value&...''.
+@end defun