summaryrefslogtreecommitdiff
path: root/manuals/haunt/Posts.html
blob: 8a7817453afb168d78db1f98bf77c4b5c10b7d81 (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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
<!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.7, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Posts (Haunt Reference Manual)</title>

<meta name="description" content="Posts (Haunt Reference Manual)">
<meta name="keywords" content="Posts (Haunt Reference Manual)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<link href="index.html" rel="start" title="Top">
<link href="Concept-Index.html" rel="index" title="Concept Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Programming-Interface.html" rel="up" title="Programming Interface">
<link href="Readers.html" rel="next" title="Readers">
<link href="Sites.html" rel="prev" title="Sites">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {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}
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}
@media (min-width: 1140px) {
    body {
        margin-left: 14rem;
        margin-right: 4rem;
        max-width: 52rem;
    }
}

@media (min-width: 800px) and (max-width: 1140px) {
    body {
        margin-left: 6rem;
        margin-right: 4rem;
        max-width: 52rem;
    }
}

@media (max-width: 800px) {
    body {
        margin: 1rem;
    }
}

-->
</style>
<link rel="stylesheet" type="text/css" href="https://dthompson.us/css/dthompson.css">


</head>

<body lang="en">
<span id="Posts"></span><div class="header">
<p>
Next: <a href="Readers.html" accesskey="n" rel="next">Readers</a>, Previous: <a href="Sites.html" accesskey="p" rel="prev">Sites</a>, Up: <a href="Programming-Interface.html" accesskey="u" rel="up">Programming Interface</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<span id="Posts-1"></span><h3 class="section">5.2 Posts</h3>

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

<p>Posts represent the articles that are kept in a site&rsquo;s post directory
and written in a markup format that Haunt can
understand. see <a href="Readers.html">Readers</a>) for how files on disk can be transformed
into posts.
</p>
<dl>
<dt id="index-make_002dpost">Scheme Procedure: <strong>make-post</strong> <em><var>file-name</var> <var>metadata</var> <var>sxml</var></em></dt>
<dd><p>Create a new post object that represents the contents of the file
<var>file-name</var>.  The body of the post, <var>sxml</var>, is represented as
an SXML tree (see <a href="https://www.gnu.org/software/guile/manual/html_node/SXML.html#SXML">SXML</a> in <cite>GNU Guile Reference Manual</cite>)
and the metadata is an association list (see <a href="https://www.gnu.org/software/guile/manual/html_node/Association-Lists.html#Association-Lists">Association Lists</a> in <cite>GNU Guile Reference Manual</cite>) of arbitrary
key/value pairs.
</p></dd></dl>

<dl>
<dt id="index-post_003f">Scheme Procedure: <strong>post?</strong> <em><var>object</var></em></dt>
<dd><p>Return <code>#t</code> if <var>object</var> is a post.
</p></dd></dl>

<dl>
<dt id="index-post_002dfile_002dname">Scheme Procedure: <strong>post-file-name</strong> <em><var>post</var></em></dt>
<dd><p>Return the file name for <var>post</var>.
</p></dd></dl>

<dl>
<dt id="index-post_002dmetadata">Scheme Procedure: <strong>post-metadata</strong> <em><var>post</var></em></dt>
<dd><p>Return the metadata association list for <var>post</var>.
</p></dd></dl>

<dl>
<dt id="index-post_002dsxml">Scheme Procedure: <strong>post-sxml</strong> <em><var>post</var></em></dt>
<dd><p>Return the SXML tree for <var>post</var>.
</p></dd></dl>

<dl>
<dt id="index-post_002dref">Scheme Procedure: <strong>post-ref</strong> <em><var>post</var> <var>key</var></em></dt>
<dd><p>Return the metadata value corresponding to <var>key</var> within
<var>post</var>.
</p></dd></dl>

<dl>
<dt id="index-post_002dslug">Scheme Procedure: <strong>post-slug</strong> <em><var>post</var></em></dt>
<dd><p>Transform the title of <var>post</var> into a URL slug suitable for the
file name of a web page.
</p></dd></dl>

<dl>
<dt id="index-_0025default_002ddate">Scheme Variable: <strong>%default-date</strong></dt>
<dd><p>The default date of a post when no other date is specified in the
metadata association list.
</p></dd></dl>

<dl>
<dt id="index-post_002ddate">Scheme Procedure: <strong>post-date</strong> <em><var>post</var></em></dt>
<dd><p>Return the date for <var>post</var>, or <code>%default-date</code> if no date is
specified.
</p></dd></dl>

<dl>
<dt id="index-posts_002freverse_002dchronological">Scheme Procedure: <strong>posts/reverse-chronological</strong> <em><var>posts</var></em></dt>
<dd><p>Sort <var>posts</var>, a list of posts, in reverse chronological order.
</p></dd></dl>

<dl>
<dt id="index-posts_002fgroup_002dby_002dtag">Scheme Procedure: <strong>posts/group-by-tag</strong> <em><var>posts</var></em></dt>
<dd><p>Create an association list of tags mapped to the posts in the list
<var>posts</var> that used them.
</p></dd></dl>

<hr>
<div class="header">
<p>
Next: <a href="Readers.html" accesskey="n" rel="next">Readers</a>, Previous: <a href="Sites.html" accesskey="p" rel="prev">Sites</a>, Up: <a href="Programming-Interface.html" accesskey="u" rel="up">Programming Interface</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>