diff options
| author | David Thompson <dthompson2@worcester.edu> | 2016-04-24 15:26:44 -0400 |
|---|---|---|
| committer | David Thompson <dthompson2@worcester.edu> | 2016-04-24 15:26:44 -0400 |
| commit | d3a9ba4ebea136fae676911148509ec3f729abbc (patch) | |
| tree | 244783f13c59f14a5e39c15e31411d6d81e4c36b /website/manual | |
| parent | 28fc90b25e7768a0895aeede121b89c468d4b716 (diff) | |
website: Add copy of HTML manual.
Diffstat (limited to 'website/manual')
24 files changed, 3281 insertions, 0 deletions
diff --git a/website/manual/Assets.html b/website/manual/Assets.html new file mode 100644 index 0000000..a93a1a3 --- /dev/null +++ b/website/manual/Assets.html @@ -0,0 +1,116 @@ +<!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.0, http://www.gnu.org/software/texinfo/ --> +<head> +<title>Haunt Reference Manual: Assets</title> + +<meta name="description" content="Haunt Reference Manual: Assets"> +<meta name="keywords" content="Haunt Reference Manual: Assets"> +<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="Programming-Interface.html#Programming-Interface" rel="up" title="Programming Interface"> +<link href="Builders.html#Builders" rel="next" title="Builders"> +<link href="Pages.html#Pages" rel="prev" title="Pages"> +<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.nocodebreak {white-space: nowrap} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: serif; 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="Assets"></a> +<div class="header"> +<p> +Next: <a href="Builders.html#Builders" accesskey="n" rel="next">Builders</a>, Previous: <a href="Pages.html#Pages" accesskey="p" rel="prev">Pages</a>, Up: <a href="Programming-Interface.html#Programming-Interface" accesskey="u" rel="up">Programming Interface</a> [<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="Assets-1"></a> +<h3 class="section">5.5 Assets</h3> + +<div class="example"> +<pre class="example">(use-modules (haunt asset)) +</pre></div> + +<p>Assets represent files on disk that should be copied verbatim to a +site’s output directory. Common types of assets include CSS, +JavaScript, images, and fonts. +</p> +<dl> +<dt><a name="index-make_002dasset"></a>Scheme Procedure: <strong>make-asset</strong> <em><var>source</var> <var>target</var></em></dt> +<dd><p>Create a new asset object. The <var>source</var> and <var>target</var> +arguments are file names that are relative to a site source and target +directory, respectively (see <a href="Sites.html#Sites">Sites</a>). +</p></dd></dl> + +<dl> +<dt><a name="index-asset_003f"></a>Scheme Procedure: <strong>asset?</strong> <em><var>object</var></em></dt> +<dd><p>Return <code>#t</code> if <var>object</var> is an asset object. +</p></dd></dl> + +<dl> +<dt><a name="index-asset_002dsource"></a>Scheme Procedure: <strong>asset-source</strong> <em><var>asset</var></em></dt> +<dd><p>Return the source file name for <var>asset</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-asset_002dtarget"></a>Scheme Procedure: <strong>asset-target</strong> <em><var>asset</var></em></dt> +<dd><p>Return the target file name for <var>asset</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-install_002dasset"></a>Scheme Procedure: <strong>install-asset</strong> <em><var>asset</var> <var>prefix</var></em></dt> +<dd><p>Install the source file of <var>asset</var> into the target directory +within <var>prefix</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-directory_002dassets"></a>Scheme Procedure: <strong>directory-assets</strong> <em><var>directory</var> <var>keep?</var> <var>dest</var></em></dt> +<dd><p>Create a list of asset objects to be stored within <var>dest</var> for all +files in <var>directory</var> that match <var>keep?</var>, recursively. +</p></dd></dl> + + + + +</body> +</html> diff --git a/website/manual/Atom.html b/website/manual/Atom.html new file mode 100644 index 0000000..5cbe312 --- /dev/null +++ b/website/manual/Atom.html @@ -0,0 +1,131 @@ +<!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.0, 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.nocodebreak {white-space: nowrap} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: serif; 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> [<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’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 “Recent Posts”. +</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> 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 @@ +<!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.0, http://www.gnu.org/software/texinfo/ --> +<head> +<title>Haunt Reference Manual: Blog</title> + +<meta name="description" content="Haunt Reference Manual: Blog"> +<meta name="keywords" content="Haunt Reference Manual: Blog"> +<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="Atom.html#Atom" rel="next" title="Atom"> +<link href="Static-Assets.html#Static-Assets" rel="prev" title="Static Assets"> +<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.nocodebreak {white-space: nowrap} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: serif; 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="Blog"></a> +<div class="header"> +<p> +Next: <a href="Atom.html#Atom" accesskey="n" rel="next">Atom</a>, Previous: <a href="Static-Assets.html#Static-Assets" accesskey="p" rel="prev">Static Assets</a>, Up: <a href="Builders.html#Builders" accesskey="u" rel="up">Builders</a> [<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="Blog-1"></a> +<h4 class="subsection">5.6.2 Blog</h4> + +<div class="example"> +<pre class="example">(use-modules (haunt builder blog)) +</pre></div> + +<dl> +<dt><a name="index-theme"></a>Scheme Procedure: <strong>theme</strong> <em>[#:name #:layout #:post-template #:collection-template]</em></dt> +<dd><p>Create a new theme named <var>name</var>. +</p> +<p>The procedure <var>layout</var> 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. +</p> +<p>The procedure <var>post-template</var> 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. +</p> +<p>The procedure <var>collection-template</var> 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. +</p></dd></dl> + +<dl> +<dt><a name="index-theme_003f"></a>Scheme Procedure: <strong>theme?</strong> <em><var>object</var></em></dt> +<dd><p>Return <code>#t</code> if <var>object</var> is a theme object. +</p></dd></dl> + +<dl> +<dt><a name="index-blog"></a>Scheme Procedure: <strong>blog</strong> <em>[#:theme #:prefix #:collections]</em></dt> +<dd><p>Create a builder procedure that transforms a list of posts into pages +decorated by <var>theme</var>, a theme object, whose URLs start with +<var>prefix</var>. +</p> +<p>Additionally, this builder creates pages that aggregate previews of +many posts corresponding to what is specified in the list +<var>collections</var>. Each collection is a three element list in the +form <code>(title file-name filter)</code>. +</p> +<dl compact="compact"> +<dt><var>title</var></dt> +<dd><p>The human readable name of the collection. +</p> +</dd> +<dt><var>file-name</var></dt> +<dd><p>The HTML file that will contain the rendered collection. +</p> +</dd> +<dt><var>filter</var></dt> +<dd><p>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. +</p> +</dd> +</dl> + +<p>By default, a single collection is created that lists posts in reverse +chronological order and writes to <samp>index.html</samp>. +</p> +<p>The default theme is intended only for testing purposes. +</p> +</dd></dl> + +<hr> +<div class="header"> +<p> +Next: <a href="Atom.html#Atom" accesskey="n" rel="next">Atom</a>, Previous: <a href="Static-Assets.html#Static-Assets" accesskey="p" rel="prev">Static Assets</a>, Up: <a href="Builders.html#Builders" accesskey="u" rel="up">Builders</a> [<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> diff --git a/website/manual/Builders.html b/website/manual/Builders.html new file mode 100644 index 0000000..734ad74 --- /dev/null +++ b/website/manual/Builders.html @@ -0,0 +1,90 @@ +<!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.0, http://www.gnu.org/software/texinfo/ --> +<head> +<title>Haunt Reference Manual: Builders</title> + +<meta name="description" content="Haunt Reference Manual: Builders"> +<meta name="keywords" content="Haunt Reference Manual: Builders"> +<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="Programming-Interface.html#Programming-Interface" rel="up" title="Programming Interface"> +<link href="Static-Assets.html#Static-Assets" rel="next" title="Static Assets"> +<link href="Assets.html#Assets" rel="prev" title="Assets"> +<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.nocodebreak {white-space: nowrap} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: serif; 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="Builders"></a> +<div class="header"> +<p> +Previous: <a href="Assets.html#Assets" accesskey="p" rel="prev">Assets</a>, Up: <a href="Programming-Interface.html#Programming-Interface" accesskey="u" rel="up">Programming Interface</a> [<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="Builders-1"></a> +<h3 class="section">5.6 Builders</h3> + +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• <a href="Static-Assets.html#Static-Assets" accesskey="1">Static Assets</a>:</td><td> </td><td align="left" valign="top">Images, CSS, JavaScript, etc. +</td></tr> +<tr><td align="left" valign="top">• <a href="Blog.html#Blog" accesskey="2">Blog</a>:</td><td> </td><td align="left" valign="top">Dear diary... +</td></tr> +<tr><td align="left" valign="top">• <a href="Atom.html#Atom" accesskey="3">Atom</a>:</td><td> </td><td align="left" valign="top">Atom feeds. +</td></tr> +</table> + +<p>Builders are procedures that return one or more page objects +(see <a href="Pages.html#Pages">Pages</a>) when applied. A builder accepts two arguments: A site +(see <a href="Sites.html#Sites">Sites</a> and a list of posts (see <a href="Posts.html#Posts">Posts</a>). +</p> +<p>Haunt comes with a few convenient builders to help users who want to +create a simple blog with an Atom feed. +</p> + + + +</body> +</html> diff --git a/website/manual/Building.html b/website/manual/Building.html new file mode 100644 index 0000000..1f29de8 --- /dev/null +++ b/website/manual/Building.html @@ -0,0 +1,83 @@ +<!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.0, http://www.gnu.org/software/texinfo/ --> +<head> +<title>Haunt Reference Manual: Building</title> + +<meta name="description" content="Haunt Reference Manual: Building"> +<meta name="keywords" content="Haunt Reference Manual: Building"> +<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="Installation.html#Installation" rel="up" title="Installation"> +<link href="Tutorial.html#Tutorial" rel="next" title="Tutorial"> +<link href="Requirements.html#Requirements" rel="prev" title="Requirements"> +<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.nocodebreak {white-space: nowrap} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: serif; 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="Building"></a> +<div class="header"> +<p> +Previous: <a href="Requirements.html#Requirements" accesskey="p" rel="prev">Requirements</a>, Up: <a href="Installation.html#Installation" accesskey="u" rel="up">Installation</a> [<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="Building-1"></a> +<h3 class="section">2.3 Building</h3> + +<p>Haunt uses the standard GNU build system, so the basic installation +procedure looks like this: +</p> +<div class="example"> +<pre class="example">./configure +make +make install +</pre></div> + + + + +</body> +</html> diff --git a/website/manual/Command_002dline-Interface.html b/website/manual/Command_002dline-Interface.html new file mode 100644 index 0000000..3071266 --- /dev/null +++ b/website/manual/Command_002dline-Interface.html @@ -0,0 +1,88 @@ +<!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.0, http://www.gnu.org/software/texinfo/ --> +<head> +<title>Haunt Reference Manual: Command-line Interface</title> + +<meta name="description" content="Haunt Reference Manual: Command-line Interface"> +<meta name="keywords" content="Haunt Reference Manual: Command-line Interface"> +<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="index.html#Top" rel="up" title="Top"> +<link href="Invoking-haunt-build.html#Invoking-haunt-build" rel="next" title="Invoking haunt build"> +<link href="Tutorial.html#Tutorial" rel="prev" title="Tutorial"> +<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.nocodebreak {white-space: nowrap} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: serif; 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="Command_002dline-Interface"></a> +<div class="header"> +<p> +Next: <a href="Programming-Interface.html#Programming-Interface" accesskey="n" rel="next">Programming Interface</a>, Previous: <a href="Tutorial.html#Tutorial" accesskey="p" rel="prev">Tutorial</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> [<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="Command_002dline-Interface-1"></a> +<h2 class="chapter">4 Command-line Interface</h2> + +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• <a href="Invoking-haunt-build.html#Invoking-haunt-build" accesskey="1">Invoking haunt build</a>:</td><td> </td><td align="left" valign="top">Build the website. +</td></tr> +<tr><td align="left" valign="top">• <a href="Invoking-haunt-serve.html#Invoking-haunt-serve" accesskey="2">Invoking haunt serve</a>:</td><td> </td><td align="left" valign="top">Serve the website over HTTP. +</td></tr> +</table> + +<p>The Haunt command-line interface is composed of many subcommands. The +general syntax for all Haunt commands is: +</p> +<div class="example"> +<pre class="example">haunt <var>subcommand</var> <var>options</var>… +</pre></div> + + + + +</body> +</html> diff --git a/website/manual/Concept-Index.html b/website/manual/Concept-Index.html new file mode 100644 index 0000000..44f2361 --- /dev/null +++ b/website/manual/Concept-Index.html @@ -0,0 +1,74 @@ +<!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.0, http://www.gnu.org/software/texinfo/ --> +<head> +<title>Haunt Reference Manual: Concept Index</title> + +<meta name="description" content="Haunt Reference Manual: Concept Index"> +<meta name="keywords" content="Haunt Reference Manual: Concept Index"> +<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" rel="index" title="Concept Index"> +<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> +<link href="index.html#Top" rel="up" title="Top"> +<link href="Programming-Index.html#Programming-Index" rel="next" title="Programming Index"> +<link href="GNU-Free-Documentation-License.html#GNU-Free-Documentation-License" rel="prev" title="GNU Free Documentation License"> +<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.nocodebreak {white-space: nowrap} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: serif; 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="Concept-Index"></a> +<div class="header"> +<p> +Next: <a href="Programming-Index.html#Programming-Index" accesskey="n" rel="next">Programming Index</a>, Previous: <a href="GNU-Free-Documentation-License.html#GNU-Free-Documentation-License" accesskey="p" rel="prev">GNU Free Documentation License</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> +</div> +<hr> +<a name="Concept-Index-1"></a> +<h2 class="unnumbered">Concept Index</h2> + + + + +</body> +</html> diff --git a/website/manual/Contributing.html b/website/manual/Contributing.html new file mode 100644 index 0000000..54047ea --- /dev/null +++ b/website/manual/Contributing.html @@ -0,0 +1,74 @@ +<!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.0, http://www.gnu.org/software/texinfo/ --> +<head> +<title>Haunt Reference Manual: Contributing</title> + +<meta name="description" content="Haunt Reference Manual: Contributing"> +<meta name="keywords" content="Haunt Reference Manual: Contributing"> +<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="index.html#Top" rel="up" title="Top"> +<link href="GNU-Free-Documentation-License.html#GNU-Free-Documentation-License" rel="next" title="GNU Free Documentation License"> +<link href="Atom.html#Atom" rel="prev" title="Atom"> +<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.nocodebreak {white-space: nowrap} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: serif; 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="Contributing"></a> +<div class="header"> +<p> +Next: <a href="GNU-Free-Documentation-License.html#GNU-Free-Documentation-License" accesskey="n" rel="next">GNU Free Documentation License</a>, Previous: <a href="Programming-Interface.html#Programming-Interface" accesskey="p" rel="prev">Programming Interface</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> [<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="Contributing-1"></a> +<h2 class="chapter">6 Contributing</h2> + + + + +</body> +</html> diff --git a/website/manual/Downloading.html b/website/manual/Downloading.html new file mode 100644 index 0000000..4a449cf --- /dev/null +++ b/website/manual/Downloading.html @@ -0,0 +1,78 @@ +<!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.0, http://www.gnu.org/software/texinfo/ --> +<head> +<title>Haunt Reference Manual: Downloading</title> + +<meta name="description" content="Haunt Reference Manual: Downloading"> +<meta name="keywords" content="Haunt Reference Manual: Downloading"> +<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="Installation.html#Installation" rel="up" title="Installation"> +<link href="Requirements.html#Requirements" rel="next" title="Requirements"> +<link href="Installation.html#Installation" rel="prev" title="Installation"> +<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.nocodebreak {white-space: nowrap} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: serif; 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="Downloading"></a> +<div class="header"> +<p> +Next: <a href="Requirements.html#Requirements" accesskey="n" rel="next">Requirements</a>, Up: <a href="Installation.html#Installation" accesskey="u" rel="up">Installation</a> [<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="Downloading-1"></a> +<h3 class="section">2.1 Downloading</h3> + +<p>Official Haunt source code release tarballs can be found on the +<a href="http://haunt.dthompson.us/downloads.html">downloads page</a> of +Haunt’s website, along with their associated checksums. +</p> + + + +</body> +</html> diff --git a/website/manual/GNU-Free-Documentation-License.html b/website/manual/GNU-Free-Documentation-License.html new file mode 100644 index 0000000..d915f17 --- /dev/null +++ b/website/manual/GNU-Free-Documentation-License.html @@ -0,0 +1,548 @@ +<!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.0, http://www.gnu.org/software/texinfo/ --> +<head> +<title>Haunt Reference Manual: GNU Free Documentation License</title> + +<meta name="description" content="Haunt Reference Manual: GNU Free Documentation License"> +<meta name="keywords" content="Haunt Reference Manual: GNU Free Documentation License"> +<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="index.html#Top" rel="up" title="Top"> +<link href="Concept-Index.html#Concept-Index" rel="next" title="Concept Index"> +<link href="Contributing.html#Contributing" rel="prev" title="Contributing"> +<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.nocodebreak {white-space: nowrap} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: serif; 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="GNU-Free-Documentation-License"></a> +<div class="header"> +<p> +Next: <a href="Concept-Index.html#Concept-Index" accesskey="n" rel="next">Concept Index</a>, Previous: <a href="Contributing.html#Contributing" accesskey="p" rel="prev">Contributing</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> [<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="GNU-Free-Documentation-License-1"></a> +<h2 class="appendix">Appendix A GNU Free Documentation License</h2> + +<div align="center">Version 1.3, 3 November 2008 +</div> + +<div class="display"> +<pre class="display">Copyright © 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. +<a href="http://fsf.org/">http://fsf.org/</a> + +Everyone is permitted to copy and distribute verbatim copies +of this license document, but changing it is not allowed. +</pre></div> + +<ol> +<li> PREAMBLE + +<p>The purpose of this License is to make a manual, textbook, or other +functional and useful document <em>free</em> in the sense of freedom: to +assure everyone the effective freedom to copy and redistribute it, +with or without modifying it, either commercially or noncommercially. +Secondarily, this License preserves for the author and publisher a way +to get credit for their work, while not being considered responsible +for modifications made by others. +</p> +<p>This License is a kind of “copyleft”, which means that derivative +works of the document must themselves be free in the same sense. It +complements the GNU General Public License, which is a copyleft +license designed for free software. +</p> +<p>We have designed this License in order to use it for manuals for free +software, because free software needs free documentation: a free +program should come with manuals providing the same freedoms that the +software does. But this License is not limited to software manuals; +it can be used for any textual work, regardless of subject matter or +whether it is published as a printed book. We recommend this License +principally for works whose purpose is instruction or reference. +</p> +</li><li> APPLICABILITY AND DEFINITIONS + +<p>This License applies to any manual or other work, in any medium, that +contains a notice placed by the copyright holder saying it can be +distributed under the terms of this License. Such a notice grants a +world-wide, royalty-free license, unlimited in duration, to use that +work under the conditions stated herein. The “Document”, below, +refers to any such manual or work. Any member of the public is a +licensee, and is addressed as “you”. You accept the license if you +copy, modify or distribute the work in a way requiring permission +under copyright law. +</p> +<p>A “Modified Version” of the Document means any work containing the +Document or a portion of it, either copied verbatim, or with +modifications and/or translated into another language. +</p> +<p>A “Secondary Section” is a named appendix or a front-matter section +of the Document that deals exclusively with the relationship of the +publishers or authors of the Document to the Document’s overall +subject (or to related matters) and contains nothing that could fall +directly within that overall subject. (Thus, if the Document is in +part a textbook of mathematics, a Secondary Section may not explain +any mathematics.) The relationship could be a matter of historical +connection with the subject or with related matters, or of legal, +commercial, philosophical, ethical or political position regarding +them. +</p> +<p>The “Invariant Sections” are certain Secondary Sections whose titles +are designated, as being those of Invariant Sections, in the notice +that says that the Document is released under this License. If a +section does not fit the above definition of Secondary then it is not +allowed to be designated as Invariant. The Document may contain zero +Invariant Sections. If the Document does not identify any Invariant +Sections then there are none. +</p> +<p>The “Cover Texts” are certain short passages of text that are listed, +as Front-Cover Texts or Back-Cover Texts, in the notice that says that +the Document is released under this License. A Front-Cover Text may +be at most 5 words, and a Back-Cover Text may be at most 25 words. +</p> +<p>A “Transparent” copy of the Document means a machine-readable copy, +represented in a format whose specification is available to the +general public, that is suitable for revising the document +straightforwardly with generic text editors or (for images composed of +pixels) generic paint programs or (for drawings) some widely available +drawing editor, and that is suitable for input to text formatters or +for automatic translation to a variety of formats suitable for input +to text formatters. A copy made in an otherwise Transparent file +format whose markup, or absence of markup, has been arranged to thwart +or discourage subsequent modification by readers is not Transparent. +An image format is not Transparent if used for any substantial amount +of text. A copy that is not “Transparent” is called “Opaque”. +</p> +<p>Examples of suitable formats for Transparent copies include plain +ASCII without markup, Texinfo input format, LaTeX input +format, SGML or XML using a publicly available +DTD, and standard-conforming simple HTML, +PostScript or PDF designed for human modification. Examples +of transparent image formats include PNG, XCF and +JPG. Opaque formats include proprietary formats that can be +read and edited only by proprietary word processors, SGML or +XML for which the DTD and/or processing tools are +not generally available, and the machine-generated HTML, +PostScript or PDF produced by some word processors for +output purposes only. +</p> +<p>The “Title Page” means, for a printed book, the title page itself, +plus such following pages as are needed to hold, legibly, the material +this License requires to appear in the title page. For works in +formats which do not have any title page as such, “Title Page” means +the text near the most prominent appearance of the work’s title, +preceding the beginning of the body of the text. +</p> +<p>The “publisher” means any person or entity that distributes copies +of the Document to the public. +</p> +<p>A section “Entitled XYZ” means a named subunit of the Document whose +title either is precisely XYZ or contains XYZ in parentheses following +text that translates XYZ in another language. (Here XYZ stands for a +specific section name mentioned below, such as “Acknowledgements”, +“Dedications”, “Endorsements”, or “History”.) To “Preserve the Title” +of such a section when you modify the Document means that it remains a +section “Entitled XYZ” according to this definition. +</p> +<p>The Document may include Warranty Disclaimers next to the notice which +states that this License applies to the Document. These Warranty +Disclaimers are considered to be included by reference in this +License, but only as regards disclaiming warranties: any other +implication that these Warranty Disclaimers may have is void and has +no effect on the meaning of this License. +</p> +</li><li> VERBATIM COPYING + +<p>You may copy and distribute the Document in any medium, either +commercially or noncommercially, provided that this License, the +copyright notices, and the license notice saying this License applies +to the Document are reproduced in all copies, and that you add no other +conditions whatsoever to those of this License. You may not use +technical measures to obstruct or control the reading or further +copying of the copies you make or distribute. However, you may accept +compensation in exchange for copies. If you distribute a large enough +number of copies you must also follow the conditions in section 3. +</p> +<p>You may also lend copies, under the same conditions stated above, and +you may publicly display copies. +</p> +</li><li> COPYING IN QUANTITY + +<p>If you publish printed copies (or copies in media that commonly have +printed covers) of the Document, numbering more than 100, and the +Document’s license notice requires Cover Texts, you must enclose the +copies in covers that carry, clearly and legibly, all these Cover +Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on +the back cover. Both covers must also clearly and legibly identify +you as the publisher of these copies. The front cover must present +the full title with all words of the title equally prominent and +visible. You may add other material on the covers in addition. +Copying with changes limited to the covers, as long as they preserve +the title of the Document and satisfy these conditions, can be treated +as verbatim copying in other respects. +</p> +<p>If the required texts for either cover are too voluminous to fit +legibly, you should put the first ones listed (as many as fit +reasonably) on the actual cover, and continue the rest onto adjacent +pages. +</p> +<p>If you publish or distribute Opaque copies of the Document numbering +more than 100, you must either include a machine-readable Transparent +copy along with each Opaque copy, or state in or with each Opaque copy +a computer-network location from which the general network-using +public has access to download using public-standard network protocols +a complete Transparent copy of the Document, free of added material. +If you use the latter option, you must take reasonably prudent steps, +when you begin distribution of Opaque copies in quantity, to ensure +that this Transparent copy will remain thus accessible at the stated +location until at least one year after the last time you distribute an +Opaque copy (directly or through your agents or retailers) of that +edition to the public. +</p> +<p>It is requested, but not required, that you contact the authors of the +Document well before redistributing any large number of copies, to give +them a chance to provide you with an updated version of the Document. +</p> +</li><li> MODIFICATIONS + +<p>You may copy and distribute a Modified Version of the Document under +the conditions of sections 2 and 3 above, provided that you release +the Modified Version under precisely this License, with the Modified +Version filling the role of the Document, thus licensing distribution +and modification of the Modified Version to whoever possesses a copy +of it. In addition, you must do these things in the Modified Version: +</p> +<ol> +<li> Use in the Title Page (and on the covers, if any) a title distinct +from that of the Document, and from those of previous versions +(which should, if there were any, be listed in the History section +of the Document). You may use the same title as a previous version +if the original publisher of that version gives permission. + +</li><li> List on the Title Page, as authors, one or more persons or entities +responsible for authorship of the modifications in the Modified +Version, together with at least five of the principal authors of the +Document (all of its principal authors, if it has fewer than five), +unless they release you from this requirement. + +</li><li> State on the Title page the name of the publisher of the +Modified Version, as the publisher. + +</li><li> Preserve all the copyright notices of the Document. + +</li><li> Add an appropriate copyright notice for your modifications +adjacent to the other copyright notices. + +</li><li> Include, immediately after the copyright notices, a license notice +giving the public permission to use the Modified Version under the +terms of this License, in the form shown in the Addendum below. + +</li><li> Preserve in that license notice the full lists of Invariant Sections +and required Cover Texts given in the Document’s license notice. + +</li><li> Include an unaltered copy of this License. + +</li><li> Preserve the section Entitled “History”, Preserve its Title, and add +to it an item stating at least the title, year, new authors, and +publisher of the Modified Version as given on the Title Page. If +there is no section Entitled “History” in the Document, create one +stating the title, year, authors, and publisher of the Document as +given on its Title Page, then add an item describing the Modified +Version as stated in the previous sentence. + +</li><li> Preserve the network location, if any, given in the Document for +public access to a Transparent copy of the Document, and likewise +the network locations given in the Document for previous versions +it was based on. These may be placed in the “History” section. +You may omit a network location for a work that was published at +least four years before the Document itself, or if the original +publisher of the version it refers to gives permission. + +</li><li> For any section Entitled “Acknowledgements” or “Dedications”, Preserve +the Title of the section, and preserve in the section all the +substance and tone of each of the contributor acknowledgements and/or +dedications given therein. + +</li><li> Preserve all the Invariant Sections of the Document, +unaltered in their text and in their titles. Section numbers +or the equivalent are not considered part of the section titles. + +</li><li> Delete any section Entitled “Endorsements”. Such a section +may not be included in the Modified Version. + +</li><li> Do not retitle any existing section to be Entitled “Endorsements” or +to conflict in title with any Invariant Section. + +</li><li> Preserve any Warranty Disclaimers. +</li></ol> + +<p>If the Modified Version includes new front-matter sections or +appendices that qualify as Secondary Sections and contain no material +copied from the Document, you may at your option designate some or all +of these sections as invariant. To do this, add their titles to the +list of Invariant Sections in the Modified Version’s license notice. +These titles must be distinct from any other section titles. +</p> +<p>You may add a section Entitled “Endorsements”, provided it contains +nothing but endorsements of your Modified Version by various +parties—for example, statements of peer review or that the text has +been approved by an organization as the authoritative definition of a +standard. +</p> +<p>You may add a passage of up to five words as a Front-Cover Text, and a +passage of up to 25 words as a Back-Cover Text, to the end of the list +of Cover Texts in the Modified Version. Only one passage of +Front-Cover Text and one of Back-Cover Text may be added by (or +through arrangements made by) any one entity. If the Document already +includes a cover text for the same cover, previously added by you or +by arrangement made by the same entity you are acting on behalf of, +you may not add another; but you may replace the old one, on explicit +permission from the previous publisher that added the old one. +</p> +<p>The author(s) and publisher(s) of the Document do not by this License +give permission to use their names for publicity for or to assert or +imply endorsement of any Modified Version. +</p> +</li><li> COMBINING DOCUMENTS + +<p>You may combine the Document with other documents released under this +License, under the terms defined in section 4 above for modified +versions, provided that you include in the combination all of the +Invariant Sections of all of the original documents, unmodified, and +list them all as Invariant Sections of your combined work in its +license notice, and that you preserve all their Warranty Disclaimers. +</p> +<p>The combined work need only contain one copy of this License, and +multiple identical Invariant Sections may be replaced with a single +copy. If there are multiple Invariant Sections with the same name but +different contents, make the title of each such section unique by +adding at the end of it, in parentheses, the name of the original +author or publisher of that section if known, or else a unique number. +Make the same adjustment to the section titles in the list of +Invariant Sections in the license notice of the combined work. +</p> +<p>In the combination, you must combine any sections Entitled “History” +in the various original documents, forming one section Entitled +“History”; likewise combine any sections Entitled “Acknowledgements”, +and any sections Entitled “Dedications”. You must delete all +sections Entitled “Endorsements.” +</p> +</li><li> COLLECTIONS OF DOCUMENTS + +<p>You may make a collection consisting of the Document and other documents +released under this License, and replace the individual copies of this +License in the various documents with a single copy that is included in +the collection, provided that you follow the rules of this License for +verbatim copying of each of the documents in all other respects. +</p> +<p>You may extract a single document from such a collection, and distribute +it individually under this License, provided you insert a copy of this +License into the extracted document, and follow this License in all +other respects regarding verbatim copying of that document. +</p> +</li><li> AGGREGATION WITH INDEPENDENT WORKS + +<p>A compilation of the Document or its derivatives with other separate +and independent documents or works, in or on a volume of a storage or +distribution medium, is called an “aggregate” if the copyright +resulting from the compilation is not used to limit the legal rights +of the compilation’s users beyond what the individual works permit. +When the Document is included in an aggregate, this License does not +apply to the other works in the aggregate which are not themselves +derivative works of the Document. +</p> +<p>If the Cover Text requirement of section 3 is applicable to these +copies of the Document, then if the Document is less than one half of +the entire aggregate, the Document’s Cover Texts may be placed on +covers that bracket the Document within the aggregate, or the +electronic equivalent of covers if the Document is in electronic form. +Otherwise they must appear on printed covers that bracket the whole +aggregate. +</p> +</li><li> TRANSLATION + +<p>Translation is considered a kind of modification, so you may +distribute translations of the Document under the terms of section 4. +Replacing Invariant Sections with translations requires special +permission from their copyright holders, but you may include +translations of some or all Invariant Sections in addition to the +original versions of these Invariant Sections. You may include a +translation of this License, and all the license notices in the +Document, and any Warranty Disclaimers, provided that you also include +the original English version of this License and the original versions +of those notices and disclaimers. In case of a disagreement between +the translation and the original version of this License or a notice +or disclaimer, the original version will prevail. +</p> +<p>If a section in the Document is Entitled “Acknowledgements”, +“Dedications”, or “History”, the requirement (section 4) to Preserve +its Title (section 1) will typically require changing the actual +title. +</p> +</li><li> TERMINATION + +<p>You may not copy, modify, sublicense, or distribute the Document +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense, or distribute it is void, and +will automatically terminate your rights under this License. +</p> +<p>However, if you cease all violation of this License, then your license +from a particular copyright holder is reinstated (a) provisionally, +unless and until the copyright holder explicitly and finally +terminates your license, and (b) permanently, if the copyright holder +fails to notify you of the violation by some reasonable means prior to +60 days after the cessation. +</p> +<p>Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. +</p> +<p>Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, receipt of a copy of some or all of the same material does +not give you any rights to use it. +</p> +</li><li> FUTURE REVISIONS OF THIS LICENSE + +<p>The Free Software Foundation may publish new, revised versions +of the GNU Free Documentation License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. See +<a href="http://www.gnu.org/copyleft/">http://www.gnu.org/copyleft/</a>. +</p> +<p>Each version of the License is given a distinguishing version number. +If the Document specifies that a particular numbered version of this +License “or any later version” applies to it, you have the option of +following the terms and conditions either of that specified version or +of any later version that has been published (not as a draft) by the +Free Software Foundation. If the Document does not specify a version +number of this License, you may choose any version ever published (not +as a draft) by the Free Software Foundation. If the Document +specifies that a proxy can decide which future versions of this +License can be used, that proxy’s public statement of acceptance of a +version permanently authorizes you to choose that version for the +Document. +</p> +</li><li> RELICENSING + +<p>“Massive Multiauthor Collaboration Site” (or “MMC Site”) means any +World Wide Web server that publishes copyrightable works and also +provides prominent facilities for anybody to edit those works. A +public wiki that anybody can edit is an example of such a server. A +“Massive Multiauthor Collaboration” (or “MMC”) contained in the +site means any set of copyrightable works thus published on the MMC +site. +</p> +<p>“CC-BY-SA” means the Creative Commons Attribution-Share Alike 3.0 +license published by Creative Commons Corporation, a not-for-profit +corporation with a principal place of business in San Francisco, +California, as well as future copyleft versions of that license +published by that same organization. +</p> +<p>“Incorporate” means to publish or republish a Document, in whole or +in part, as part of another Document. +</p> +<p>An MMC is “eligible for relicensing” if it is licensed under this +License, and if all works that were first published under this License +somewhere other than this MMC, and subsequently incorporated in whole +or in part into the MMC, (1) had no cover texts or invariant sections, +and (2) were thus incorporated prior to November 1, 2008. +</p> +<p>The operator of an MMC Site may republish an MMC contained in the site +under CC-BY-SA on the same site at any time before August 1, 2009, +provided the MMC is eligible for relicensing. +</p> +</li></ol> + +<a name="ADDENDUM_003a-How-to-use-this-License-for-your-documents"></a> +<h3 class="heading">ADDENDUM: How to use this License for your documents</h3> + +<p>To use this License in a document you have written, include a copy of +the License in the document and put the following copyright and +license notices just after the title page: +</p> +<div class="smallexample"> +<pre class="smallexample"> Copyright (C) <var>year</var> <var>your name</var>. + 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''. +</pre></div> + +<p>If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, +replace the “with…Texts.” line with this: +</p> +<div class="smallexample"> +<pre class="smallexample"> with the Invariant Sections being <var>list their titles</var>, with + the Front-Cover Texts being <var>list</var>, and with the Back-Cover Texts + being <var>list</var>. +</pre></div> + +<p>If you have Invariant Sections without Cover Texts, or some other +combination of the three, merge those two alternatives to suit the +situation. +</p> +<p>If your document contains nontrivial examples of program code, we +recommend releasing these examples in parallel under your choice of +free software license, such as the GNU General Public License, +to permit their use in free software. +</p> + +<hr> +<div class="header"> +<p> +Next: <a href="Concept-Index.html#Concept-Index" accesskey="n" rel="next">Concept Index</a>, Previous: <a href="Contributing.html#Contributing" accesskey="p" rel="prev">Contributing</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> [<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> diff --git a/website/manual/Installation.html b/website/manual/Installation.html new file mode 100644 index 0000000..25091f5 --- /dev/null +++ b/website/manual/Installation.html @@ -0,0 +1,83 @@ +<!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.0, http://www.gnu.org/software/texinfo/ --> +<head> +<title>Haunt Reference Manual: Installation</title> + +<meta name="description" content="Haunt Reference Manual: Installation"> +<meta name="keywords" content="Haunt Reference Manual: Installation"> +<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="index.html#Top" rel="up" title="Top"> +<link href="Downloading.html#Downloading" rel="next" title="Downloading"> +<link href="Introduction.html#Introduction" rel="prev" title="Introduction"> +<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.nocodebreak {white-space: nowrap} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: serif; 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="Installation"></a> +<div class="header"> +<p> +Next: <a href="Tutorial.html#Tutorial" accesskey="n" rel="next">Tutorial</a>, Previous: <a href="Introduction.html#Introduction" accesskey="p" rel="prev">Introduction</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> [<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="Installation-1"></a> +<h2 class="chapter">2 Installation</h2> + +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• <a href="Downloading.html#Downloading" accesskey="1">Downloading</a>:</td><td> </td><td align="left" valign="top">Downloading the source code. +</td></tr> +<tr><td align="left" valign="top">• <a href="Requirements.html#Requirements" accesskey="2">Requirements</a>:</td><td> </td><td align="left" valign="top">Software needed to build and run Haunt. +</td></tr> +<tr><td align="left" valign="top">• <a href="Building.html#Building" accesskey="3">Building</a>:</td><td> </td><td align="left" valign="top">Building from source code. +</td></tr> +</table> + + + + +</body> +</html> diff --git a/website/manual/Introduction.html b/website/manual/Introduction.html new file mode 100644 index 0000000..d907168 --- /dev/null +++ b/website/manual/Introduction.html @@ -0,0 +1,138 @@ +<!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.0, http://www.gnu.org/software/texinfo/ --> +<head> +<title>Haunt Reference Manual: Introduction</title> + +<meta name="description" content="Haunt Reference Manual: Introduction"> +<meta name="keywords" content="Haunt Reference Manual: Introduction"> +<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="index.html#Top" rel="up" title="Top"> +<link href="Installation.html#Installation" rel="next" title="Installation"> +<link href="index.html#Top" rel="prev" title="Top"> +<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.nocodebreak {white-space: nowrap} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: serif; 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="Introduction"></a> +<div class="header"> +<p> +Next: <a href="Installation.html#Installation" accesskey="n" rel="next">Installation</a>, Previous: <a href="index.html#Top" accesskey="p" rel="prev">Top</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> [<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="Introduction-1"></a> +<h2 class="chapter">1 Introduction</h2> + +<p>Haunt is a hackable static site generator written in Guile Scheme. A +static site generator assists an author with generating the HTML pages +that they publish on the web. Unlike “content management systems” +such as Wordpress or Drupal, static site generators are not dynamic +web applications (complete with a relational database) that build +pages on-the-fly. Instead, web pages are built in advance, on the +author’s computer, and copied to a web server when it is time to +publish changes. The consequence of this design is that the web +server no longer needs to run a complex, potentially insecure web +application that connects to a database to retrieve data. Static +files can be served easily by any generic web server. Since there is +no web application or database server to deal with, static websites +are easier to maintain, more secure, and resistant to high web traffic +(“slashdotting.”) Furthermore, the entire website is stored in +plain text, which allows the files to be version-controlled rather +than kept in a relational database with no concept of history that +needs to be backed up regularly. +</p> +<p>At the time that Haunt was conceived, there existed literally hundreds +of other static site generators. Why add another one? Haunt +differentiates itself from most other static site generators in that +it aspires to the Emacs philosophy of “practical software freedom.” +Not only is the source code available under a Free Software license, +as most static site generators are, it is designed to be easily hacked +and extended without altering the core source code. Haunt +purposefully blurs the line between document and program, author and +programmer, by embracing the notion of data as code. A Haunt-based +website is not simply data, but a computer program. This design +strategy encourages authors to automate repetitive tasks and empowers +them to extend the software with their own ideas. +</p> +<p>To make such a system work well, a general-purpose, extensible +programming language is needed. A traditional configuration file +format simply will not do. The programming language that we feel is +best suited to this task is Scheme, a clean and elegant dialect of +Lisp. We believe that by giving authors the full expressive power of +Scheme, they will be able to produce better websites and make better +use of their time than with less programmable systems and less capable +programming languages. Authors should feel empowered to hack the +system to make it do what they want rather than what some programmer +decided they should want. And perhaps most importantly, building +websites with Haunt should be <em>fun</em>. +</p> +<p>Websites written in Haunt are described as purely functional programs +that accept “posts”, text documents containing arbitrary metadata, +as input and transform them into complete HTML pages using Scheme +procedures. Haunt has no opinion about what markup language authors +should use to write their posts and will happily work with any format +for which a “reader” procedure exists. Likewise, Haunt also has no +opinion about how authors should structure their sites, but has sane +defaults. Currently, there exist helpful “builder” procedures that +do common tasks such as generating a blog or Atom feed. While the +built-in features may be enough for some, they surely will not be +enough for all. Haunt’s Scheme API empowers authors to easily tweak +existing components, write replacements, or add entirely new features +that do things no else has thought to do yet. +</p> +<p>Happy haunting! +</p> +<hr> +<div class="header"> +<p> +Next: <a href="Installation.html#Installation" accesskey="n" rel="next">Installation</a>, Previous: <a href="index.html#Top" accesskey="p" rel="prev">Top</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> [<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> diff --git a/website/manual/Invoking-haunt-build.html b/website/manual/Invoking-haunt-build.html new file mode 100644 index 0000000..308423a --- /dev/null +++ b/website/manual/Invoking-haunt-build.html @@ -0,0 +1,93 @@ +<!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.0, http://www.gnu.org/software/texinfo/ --> +<head> +<title>Haunt Reference Manual: Invoking haunt build</title> + +<meta name="description" content="Haunt Reference Manual: Invoking haunt build"> +<meta name="keywords" content="Haunt Reference Manual: Invoking haunt build"> +<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="Command_002dline-Interface.html#Command_002dline-Interface" rel="up" title="Command-line Interface"> +<link href="Invoking-haunt-serve.html#Invoking-haunt-serve" rel="next" title="Invoking haunt serve"> +<link href="Command_002dline-Interface.html#Command_002dline-Interface" rel="prev" title="Command-line Interface"> +<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.nocodebreak {white-space: nowrap} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: serif; 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="Invoking-haunt-build"></a> +<div class="header"> +<p> +Next: <a href="Invoking-haunt-serve.html#Invoking-haunt-serve" accesskey="n" rel="next">Invoking haunt serve</a>, Up: <a href="Command_002dline-Interface.html#Command_002dline-Interface" accesskey="u" rel="up">Command-line Interface</a> [<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="Invoking-haunt-build-1"></a> +<h3 class="section">4.1 Invoking <code>haunt build</code></h3> + +<p>The <code>haunt build</code> command realizes a Haunt site configuration +file by compiling web pages and copying static assets to the output +directory. For details on how to configure a Haunt site, +see <a href="Sites.html#Sites">Sites</a>. +</p> +<p>Example: +</p> +<div class="example"> +<pre class="example">haunt build --config=haunt.scm +</pre></div> + +<dl compact="compact"> +<dt><code>--config=<var>configuration-file</var></code></dt> +<dt><code>-c <var>configuration-file</var></code></dt> +<dd><p>Load the Haunt site declaration from <var>configuration-file</var>. +</p> +</dd> +</dl> + + + + +</body> +</html> diff --git a/website/manual/Invoking-haunt-serve.html b/website/manual/Invoking-haunt-serve.html new file mode 100644 index 0000000..dce68b3 --- /dev/null +++ b/website/manual/Invoking-haunt-serve.html @@ -0,0 +1,108 @@ +<!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.0, http://www.gnu.org/software/texinfo/ --> +<head> +<title>Haunt Reference Manual: Invoking haunt serve</title> + +<meta name="description" content="Haunt Reference Manual: Invoking haunt serve"> +<meta name="keywords" content="Haunt Reference Manual: Invoking haunt serve"> +<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="Command_002dline-Interface.html#Command_002dline-Interface" rel="up" title="Command-line Interface"> +<link href="Programming-Interface.html#Programming-Interface" rel="next" title="Programming Interface"> +<link href="Invoking-haunt-build.html#Invoking-haunt-build" rel="prev" title="Invoking haunt build"> +<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.nocodebreak {white-space: nowrap} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: serif; 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="Invoking-haunt-serve"></a> +<div class="header"> +<p> +Previous: <a href="Invoking-haunt-build.html#Invoking-haunt-build" accesskey="p" rel="prev">Invoking haunt build</a>, Up: <a href="Command_002dline-Interface.html#Command_002dline-Interface" accesskey="u" rel="up">Command-line Interface</a> [<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="Invoking-haunt-serve-1"></a> +<h3 class="section">4.2 Invoking <code>haunt serve</code></h3> + +<p>The <code>haunt serve</code> command allows one to quickly view a local +preview of the generated website before publishing the finished +product to a remote web server. When <code>haunt serve</code> runs, a +local HTTP server is spawned. Visit the server using a web browser to +inspect the results of the build. By default, the web server listens +on port 8080, so the URL to visit would be +<a href="http://localhost:8080">http://localhost:8080</a>. +</p> +<p>While developing, it is common to rebuild the site frequently to view +the results of incremental changes. Rather than manually running +<code>haunt build</code> (<a href="Invoking-haunt-build.html#Invoking-haunt-build">Invoking haunt build</a>) each time changes +are made, the <code>--watch</code> flag can be used to automatically rebuild +the site when a source file changes on disk. +</p> +<dl compact="compact"> +<dt><code>--config=<var>configuration-file</var></code></dt> +<dt><code>-c <var>configuration-file</var></code></dt> +<dd><p>Load the Haunt site declaration from <var>configuration-file</var>. +</p> +</dd> +<dt><code>--port=<var>port</var></code></dt> +<dt><code>-p <var>port</var></code></dt> +<dd> +<p>Listen for HTTP requests on <var>port</var>. +</p> +</dd> +<dt><code>--watch</code></dt> +<dt><code>-w</code></dt> +<dd> +<p>Automatically rebuild the site when source files change. +</p> +</dd> +</dl> + + + + +</body> +</html> diff --git a/website/manual/Pages.html b/website/manual/Pages.html new file mode 100644 index 0000000..d061e10 --- /dev/null +++ b/website/manual/Pages.html @@ -0,0 +1,115 @@ +<!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.0, http://www.gnu.org/software/texinfo/ --> +<head> +<title>Haunt Reference Manual: Pages</title> + +<meta name="description" content="Haunt Reference Manual: Pages"> +<meta name="keywords" content="Haunt Reference Manual: Pages"> +<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="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"> +<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.nocodebreak {white-space: nowrap} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: serif; 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="Pages"></a> +<div class="header"> +<p> +Next: <a href="Assets.html#Assets" accesskey="n" rel="next">Assets</a>, Previous: <a href="Readers.html#Readers" accesskey="p" rel="prev">Readers</a>, Up: <a href="Programming-Interface.html#Programming-Interface" accesskey="u" rel="up">Programming Interface</a> [<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="Pages-1"></a> +<h3 class="section">5.4 Pages</h3> + +<div class="example"> +<pre class="example">(use-modules (haunt page)) +</pre></div> + +<p>Page objects represent files that have yet to be written to disk. +Their contents may be any arbitrary object that their writer procedure +knows how to serialize. In practice, pages are almost always written +to disk as HTML or XML. +</p> +<dl> +<dt><a name="index-make_002dpage"></a>Scheme Procedure: <strong>make-page</strong> <em><var>file-name</var> <var>contents</var> <var>writer</var></em></dt> +<dd><p>Create a new page object. The string <var>file-name</var> specifies where +the page should be written to in the file system. The procedure +<var>writer</var> is responsible for serializing <var>contents</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-page_003f"></a>Scheme Procedure: <strong>page?</strong> <em><var>object</var></em></dt> +<dd><p>Return <code>#t</code> if <var>object</var> is a page object. +</p></dd></dl> + +<dl> +<dt><a name="index-page_002dfile_002dname"></a>Scheme Procedure: <strong>page-file-name</strong> <em><var>page</var></em></dt> +<dd><p>Return the file name string for <var>page</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-page_002dcontents"></a>Scheme Procedure: <strong>page-contents</strong> <em><var>page</var></em></dt> +<dd><p>Return the contents of <var>page</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-page_002dwriter"></a>Scheme Procedure: <strong>page-writer</strong> <em><var>page</var></em></dt> +<dd><p>Return the writer procedure <var>page</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-write_002dpage"></a>Scheme Procedure: <strong>write-page</strong> <em><var>page</var> <var>output-directory</var></em></dt> +<dd><p>Write <var>page</var> to <var>output-directory</var>. +</p></dd></dl> + + + + +</body> +</html> diff --git a/website/manual/Posts.html b/website/manual/Posts.html new file mode 100644 index 0000000..9e83b84 --- /dev/null +++ b/website/manual/Posts.html @@ -0,0 +1,152 @@ +<!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.0, http://www.gnu.org/software/texinfo/ --> +<head> +<title>Haunt Reference Manual: Posts</title> + +<meta name="description" content="Haunt Reference Manual: Posts"> +<meta name="keywords" content="Haunt Reference Manual: Posts"> +<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="Programming-Interface.html#Programming-Interface" rel="up" title="Programming Interface"> +<link href="Readers.html#Readers" rel="next" title="Readers"> +<link href="Sites.html#Sites" rel="prev" title="Sites"> +<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.nocodebreak {white-space: nowrap} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: serif; 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="Posts"></a> +<div class="header"> +<p> +Next: <a href="Readers.html#Readers" accesskey="n" rel="next">Readers</a>, Previous: <a href="Sites.html#Sites" accesskey="p" rel="prev">Sites</a>, Up: <a href="Programming-Interface.html#Programming-Interface" accesskey="u" rel="up">Programming Interface</a> [<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="Posts-1"></a> +<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’s post directory +and written in a markup format that Haunt can +understand. see <a href="Readers.html#Readers">Readers</a>) for how files on disk can be transformed +into posts. +</p> +<dl> +<dt><a name="index-make_002dpost"></a>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="http://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="http://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><a name="index-post_003f"></a>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><a name="index-post_002dfile_002dname"></a>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><a name="index-post_002dmetadata"></a>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><a name="index-post_002dsxml"></a>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><a name="index-post_002dref"></a>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><a name="index-post_002dslug"></a>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><a name="index-_0025default_002ddate"></a>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><a name="index-post_002ddata"></a>Scheme Procedure: <strong>post-data</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><a name="index-posts_002freverse_002dchronological"></a>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><a name="index-posts_002fgroup_002dby_002dtag"></a>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#Readers" accesskey="n" rel="next">Readers</a>, Previous: <a href="Sites.html#Sites" accesskey="p" rel="prev">Sites</a>, Up: <a href="Programming-Interface.html#Programming-Interface" accesskey="u" rel="up">Programming Interface</a> [<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> diff --git a/website/manual/Programming-Index.html b/website/manual/Programming-Index.html new file mode 100644 index 0000000..a5a2843 --- /dev/null +++ b/website/manual/Programming-Index.html @@ -0,0 +1,207 @@ +<!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.0, http://www.gnu.org/software/texinfo/ --> +<head> +<title>Haunt Reference Manual: Programming Index</title> + +<meta name="description" content="Haunt Reference Manual: Programming Index"> +<meta name="keywords" content="Haunt Reference Manual: Programming Index"> +<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="index.html#Top" rel="up" title="Top"> +<link href="Concept-Index.html#Concept-Index" rel="prev" title="Concept Index"> +<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.nocodebreak {white-space: nowrap} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: serif; 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="Programming-Index"></a> +<div class="header"> +<p> +Previous: <a href="Concept-Index.html#Concept-Index" accesskey="p" rel="prev">Concept Index</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> [<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="Programming-Index-1"></a> +<h2 class="unnumbered">Programming Index</h2> +<table><tr><th valign="top">Jump to: </th><td><a class="summary-letter" href="#Programming-Index_fn_symbol-1"><b>%</b></a> + +<br> +<a class="summary-letter" href="#Programming-Index_fn_letter-A"><b>A</b></a> + +<a class="summary-letter" href="#Programming-Index_fn_letter-B"><b>B</b></a> + +<a class="summary-letter" href="#Programming-Index_fn_letter-D"><b>D</b></a> + +<a class="summary-letter" href="#Programming-Index_fn_letter-H"><b>H</b></a> + +<a class="summary-letter" href="#Programming-Index_fn_letter-I"><b>I</b></a> + +<a class="summary-letter" href="#Programming-Index_fn_letter-M"><b>M</b></a> + +<a class="summary-letter" href="#Programming-Index_fn_letter-P"><b>P</b></a> + +<a class="summary-letter" href="#Programming-Index_fn_letter-R"><b>R</b></a> + +<a class="summary-letter" href="#Programming-Index_fn_letter-S"><b>S</b></a> + +<a class="summary-letter" href="#Programming-Index_fn_letter-T"><b>T</b></a> + +<a class="summary-letter" href="#Programming-Index_fn_letter-W"><b>W</b></a> + +</td></tr></table> +<table class="index-fn" border="0"> +<tr><td></td><th align="left">Index Entry</th><td> </td><th align="left"> Section</th></tr> +<tr><td colspan="4"> <hr></td></tr> +<tr><th><a name="Programming-Index_fn_symbol-1">%</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="Posts.html#index-_0025default_002ddate"><code>%default-date</code></a>:</td><td> </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-A">A</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="Assets.html#index-asset_002dsource"><code>asset-source</code></a>:</td><td> </td><td valign="top"><a href="Assets.html#Assets">Assets</a></td></tr> +<tr><td></td><td valign="top"><a href="Assets.html#index-asset_002dtarget"><code>asset-target</code></a>:</td><td> </td><td valign="top"><a href="Assets.html#Assets">Assets</a></td></tr> +<tr><td></td><td valign="top"><a href="Assets.html#index-asset_003f"><code>asset?</code></a>:</td><td> </td><td valign="top"><a href="Assets.html#Assets">Assets</a></td></tr> +<tr><td></td><td valign="top"><a href="Atom.html#index-atom_002dfeed"><code>atom-feed</code></a>:</td><td> </td><td valign="top"><a href="Atom.html#Atom">Atom</a></td></tr> +<tr><td></td><td valign="top"><a href="Atom.html#index-atom_002dfeeds_002dby_002dtag"><code>atom-feeds-by-tag</code></a>:</td><td> </td><td valign="top"><a href="Atom.html#Atom">Atom</a></td></tr> +<tr><td colspan="4"> <hr></td></tr> +<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> </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-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> </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> </td><td valign="top"><a href="Readers.html#Readers">Readers</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> </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> </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> </td><td valign="top"><a href="Readers.html#Readers">Readers</a></td></tr> +<tr><td></td><td valign="top"><a href="Pages.html#index-make_002dpage"><code>make-page</code></a>:</td><td> </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> </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> </td><td valign="top"><a href="Readers.html#Readers">Readers</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> </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> </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> </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> </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> </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> </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> </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> </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_002dslug"><code>post-slug</code></a>:</td><td> </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_002dsxml"><code>post-sxml</code></a>:</td><td> </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_003f"><code>post?</code></a>:</td><td> </td><td valign="top"><a href="Posts.html#Posts">Posts</a></td></tr> +<tr><td></td><td valign="top"><a href="Posts.html#index-posts_002fgroup_002dby_002dtag"><code>posts/group-by-tag</code></a>:</td><td> </td><td valign="top"><a href="Posts.html#Posts">Posts</a></td></tr> +<tr><td></td><td valign="top"><a href="Posts.html#index-posts_002freverse_002dchronological"><code>posts/reverse-chronological</code></a>:</td><td> </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> </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> </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> </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> </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> </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> </td><td valign="top"><a href="Readers.html#Readers">Readers</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> </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_002dbuild_002ddirectory"><code>site-build-directory</code></a>:</td><td> </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_002dbuilders"><code>site-builders</code></a>:</td><td> </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_002ddomain"><code>site-domain</code></a>:</td><td> </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_002dfile_002dfilter"><code>site-file-filter</code></a>:</td><td> </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_002dmake_002dslug"><code>site-make-slug</code></a>:</td><td> </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_002dposts_002ddirectory"><code>site-posts-directory</code></a>:</td><td> </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_002dreaders"><code>site-readers</code></a>:</td><td> </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> </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> </td><td valign="top"><a href="Sites.html#Sites">Sites</a></td></tr> +<tr><td></td><td valign="top"><a href="Static-Assets.html#index-static_002ddirectory"><code>static-directory</code></a>:</td><td> </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> </td><td valign="top"><a href="Readers.html#Readers">Readers</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="Blog.html#index-theme"><code>theme</code></a>:</td><td> </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> </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-W">W</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="Pages.html#index-write_002dpage"><code>write-page</code></a>:</td><td> </td><td valign="top"><a href="Pages.html#Pages">Pages</a></td></tr> +<tr><td colspan="4"> <hr></td></tr> +</table> +<table><tr><th valign="top">Jump to: </th><td><a class="summary-letter" href="#Programming-Index_fn_symbol-1"><b>%</b></a> + +<br> +<a class="summary-letter" href="#Programming-Index_fn_letter-A"><b>A</b></a> + +<a class="summary-letter" href="#Programming-Index_fn_letter-B"><b>B</b></a> + +<a class="summary-letter" href="#Programming-Index_fn_letter-D"><b>D</b></a> + +<a class="summary-letter" href="#Programming-Index_fn_letter-H"><b>H</b></a> + +<a class="summary-letter" href="#Programming-Index_fn_letter-I"><b>I</b></a> + +<a class="summary-letter" href="#Programming-Index_fn_letter-M"><b>M</b></a> + +<a class="summary-letter" href="#Programming-Index_fn_letter-P"><b>P</b></a> + +<a class="summary-letter" href="#Programming-Index_fn_letter-R"><b>R</b></a> + +<a class="summary-letter" href="#Programming-Index_fn_letter-S"><b>S</b></a> + +<a class="summary-letter" href="#Programming-Index_fn_letter-T"><b>T</b></a> + +<a class="summary-letter" href="#Programming-Index_fn_letter-W"><b>W</b></a> + +</td></tr></table> + +<hr> +<div class="header"> +<p> +Previous: <a href="Concept-Index.html#Concept-Index" accesskey="p" rel="prev">Concept Index</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> [<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> diff --git a/website/manual/Programming-Interface.html b/website/manual/Programming-Interface.html new file mode 100644 index 0000000..88d215f --- /dev/null +++ b/website/manual/Programming-Interface.html @@ -0,0 +1,92 @@ +<!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.0, http://www.gnu.org/software/texinfo/ --> +<head> +<title>Haunt Reference Manual: Programming Interface</title> + +<meta name="description" content="Haunt Reference Manual: Programming Interface"> +<meta name="keywords" content="Haunt Reference Manual: Programming Interface"> +<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="index.html#Top" rel="up" title="Top"> +<link href="Sites.html#Sites" rel="next" title="Sites"> +<link href="Invoking-haunt-serve.html#Invoking-haunt-serve" rel="prev" title="Invoking haunt serve"> +<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.nocodebreak {white-space: nowrap} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: serif; 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="Programming-Interface"></a> +<div class="header"> +<p> +Next: <a href="Contributing.html#Contributing" accesskey="n" rel="next">Contributing</a>, Previous: <a href="Command_002dline-Interface.html#Command_002dline-Interface" accesskey="p" rel="prev">Command-line Interface</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> [<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="Programming-Interface-1"></a> +<h2 class="chapter">5 Programming Interface</h2> + +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• <a href="Sites.html#Sites" accesskey="1">Sites</a>:</td><td> </td><td align="left" valign="top">Description of the site and how to build it. +</td></tr> +<tr><td align="left" valign="top">• <a href="Posts.html#Posts" accesskey="2">Posts</a>:</td><td> </td><td align="left" valign="top">Articles, prose, blog posts, etc. +</td></tr> +<tr><td align="left" valign="top">• <a href="Readers.html#Readers" accesskey="3">Readers</a>:</td><td> </td><td align="left" valign="top">Post interpreters. +</td></tr> +<tr><td align="left" valign="top">• <a href="Pages.html#Pages" accesskey="4">Pages</a>:</td><td> </td><td align="left" valign="top">HTML/XML pages. +</td></tr> +<tr><td align="left" valign="top">• <a href="Assets.html#Assets" accesskey="5">Assets</a>:</td><td> </td><td align="left" valign="top">Images, stylesheets, etc. +</td></tr> +<tr><td align="left" valign="top">• <a href="Builders.html#Builders" accesskey="6">Builders</a>:</td><td> </td><td align="left" valign="top">Web page builders. +</td></tr> +</table> + +<p>Haunt is a fully-programmable system composed of several Guile Scheme +modules. This section documents the public API. +</p> + + + +</body> +</html> diff --git a/website/manual/Readers.html b/website/manual/Readers.html new file mode 100644 index 0000000..b0e2f18 --- /dev/null +++ b/website/manual/Readers.html @@ -0,0 +1,181 @@ +<!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.0, http://www.gnu.org/software/texinfo/ --> +<head> +<title>Haunt Reference Manual: Readers</title> + +<meta name="description" content="Haunt Reference Manual: Readers"> +<meta name="keywords" content="Haunt Reference Manual: Readers"> +<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="Programming-Interface.html#Programming-Interface" rel="up" title="Programming Interface"> +<link href="Pages.html#Pages" rel="next" title="Pages"> +<link href="Posts.html#Posts" rel="prev" title="Posts"> +<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.nocodebreak {white-space: nowrap} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: serif; 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="Readers"></a> +<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> [<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="Readers-1"></a> +<h3 class="section">5.3 Readers</h3> + +<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_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 +“.ext”. +</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 . "Hello, world!") + (date . ,(string->date* "2015-04-10 23:00")) + (tags "foo" "bar") + (summary . "Just a test") + (content + ((h2 "Hello!") + (p "This is Haunt. A static site generator for GNU Guile.")))) +</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’ 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 +--- +<p> + This is an example using raw HTML, because Guile doesn't have a + Markdown parser. +</p> +</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> [<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> diff --git a/website/manual/Requirements.html b/website/manual/Requirements.html new file mode 100644 index 0000000..3a6a694 --- /dev/null +++ b/website/manual/Requirements.html @@ -0,0 +1,88 @@ +<!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.0, http://www.gnu.org/software/texinfo/ --> +<head> +<title>Haunt Reference Manual: Requirements</title> + +<meta name="description" content="Haunt Reference Manual: Requirements"> +<meta name="keywords" content="Haunt Reference Manual: Requirements"> +<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="Installation.html#Installation" rel="up" title="Installation"> +<link href="Building.html#Building" rel="next" title="Building"> +<link href="Downloading.html#Downloading" rel="prev" title="Downloading"> +<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.nocodebreak {white-space: nowrap} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: serif; 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="Requirements"></a> +<div class="header"> +<p> +Next: <a href="Building.html#Building" accesskey="n" rel="next">Building</a>, Previous: <a href="Downloading.html#Downloading" accesskey="p" rel="prev">Downloading</a>, Up: <a href="Installation.html#Installation" accesskey="u" rel="up">Installation</a> [<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="Requirements-1"></a> +<h3 class="section">2.2 Requirements</h3> + +<p>Haunt depends on the following packages: +</p> +<ul> +<li> <a href="https://gnu.org/software/guile">GNU Guile</a> version 2.0.11 or +later +</li></ul> + +<p>The following dependencies are optional: +</p> +<ul> +<li> <a href="http://www.nongnu.org/guile-reader/">Guile-Reader</a> version 0.6 or +later (for Skribe support) +</li></ul> + + + + +</body> +</html> diff --git a/website/manual/Sites.html b/website/manual/Sites.html new file mode 100644 index 0000000..bae2e72 --- /dev/null +++ b/website/manual/Sites.html @@ -0,0 +1,177 @@ +<!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.0, http://www.gnu.org/software/texinfo/ --> +<head> +<title>Haunt Reference Manual: Sites</title> + +<meta name="description" content="Haunt Reference Manual: Sites"> +<meta name="keywords" content="Haunt Reference Manual: Sites"> +<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="Programming-Interface.html#Programming-Interface" rel="up" title="Programming Interface"> +<link href="Posts.html#Posts" rel="next" title="Posts"> +<link href="Programming-Interface.html#Programming-Interface" rel="prev" title="Programming Interface"> +<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.nocodebreak {white-space: nowrap} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: serif; 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="Sites"></a> +<div class="header"> +<p> +Next: <a href="Posts.html#Posts" accesskey="n" rel="next">Posts</a>, Up: <a href="Programming-Interface.html#Programming-Interface" accesskey="u" rel="up">Programming Interface</a> [<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="Sites-1"></a> +<h3 class="section">5.1 Sites</h3> + +<div class="example"> +<pre class="example">(use-modules (haunt site)) +</pre></div> + +<p>A site object defines all of the properties for a Haunt website: The +site name, domain name, where blog posts are found, what post formats +are understood, which procedures are used to build the site, where the +output files are written to, etc. +</p> +<dl> +<dt><a name="index-site"></a>Scheme Procedure: <strong>site</strong> <em>[#:title "This Place is Haunted"] [#:domain "example.com"] [#:posts-directory "posts"] [#:file-filter <code>default-file-filter</code>] [#:build-directory "site"] [#:default-metadata '()] [#:make-slug <code>post-slug</code>] [#:readers '()] [#:builders '()]</em></dt> +<dd><p>Create a new site object. All arguments are optional: +</p> +<dl compact="compact"> +<dt><var>title</var></dt> +<dd><p>The name of the site. +</p> +</dd> +<dt><var>posts-directory</var></dt> +<dd><p>The directory where posts are found. +</p> +</dd> +<dt><var>file-filter</var></dt> +<dd><p>A predicate procedure that returns <code>#f</code> when a post file should +be ignored, and <code>#t</code> otherwise. Emacs temporary files are +ignored by default. +</p> +</dd> +<dt><var>build-directory</var></dt> +<dd><p>The directory that generated pages are stored in. +</p> +</dd> +<dt><var>default-metadata</var></dt> +<dd><p>An alist of arbitrary default metadata for posts whose keys are +symbols. +</p> +</dd> +<dt><var>make-slug</var></dt> +<dd><p>A procedure generating a file name slug from a post. +</p> +</dd> +<dt><var>readers</var></dt> +<dd><p>A list of reader objects for processing posts. +</p> +</dd> +<dt><var>builders</var></dt> +<dd><p>A list of procedures for building pages from posts. +</p> +</dd> +</dl> + +</dd></dl> + +<dl> +<dt><a name="index-site_003f"></a>Scheme Procedure: <strong>site?</strong> <em><var>obj</var></em></dt> +<dd><p>Return <code>#t</code> if <var>obj</var> is a site object. +</p></dd></dl> + +<dl> +<dt><a name="index-site_002dtitle"></a>Scheme Procedure: <strong>site-title</strong> <em><var>site</var></em></dt> +<dd><p>Return the title of <var>site</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-site_002ddomain"></a>Scheme Procedure: <strong>site-domain</strong> <em><var>site</var></em></dt> +<dd><p>Return the domain of <var>site</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-site_002dposts_002ddirectory"></a>Scheme Procedure: <strong>site-posts-directory</strong> <em><var>site</var></em></dt> +<dd><p>Return the posts directory for <var>site</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-site_002dfile_002dfilter"></a>Scheme Procedure: <strong>site-file-filter</strong> <em><var>site</var></em></dt> +<dd><p>Return the file filter procedure for <var>site</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-site_002dbuild_002ddirectory"></a>Scheme Procedure: <strong>site-build-directory</strong> <em><var>site</var></em></dt> +<dd><p>Return the build directory of <var>site</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-site_002dmake_002dslug"></a>Scheme Procedure: <strong>site-make-slug</strong> <em><var>site</var></em></dt> +<dd><p>Return the slug constructor for <var>site</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-site_002dreaders"></a>Scheme Procedure: <strong>site-readers</strong> <em><var>site</var></em></dt> +<dd><p>Return the list of reader procedures for <var>site</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-site_002dbuilders"></a>Scheme Procedure: <strong>site-builders</strong> <em><var>site</var></em></dt> +<dd><p>Return the list of builder procedures for <var>site</var>. +</p></dd></dl> + +<hr> +<div class="header"> +<p> +Next: <a href="Posts.html#Posts" accesskey="n" rel="next">Posts</a>, Up: <a href="Programming-Interface.html#Programming-Interface" accesskey="u" rel="up">Programming Interface</a> [<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> diff --git a/website/manual/Static-Assets.html b/website/manual/Static-Assets.html new file mode 100644 index 0000000..0248edb --- /dev/null +++ b/website/manual/Static-Assets.html @@ -0,0 +1,87 @@ +<!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.0, http://www.gnu.org/software/texinfo/ --> +<head> +<title>Haunt Reference Manual: Static Assets</title> + +<meta name="description" content="Haunt Reference Manual: Static Assets"> +<meta name="keywords" content="Haunt Reference Manual: Static Assets"> +<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="Blog.html#Blog" rel="next" title="Blog"> +<link href="Builders.html#Builders" rel="prev" title="Builders"> +<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.nocodebreak {white-space: nowrap} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: serif; 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="Static-Assets"></a> +<div class="header"> +<p> +Next: <a href="Blog.html#Blog" accesskey="n" rel="next">Blog</a>, Up: <a href="Builders.html#Builders" accesskey="u" rel="up">Builders</a> [<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="Static-Assets-1"></a> +<h4 class="subsection">5.6.1 Static Assets</h4> + +<div class="example"> +<pre class="example">(use-modules (haunt builder assets)) +</pre></div> + +<dl> +<dt><a name="index-static_002ddirectory"></a>Scheme Procedure: <strong>static-directory</strong> <em><var>directory</var> [<var>dest</var> <var>directory</var>]</em></dt> +<dd> +<p>Create a builder procedure that recursively copies all of the files in +<var>directory</var>, a file names relative to a site’s source directory, +and copies them into <var>dest</var>, a prefix relative to a site’s target +output directory. By default, <var>dest</var> is <var>directory</var>. +</p></dd></dl> + + + + +</body> +</html> diff --git a/website/manual/Tutorial.html b/website/manual/Tutorial.html new file mode 100644 index 0000000..6068592 --- /dev/null +++ b/website/manual/Tutorial.html @@ -0,0 +1,170 @@ +<!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.0, http://www.gnu.org/software/texinfo/ --> +<head> +<title>Haunt Reference Manual: Tutorial</title> + +<meta name="description" content="Haunt Reference Manual: Tutorial"> +<meta name="keywords" content="Haunt Reference Manual: Tutorial"> +<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="index.html#Top" rel="up" title="Top"> +<link href="Command_002dline-Interface.html#Command_002dline-Interface" rel="next" title="Command-line Interface"> +<link href="Building.html#Building" rel="prev" title="Building"> +<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.nocodebreak {white-space: nowrap} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: serif; 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="Tutorial"></a> +<div class="header"> +<p> +Next: <a href="Command_002dline-Interface.html#Command_002dline-Interface" accesskey="n" rel="next">Command-line Interface</a>, Previous: <a href="Installation.html#Installation" accesskey="p" rel="prev">Installation</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> [<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="Tutorial-1"></a> +<h2 class="chapter">3 Tutorial</h2> + +<p>The goal of this tutorial is to quickly create a barebones blog with +Haunt in order to demonstrate the basic workflow and key concepts. +</p> +<p>First, create a directory for the new site: +</p> +<div class="example"> +<pre class="example">mkdir haunt-tutorial +cd haunt-tutorial +</pre></div> + +<p>Next, create the site configuration file <samp>haunt.scm</samp>. This is +where all of the code for building the website will go. +</p> +<p>Here’s what a simple Haunt configuration looks like: +</p> +<div class="example"> +<pre class="example">(use-modules (haunt asset) + (haunt site) + (haunt builder blog) + (haunt builder atom) + (haunt reader skribe)) + +(site #:title "My First Haunt Site" + #:domain "example.com" + #:default-metadata + '((author . "Eva Luator") + (email . "eva@example.com")) + #:readers (list skribe-reader) + #:builders (list (blog) + (atom-feed) + (atom-feeds-by-tag))) +</pre></div> + +<p>Haunt represents the full configuration of the website using the +<code>site</code> procedure. Site objects specify things like the site +title, the default metadata to use for posts, which markup formats are +supported, and which builders are used to generate web pages. +</p> +<p>With the above code saved into the <samp>haunt.scm</samp> file, the next +step is to create a <samp>posts</samp> directory and populate it with +articles to publish. Put the text below into a file named +<samp>posts/hello.skr</samp>: +</p> +<div class="example"> +<pre class="example">(post + :title "Hello, World!" + :date (make-date* 2015 10 15) + :tags '("hello") + + (h1 [Hello, World!]) + + (p [This is my very first Skribe document!])) +</pre></div> + +<p>This is a +<a href="http://www.nongnu.org/skribilo/doc/user-3.html#skribe-syntax">Skribe</a> document. Skribe is one of the built-in languages that Haunt +knows how to work with. It’s basically Scheme, but with support for +writing literal text without quoting it all by enclosing it in square +brackets. The code above defines a post named “Hello, World!” with +a publishing date of 2015-10-15, whose contents are just a single +heading and a paragraph. +</p> +<p>To build the site, run <code>haunt build</code> to compile all of the +HTML pages. To view the results, run <code>haunt serve</code> and visit +<a href="http://localhost:8080">http://localhost:8080</a> in a web browser. <code>haunt serve</code> +is a handy utility that serves the contents of the website using +Guile’s built-in HTTP server. Since the blog builder was specified in +<samp>haunt.scm</samp>, the default index page is a simple listing of all +posts, which for now is a single post. Clicking on the post title +will display a page with only that post’s contents. +</p> +<p>In addition to the basic blog builder, the <samp>haunt.scm</samp> file +specifies two additional builders for Atom feeds. The +<code>atom-feed</code> builder creates a feed of all posts located at +<a href="http://localhost:8080/feed.xml">http://localhost:8080/feed.xml</a>. The <code>atom-feeds-by-tag</code> +builder creates one feed for each unique tag specified in the post +metadata. There’s only one tag right now, “hello”, and its feed is +located at <a href="http://localhost/feeds/tags/hello.xml">http://localhost/feeds/tags/hello.xml</a>. +</p> +<p>Tweaking a post, rebuilding the site, and viewing the results in a web +browser is the typical Haunt workflow. However, having to run +<code>haunt build</code> every after each edit is tedious. To address +this, run <code>haunt serve --watch</code>. The Haunt web server, in +addition to serving web pages, will now watch for changes to important +files and automatically rebuild the site when they are edited. This +streamlines the workflow into an edit, save, view loop. +</p> +<p>Now that we’ve introduced the basic utilities and concepts, continue +reading this manual to learn more about Haunt’s command-line and +programming interfaces. +</p> +<hr> +<div class="header"> +<p> +Next: <a href="Command_002dline-Interface.html#Command_002dline-Interface" accesskey="n" rel="next">Command-line Interface</a>, Previous: <a href="Installation.html#Installation" accesskey="p" rel="prev">Installation</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> [<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> diff --git a/website/manual/index.html b/website/manual/index.html new file mode 100644 index 0000000..26f9320 --- /dev/null +++ b/website/manual/index.html @@ -0,0 +1,162 @@ +<!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.0, http://www.gnu.org/software/texinfo/ --> +<head> +<title>Haunt Reference Manual: Top</title> + +<meta name="description" content="Haunt Reference Manual: Top"> +<meta name="keywords" content="Haunt Reference Manual: Top"> +<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="#Top" rel="start" title="Top"> +<link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index"> +<link href="#SEC_Contents" rel="contents" title="Table of Contents"> +<link href="../dir/index.html" rel="up" title="(dir)"> +<link href="Introduction.html#Introduction" rel="next" title="Introduction"> +<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.nocodebreak {white-space: nowrap} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: serif; font-weight: normal} +span.sansserif {font-family: sans-serif; font-weight: normal} +ul.no-bullet {list-style: none} +--> +</style> + + +</head> + +<body lang="en"> +<h1 class="settitle" align="center">Haunt Reference Manual</h1> + + + + + +<a name="SEC_Contents"></a> +<h2 class="contents-heading">Table of Contents</h2> + +<div class="contents"> + +<ul class="no-bullet"> + <li><a name="toc-Introduction-1" href="Introduction.html#Introduction">1 Introduction</a></li> + <li><a name="toc-Installation-1" href="Installation.html#Installation">2 Installation</a> + <ul class="no-bullet"> + <li><a name="toc-Downloading-1" href="Downloading.html#Downloading">2.1 Downloading</a></li> + <li><a name="toc-Requirements-1" href="Requirements.html#Requirements">2.2 Requirements</a></li> + <li><a name="toc-Building-1" href="Building.html#Building">2.3 Building</a></li> + </ul></li> + <li><a name="toc-Tutorial-1" href="Tutorial.html#Tutorial">3 Tutorial</a></li> + <li><a name="toc-Command_002dline-Interface-1" href="Command_002dline-Interface.html#Command_002dline-Interface">4 Command-line Interface</a> + <ul class="no-bullet"> + <li><a name="toc-Invoking-haunt-build-1" href="Invoking-haunt-build.html#Invoking-haunt-build">4.1 Invoking <code>haunt build</code></a></li> + <li><a name="toc-Invoking-haunt-serve-1" href="Invoking-haunt-serve.html#Invoking-haunt-serve">4.2 Invoking <code>haunt serve</code></a></li> + </ul></li> + <li><a name="toc-Programming-Interface-1" href="Programming-Interface.html#Programming-Interface">5 Programming Interface</a> + <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-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> + <ul class="no-bullet"> + <li><a name="toc-Static-Assets-1" href="Static-Assets.html#Static-Assets">5.6.1 Static Assets</a></li> + <li><a name="toc-Blog-1" href="Blog.html#Blog">5.6.2 Blog</a></li> + <li><a name="toc-Atom-1" href="Atom.html#Atom">5.6.3 Atom</a></li> + </ul></li> + </ul></li> + <li><a name="toc-Contributing-1" href="Contributing.html#Contributing">6 Contributing</a></li> + <li><a name="toc-GNU-Free-Documentation-License-1" href="GNU-Free-Documentation-License.html#GNU-Free-Documentation-License">Appendix A GNU Free Documentation License</a></li> + <li><a name="toc-Concept-Index-1" href="Concept-Index.html#Concept-Index">Concept Index</a></li> + <li><a name="toc-Programming-Index-1" href="Programming-Index.html#Programming-Index">Programming Index</a></li> +</ul> +</div> + + +<a name="Top"></a> +<div class="header"> +<p> +Next: <a href="Introduction.html#Introduction" accesskey="n" rel="next">Introduction</a>, Up: <a href="../dir/index.html" accesskey="u" rel="up">(dir)</a> [<a href="#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="Haunt"></a> +<h1 class="top">Haunt</h1> + +<p>This document describes Haunt version 0.2, an extensible, +functional static site generator. +</p> +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• <a href="Introduction.html#Introduction" accesskey="1">Introduction</a>:</td><td> </td><td align="left" valign="top">About Haunt. +</td></tr> +<tr><td align="left" valign="top">• <a href="Installation.html#Installation" accesskey="2">Installation</a>:</td><td> </td><td align="left" valign="top">Installing Haunt. +</td></tr> +<tr><td align="left" valign="top">• <a href="Tutorial.html#Tutorial" accesskey="3">Tutorial</a>:</td><td> </td><td align="left" valign="top">How to get started quickly. +</td></tr> +<tr><td align="left" valign="top">• <a href="Command_002dline-Interface.html#Command_002dline-Interface" accesskey="4">Command-line Interface</a>:</td><td> </td><td align="left" valign="top">Using Haunt from the command-line. +</td></tr> +<tr><td align="left" valign="top">• <a href="Programming-Interface.html#Programming-Interface" accesskey="5">Programming Interface</a>:</td><td> </td><td align="left" valign="top">Using the Haunt API in Scheme. +</td></tr> +<tr><td align="left" valign="top">• <a href="Contributing.html#Contributing" accesskey="6">Contributing</a>:</td><td> </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">• <a href="GNU-Free-Documentation-License.html#GNU-Free-Documentation-License" accesskey="7">GNU Free Documentation License</a>:</td><td> </td><td align="left" valign="top">The license of this manual. +</td></tr> +<tr><td align="left" valign="top">• <a href="Concept-Index.html#Concept-Index" accesskey="8">Concept Index</a>:</td><td> </td><td align="left" valign="top">Concepts. +</td></tr> +<tr><td align="left" valign="top">• <a href="Programming-Index.html#Programming-Index" accesskey="9">Programming Index</a>:</td><td> </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"> — The Detailed Node Listing — + +Installation + +</pre></th></tr><tr><td align="left" valign="top">• <a href="Downloading.html#Downloading">Downloading</a>:</td><td> </td><td align="left" valign="top">Downloading the source code. +</td></tr> +<tr><td align="left" valign="top">• <a href="Requirements.html#Requirements">Requirements</a>:</td><td> </td><td align="left" valign="top">Software needed to build and run Haunt. +</td></tr> +<tr><td align="left" valign="top">• <a href="Building.html#Building">Building</a>:</td><td> </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> +<div class="header"> +<p> +Next: <a href="Introduction.html#Introduction" accesskey="n" rel="next">Introduction</a>, Up: <a href="../dir/index.html" accesskey="u" rel="up">(dir)</a> [<a href="#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> |