From d3a9ba4ebea136fae676911148509ec3f729abbc Mon Sep 17 00:00:00 2001 From: David Thompson Date: Sun, 24 Apr 2016 15:26:44 -0400 Subject: website: Add copy of HTML manual. --- website/manual/Assets.html | 116 +++++ website/manual/Atom.html | 131 +++++ website/manual/Blog.html | 146 ++++++ website/manual/Builders.html | 90 ++++ website/manual/Building.html | 83 ++++ website/manual/Command_002dline-Interface.html | 88 ++++ website/manual/Concept-Index.html | 74 +++ website/manual/Contributing.html | 74 +++ website/manual/Downloading.html | 78 +++ website/manual/GNU-Free-Documentation-License.html | 548 +++++++++++++++++++++ website/manual/Installation.html | 83 ++++ website/manual/Introduction.html | 138 ++++++ website/manual/Invoking-haunt-build.html | 93 ++++ website/manual/Invoking-haunt-serve.html | 108 ++++ website/manual/Pages.html | 115 +++++ website/manual/Posts.html | 152 ++++++ website/manual/Programming-Index.html | 207 ++++++++ website/manual/Programming-Interface.html | 92 ++++ website/manual/Readers.html | 181 +++++++ website/manual/Requirements.html | 88 ++++ website/manual/Sites.html | 177 +++++++ website/manual/Static-Assets.html | 87 ++++ website/manual/Tutorial.html | 170 +++++++ website/manual/index.html | 162 ++++++ 24 files changed, 3281 insertions(+) create mode 100644 website/manual/Assets.html create mode 100644 website/manual/Atom.html create mode 100644 website/manual/Blog.html create mode 100644 website/manual/Builders.html create mode 100644 website/manual/Building.html create mode 100644 website/manual/Command_002dline-Interface.html create mode 100644 website/manual/Concept-Index.html create mode 100644 website/manual/Contributing.html create mode 100644 website/manual/Downloading.html create mode 100644 website/manual/GNU-Free-Documentation-License.html create mode 100644 website/manual/Installation.html create mode 100644 website/manual/Introduction.html create mode 100644 website/manual/Invoking-haunt-build.html create mode 100644 website/manual/Invoking-haunt-serve.html create mode 100644 website/manual/Pages.html create mode 100644 website/manual/Posts.html create mode 100644 website/manual/Programming-Index.html create mode 100644 website/manual/Programming-Interface.html create mode 100644 website/manual/Readers.html create mode 100644 website/manual/Requirements.html create mode 100644 website/manual/Sites.html create mode 100644 website/manual/Static-Assets.html create mode 100644 website/manual/Tutorial.html create mode 100644 website/manual/index.html (limited to 'website/manual') 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 @@ + + + + + +Haunt Reference Manual: Assets + + + + + + + + + + + + + + + + + + + + +
+

+Next: , Previous: , Up: Programming Interface   [Contents][Index]

+
+
+ +

5.5 Assets

+ +
+
(use-modules (haunt asset))
+
+ +

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. +

+
+
Scheme Procedure: make-asset source target
+

Create a new asset object. The source and target +arguments are file names that are relative to a site source and target +directory, respectively (see Sites). +

+ +
+
Scheme Procedure: asset? object
+

Return #t if object is an asset object. +

+ +
+
Scheme Procedure: asset-source asset
+

Return the source file name for asset. +

+ +
+
Scheme Procedure: asset-target asset
+

Return the target file name for asset. +

+ +
+
Scheme Procedure: install-asset asset prefix
+

Install the source file of asset into the target directory +within prefix. +

+ +
+
Scheme Procedure: directory-assets directory keep? dest
+

Create a list of asset objects to be stored within dest for all +files in directory that match keep?, recursively. +

+ + + + + + 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 @@ + + + + + +Haunt Reference Manual: Atom + + + + + + + + + + + + + + + + + + + + +
+

+Previous: , Up: Builders   [Contents][Index]

+
+
+ +

5.6.3 Atom

