dan
/
haunt
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

website: Update manual.

This commit is contained in:
David Thompson 2017-01-23 20:40:04 -05:00
parent 16bc1eae0c
commit 9e4fba766d
28 changed files with 578 additions and 194 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
website/manual/Assets.html
View File

@ -9,7 +9,7 @@ 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.0, http://www.gnu.org/software/texinfo/ -->
<!-- Created by GNU Texinfo 6.3, http://www.gnu.org/software/texinfo/ -->
<head>
<title>Haunt Reference Manual: Assets</title>
@ -46,9 +46,8 @@ 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.nocodebreak {white-space: nowrap}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: serif; font-weight: normal}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->

5
website/manual/Atom.html
View File

@ -9,7 +9,7 @@ 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.0, http://www.gnu.org/software/texinfo/ -->
<!-- Created by GNU Texinfo 6.3, http://www.gnu.org/software/texinfo/ -->
<head>
<title>Haunt Reference Manual: Atom</title>
@ -46,9 +46,8 @@ 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.nocodebreak {white-space: nowrap}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: serif; font-weight: normal}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->

5
website/manual/Blog.html
View File

@ -9,7 +9,7 @@ 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.0, http://www.gnu.org/software/texinfo/ -->
<!-- Created by GNU Texinfo 6.3, http://www.gnu.org/software/texinfo/ -->
<head>
<title>Haunt Reference Manual: Blog</title>
@ -46,9 +46,8 @@ 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.nocodebreak {white-space: nowrap}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: serif; font-weight: normal}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->

5
website/manual/Builders.html
View File

@ -9,7 +9,7 @@ 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.0, http://www.gnu.org/software/texinfo/ -->
<!-- Created by GNU Texinfo 6.3, http://www.gnu.org/software/texinfo/ -->
<head>
<title>Haunt Reference Manual: Builders</title>
@ -46,9 +46,8 @@ 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.nocodebreak {white-space: nowrap}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: serif; font-weight: normal}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->

5
website/manual/Building.html
View File

@ -9,7 +9,7 @@ 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.0, http://www.gnu.org/software/texinfo/ -->
<!-- Created by GNU Texinfo 6.3, http://www.gnu.org/software/texinfo/ -->
<head>
<title>Haunt Reference Manual: Building</title>
@ -46,9 +46,8 @@ 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.nocodebreak {white-space: nowrap}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: serif; font-weight: normal}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->

5
website/manual/Command_002dline-Interface.html
View File

@ -9,7 +9,7 @@ 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.0, http://www.gnu.org/software/texinfo/ -->
<!-- Created by GNU Texinfo 6.3, http://www.gnu.org/software/texinfo/ -->
<head>
<title>Haunt Reference Manual: Command-line Interface</title>
@ -46,9 +46,8 @@ 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.nocodebreak {white-space: nowrap}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: serif; font-weight: normal}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->

100
website/manual/CommonMark.html Normal file
View File

@ -0,0 +1,100 @@
<!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: CommonMark</title>
<meta name="description" content="Haunt Reference Manual: CommonMark">
<meta name="keywords" content="Haunt Reference Manual: CommonMark">
<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="Readers.html#Readers" rel="up" title="Readers">
<link href="Pages.html#Pages" rel="next" title="Pages">
<link href="Skribe.html#Skribe" rel="prev" title="Skribe">
<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="CommonMark"></a>
<div class="header">
<p>
Previous: <a href="Skribe.html#Skribe" accesskey="p" rel="prev">Skribe</a>, Up: <a href="Readers.html#Readers" accesskey="u" rel="up">Readers</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="CommonMark-1"></a>
<h4 class="subsection">5.3.4 CommonMark</h4>
<div class="example">
<pre class="example">(use-modules (haunt reader commonmark))
</pre></div>
<dl>
<dt><a name="index-commonmark_002dreader"></a>Scheme Procedure: <strong>commonmark-reader</strong></dt>
<dd><p>A reader for posts written in CommonMark, a fully specified variant of
Markdown. Metadata is encoded as <code>key: value</code> pairs, one per line,
at the beginning of the file. A line with the <code>---</code> sentinel marks
the end of the metadata section and the rest of the file is encoded as HTML.
</p>
<p>Example:
</p>
<div class="example">
<pre class="example">title: Hello, CommonMark!
date: 2016-08-20 12:00
tags: markdown, commonmark
---
## This is a CommonMark post
CommonMark is a **strongly** defined, *highly* compatible
specification of Markdown, learn more about CommomMark
[here](http://commonmark.org/).
</pre></div>
</dd></dl>
</body>
</html>

5
website/manual/Concept-Index.html
View File

@ -9,7 +9,7 @@ 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.0, http://www.gnu.org/software/texinfo/ -->
<!-- Created by GNU Texinfo 6.3, http://www.gnu.org/software/texinfo/ -->
<head>
<title>Haunt Reference Manual: Concept Index</title>
@ -46,9 +46,8 @@ 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.nocodebreak {white-space: nowrap}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: serif; font-weight: normal}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->

5
website/manual/Contributing.html
View File

