diff options
| author | David Thompson <dthompson2@worcester.edu> | 2017-01-23 20:40:04 -0500 |
|---|---|---|
| committer | David Thompson <dthompson2@worcester.edu> | 2017-01-23 20:40:04 -0500 |
| commit | 9e4fba766d070a2dd72b7180c1a040d4621218b8 (patch) | |
| tree | f4d817ed6e5489792a0bccb5bf0dfc22720ed95f /website/manual/Readers.html | |
| parent | 16bc1eae0c66d418fd60b81068cc37c7b6ec01ea (diff) | |
website: Update manual.
Diffstat (limited to 'website/manual/Readers.html')
| -rw-r--r-- | website/manual/Readers.html | 123 |
1 files changed, 13 insertions, 110 deletions
diff --git a/website/manual/Readers.html b/website/manual/Readers.html index b0e2f18..d120a38 100644 --- a/website/manual/Readers.html +++ b/website/manual/Readers.html @@ -9,7 +9,7 @@ any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License". --> -<!-- Created by GNU Texinfo 6.0, http://www.gnu.org/software/texinfo/ --> +<!-- Created by GNU Texinfo 6.3, http://www.gnu.org/software/texinfo/ --> <head> <title>Haunt Reference Manual: Readers</title> @@ -23,7 +23,7 @@ Documentation License". --> <link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index"> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> <link href="Programming-Interface.html#Programming-Interface" rel="up" title="Programming Interface"> -<link href="Pages.html#Pages" rel="next" title="Pages"> +<link href="Reader.html#Reader" rel="next" title="Reader"> <link href="Posts.html#Posts" rel="prev" title="Posts"> <style type="text/css"> <!-- @@ -46,9 +46,8 @@ pre.smalldisplay {font-family: inherit; font-size: smaller} pre.smallexample {font-size: smaller} pre.smallformat {font-family: inherit; font-size: smaller} pre.smalllisp {font-size: smaller} -span.nocodebreak {white-space: nowrap} span.nolinebreak {white-space: nowrap} -span.roman {font-family: serif; font-weight: normal} +span.roman {font-family: initial; font-weight: normal} span.sansserif {font-family: sans-serif; font-weight: normal} ul.no-bullet {list-style: none} --> @@ -67,113 +66,17 @@ Next: <a href="Pages.html#Pages" accesskey="n" rel="next">Pages</a>, Previous: < <a name="Readers-1"></a> <h3 class="section">5.3 Readers</h3> -<div class="example"> -<pre class="example">(use-modules (haunt reader)) -</pre></div> +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• <a href="Reader.html#Reader" accesskey="1">Reader</a>:</td><td> </td><td align="left" valign="top">Reader interface and basic readers +</td></tr> +<tr><td align="left" valign="top">• <a href="Texinfo.html#Texinfo" accesskey="2">Texinfo</a>:</td><td> </td><td align="left" valign="top">Texinfo reader +</td></tr> +<tr><td align="left" valign="top">• <a href="Skribe.html#Skribe" accesskey="3">Skribe</a>:</td><td> </td><td align="left" valign="top">Skribe reader +</td></tr> +<tr><td align="left" valign="top">• <a href="CommonMark.html#CommonMark" accesskey="4">CommonMark</a>:</td><td> </td><td align="left" valign="top">CommonMark reader +</td></tr> +</table> -<p>The purpose of a reader is to translate the markup within a post file -into an SXML tree representing the HTML structure and associate some -metadata with it. -</p> -<dl> -<dt><a name="index-make_002dreader"></a>Scheme Procedure: <strong>make-reader</strong> <em><var>matcher</var> <var>proc</var></em></dt> -<dd><p>Create a new reader. The reader is to be activated when -<var>matcher</var>, a procedure that accepts a file name as its only -argument, returns <code>#t</code>. When a post file matches, the procedure -<var>proc</var>, which also accepts a file name as its only argument, reads -the contents and returns a post object (see <a href="Posts.html#Posts">Posts</a>). -</p></dd></dl> - -<dl> -<dt><a name="index-reader_003f"></a>Scheme Procedure: <strong>reader?</strong> <em><var>object</var></em></dt> -<dd><p>Return <code>#t</code> if <var>object</var> is a reader. -</p></dd></dl> - -<dl> -<dt><a name="index-reader_002dmatcher"></a>Scheme Procedure: <strong>reader-matcher</strong> <em><var>reader</var></em></dt> -<dd><p>Return the match procedure for <var>reader</var>. -</p></dd></dl> - -<dl> -<dt><a name="index-reader_002dmatcher-1"></a>Scheme Procedure: <strong>reader-matcher</strong> <em><var>reader</var></em></dt> -<dd><p>Return the read procedure for <var>reader</var>. -</p></dd></dl> - -<dl> -<dt><a name="index-reader_002dmatch_003f"></a>Scheme Procedure: <strong>reader-match?</strong> <em><var>reader</var> <var>file-name</var></em></dt> -<dd><p>Return <code>#t</code> if <var>file-name</var> is a file supported by -<var>reader</var>. -</p></dd></dl> - -<dl> -<dt><a name="index-read_002dpost"></a>Scheme Procedure: <strong>read-post</strong> <em><var>reader</var> <var>file-name</var> [<var>default-metadata</var>]</em></dt> -<dd><p>Read a post object from <var>file-name</var> using <var>reader</var>, merging -its metadata with <var>default-metadata</var>, or the empty list if not -specified. -</p></dd></dl> - -<dl> -<dt><a name="index-read_002dposts"></a>Scheme Procedure: <strong>read-posts</strong> <em><var>directory</var> <var>keep?</var> <var>readers</var> [<var>default-metadata</var>]</em></dt> -<dd><p>Read all of the files in <var>directory</var> that match <var>keep?</var> as -post objects. The <var>readers</var> list must contain a matching reader -for every post. -</p></dd></dl> - -<dl> -<dt><a name="index-make_002dfile_002dextension_002dmatcher"></a>Scheme Procedure: <strong>make-file-extension-matcher</strong> <em><var>ext</var></em></dt> -<dd><p>Create a procedure that returns <code>#t</code> when a file name ends with -“.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> |