diff options
Diffstat (limited to 'manuals/haunt/Sites.html')
| -rw-r--r-- | manuals/haunt/Sites.html | 188 |
1 files changed, 0 insertions, 188 deletions
diff --git a/manuals/haunt/Sites.html b/manuals/haunt/Sites.html deleted file mode 100644 index eae011f..0000000 --- a/manuals/haunt/Sites.html +++ /dev/null @@ -1,188 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<html> -<!-- Copyright (C) 2015-2021 David Thompson - - -Permission is granted to copy, distribute and/or modify this document -under the terms of the GNU Free Documentation License, Version 1.3 or -any later version published by the Free Software Foundation; with no -Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A -copy of the license is included in the section entitled "GNU Free -Documentation License". --> -<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>Sites (Haunt Reference Manual)</title> - -<meta name="description" content="Sites (Haunt Reference Manual)"> -<meta name="keywords" content="Sites (Haunt Reference Manual)"> -<meta name="resource-type" content="document"> -<meta name="distribution" content="global"> -<meta name="Generator" content="makeinfo"> -<link href="index.html" rel="start" title="Top"> -<link href="Concept-Index.html" rel="index" title="Concept Index"> -<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> -<link href="Programming-Interface.html" rel="up" title="Programming Interface"> -<link href="Posts.html" rel="next" title="Posts"> -<link href="Programming-Interface.html" rel="prev" title="Programming Interface"> -<style type="text/css"> -<!-- -a.summary-letter {text-decoration: none} -blockquote.indentedblock {margin-right: 0em} -div.display {margin-left: 3.2em} -div.example {margin-left: 3.2em} -div.lisp {margin-left: 3.2em} -kbd {font-style: oblique} -pre.display {font-family: inherit} -pre.format {font-family: inherit} -pre.menu-comment {font-family: serif} -pre.menu-preformatted {font-family: serif} -span.nolinebreak {white-space: nowrap} -span.roman {font-family: initial; font-weight: normal} -span.sansserif {font-family: sans-serif; font-weight: normal} -ul.no-bullet {list-style: none} -@media (min-width: 1140px) { - body { - margin-left: 14rem; - margin-right: 4rem; - max-width: 52rem; - } -} - -@media (min-width: 800px) and (max-width: 1140px) { - body { - margin-left: 6rem; - margin-right: 4rem; - max-width: 52rem; - } -} - -@media (max-width: 800px) { - body { - margin: 1rem; - } -} - ---> -</style> -<link rel="stylesheet" type="text/css" href="https://dthompson.us/css/dthompson.css"> - - -</head> - -<body lang="en"> -<span id="Sites"></span><div class="header"> -<p> -Next: <a href="Posts.html" accesskey="n" rel="next">Posts</a>, Up: <a href="Programming-Interface.html" 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" title="Index" rel="index">Index</a>]</p> -</div> -<hr> -<span id="Sites-1"></span><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 id="index-site">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 id="index-site_003f">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 id="index-site_002dtitle">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 id="index-site_002ddomain">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 id="index-site_002dposts_002ddirectory">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 id="index-site_002dfile_002dfilter">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 id="index-site_002dbuild_002ddirectory">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 id="index-site_002dmake_002dslug">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 id="index-site_002dreaders">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 id="index-site_002dbuilders">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" accesskey="n" rel="next">Posts</a>, Up: <a href="Programming-Interface.html" 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" title="Index" rel="index">Index</a>]</p> -</div> - - - -</body> -</html> |