@ -9,7 +9,7 @@ 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.0, http://www.gnu.org/software/texinfo/ -->
<!-- Created by GNU Texinfo 6.3, http://www.gnu.org/software/texinfo/ -->
<head>
<title>Haunt Reference Manual: Contributing</title>
@ -46,9 +46,8 @@ 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.nocodebreak {white-space: nowrap}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: serif; font-weight: normal}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->

5
website/manual/Downloading.html
View File

@ -9,7 +9,7 @@ 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.0, http://www.gnu.org/software/texinfo/ -->
<!-- Created by GNU Texinfo 6.3, http://www.gnu.org/software/texinfo/ -->
<head>
<title>Haunt Reference Manual: Downloading</title>
@ -46,9 +46,8 @@ 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.nocodebreak {white-space: nowrap}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: serif; font-weight: normal}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->

5
website/manual/GNU-Free-Documentation-License.html
View File

@ -9,7 +9,7 @@ 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.0, http://www.gnu.org/software/texinfo/ -->
<!-- Created by GNU Texinfo 6.3, http://www.gnu.org/software/texinfo/ -->
<head>
<title>Haunt Reference Manual: GNU Free Documentation License</title>
@ -46,9 +46,8 @@ 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.nocodebreak {white-space: nowrap}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: serif; font-weight: normal}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->

5
website/manual/Installation.html
View File

@ -9,7 +9,7 @@ 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.0, http://www.gnu.org/software/texinfo/ -->
<!-- Created by GNU Texinfo 6.3, http://www.gnu.org/software/texinfo/ -->
<head>
<title>Haunt Reference Manual: Installation</title>
@ -46,9 +46,8 @@ 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.nocodebreak {white-space: nowrap}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: serif; font-weight: normal}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->

5
website/manual/Introduction.html
View File

@ -9,7 +9,7 @@ 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.0, http://www.gnu.org/software/texinfo/ -->
<!-- Created by GNU Texinfo 6.3, http://www.gnu.org/software/texinfo/ -->
<head>
<title>Haunt Reference Manual: Introduction</title>
@ -46,9 +46,8 @@ 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.nocodebreak {white-space: nowrap}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: serif; font-weight: normal}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->

5
website/manual/Invoking-haunt-build.html
View File

@ -9,7 +9,7 @@ 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.0, http://www.gnu.org/software/texinfo/ -->
<!-- Created by GNU Texinfo 6.3, http://www.gnu.org/software/texinfo/ -->
<head>
<title>Haunt Reference Manual: Invoking haunt build</title>
@ -46,9 +46,8 @@ 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.nocodebreak {white-space: nowrap}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: serif; font-weight: normal}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->

5
website/manual/Invoking-haunt-serve.html
View File

@ -9,7 +9,7 @@ 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.0, http://www.gnu.org/software/texinfo/ -->
<!-- Created by GNU Texinfo 6.3, http://www.gnu.org/software/texinfo/ -->
<head>
<title>Haunt Reference Manual: Invoking haunt serve</title>
@ -46,9 +46,8 @@ 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.nocodebreak {white-space: nowrap}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: serif; font-weight: normal}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->

7
website/manual/Pages.html
View File

@ -9,7 +9,7 @@ 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.0, http://www.gnu.org/software/texinfo/ -->
<!-- Created by GNU Texinfo 6.3, http://www.gnu.org/software/texinfo/ -->
<head>
<title>Haunt Reference Manual: Pages</title>
@ -24,7 +24,7 @@ Documentation License". -->
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Programming-Interface.html#Programming-Interface" rel="up" title="Programming Interface">
<link href="Assets.html#Assets" rel="next" title="Assets">
<link href="Readers.html#Readers" rel="prev" title="Readers">
<link href="CommonMark.html#CommonMark" rel="prev" title="CommonMark">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
@ -46,9 +46,8 @@ 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.nocodebreak {white-space: nowrap}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: serif; font-weight: normal}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->

7
website/manual/Posts.html
View File

@ -9,7 +9,7 @@ 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.0, http://www.gnu.org/software/texinfo/ -->
<!-- Created by GNU Texinfo 6.3, http://www.gnu.org/software/texinfo/ -->
<head>
<title>Haunt Reference Manual: Posts</title>
@ -46,9 +46,8 @@ 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.nocodebreak {white-space: nowrap}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: serif; font-weight: normal}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
@ -124,7 +123,7 @@ metadata association list.
</p></dd></dl>
<dl>
<dt><a name="index-post_002ddata"></a>Scheme Procedure: <strong>post-data</strong> <em><var>post</var></em></dt>
<dt><a name="index-post_002ddate"></a>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>

36
website/manual/Programming-Index.html
View File

