summaryrefslogtreecommitdiff
path: root/website/manual/Pages.html
diff options
context:
space:
mode:
Diffstat (limited to 'website/manual/Pages.html')
-rw-r--r--website/manual/Pages.html115
1 files changed, 115 insertions, 0 deletions
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> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
+</div>
+<hr>
+<a name="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>