+ +
+
(use-modules (haunt builder atom))
+
+ +
+
Scheme Procedure: atom-feed [#:file-name #:subtitle #:filter #:max-entries #:blog-prefix]
+

Return a builder procedure that renders a site’s posts as an Atom +feed. All arguments are optional: +

+
+
file-name:
+

The page file name. The default is feed.xml. +

+
+
subtitle
+

The feed subtitle. The default is “Recent Posts”. +

+
+
filter
+

The procedure called to manipulate the posts list before rendering. +The default is to keep all posts and sort them in reverse +chronological order. +

+
+
max-entries
+

The maximum number of posts to render in the feed. The default is 20. +

+
+ +
+ +
+
Scheme Procedure: atom-feeds-by-tag [#:prefix #:filter #:max-entries #:blog-prefix]
+

Return a builder procedure that renders an atom feed for every tag +used in a post. All arguments are optional: +

+
+
prefix
+

The directory in which to write the feeds. The default is +feeds/tags. +

+
+
filter
+

The procedure called to manipulate the posts list before rendering. +The default is to keep all posts and sort them in reverse +chronological order. +

+
+
max-entries
+

The maximum number of posts to render in each feed. The default is +20. +

+
+
+ +
+ + + + + + 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 @@ + + + + + +Haunt Reference Manual: Blog + + + + + + + + + + + + + + + + + + + + +
+

+Next: , Previous: , Up: Builders   [Contents][Index]

+
+
+ +

5.6.2 Blog

+ +
+
(use-modules (haunt builder blog))
+
+ +
+
Scheme Procedure: theme [#:name #:layout #:post-template #:collection-template]
+

Create a new theme named name. +

+

The procedure layout 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. +

+

The procedure post-template 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. +

+

The procedure collection-template 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. +

+ +
+
Scheme Procedure: theme? object
+

Return #t if object is a theme object. +

+ +
+
Scheme Procedure: blog [#:theme #:prefix #:collections]
+

Create a builder procedure that transforms a list of posts into pages +decorated by theme, a theme object, whose URLs start with +prefix. +

+

Additionally, this builder creates pages that aggregate previews of +many posts corresponding to what is specified in the list +collections. Each collection is a three element list in the +form (title file-name filter). +

+
+
title
+

The human readable name of the collection. +

+
+
file-name
+

The HTML file that will contain the rendered collection. +

+
+
filter
+

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. +

+
+
+ +

By default, a single collection is created that lists posts in reverse +chronological order and writes to index.html. +

+

The default theme is intended only for testing purposes. +

+
+ +
+
+

+Next: , Previous: , Up: Builders   [Contents][Index]

+
+ + + + + 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 @@ + + + + + +Haunt Reference Manual: Builders + + + + + + + + + + + + + + + + + + + + +
+

+Previous: , Up: Programming Interface   [Contents][Index]

+
+
+ +

5.6 Builders

+ + + + + +
• Static Assets:  Images, CSS, JavaScript, etc. +
• Blog:  Dear diary... +
• Atom:  Atom feeds. +
+ +

Builders are procedures that return one or more page objects +(see Pages) when applied. A builder accepts two arguments: A site +(see Sites and a list of posts (see Posts). +

+

Haunt comes with a few convenient builders to help users who want to +create a simple blog with an Atom feed. +

+ + + + + 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 @@ + + + + + +Haunt Reference Manual: Building + + + + + + + + + + + + + + + + + + + + +
+

+Previous: , Up: Installation   [Contents][Index]

+
+
+ +

2.3 Building

+ +

Haunt uses the standard GNU build system, so the basic installation +procedure looks like this: +

+
+
./configure
+make
+make install
+
+ + + + + + 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 @@ + + + + + +Haunt Reference Manual: Command-line Interface + + + + + + + + + + + + + + + + + + + + +
+

+Next: , Previous: , Up: Top   [Contents][Index]

+
+
+ +

4 Command-line Interface

+ + + + +
• Invoking haunt build:  Build the website. +
• Invoking haunt serve:  Serve the website over HTTP. +
+ +

The Haunt command-line interface is composed of many subcommands. The +general syntax for all Haunt commands is: +

+
+
haunt subcommand options…
+
+ + + + + + 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 @@ + + + + + +Haunt Reference Manual: Concept Index + + + + + + + + + + + + + + + + + + + + +
+

+Next: , Previous: , Up: Top   [Contents][Index]

+
+
+ +

Concept Index

+ + + + + + 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 @@ + + + + + +Haunt Reference Manual: Contributing + + + + + + + + + + + + + + + + + + + + +
+

+Next: , Previous: , Up: Top   [Contents][Index]

+
+
+ +

6 Contributing

+ + + + + + 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 @@ + + + + + +Haunt Reference Manual: Downloading + + + + + + + + + + + + + + + + + + + + +
+

+Next: , Up: Installation   [Contents][Index]

+
+
+ +

2.1 Downloading

+ +

Official Haunt source code release tarballs can be found on the +downloads page of +Haunt’s website, along with their associated checksums. +

+ + + + + 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 @@ + + + + + +Haunt Reference Manual: GNU Free Documentation License + + + + + + + + + + + + + + + + + + + + +
+

+Next: , Previous: , Up: Top   [Contents][Index]

+
+
+ +

Appendix A GNU Free Documentation License

+ +
Version 1.3, 3 November 2008 +
+ +
+
Copyright © 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.
+http://fsf.org/
+
+Everyone is permitted to copy and distribute verbatim copies
+of this license document, but changing it is not allowed.
+
+ +
    +
  1. PREAMBLE + +

    The purpose of this License is to make a manual, textbook, or other +functional and useful document free 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. +

    +

    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. +

    +

    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. +

    +
  2. APPLICABILITY AND DEFINITIONS + +

    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. +

    +

    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. +

    +

    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. +

    +

    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. +

    +

    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. +

    +

    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”. +

    +

    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. +

    +

    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. +

    +

    The “publisher” means any person or entity that distributes copies +of the Document to the public. +

    +

    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. +

    +

    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. +

    +
  3. VERBATIM COPYING + +

    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. +

    +

    You may also lend copies, under the same conditions stated above, and +you may publicly display copies. +

    +
  4. COPYING IN QUANTITY + +

    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. +

    +

    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. +

    +

    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. +

    +

    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. +

    +
  5. MODIFICATIONS + +

    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: +

    +
      +
    1. 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. + +
    2. 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. + +
    3. State on the Title page the name of the publisher of the +Modified Version, as the publisher. + +
    4. Preserve all the copyright notices of the Document. + +
    5. Add an appropriate copyright notice for your modifications +adjacent to the other copyright notices. + +
    6. 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. + +
    7. Preserve in that license notice the full lists of Invariant Sections +and required Cover Texts given in the Document’s license notice. + +
    8. Include an unaltered copy of this License. + +
    9. 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. + +
    10. 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. + +
    11. 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. + +
    12. 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. + +
    13. Delete any section Entitled “Endorsements”. Such a section +may not be included in the Modified Version. + +
    14. Do not retitle any existing section to be Entitled “Endorsements” or +to conflict in title with any Invariant Section. + +
    15. Preserve any Warranty Disclaimers. +
    + +

    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. +

    +

    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. +

    +

    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. +

    +

    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. +

    +
  6. COMBINING DOCUMENTS + +

    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. +

    +

    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. +

    +

    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.” +

    +
  7. COLLECTIONS OF DOCUMENTS + +

    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. +

    +

    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. +

    +
  8. AGGREGATION WITH INDEPENDENT WORKS + +

    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. +

    +

    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. +

    +
  9. TRANSLATION + +

    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. +

    +

    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. +

    +
  10. TERMINATION + +

    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. +

    +

    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. +

    +

    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. +

    +

    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. +

    +
  11. FUTURE REVISIONS OF THIS LICENSE + +

    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 +http://www.gnu.org/copyleft/. +

    +

    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. +

    +
  12. RELICENSING + +

    “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. +

    +

    “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. +

    +

    “Incorporate” means to publish or republish a Document, in whole or +in part, as part of another Document. +

    +

    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. +

    +

    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. +

    +
+ + +

ADDENDUM: How to use this License for your documents

+ +

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: +

+
+
  Copyright (C)  year  your name.
+  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''.
+
+ +

If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, +replace the “with…Texts.” line with this: +

+
+
    with the Invariant Sections being list their titles, with
+    the Front-Cover Texts being list, and with the Back-Cover Texts
+    being list.
+
+ +

If you have Invariant Sections without Cover Texts, or some other +combination of the three, merge those two alternatives to suit the +situation. +

+

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. +

+ +
+
+

+Next: , Previous: , Up: Top   [Contents][Index]

+
+ + + + + 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 @@ + + + + + +Haunt Reference Manual: Installation + + + + + + + + + + + + + + + + + + + + +
+

+Next: , Previous: , Up: Top   [Contents][Index]

+
+
+ +

2 Installation

+ + + + + +
• Downloading:  Downloading the source code. +
• Requirements:  Software needed to build and run Haunt. +
• Building:  Building from source code. +
+ + + + + + 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 @@ + + + + + +Haunt Reference Manual: Introduction + + + + + + + + + + + + + + + + + + + + +
+

+Next: , Previous: , Up: Top   [Contents][Index]

+
+
+ +

1 Introduction

+ +

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. +

+

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. +

+

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 fun. +

+

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. +

+

Happy haunting! +

+
+
+

+Next: , Previous: , Up: Top   [Contents][Index]

+
+ + + + + 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 @@ + + + + + +Haunt Reference Manual: Invoking haunt build + + + + + + + + + + + + + + + + + + + + +
+

+Next: , Up: Command-line Interface   [Contents][Index]

+
+
+ +

4.1 Invoking haunt build

+ +

The haunt build 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 Sites. +

+

Example: +

+
+
haunt build --config=haunt.scm
+
+ +
+
--config=configuration-file
+
-c configuration-file
+

Load the Haunt site declaration from configuration-file. +

+
+
+ + + + + + 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 @@ + + + + + +Haunt Reference Manual: Invoking haunt serve + + + + + + + + + + + + + + + + + + + + +
+

+Previous: , Up: Command-line Interface   [Contents][Index]

+
+
+ +

4.2 Invoking haunt serve

+ +

The haunt serve command allows one to quickly view a local +preview of the generated website before publishing the finished +product to a remote web server. When haunt serve 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 +http://localhost:8080. +

+

While developing, it is common to rebuild the site frequently to view +the results of incremental changes. Rather than manually running +haunt build (Invoking haunt build) each time changes +are made, the --watch flag can be used to automatically rebuild +the site when a source file changes on disk. +

+
+
--config=configuration-file
+
-c configuration-file
+

Load the Haunt site declaration from configuration-file. +

+
+
--port=port
+
-p port
+
+

Listen for HTTP requests on port. +

+
+
--watch
+
-w
+
+

Automatically rebuild the site when source files change. +

+
+
+ + + + + + 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 @@ + + + + + +Haunt Reference Manual: Pages + + + + + + + + + + + + + + + + + + + + +
+

+Next: , Previous: , Up: Programming Interface   [Contents][Index]

+
+
+ +

5.4 Pages

+ +
+
(use-modules (haunt page))
+
+ +

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. +

+
+
Scheme Procedure: make-page file-name contents writer
+

Create a new page object. The string file-name specifies where +the page should be written to in the file system. The procedure +writer is responsible for serializing contents. +

+ +
+
Scheme Procedure: page? object
+

Return #t if object is a page object. +

+ +
+
Scheme Procedure: page-file-name page
+

Return the file name string for page. +

+ +
+
Scheme Procedure: page-contents page
+

Return the contents of page. +

+ +
+
Scheme Procedure: page-writer page
+

Return the writer procedure page. +

+ +
+
Scheme Procedure: write-page page output-directory
+

Write page to output-directory. +

+ + + + + + 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 @@ + + + + + +Haunt Reference Manual: Posts + + + + + + + + + + + + + + + + + + + + +
+

+Next: , Previous: , Up: Programming Interface   [Contents][Index]

+
+
+ +

5.2 Posts

+ +
+
(use-modules (haunt post))
+
+ +

Posts represent the articles that are kept in a site’s post directory +and written in a markup format that Haunt can +understand. see Readers) for how files on disk can be transformed +into posts. +

+
+
Scheme Procedure: make-post file-name metadata sxml
+

Create a new post object that represents the contents of the file +file-name. The body of the post, sxml, is represented as +an SXML tree (see SXML in GNU Guile Reference Manual) +and the metadata is an association list (see Association Lists in GNU Guile Reference Manual) of arbitrary +key/value pairs. +

+ +
+
Scheme Procedure: post? object
+

Return #t if object is a post. +

+ +
+
Scheme Procedure: post-file-name post
+

Return the file name for post. +

+ +
+
Scheme Procedure: post-metadata post
+

Return the metadata association list for post. +

+ +
+
Scheme Procedure: post-sxml post
+

Return the SXML tree for post. +

+ +
+
Scheme Procedure: post-ref post key
+

Return the metadata value corresponding to key within +post. +

+ +
+
Scheme Procedure: post-slug post
+

Transform the title of post into a URL slug suitable for the +file name of a web page. +

+ +
+
Scheme Variable: %default-date
+

The default date of a post when no other date is specified in the +metadata association list. +

+ +
+
Scheme Procedure: post-data post
+

Return the date for post, or %default-date if no date is +specified. +

+ +
+
Scheme Procedure: posts/reverse-chronological posts
+

Sort posts, a list of posts, in reverse chronological order. +

+ +
+
Scheme Procedure: posts/group-by-tag posts
+

Create an association list of tags mapped to the posts in the list +posts that used them. +

+ +
+
+

+Next: , Previous: , Up: Programming Interface   [Contents][Index]

+
+ + + + + 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 @@ + + + + + +Haunt Reference Manual: Programming Index + + + + + + + + + + + + + + + + + + + +
+

+Previous: , Up: Top   [Contents][Index]

+
+
+ +

Programming Index

+
Jump to:   % +   +
+A +   +B +   +D +   +H +   +I +   +M +   +P +   +R +   +S +   +T +   +W +   +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Index Entry  Section
%
%default-date: Posts
A
asset-source: Assets
asset-target: Assets
asset?: Assets
atom-feed: Atom
atom-feeds-by-tag: Atom
B
blog: Blog
D
directory-assets: Assets
H
html-reader: Readers
I
install-asset: Assets
M
make-asset: Assets
make-file-extension-matcher: Readers
make-page: Pages
make-post: Posts
make-reader: Readers
P
page-contents: Pages
page-file-name: Pages
page-writer: Pages
page?: Pages
post-data: Posts
post-file-name: Posts
post-metadata: Posts
post-ref: Posts
post-slug: Posts
post-sxml: Posts
post?: Posts
posts/group-by-tag: Posts
posts/reverse-chronological: Posts
R
read-post: Readers
read-posts: Readers
reader-match?: Readers
reader-matcher: Readers
reader-matcher: Readers
reader?: Readers
S
site: Sites
site-build-directory: Sites
site-builders: Sites
site-domain: Sites
site-file-filter: Sites
site-make-slug: Sites
site-posts-directory: Sites
site-readers: Sites
site-title: Sites
site?: Sites
static-directory: Static Assets
sxml-reader: Readers
T
theme: Blog
theme?: Blog
W
write-page: Pages
+
Jump to:   % +   +
+A +   +B +   +D +   +H +   +I +   +M +   +P +   +R +   +S +   +T +   +W +   +
+ +
+
+

+Previous: , Up: Top   [Contents][Index]

+
+ + + + + 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 @@ + + + + + +Haunt Reference Manual: Programming Interface + + + + + + + + + + + + + + + + + + + + +
+

+Next: , Previous: , Up: Top   [Contents][Index]

+
+
+ +

5 Programming Interface

+ + + + + + + + +
• Sites:  Description of the site and how to build it. +
• Posts:  Articles, prose, blog posts, etc. +
• Readers:  Post interpreters. +
• Pages:  HTML/XML pages. +
• Assets:  Images, stylesheets, etc. +
• Builders:  Web page builders. +
+ +

Haunt is a fully-programmable system composed of several Guile Scheme +modules. This section documents the public API. +

+ + + + + 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 @@ + + + + + +Haunt Reference Manual: Readers + + + + + + + + + + + + + + + + + + + + +
+

+Next: , Previous: , Up: Programming Interface   [Contents][Index]

+
+
+ +

5.3 Readers

+ +
+
(use-modules (haunt reader))
+
+ +

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. +

+
+
Scheme Procedure: make-reader matcher proc
+

Create a new reader. The reader is to be activated when +matcher, a procedure that accepts a file name as its only +argument, returns #t. When a post file matches, the procedure +proc, which also accepts a file name as its only argument, reads +the contents and returns a post object (see Posts). +

+ +
+
Scheme Procedure: reader? object
+

Return #t if object is a reader. +

+ +
+
Scheme Procedure: reader-matcher reader
+

Return the match procedure for reader. +

+ +
+
Scheme Procedure: reader-matcher reader
+

Return the read procedure for reader. +

+ +
+
Scheme Procedure: reader-match? reader file-name
+

Return #t if file-name is a file supported by +reader. +

+ +
+
Scheme Procedure: read-post reader file-name [default-metadata]
+

Read a post object from file-name using reader, merging +its metadata with default-metadata, or the empty list if not +specified. +

+ +
+
Scheme Procedure: read-posts directory keep? readers [default-metadata]
+

Read all of the files in directory that match keep? as +post objects. The readers list must contain a matching reader +for every post. +

+ +
+
Scheme Procedure: make-file-extension-matcher ext
+

Create a procedure that returns #t when a file name ends with +“.ext”. +

+ +
+
Scheme Procedure: sxml-reader
+

A basic reader for posts written as Scheme code that evaluates to an +an association list. The special key content contains the post +body as an SXML tree. +

+

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."))))
+
+ +
+ +
+
Scheme Procedure: html-reader
+

A basic reader for posts written in plain ol’ HTML. Metadata is +encoded as the key: value pairs, one per line, at the beginning +of the file. A line with the --- sentinel marks the end of the +metadata section and the rest of the file is encoded as HTML. +

+

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>
+
+ +
+ +
+
+

+Next: , Previous: , Up: Programming Interface   [Contents][Index]

+
+ + + + + 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 @@ + + + + + +Haunt Reference Manual: Requirements + + + + + + + + + + + + + + + + + + + + +
+

+Next: , Previous: , Up: Installation   [Contents][Index]

+
+
+ +

2.2 Requirements

+ +

Haunt depends on the following packages: +

+ + +

The following dependencies are optional: +

+ + + + + + + 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 @@ + + + + + +Haunt Reference Manual: Sites + + + + + + + + + + + + + + + + + + + + +
+

+Next: , Up: Programming Interface   [Contents][Index]

+
+
+ +

5.1 Sites

+ +
+
(use-modules (haunt site))
+
+ +

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. +

+
+
Scheme Procedure: site [#:title "This Place is Haunted"] [#:domain "example.com"] [#:posts-directory "posts"] [#:file-filter default-file-filter] [#:build-directory "site"] [#:default-metadata '()] [#:make-slug post-slug] [#:readers '()] [#:builders '()]
+

Create a new site object. All arguments are optional: +

+
+
title
+

The name of the site. +

+
+
posts-directory
+

The directory where posts are found. +

+
+
file-filter
+

A predicate procedure that returns #f when a post file should +be ignored, and #t otherwise. Emacs temporary files are +ignored by default. +

+
+
build-directory
+

The directory that generated pages are stored in. +

+
+
default-metadata
+

An alist of arbitrary default metadata for posts whose keys are +symbols. +

+
+
make-slug
+

A procedure generating a file name slug from a post. +

+
+
readers
+

A list of reader objects for processing posts. +

+
+
builders
+

A list of procedures for building pages from posts. +

+
+
+ +
+ +
+
Scheme Procedure: site? obj
+

Return #t if obj is a site object. +

+ +
+
Scheme Procedure: site-title site
+

Return the title of site. +

+ +
+
Scheme Procedure: site-domain site
+

Return the domain of site. +

+ +
+
Scheme Procedure: site-posts-directory site
+

Return the posts directory for site. +

+ +
+
Scheme Procedure: site-file-filter site
+

Return the file filter procedure for site. +

+ +
+
Scheme Procedure: site-build-directory site
+

Return the build directory of site. +

+ +
+
Scheme Procedure: site-make-slug site
+

Return the slug constructor for site. +

+ +
+
Scheme Procedure: site-readers site
+

Return the list of reader procedures for site. +

+ +
+
Scheme Procedure: site-builders site
+

Return the list of builder procedures for site. +

+ +
+
+

+Next: , Up: Programming Interface   [Contents][Index]

+
+ + + + + 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 @@ + + + + + +Haunt Reference Manual: Static Assets + + + + + + + + + + + + + + + + + + + + +
+

+Next: , Up: Builders   [Contents][Index]

+
+
+ +

5.6.1 Static Assets

+ +
+
(use-modules (haunt builder assets))
+
+ +
+
Scheme Procedure: static-directory directory [dest directory]
+
+

Create a builder procedure that recursively copies all of the files in +directory, a file names relative to a site’s source directory, +and copies them into dest, a prefix relative to a site’s target +output directory. By default, dest is directory. +

+ + + + + + 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 @@ + + + + + +Haunt Reference Manual: Tutorial + + + + + + + + + + + + + + + + + + + + +
+

+Next: , Previous: , Up: Top   [Contents][Index]

+
+
+ +

3 Tutorial

+ +

The goal of this tutorial is to quickly create a barebones blog with +Haunt in order to demonstrate the basic workflow and key concepts. +

+

First, create a directory for the new site: +

+
+
mkdir haunt-tutorial
+cd haunt-tutorial
+
+ +

Next, create the site configuration file haunt.scm. This is +where all of the code for building the website will go. +

+

Here’s what a simple Haunt configuration looks like: +

+
+
(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)))
+
+ +

Haunt represents the full configuration of the website using the +site 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. +

+

With the above code saved into the haunt.scm file, the next +step is to create a posts directory and populate it with +articles to publish. Put the text below into a file named +posts/hello.skr: +

+
+
(post
+ :title "Hello, World!"
+ :date (make-date* 2015 10 15)
+ :tags '("hello")
+
+ (h1 [Hello, World!])
+
+ (p [This is my very first Skribe document!]))
+
+ +

This is a +Skribe 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. +

+

To build the site, run haunt build to compile all of the +HTML pages. To view the results, run haunt serve and visit +http://localhost:8080 in a web browser. haunt serve +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 +haunt.scm, 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. +

+

In addition to the basic blog builder, the haunt.scm file +specifies two additional builders for Atom feeds. The +atom-feed builder creates a feed of all posts located at +http://localhost:8080/feed.xml. The atom-feeds-by-tag +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 http://localhost/feeds/tags/hello.xml. +

+

Tweaking a post, rebuilding the site, and viewing the results in a web +browser is the typical Haunt workflow. However, having to run +haunt build every after each edit is tedious. To address +this, run haunt serve --watch. 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. +

+

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. +

+
+
+

+Next: , Previous: , Up: Top   [Contents][Index]

+
+ + + + + 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 @@ + + + + + +Haunt Reference Manual: Top + + + + + + + + + + + + + + + + + + +

Haunt Reference Manual

+ + + + + + +

Table of Contents

+ +
+ + +
+ + + +
+

+Next: , Up: (dir)   [Contents][Index]

+
+
+ +

Haunt

+ +

This document describes Haunt version 0.2, an extensible, +functional static site generator. +

+ + + + + + + + + + + + + +
• Introduction:  About Haunt. +
• Installation:  Installing Haunt. +
• Tutorial:  How to get started quickly. +
• Command-line Interface:  Using Haunt from the command-line. +
• Programming Interface:  Using the Haunt API in Scheme. +
• Contributing:  How to contribute to Haunt. +
+
• GNU Free Documentation License:  The license of this manual. +
• Concept Index:  Concepts. +
• Programming Index:  Data types, procedures, syntax, and variables. +
+
 — The Detailed Node Listing —
+
+Installation
+
+
• Downloading:  Downloading the source code. +
• Requirements:  Software needed to build and run Haunt. +
• Building:  Building from source code. +
+
+ +
+
+

+Next: , Up: (dir)   [Contents][Index]

+
+ + + + + -- cgit v1.2.3