@ -9,7 +9,7 @@ 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.0, http://www.gnu.org/software/texinfo/ -->
<!-- Created by GNU Texinfo 6.3, http://www.gnu.org/software/texinfo/ -->
<head>
<title>Haunt Reference Manual: Programming Index</title>
@ -45,9 +45,8 @@ 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.nocodebreak {white-space: nowrap}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: serif; font-weight: normal}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
@ -72,6 +71,8 @@ Previous: <a href="Concept-Index.html#Concept-Index" accesskey="p" rel="prev">Co
&nbsp;
<a class="summary-letter" href="#Programming-Index_fn_letter-B"><b>B</b></a>
&nbsp;
<a class="summary-letter" href="#Programming-Index_fn_letter-C"><b>C</b></a>
&nbsp;
<a class="summary-letter" href="#Programming-Index_fn_letter-D"><b>D</b></a>
&nbsp;
<a class="summary-letter" href="#Programming-Index_fn_letter-H"><b>H</b></a>
@ -107,28 +108,31 @@ Previous: <a href="Concept-Index.html#Concept-Index" accesskey="p" rel="prev">Co
<tr><th><a name="Programming-Index_fn_letter-B">B</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="Blog.html#index-blog"><code>blog</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="Blog.html#Blog">Blog</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Programming-Index_fn_letter-C">C</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="CommonMark.html#index-commonmark_002dreader"><code>commonmark-reader</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="CommonMark.html#CommonMark">CommonMark</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Programming-Index_fn_letter-D">D</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="Assets.html#index-directory_002dassets"><code>directory-assets</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="Assets.html#Assets">Assets</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Programming-Index_fn_letter-H">H</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="Readers.html#index-html_002dreader"><code>html-reader</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="Readers.html#Readers">Readers</a></td></tr>
<tr><td></td><td valign="top"><a href="Reader.html#index-html_002dreader"><code>html-reader</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="Reader.html#Reader">Reader</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Programming-Index_fn_letter-I">I</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="Assets.html#index-install_002dasset"><code>install-asset</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="Assets.html#Assets">Assets</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Programming-Index_fn_letter-M">M</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="Assets.html#index-make_002dasset"><code>make-asset</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="Assets.html#Assets">Assets</a></td></tr>
<tr><td></td><td valign="top"><a href="Readers.html#index-make_002dfile_002dextension_002dmatcher"><code>make-file-extension-matcher</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="Readers.html#Readers">Readers</a></td></tr>
<tr><td></td><td valign="top"><a href="Reader.html#index-make_002dfile_002dextension_002dmatcher"><code>make-file-extension-matcher</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="Reader.html#Reader">Reader</a></td></tr>
<tr><td></td><td valign="top"><a href="Pages.html#index-make_002dpage"><code>make-page</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="Pages.html#Pages">Pages</a></td></tr>
<tr><td></td><td valign="top"><a href="Posts.html#index-make_002dpost"><code>make-post</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="Posts.html#Posts">Posts</a></td></tr>
<tr><td></td><td valign="top"><a href="Readers.html#index-make_002dreader"><code>make-reader</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="Readers.html#Readers">Readers</a></td></tr>
<tr><td></td><td valign="top"><a href="Reader.html#index-make_002dreader"><code>make-reader</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="Reader.html#Reader">Reader</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Programming-Index_fn_letter-P">P</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="Pages.html#index-page_002dcontents"><code>page-contents</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="Pages.html#Pages">Pages</a></td></tr>
<tr><td></td><td valign="top"><a href="Pages.html#index-page_002dfile_002dname"><code>page-file-name</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="Pages.html#Pages">Pages</a></td></tr>
<tr><td></td><td valign="top"><a href="Pages.html#index-page_002dwriter"><code>page-writer</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="Pages.html#Pages">Pages</a></td></tr>
<tr><td></td><td valign="top"><a href="Pages.html#index-page_003f"><code>page?</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="Pages.html#Pages">Pages</a></td></tr>
<tr><td></td><td valign="top"><a href="Posts.html#index-post_002ddata"><code>post-data</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="Posts.html#Posts">Posts</a></td></tr>
<tr><td></td><td valign="top"><a href="Posts.html#index-post_002ddate"><code>post-date</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="Posts.html#Posts">Posts</a></td></tr>
<tr><td></td><td valign="top"><a href="Posts.html#index-post_002dfile_002dname"><code>post-file-name</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="Posts.html#Posts">Posts</a></td></tr>
<tr><td></td><td valign="top"><a href="Posts.html#index-post_002dmetadata"><code>post-metadata</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="Posts.html#Posts">Posts</a></td></tr>
<tr><td></td><td valign="top"><a href="Posts.html#index-post_002dref"><code>post-ref</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="Posts.html#Posts">Posts</a></td></tr>
@ -139,12 +143,12 @@ Previous: <a href="Concept-Index.html#Concept-Index" accesskey="p" rel="prev">Co
<tr><td></td><td valign="top"><a href="Posts.html#index-posts_002freverse_002dchronological"><code>posts/reverse-chronological</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="Posts.html#Posts">Posts</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Programming-Index_fn_letter-R">R</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="Readers.html#index-read_002dpost"><code>read-post</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="Readers.html#Readers">Readers</a></td></tr>
<tr><td></td><td valign="top"><a href="Readers.html#index-read_002dposts"><code>read-posts</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="Readers.html#Readers">Readers</a></td></tr>
<tr><td></td><td valign="top"><a href="Readers.html#index-reader_002dmatch_003f"><code>reader-match?</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="Readers.html#Readers">Readers</a></td></tr>
<tr><td></td><td valign="top"><a href="Readers.html#index-reader_002dmatcher"><code>reader-matcher</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="Readers.html#Readers">Readers</a></td></tr>
<tr><td></td><td valign="top"><a href="Readers.html#index-reader_002dmatcher-1"><code>reader-matcher</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="Readers.html#Readers">Readers</a></td></tr>
<tr><td></td><td valign="top"><a href="Readers.html#index-reader_003f"><code>reader?</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="Readers.html#Readers">Readers</a></td></tr>
<tr><td></td><td valign="top"><a href="Reader.html#index-read_002dpost"><code>read-post</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="Reader.html#Reader">Reader</a></td></tr>
<tr><td></td><td valign="top"><a href="Reader.html#index-read_002dposts"><code>read-posts</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="Reader.html#Reader">Reader</a></td></tr>
<tr><td></td><td valign="top"><a href="Reader.html#index-reader_002dmatch_003f"><code>reader-match?</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="Reader.html#Reader">Reader</a></td></tr>
<tr><td></td><td valign="top"><a href="Reader.html#index-reader_002dmatcher"><code>reader-matcher</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="Reader.html#Reader">Reader</a></td></tr>
<tr><td></td><td valign="top"><a href="Reader.html#index-reader_002dproc"><code>reader-proc</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="Reader.html#Reader">Reader</a></td></tr>
<tr><td></td><td valign="top"><a href="Reader.html#index-reader_003f"><code>reader?</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="Reader.html#Reader">Reader</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Programming-Index_fn_letter-S">S</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="Sites.html#index-site"><code>site</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="Sites.html#Sites">Sites</a></td></tr>
@ -157,10 +161,12 @@ Previous: <a href="Concept-Index.html#Concept-Index" accesskey="p" rel="prev">Co
<tr><td></td><td valign="top"><a href="Sites.html#index-site_002dreaders"><code>site-readers</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="Sites.html#Sites">Sites</a></td></tr>
<tr><td></td><td valign="top"><a href="Sites.html#index-site_002dtitle"><code>site-title</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="Sites.html#Sites">Sites</a></td></tr>
<tr><td></td><td valign="top"><a href="Sites.html#index-site_003f"><code>site?</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="Sites.html#Sites">Sites</a></td></tr>
<tr><td></td><td valign="top"><a href="Skribe.html#index-skribe_002dreader"><code>skribe-reader</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="Skribe.html#Skribe">Skribe</a></td></tr>
<tr><td></td><td valign="top"><a href="Static-Assets.html#index-static_002ddirectory"><code>static-directory</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="Static-Assets.html#Static-Assets">Static Assets</a></td></tr>
<tr><td></td><td valign="top"><a href="Readers.html#index-sxml_002dreader"><code>sxml-reader</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="Readers.html#Readers">Readers</a></td></tr>
<tr><td></td><td valign="top"><a href="Reader.html#index-sxml_002dreader"><code>sxml-reader</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="Reader.html#Reader">Reader</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Programming-Index_fn_letter-T">T</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="Texinfo.html#index-texinfo_002dreader"><code>texinfo-reader</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="Texinfo.html#Texinfo">Texinfo</a></td></tr>
<tr><td></td><td valign="top"><a href="Blog.html#index-theme"><code>theme</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="Blog.html#Blog">Blog</a></td></tr>
<tr><td></td><td valign="top"><a href="Blog.html#index-theme_003f"><code>theme?</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="Blog.html#Blog">Blog</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
@ -175,6 +181,8 @@ Previous: <a href="Concept-Index.html#Concept-Index" accesskey="p" rel="prev">Co
&nbsp;
<a class="summary-letter" href="#Programming-Index_fn_letter-B"><b>B</b></a>
&nbsp;
<a class="summary-letter" href="#Programming-Index_fn_letter-C"><b>C</b></a>
&nbsp;
<a class="summary-letter" href="#Programming-Index_fn_letter-D"><b>D</b></a>
&nbsp;
<a class="summary-letter" href="#Programming-Index_fn_letter-H"><b>H</b></a>

