Haunt Reference Manual: Blog

From d3a9ba4ebea136fae676911148509ec3f729abbc Mon Sep 17 00:00:00 2001 From: David Thompson Date: Sun, 24 Apr 2016 15:26:44 -0400 Subject: website: Add copy of HTML manual. --- website/manual/Blog.html | 146 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 146 insertions(+) create mode 100644 website/manual/Blog.html (limited to 'website/manual/Blog.html') diff --git a/website/manual/Blog.html b/website/manual/Blog.html new file mode 100644 index 0000000..81baa16 --- /dev/null +++ b/website/manual/Blog.html @@ -0,0 +1,146 @@ + + + + + +Haunt Reference Manual: Blog + + + + + + + + + + + + + + + + + + + + + +

+ +

5.6.2 Blog

+ +

(use-modules (haunt builder blog))
+

+ +

Scheme Procedure: theme [#:name #:layout #:post-template #:collection-template]

Create a new theme named name. +

The procedure layout accepts three arguments: a site, a page +title string, and an SXML tree. Its purpose is to wrap the contents +of a post with the theme’s header/footer and return the complete SXML +tree for a web page. +

The procedure post-template accepts a single argument: a post. +Its purpose is to return an SXML tree containing the contents of the +post, applying any desired post-processing operations. The values +returned from this procedure will be wrapped in the theme’s layout. +

The procedure collection-template accepts four arguments: a +site, a title string, a list of posts, and a URL prefix string. Its +purpose is to return an SXML tree containing the body of the +collection page. The values returned from this procedure will be +wrapped in the theme’s layout. +

+ +

Scheme Procedure: theme? object: Return #t if object is a theme object. +

+ +

Scheme Procedure: blog [#:theme #:prefix #:collections]

Create a builder procedure that transforms a list of posts into pages +decorated by theme, a theme object, whose URLs start with +prefix. +

Additionally, this builder creates pages that aggregate previews of +many posts corresponding to what is specified in the list +collections. Each collection is a three element list in the +form (title file-name filter). +

title: The human readable name of the collection. +
+
file-name: The HTML file that will contain the rendered collection. +
+
filter: A procedure that accepts a list of posts as its only argument and +returns a new list of posts. The filter procedure is used to remove +and/or sort the posts into the desired form for the collection. For +example, a filter could sort posts in reverse chronological order or +select all posts that are written by a particular author. +
+

+ +

By default, a single collection is created that lists posts in reverse +chronological order and writes to index.html. +

The default theme is intended only for testing purposes. +

+ +

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