From 50dc7bb79af62b819648c67c5ccd33b3470e626c Mon Sep 17 00:00:00 2001 From: David Thompson Date: Sat, 10 Mar 2018 21:41:36 -0500 Subject: Add Haunt manual. --- manuals/haunt/Posts.html | 151 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 151 insertions(+) create mode 100644 manuals/haunt/Posts.html (limited to 'manuals/haunt/Posts.html') diff --git a/manuals/haunt/Posts.html b/manuals/haunt/Posts.html new file mode 100644 index 0000000..839be37 --- /dev/null +++ b/manuals/haunt/Posts.html @@ -0,0 +1,151 @@ + + + + + + +Posts (Haunt Reference Manual) + + + + + + + + + + + + + + + + + + + +
+

+Next: , Previous: , Up: Programming Interface   [Contents][Index]

+
+
+ +

5.2 Posts

+ +
+
(use-modules (haunt post))
+
+ +

Posts represent the articles that are kept in a site’s post directory +and written in a markup format that Haunt can +understand. see Readers) for how files on disk can be transformed +into posts. +

+
+
Scheme Procedure: make-post file-name metadata sxml
+

Create a new post object that represents the contents of the file +file-name. The body of the post, sxml, is represented as +an SXML tree (see SXML in GNU Guile Reference Manual) +and the metadata is an association list (see Association Lists in GNU Guile Reference Manual) of arbitrary +key/value pairs. +

+ +
+
Scheme Procedure: post? object
+

Return #t if object is a post. +

+ +
+
Scheme Procedure: post-file-name post
+

Return the file name for post. +

+ +
+
Scheme Procedure: post-metadata post
+

Return the metadata association list for post. +

+ +
+
Scheme Procedure: post-sxml post
+

Return the SXML tree for post. +

+ +
+
Scheme Procedure: post-ref post key
+

Return the metadata value corresponding to key within +post. +

+ +
+
Scheme Procedure: post-slug post
+

Transform the title of post into a URL slug suitable for the +file name of a web page. +

+ +
+
Scheme Variable: %default-date
+

The default date of a post when no other date is specified in the +metadata association list. +

+ +
+
Scheme Procedure: post-date post
+

Return the date for post, or %default-date if no date is +specified. +

+ +
+
Scheme Procedure: posts/reverse-chronological posts
+

Sort posts, a list of posts, in reverse chronological order. +

+ +
+
Scheme Procedure: posts/group-by-tag posts
+

Create an association list of tags mapped to the posts in the list +posts that used them. +

+ +
+
+

+Next: , Previous: , Up: Programming Interface   [Contents][Index]

+
+ + + + + -- cgit v1.2.3