5
website/manual/Programming-Interface.html
View File

@ -9,7 +9,7 @@ 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.0, http://www.gnu.org/software/texinfo/ -->
<!-- Created by GNU Texinfo 6.3, http://www.gnu.org/software/texinfo/ -->
<head>
<title>Haunt Reference Manual: Programming Interface</title>
@ -46,9 +46,8 @@ 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.nocodebreak {white-space: nowrap}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: serif; font-weight: normal}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->

179
website/manual/Reader.html Normal file
View File

@ -0,0 +1,179 @@
<!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: Reader</title>
<meta name="description" content="Haunt Reference Manual: Reader">
<meta name="keywords" content="Haunt Reference Manual: Reader">
<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="Readers.html#Readers" rel="up" title="Readers">
<link href="Texinfo.html#Texinfo" rel="next" title="Texinfo">
<link href="Readers.html#Readers" rel="prev" title="Readers">
<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="Reader"></a>
<div class="header">
<p>
Next: <a href="Texinfo.html#Texinfo" accesskey="n" rel="next">Texinfo</a>, Up: <a href="Readers.html#Readers" accesskey="u" rel="up">Readers</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="Reader-1"></a>
<h4 class="subsection">5.3.1 Reader</h4>
<div class="example">
<pre class="example">(use-modules (haunt reader))
</pre></div>
<p>The purpose of a reader is to translate the markup within a post file
into an SXML tree representing the HTML structure and associate some
metadata with it.
</p>
<dl>
<dt><a name="index-make_002dreader"></a>Scheme Procedure: <strong>make-reader</strong> <em><var>matcher</var> <var>proc</var></em></dt>
<dd><p>Create a new reader. The reader is to be activated when
<var>matcher</var>, a procedure that accepts a file name as its only
argument, returns <code>#t</code>. When a post file matches, the procedure
<var>proc</var>, which also accepts a file name as its only argument, reads
the contents and returns a post object (see <a href="Posts.html#Posts">Posts</a>).
</p></dd></dl>
<dl>
<dt><a name="index-reader_003f"></a>Scheme Procedure: <strong>reader?</strong> <em><var>object</var></em></dt>
<dd><p>Return <code>#t</code> if <var>object</var> is a reader.
</p></dd></dl>
<dl>
<dt><a name="index-reader_002dmatcher"></a>Scheme Procedure: <strong>reader-matcher</strong> <em><var>reader</var></em></dt>
<dd><p>Return the match procedure for <var>reader</var>.
</p></dd></dl>
<dl>
<dt><a name="index-reader_002dproc"></a>Scheme Procedure: <strong>reader-proc</strong> <em><var>reader</var></em></dt>
<dd><p>Return the read procedure for <var>reader</var>.
</p></dd></dl>
<dl>
<dt><a name="index-reader_002dmatch_003f"></a>Scheme Procedure: <strong>reader-match?</strong> <em><var>reader</var> <var>file-name</var></em></dt>
<dd><p>Return <code>#t</code> if <var>file-name</var> is a file supported by
<var>reader</var>.
</p></dd></dl>
<dl>
<dt><a name="index-read_002dpost"></a>Scheme Procedure: <strong>read-post</strong> <em><var>reader</var> <var>file-name</var> [<var>default-metadata</var>]</em></dt>
<dd><p>Read a post object from <var>file-name</var> using <var>reader</var>, merging
its metadata with <var>default-metadata</var>, or the empty list if not
specified.
</p></dd></dl>
<dl>
<dt><a name="index-read_002dposts"></a>Scheme Procedure: <strong>read-posts</strong> <em><var>directory</var> <var>keep?</var> <var>readers</var> [<var>default-metadata</var>]</em></dt>
<dd><p>Read all of the files in <var>directory</var> that match <var>keep?</var> as
post objects. The <var>readers</var> list must contain a matching reader
for every post.
</p></dd></dl>
<dl>
<dt><a name="index-make_002dfile_002dextension_002dmatcher"></a>Scheme Procedure: <strong>make-file-extension-matcher</strong> <em><var>ext</var></em></dt>
<dd><p>Create a procedure that returns <code>#t</code> when a file name ends with
&ldquo;.ext&rdquo;.
</p></dd></dl>
<dl>
<dt><a name="index-sxml_002dreader"></a>Scheme Procedure: <strong>sxml-reader</strong></dt>
<dd><p>A basic reader for posts written as Scheme code that evaluates to an
an association list. The special key <code>content</code> contains the post
body as an SXML tree.
</p>
<p>Example:
</p>
<div class="example">
<pre class="example">(use-modules (haunt utils))
`((title . &quot;Hello, world!&quot;)
(date . ,(string-&gt;date* &quot;2015-04-10 23:00&quot;))
(tags &quot;foo&quot; &quot;bar&quot;)
(summary . &quot;Just a test&quot;)
(content
((h2 &quot;Hello!&quot;)
(p &quot;This is Haunt. A static site generator for GNU Guile.&quot;))))
</pre></div>
</dd></dl>
<dl>
<dt><a name="index-html_002dreader"></a>Scheme Procedure: <strong>html-reader</strong></dt>
<dd><p>A basic reader for posts written in plain ol&rsquo; HTML. Metadata is
encoded as the <code>key: value</code> pairs, one per line, at the beginning
of the file. A line with the <code>---</code> sentinel marks the end of the
metadata section and the rest of the file is encoded as HTML.
</p>
<p>Example:
</p>
<div class="example">
<pre class="example">title: A Foo Walks Into a Bar
date: 2015-04-11 20:00
tags: bar
---
&lt;p&gt;
This is an example using raw HTML, because Guile doesn't have a
Markdown parser.
&lt;/p&gt;
</pre></div>
</dd></dl>
<hr>
<div class="header">
<p>
Next: <a href="Texinfo.html#Texinfo" accesskey="n" rel="next">Texinfo</a>, Up: <a href="Readers.html#Readers" accesskey="u" rel="up">Readers</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>
</body>
</html>

123
website/manual/Readers.html
View File

@ -9,7 +9,7 @@ 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.0, http://www.gnu.org/software/texinfo/ -->
<!-- Created by GNU Texinfo 6.3, http://www.gnu.org/software/texinfo/ -->
<head>
<title>Haunt Reference Manual: Readers</title>
@ -23,7 +23,7 @@ Documentation License". -->
<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="Programming-Interface.html#Programming-Interface" rel="up" title="Programming Interface">
<link href="Pages.html#Pages" rel="next" title="Pages">
<link href="Reader.html#Reader" rel="next" title="Reader">
<link href="Posts.html#Posts" rel="prev" title="Posts">
<style type="text/css">
<!--
@ -46,9 +46,8 @@ 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.nocodebreak {white-space: nowrap}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: serif; font-weight: normal}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
@ -67,113 +66,17 @@ Next: <a href="Pages.html#Pages" accesskey="n" rel="next">Pages</a>, Previous: <
<a name="Readers-1"></a>
<h3 class="section">5.3 Readers</h3>
<div class="example">
<pre class="example">(use-modules (haunt reader))
</pre></div>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">&bull; <a href="Reader.html#Reader" accesskey="1">Reader</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Reader interface and basic readers
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Texinfo.html#Texinfo" accesskey="2">Texinfo</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Texinfo reader
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Skribe.html#Skribe" accesskey="3">Skribe</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Skribe reader
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="CommonMark.html#CommonMark" accesskey="4">CommonMark</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">CommonMark reader
</td></tr>
</table>
<p>The purpose of a reader is to translate the markup within a post file
into an SXML tree representing the HTML structure and associate some
metadata with it.
</p>
<dl>
<dt><a name="index-make_002dreader"></a>Scheme Procedure: <strong>make-reader</strong> <em><var>matcher</var> <var>proc</var></em></dt>
<dd><p>Create a new reader. The reader is to be activated when
<var>matcher</var>, a procedure that accepts a file name as its only
argument, returns <code>#t</code>. When a post file matches, the procedure
<var>proc</var>, which also accepts a file name as its only argument, reads
the contents and returns a post object (see <a href="Posts.html#Posts">Posts</a>).
</p></dd></dl>
<dl>
<dt><a name="index-reader_003f"></a>Scheme Procedure: <strong>reader?</strong> <em><var>object</var></em></dt>
<dd><p>Return <code>#t</code> if <var>object</var> is a reader.
</p></dd></dl>
<dl>
<dt><a name="index-reader_002dmatcher"></a>Scheme Procedure: <strong>reader-matcher</strong> <em><var>reader</var></em></dt>
<dd><p>Return the match procedure for <var>reader</var>.
</p></dd></dl>
<dl>
<dt><a name="index-reader_002dmatcher-1"></a>Scheme Procedure: <strong>reader-matcher</strong> <em><var>reader</var></em></dt>
<dd><p>Return the read procedure for <var>reader</var>.
</p></dd></dl>
<dl>
<dt><a name="index-reader_002dmatch_003f"></a>Scheme Procedure: <strong>reader-match?</strong> <em><var>reader</var> <var>file-name</var></em></dt>
<dd><p>Return <code>#t</code> if <var>file-name</var> is a file supported by
<var>reader</var>.
</p></dd></dl>
<dl>
<dt><a name="index-read_002dpost"></a>Scheme Procedure: <strong>read-post</strong> <em><var>reader</var> <var>file-name</var> [<var>default-metadata</var>]</em></dt>
<dd><p>Read a post object from <var>file-name</var> using <var>reader</var>, merging
its metadata with <var>default-metadata</var>, or the empty list if not
specified.
</p></dd></dl>
<dl>
<dt><a name="index-read_002dposts"></a>Scheme Procedure: <strong>read-posts</strong> <em><var>directory</var> <var>keep?</var> <var>readers</var> [<var>default-metadata</var>]</em></dt>
<dd><p>Read all of the files in <var>directory</var> that match <var>keep?</var> as
post objects. The <var>readers</var> list must contain a matching reader
for every post.
</p></dd></dl>
<dl>
<dt><a name="index-make_002dfile_002dextension_002dmatcher"></a>Scheme Procedure: <strong>make-file-extension-matcher</strong> <em><var>ext</var></em></dt>
<dd><p>Create a procedure that returns <code>#t</code> when a file name ends with
&ldquo;.ext&rdquo;.
</p></dd></dl>
<dl>
<dt><a name="index-sxml_002dreader"></a>Scheme Procedure: <strong>sxml-reader</strong></dt>
<dd><p>A basic reader for posts written as Scheme code that evaluates to an
an association list. The special key <code>content</code> contains the post
body as an SXML tree.
</p>
<p>Example:
</p>
<div class="example">
<pre class="example">(use-modules (haunt utils))
`((title . &quot;Hello, world!&quot;)
(date . ,(string-&gt;date* &quot;2015-04-10 23:00&quot;))
(tags &quot;foo&quot; &quot;bar&quot;)
(summary . &quot;Just a test&quot;)
(content
((h2 &quot;Hello!&quot;)
(p &quot;This is Haunt. A static site generator for GNU Guile.&quot;))))
</pre></div>
</dd></dl>
<dl>
<dt><a name="index-html_002dreader"></a>Scheme Procedure: <strong>html-reader</strong></dt>
<dd><p>A basic reader for posts written in plain ol&rsquo; HTML. Metadata is
encoded as the <code>key: value</code> pairs, one per line, at the beginning
of the file. A line with the <code>---</code> sentinel marks the end of the
metadata section and the rest of the file is encoded as HTML.
</p>
<p>Example:
</p>
<div class="example">
<pre class="example">title: A Foo Walks Into a Bar
date: 2015-04-11 20:00
tags: bar
---
&lt;p&gt;
This is an example using raw HTML, because Guile doesn't have a
Markdown parser.
&lt;/p&gt;
</pre></div>
</dd></dl>
<hr>
<div class="header">
<p>
Next: <a href="Pages.html#Pages" accesskey="n" rel="next">Pages</a>, Previous: <a href="Posts.html#Posts" accesskey="p" rel="prev">Posts</a>, Up: <a href="Programming-Interface.html#Programming-Interface" 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#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>

