summaryrefslogtreecommitdiff
path: root/website/manual/Atom.html
blob: a279137c330f9d6a4b3ef52ea6a6ad91ab207de6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Copyright (C) 2015 David Thompson


Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.  A
copy of the license is included in the section entitled "GNU Free
Documentation License". -->
<!-- Created by GNU Texinfo 6.3, http://www.gnu.org/software/texinfo/ -->
<head>
<title>Haunt Reference Manual: Atom</title>

<meta name="description" content="Haunt Reference Manual: Atom">
<meta name="keywords" content="Haunt Reference Manual: Atom">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Builders.html#Builders" rel="up" title="Builders">
<link href="Contributing.html#Contributing" rel="next" title="Contributing">
<link href="Blog.html#Blog" rel="prev" title="Blog">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smalllisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en">
<a name="Atom"></a>
<div class="header">
<p>
Previous: <a href="Blog.html#Blog" accesskey="p" rel="prev">Blog</a>, Up: <a href="Builders.html#Builders" accesskey="u" rel="up">Builders</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Atom-1"></a>
<h4 class="subsection">5.6.3 Atom</h4>

<div class="example">
<pre class="example">(use-modules (haunt builder atom))
</pre></div>

<dl>
<dt><a name="index-atom_002dfeed"></a>Scheme Procedure: <strong>atom-feed</strong> <em>[#:file-name #:subtitle #:filter #:max-entries #:blog-prefix]</em></dt>
<dd><p>Return a builder procedure that renders a site&rsquo;s posts as an Atom
feed.  All arguments are optional:
</p>
<dl compact="compact">
<dt><var>file-name:</var></dt>
<dd><p>The page file name.  The default is <samp>feed.xml</samp>.
</p>
</dd>
<dt><var>subtitle</var></dt>
<dd><p>The feed subtitle.  The default is &ldquo;Recent Posts&rdquo;.
</p>
</dd>
<dt><var>filter</var></dt>
<dd><p>The procedure called to manipulate the posts list before rendering.
The default is to keep all posts and sort them in reverse
chronological order.
</p>
</dd>
<dt><var>max-entries</var></dt>
<dd><p>The maximum number of posts to render in the feed.  The default is 20.
</p></dd>
</dl>

</dd></dl>

<dl>
<dt><a name="index-atom_002dfeeds_002dby_002dtag"></a>Scheme Procedure: <strong>atom-feeds-by-tag</strong> <em>[#:prefix #:filter #:max-entries #:blog-prefix]</em></dt>
<dd><p>Return a builder procedure that renders an atom feed for every tag
used in a post.  All arguments are optional:
</p>
<dl compact="compact">
<dt><var>prefix</var></dt>
<dd><p>The directory in which to write the feeds.  The default is
<samp>feeds/tags</samp>.
</p>
</dd>
<dt><var>filter</var></dt>
<dd><p>The procedure called to manipulate the posts list before rendering.
The default is to keep all posts and sort them in reverse
chronological order.
</p>
</dd>
<dt><var>max-entries</var></dt>
<dd><p>The maximum number of posts to render in each feed.  The default is
20.
</p>
</dd>
</dl>

</dd></dl>




</body>
</html>