7
website/manual/Requirements.html
View File

@ -9,7 +9,7 @@ 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.0, http://www.gnu.org/software/texinfo/ -->
<!-- Created by GNU Texinfo 6.3, http://www.gnu.org/software/texinfo/ -->
<head>
<title>Haunt Reference Manual: Requirements</title>
@ -46,9 +46,8 @@ 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.nocodebreak {white-space: nowrap}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: serif; font-weight: normal}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
@ -79,6 +78,8 @@ later
<ul>
<li> <a href="http://www.nongnu.org/guile-reader/">Guile-Reader</a> version 0.6 or
later (for Skribe support)
</li><li> <a href="https://github.com/OrangeShark/guile-commonmark">guile-commonmark</a>
version 0.1 or later (for CommonMark support)
</li></ul>

5
website/manual/Sites.html
View File

@ -9,7 +9,7 @@ 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.0, http://www.gnu.org/software/texinfo/ -->
<!-- Created by GNU Texinfo 6.3, http://www.gnu.org/software/texinfo/ -->
<head>
<title>Haunt Reference Manual: Sites</title>
@ -46,9 +46,8 @@ 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.nocodebreak {white-space: nowrap}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: serif; font-weight: normal}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->

104
website/manual/Skribe.html Normal file
View File

@ -0,0 +1,104 @@
<!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: Skribe</title>
<meta name="description" content="Haunt Reference Manual: Skribe">
<meta name="keywords" content="Haunt Reference Manual: Skribe">
<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="Readers.html#Readers" rel="up" title="Readers">
<link href="CommonMark.html#CommonMark" rel="next" title="CommonMark">
<link href="Texinfo.html#Texinfo" rel="prev" title="Texinfo">
<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="Skribe"></a>
<div class="header">
<p>
Next: <a href="CommonMark.html#CommonMark" accesskey="n" rel="next">CommonMark</a>, Previous: <a href="Texinfo.html#Texinfo" accesskey="p" rel="prev">Texinfo</a>, Up: <a href="Readers.html#Readers" accesskey="u" rel="up">Readers</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="Skribe-1"></a>
<h4 class="subsection">5.3.3 Skribe</h4>
<div class="example">
<pre class="example">(use-modules (haunt reader skribe))
</pre></div>
<dl>
<dt><a name="index-skribe_002dreader"></a>Scheme Procedure: <strong>skribe-reader</strong></dt>
<dd><p>A reader for posts written in Skribe, a markup language with the full power
of Scheme. Skribe posts are created with the <code>post</code> expression with
metadata encoded as <code>:key expression</code> pairs at the beginning of the
<code>post</code> expression. After the metadata section, the rest of the <code>post</code>
expression is encoded as HTML.
</p>
<p>Example:
</p>
<div class="example">
<pre class="example">(post
:title &quot;Hello, Skribe!&quot;
:date (make-date* 2016 08 20 12 00)
:tags '(&quot;skribe&quot; &quot;foo&quot; &quot;baz&quot;)
(h2 [This is a Skribe post])
(p [Skribe is a ,(em [really]) cool document authoring format
that provides all the power of Scheme whilst giving the user
a means to write literal text without stuffing it into a
string literal. If this sort of thing suits you, be sure to
check out ,(anchor &quot;Skribilo&quot;
&quot;http://www.nongnu.org/skribilo/&quot;), too.]))
</pre></div>
</dd></dl>
</body>
</html>

5
website/manual/Static-Assets.html
View File

@ -9,7 +9,7 @@ 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.0, http://www.gnu.org/software/texinfo/ -->
<!-- Created by GNU Texinfo 6.3, http://www.gnu.org/software/texinfo/ -->
<head>
<title>Haunt Reference Manual: Static Assets</title>
@ -46,9 +46,8 @@ 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.nocodebreak {white-space: nowrap}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: serif; font-weight: normal}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->

101
website/manual/Texinfo.html Normal file
View File

@ -0,0 +1,101 @@
<!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: Texinfo</title>
<meta name="description" content="Haunt Reference Manual: Texinfo">
<meta name="keywords" content="Haunt Reference Manual: Texinfo">
<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="Readers.html#Readers" rel="up" title="Readers">
<link href="Skribe.html#Skribe" rel="next" title="Skribe">
<link href="Reader.html#Reader" rel="prev" title="Reader">
<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="Texinfo"></a>
<div class="header">
<p>
Next: <a href="Skribe.html#Skribe" accesskey="n" rel="next">Skribe</a>, Previous: <a href="Reader.html#Reader" accesskey="p" rel="prev">Reader</a>, Up: <a href="Readers.html#Readers" accesskey="u" rel="up">Readers</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="Texinfo-1"></a>
<h4 class="subsection">5.3.2 Texinfo</h4>
<div class="example">
<pre class="example">(use-modules (haunt reader texinfo))
</pre></div>
<dl>
<dt><a name="index-texinfo_002dreader"></a>Scheme Procedure: <strong>texinfo-reader</strong></dt>
<dd><p>A reader for posts written in texinfo, the official documentation format
of the GNU project. Metadata is encoded as <code>key: value</code> pairs, one
per line, at the beginning of the file. A line with the <code>---</code>
sentinel marks the end of the metadata section and the rest of the file
is encoded as HTML.
</p>
<p>Example:
</p>
<div class="example">
<pre class="example">title: Hello, Texi!
date: 2016-08-20 12:00
tags: texinfo, foo
---
@emph{Texinfo} is the official documentation format of the
@url{http://www.gnu.org/, GNU project}. It was invented by Richard
Stallman and Bob Chassell many years ago, loosely based on Brian
Reid's Scribe and other formatting languages of the time. It is
used by many non-GNU projects as well.
</pre></div>
</dd></dl>
</body>
</html>

5
website/manual/Tutorial.html
View File

@ -9,7 +9,7 @@ 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.0, http://www.gnu.org/software/texinfo/ -->
<!-- Created by GNU Texinfo 6.3, http://www.gnu.org/software/texinfo/ -->
<head>
<title>Haunt Reference Manual: Tutorial</title>
@ -46,9 +46,8 @@ 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.nocodebreak {white-space: nowrap}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: serif; font-weight: normal}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->

18
website/manual/index.html
View File

@ -9,7 +9,7 @@ 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.0, http://www.gnu.org/software/texinfo/ -->
<!-- Created by GNU Texinfo 6.3, http://www.gnu.org/software/texinfo/ -->
<head>
<title>Haunt Reference Manual: Top</title>
@ -45,9 +45,8 @@ 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.nocodebreak {white-space: nowrap}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: serif; font-weight: normal}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
@ -86,7 +85,13 @@ ul.no-bullet {list-style: none}
<ul class="no-bullet">
<li><a name="toc-Sites-1" href="Sites.html#Sites">5.1 Sites</a></li>
<li><a name="toc-Posts-1" href="Posts.html#Posts">5.2 Posts</a></li>
<li><a name="toc-Readers-1" href="Readers.html#Readers">5.3 Readers</a></li>
<li><a name="toc-Readers-1" href="Readers.html#Readers">5.3 Readers</a>
<ul class="no-bullet">
<li><a name="toc-Reader-1" href="Reader.html#Reader">5.3.1 Reader</a></li>
<li><a name="toc-Texinfo-1" href="Texinfo.html#Texinfo">5.3.2 Texinfo</a></li>
<li><a name="toc-Skribe-1" href="Skribe.html#Skribe">5.3.3 Skribe</a></li>
<li><a name="toc-CommonMark-1" href="CommonMark.html#CommonMark">5.3.4 CommonMark</a></li>
</ul></li>
<li><a name="toc-Pages-1" href="Pages.html#Pages">5.4 Pages</a></li>
<li><a name="toc-Assets-1" href="Assets.html#Assets">5.5 Assets</a></li>
<li><a name="toc-Builders-1" href="Builders.html#Builders">5.6 Builders</a>
@ -113,7 +118,7 @@ Next: <a href="Introduction.html#Introduction" accesskey="n" rel="next">Introduc
<a name="Haunt"></a>
<h1 class="top">Haunt</h1>
<p>This document describes Haunt version 0.2, an extensible,
<p>This document describes Haunt version 0.2.1, an extensible,
functional static site generator.
</p>
<table class="menu" border="0" cellspacing="0">
@ -130,6 +135,7 @@ functional static site generator.
<tr><td align="left" valign="top">&bull; <a href="Contributing.html#Contributing" accesskey="6">Contributing</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">How to contribute to Haunt.
</td></tr>
<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">
</pre></th></tr><tr><td align="left" valign="top">&bull; <a href="GNU-Free-Documentation-License.html#GNU-Free-Documentation-License" accesskey="7">GNU Free Documentation License</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">The license of this manual.
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Concept-Index.html#Concept-Index" accesskey="8">Concept Index</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Concepts.
@ -137,6 +143,7 @@ functional static site generator.
<tr><td align="left" valign="top">&bull; <a href="Programming-Index.html#Programming-Index" accesskey="9">Programming Index</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Data types, procedures, syntax, and variables.
</td></tr>
<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">
</pre></th></tr><tr><th colspan="3" align="left" valign="top"><pre class="menu-comment"> &mdash; The Detailed Node Listing &mdash;
Installation
@ -148,6 +155,7 @@ Installation
<tr><td align="left" valign="top">&bull; <a href="Building.html#Building">Building</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Building from source code.
</td></tr>
<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">
</pre></th></tr></table>
<hr>