Compare commits
No commits in common. "master" and "v0.1" have entirely different histories.
|
|
@ -1,7 +1,8 @@
|
||||||
Makefile
|
/Makefile
|
||||||
Makefile.in
|
/Makefile.in
|
||||||
/aclocal.m4
|
/aclocal.m4
|
||||||
/autom4te.cache/
|
/autom4te.cache/
|
||||||
|
/build-aux/
|
||||||
/config.log
|
/config.log
|
||||||
/config.status
|
/config.status
|
||||||
/configure
|
/configure
|
||||||
|
|
@ -13,18 +14,4 @@ Makefile.in
|
||||||
/example/site/
|
/example/site/
|
||||||
/scripts/haunt
|
/scripts/haunt
|
||||||
*.tar.gz
|
*.tar.gz
|
||||||
*.tar.gz.asc
|
|
||||||
/website/site
|
/website/site
|
||||||
/test-env
|
|
||||||
*.log
|
|
||||||
*.trs
|
|
||||||
/build-aux/install-sh
|
|
||||||
/build-aux/missing
|
|
||||||
/build-aux/mdate-sh
|
|
||||||
/build-aux/texinfo.tex
|
|
||||||
/build-aux/test-driver
|
|
||||||
/doc/.dirstamp
|
|
||||||
/doc/haunt.html/
|
|
||||||
/doc/haunt.info
|
|
||||||
/doc/stamp-vti
|
|
||||||
/doc/version.texi
|
|
||||||
|
|
|
||||||
58
Makefile.am
58
Makefile.am
|
|
@ -1,7 +1,5 @@
|
||||||
## Haunt --- Static site generator for GNU Guile
|
## Haunt --- Static site generator for GNU Guile
|
||||||
## Copyright © 2015 David Thompson <davet@gnu.org>
|
## Copyright © 2015 David Thompson <davet@gnu.org>
|
||||||
## Copyright © 2015 Mathieu Lirzin <mthl@gnu.org>
|
|
||||||
## Copyright © 2016 Erik Edrosa <erik.edrosa@gmail.com>
|
|
||||||
##
|
##
|
||||||
## This file is part of Haunt.
|
## This file is part of Haunt.
|
||||||
##
|
##
|
||||||
|
|
@ -31,14 +29,15 @@ nobase_go_DATA = $(GOBJECTS)
|
||||||
guile_install_go_files = install-nobase_goDATA
|
guile_install_go_files = install-nobase_goDATA
|
||||||
$(guile_install_go_files): install-nobase_modDATA
|
$(guile_install_go_files): install-nobase_modDATA
|
||||||
|
|
||||||
|
CLEANFILES = $(GOBJECTS)
|
||||||
EXTRA_DIST = $(SOURCES) $(NOCOMP_SOURCES)
|
EXTRA_DIST = $(SOURCES) $(NOCOMP_SOURCES)
|
||||||
GUILE_WARNINGS = -Wunbound-variable -Warity-mismatch -Wformat
|
GUILE_WARNINGS = -Wunbound-variable -Warity-mismatch -Wformat
|
||||||
SUFFIXES = .scm .go
|
SUFFIXES = .scm .go
|
||||||
.scm.go:
|
.scm.go:
|
||||||
$(AM_V_GEN)$(top_builddir)/pre-inst-env $(GUILE_TOOLS) compile $(GUILE_WARNINGS) -o "$@" "$<"
|
$(AM_V_GEN)$(top_builddir)/pre-inst-env $(GUILE_TOOLS) compile $(GUILE_WARNINGS) -o "$@" "$<"
|
||||||
|
|
||||||
moddir=$(prefix)/share/guile/site/$(GUILE_EFFECTIVE_VERSION)
|
moddir=$(prefix)/share/guile/site/2.0
|
||||||
godir=$(libdir)/guile/$(GUILE_EFFECTIVE_VERSION)/site-ccache
|
godir=$(libdir)/guile/2.0/ccache
|
||||||
|
|
||||||
bin_SCRIPTS = \
|
bin_SCRIPTS = \
|
||||||
scripts/haunt
|
scripts/haunt
|
||||||
|
|
@ -47,6 +46,7 @@ SOURCES = \
|
||||||
haunt/config.scm \
|
haunt/config.scm \
|
||||||
haunt/utils.scm \
|
haunt/utils.scm \
|
||||||
haunt/post.scm \
|
haunt/post.scm \
|
||||||
|
haunt/reader.scm \
|
||||||
haunt/page.scm \
|
haunt/page.scm \
|
||||||
haunt/asset.scm \
|
haunt/asset.scm \
|
||||||
haunt/site.scm \
|
haunt/site.scm \
|
||||||
|
|
@ -54,58 +54,10 @@ SOURCES = \
|
||||||
haunt/builder/assets.scm \
|
haunt/builder/assets.scm \
|
||||||
haunt/builder/atom.scm \
|
haunt/builder/atom.scm \
|
||||||
haunt/builder/blog.scm \
|
haunt/builder/blog.scm \
|
||||||
haunt/builder/rss.scm \
|
|
||||||
haunt/reader.scm \
|
|
||||||
haunt/reader/texinfo.scm \
|
|
||||||
haunt/ui.scm \
|
haunt/ui.scm \
|
||||||
haunt/ui/build.scm \
|
haunt/ui/build.scm \
|
||||||
haunt/ui/serve.scm \
|
haunt/ui/serve.scm \
|
||||||
haunt/serve/mime-types.scm \
|
haunt/serve/mime-types.scm \
|
||||||
haunt/serve/web-server.scm
|
haunt/serve/web-server.scm
|
||||||
|
|
||||||
if HAVE_GUILE_READER
|
EXTRA_DIST += pre-inst-env.in
|
||||||
|
|
||||||
SOURCES += \
|
|
||||||
haunt/skribe.scm \
|
|
||||||
haunt/skribe/utils.scm \
|
|
||||||
haunt/reader/skribe.scm
|
|
||||||
|
|
||||||
endif
|
|
||||||
|
|
||||||
if HAVE_GUILE_COMMONMARK
|
|
||||||
|
|
||||||
SOURCES += \
|
|
||||||
haunt/reader/commonmark.scm
|
|
||||||
|
|
||||||
endif
|
|
||||||
|
|
||||||
TESTS = \
|
|
||||||
tests/post.scm \
|
|
||||||
tests/utils.scm
|
|
||||||
|
|
||||||
TEST_EXTENSIONS = .scm
|
|
||||||
SCM_LOG_COMPILER = $(top_builddir)/test-env $(GUILE)
|
|
||||||
AM_SCM_LOG_FLAGS = --no-auto-compile -L "$(top_srcdir)"
|
|
||||||
|
|
||||||
info_TEXINFOS = doc/haunt.texi
|
|
||||||
doc_haunt_TEXINFOS = doc/fdl-1.3.texi
|
|
||||||
dvi: # Don't build dvi docs
|
|
||||||
|
|
||||||
EXTRA_DIST += \
|
|
||||||
pre-inst-env.in \
|
|
||||||
README \
|
|
||||||
guix.scm \
|
|
||||||
$(TESTS)
|
|
||||||
|
|
||||||
SUBDIRS = \
|
|
||||||
example \
|
|
||||||
website
|
|
||||||
|
|
||||||
CLEANFILES = \
|
|
||||||
$(GOBJECTS) \
|
|
||||||
$(TESTS:tests/%.scm=%.log)
|
|
||||||
|
|
||||||
publish: distcheck
|
|
||||||
gpg --sign --armor --yes haunt-$(VERSION).tar.gz && \
|
|
||||||
scp haunt-$(VERSION).tar.gz haunt-$(VERSION).tar.gz.asc \
|
|
||||||
blog@dthompson.us:/var/www/files/haunt/
|
|
||||||
|
|
|
||||||
88
README
88
README
|
|
@ -1,88 +0,0 @@
|
||||||
-*- mode: org -*-
|
|
||||||
|
|
||||||
Haunt is a static site generator written in Guile Scheme. It's
|
|
||||||
simple, functional, and extensible.
|
|
||||||
|
|
||||||
* Features
|
|
||||||
|
|
||||||
- Easy blog and Atom/RSS feed generation
|
|
||||||
- Supports any markup language that can be parsed to SXML
|
|
||||||
- Simple development server
|
|
||||||
- Purely functional build process
|
|
||||||
- User extensible
|
|
||||||
|
|
||||||
* Example Configuration
|
|
||||||
|
|
||||||
#+BEGIN_SRC scheme
|
|
||||||
(use-modules (haunt site)
|
|
||||||
(haunt reader)
|
|
||||||
(haunt builder blog)
|
|
||||||
(haunt builder atom)
|
|
||||||
(haunt builder assets))
|
|
||||||
|
|
||||||
(site #:title "Built with Guile"
|
|
||||||
#:domain "example.com"
|
|
||||||
#:default-metadata
|
|
||||||
'((author . "Eva Luator")
|
|
||||||
(email . "eva@example.com"))
|
|
||||||
#:readers (list sxml-reader html-reader)
|
|
||||||
#:builders (list (blog)
|
|
||||||
(atom-feed)
|
|
||||||
(atom-feeds-by-tag)
|
|
||||||
(static-directory "images"))
|
|
||||||
#+END_SRC
|
|
||||||
|
|
||||||
* Usage
|
|
||||||
|
|
||||||
Write a configuration file named =haunt.scm=. Add your posts to a
|
|
||||||
directory named =posts=. Then run =haunt build=!
|
|
||||||
|
|
||||||
To view your creation, run =haunt serve= and browse to
|
|
||||||
=localhost:8080=. For quicker development cycles, run =haunt serve
|
|
||||||
--watch= to automatically rebuild the site when things change.
|
|
||||||
|
|
||||||
* Requirements
|
|
||||||
|
|
||||||
- GNU Guile >= 2.0.11
|
|
||||||
|
|
||||||
Optional:
|
|
||||||
|
|
||||||
- guile-reader (for Skribe support)
|
|
||||||
- guile-commonmark (for CommonMark support)
|
|
||||||
|
|
||||||
* Building from Git
|
|
||||||
|
|
||||||
Haunt uses the familiar GNU build system. GNU automake, autoconf, and
|
|
||||||
make are required to build from a git checkout.
|
|
||||||
|
|
||||||
#+BEGIN_SRC sh
|
|
||||||
./bootstrap && ./configure && make
|
|
||||||
#+END_SRC
|
|
||||||
|
|
||||||
Once Haunt is built, it can be run directly from the source tree (no
|
|
||||||
need to run =make install=) via the =pre-inst-env= script:
|
|
||||||
|
|
||||||
#+BEGIN_SRC sh
|
|
||||||
./pre-inst-env haunt --help
|
|
||||||
#+END_SRC
|
|
||||||
|
|
||||||
GNU Guix users can quickly create a build environment with all of the
|
|
||||||
necessary dependencies using the handy =guix environment= tool:
|
|
||||||
|
|
||||||
#+BEGIN_SRC sh
|
|
||||||
guix environment -l guix.scm
|
|
||||||
#+END_SRC
|
|
||||||
|
|
||||||
* Example
|
|
||||||
|
|
||||||
An example Haunt site can be found in the =example= directory. To
|
|
||||||
build it, run:
|
|
||||||
|
|
||||||
#+BEGIN_SRC sh
|
|
||||||
cd example
|
|
||||||
../pre-inst-env haunt build
|
|
||||||
#+END_SRC
|
|
||||||
|
|
||||||
* License
|
|
||||||
|
|
||||||
GNU GPLv3 or later. See =COPYING= for the full license text.
|
|
||||||
|
|
@ -0,0 +1,75 @@
|
||||||
|
Haunt
|
||||||
|
=====
|
||||||
|
|
||||||
|
About
|
||||||
|
-----
|
||||||
|
|
||||||
|
Haunt is a static site generator written in Guile Scheme. It's
|
||||||
|
simple, functional, and extensible.
|
||||||
|
|
||||||
|
Features
|
||||||
|
--------
|
||||||
|
|
||||||
|
* Easy blog and Atom feed generation
|
||||||
|
* Supports any markup language that can be parsed to SXML
|
||||||
|
* Simple development server
|
||||||
|
* Purely functional build process
|
||||||
|
* User extensible
|
||||||
|
|
||||||
|
Example Configuration
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
```
|
||||||
|
(use-modules (haunt site)
|
||||||
|
(haunt reader)
|
||||||
|
(haunt builder blog)
|
||||||
|
(haunt builder atom)
|
||||||
|
(haunt builder assets))
|
||||||
|
|
||||||
|
(site #:title "Built with Guile"
|
||||||
|
#:domain "example.com"
|
||||||
|
#:default-metadata
|
||||||
|
'((author . "Eva Luator")
|
||||||
|
(email . "eva@example.com"))
|
||||||
|
#:readers (list sxml-reader html-reader)
|
||||||
|
#:builders (list (blog)
|
||||||
|
(atom-feed)
|
||||||
|
(atom-feeds-by-tag)
|
||||||
|
(static-directory "images"))
|
||||||
|
```
|
||||||
|
|
||||||
|
Usage
|
||||||
|
-----
|
||||||
|
|
||||||
|
Write a configuration file named `haunt.scm`. Add your posts to a
|
||||||
|
directory named `posts`. Then run `haunt build`!
|
||||||
|
|
||||||
|
To view your creation, run `haunt serve` and browse to
|
||||||
|
`localhost:8080`.
|
||||||
|
|
||||||
|
Requirements
|
||||||
|
------------
|
||||||
|
|
||||||
|
GNU Guile >= 2.0.9
|
||||||
|
|
||||||
|
Building from Git
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
Haunt uses the familiar GNU build system. GNU automake, autoconf, and
|
||||||
|
make are required to build from a git checkout.
|
||||||
|
|
||||||
|
```
|
||||||
|
./bootstrap && ./configure && make
|
||||||
|
```
|
||||||
|
|
||||||
|
GNU Guix users can create a build environment with all necessary
|
||||||
|
dependencies using the handy `guix environment` tool:
|
||||||
|
|
||||||
|
```
|
||||||
|
guix environment -l package.scm
|
||||||
|
```
|
||||||
|
|
||||||
|
License
|
||||||
|
-------
|
||||||
|
|
||||||
|
GNU GPLv3 or later
|
||||||
5
THANKS
5
THANKS
|
|
@ -1,5 +0,0 @@
|
||||||
Ben Sturmfels <ben@sturm.com.au>
|
|
||||||
Vladimir Zhbanov <vzhbanov@gmail.com>
|
|
||||||
Urbain Vaes <urbain@vaes.uk>
|
|
||||||
Alex Kost <alezost@gmail.com>
|
|
||||||
Jorge Maldonado Ventura <jorgesumle@freakspot.net>
|
|
||||||
15
configure.ac
15
configure.ac
|
|
@ -1,24 +1,15 @@
|
||||||
dnl -*- Autoconf -*-
|
dnl -*- Autoconf -*-
|
||||||
|
|
||||||
AC_INIT(Haunt, 0.2.4)
|
AC_INIT(Haunt, 0.1)
|
||||||
AC_CONFIG_SRCDIR(haunt)
|
AC_CONFIG_SRCDIR(haunt)
|
||||||
AC_CONFIG_AUX_DIR([build-aux])
|
AC_CONFIG_AUX_DIR([build-aux])
|
||||||
AM_INIT_AUTOMAKE([color-tests -Wall -Wno-portability foreign])
|
AM_INIT_AUTOMAKE([color-tests -Wall -Wno-portability foreign])
|
||||||
AM_SILENT_RULES([yes])
|
AM_SILENT_RULES([yes])
|
||||||
|
|
||||||
AC_CONFIG_FILES([Makefile example/Makefile website/Makefile haunt/config.scm])
|
AC_CONFIG_FILES([Makefile haunt/config.scm])
|
||||||
AC_CONFIG_FILES([pre-inst-env], [chmod +x pre-inst-env])
|
AC_CONFIG_FILES([pre-inst-env], [chmod +x pre-inst-env])
|
||||||
AC_CONFIG_FILES([test-env], [chmod +x test-env])
|
|
||||||
AC_CONFIG_FILES([scripts/haunt], [chmod +x scripts/haunt])
|
AC_CONFIG_FILES([scripts/haunt], [chmod +x scripts/haunt])
|
||||||
|
|
||||||
GUILE_PKG([3.0 2.2 2.0])
|
GUILE_PROGS([2.0.11])
|
||||||
GUILE_PROGS
|
|
||||||
|
|
||||||
dnl Guile-reader is needed for Skribe support
|
|
||||||
GUILE_MODULE_AVAILABLE([have_guile_reader], [(system reader)])
|
|
||||||
AM_CONDITIONAL([HAVE_GUILE_READER], [test "x$have_guile_reader" = "xyes"])
|
|
||||||
|
|
||||||
GUILE_MODULE_AVAILABLE([have_guile_commonmark], [(commonmark)])
|
|
||||||
AM_CONDITIONAL([HAVE_GUILE_COMMONMARK], [test "x$have_guile_commonmark" = "xyes"])
|
|
||||||
|
|
||||||
AC_OUTPUT
|
AC_OUTPUT
|
||||||
|
|
|
||||||
505
doc/fdl-1.3.texi
505
doc/fdl-1.3.texi
|
|
@ -1,505 +0,0 @@
|
||||||
@c The GNU Free Documentation License.
|
|
||||||
@center Version 1.3, 3 November 2008
|
|
||||||
|
|
||||||
@c This file is intended to be included within another document,
|
|
||||||
@c hence no sectioning command or @node.
|
|
||||||
|
|
||||||
@display
|
|
||||||
Copyright @copyright{} 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.
|
|
||||||
@uref{http://fsf.org/}
|
|
||||||
|
|
||||||
Everyone is permitted to copy and distribute verbatim copies
|
|
||||||
of this license document, but changing it is not allowed.
|
|
||||||
@end display
|
|
||||||
|
|
||||||
@enumerate 0
|
|
||||||
@item
|
|
||||||
PREAMBLE
|
|
||||||
|
|
||||||
The purpose of this License is to make a manual, textbook, or other
|
|
||||||
functional and useful document @dfn{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.
|
|
||||||
|
|
||||||
@item
|
|
||||||
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, La@TeX{} 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.
|
|
||||||
|
|
||||||
@item
|
|
||||||
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.
|
|
||||||
|
|
||||||
@item
|
|
||||||
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.
|
|
||||||
|
|
||||||
@item
|
|
||||||
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:
|
|
||||||
|
|
||||||
@enumerate A
|
|
||||||
@item
|
|
||||||
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.
|
|
||||||
|
|
||||||
@item
|
|
||||||
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.
|
|
||||||
|
|
||||||
@item
|
|
||||||
State on the Title page the name of the publisher of the
|
|
||||||
Modified Version, as the publisher.
|
|
||||||
|
|
||||||
@item
|
|
||||||
Preserve all the copyright notices of the Document.
|
|
||||||
|
|
||||||
@item
|
|
||||||
Add an appropriate copyright notice for your modifications
|
|
||||||
adjacent to the other copyright notices.
|
|
||||||
|
|
||||||
@item
|
|
||||||
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.
|
|
||||||
|
|
||||||
@item
|
|
||||||
Preserve in that license notice the full lists of Invariant Sections
|
|
||||||
and required Cover Texts given in the Document's license notice.
|
|
||||||
|
|
||||||
@item
|
|
||||||
Include an unaltered copy of this License.
|
|
||||||
|
|
||||||
@item
|
|
||||||
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.
|
|
||||||
|
|
||||||
@item
|
|
||||||
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.
|
|
||||||
|
|
||||||
@item
|
|
||||||
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.
|
|
||||||
|
|
||||||
@item
|
|
||||||
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.
|
|
||||||
|
|
||||||
@item
|
|
||||||
Delete any section Entitled ``Endorsements''. Such a section
|
|
||||||
may not be included in the Modified Version.
|
|
||||||
|
|
||||||
@item
|
|
||||||
Do not retitle any existing section to be Entitled ``Endorsements'' or
|
|
||||||
to conflict in title with any Invariant Section.
|
|
||||||
|
|
||||||
@item
|
|
||||||
Preserve any Warranty Disclaimers.
|
|
||||||
@end enumerate
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
@item
|
|
||||||
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.''
|
|
||||||
|
|
||||||
@item
|
|
||||||
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.
|
|
||||||
|
|
||||||
@item
|
|
||||||
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.
|
|
||||||
|
|
||||||
@item
|
|
||||||
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.
|
|
||||||
|
|
||||||
@item
|
|
||||||
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.
|
|
||||||
|
|
||||||
@item
|
|
||||||
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
|
|
||||||
@uref{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.
|
|
||||||
|
|
||||||
@item
|
|
||||||
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.
|
|
||||||
|
|
||||||
@end enumerate
|
|
||||||
|
|
||||||
@page
|
|
||||||
@heading 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:
|
|
||||||
|
|
||||||
@smallexample
|
|
||||||
@group
|
|
||||||
Copyright (C) @var{year} @var{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''.
|
|
||||||
@end group
|
|
||||||
@end smallexample
|
|
||||||
|
|
||||||
If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
|
|
||||||
replace the ``with@dots{}Texts.''@: line with this:
|
|
||||||
|
|
||||||
@smallexample
|
|
||||||
@group
|
|
||||||
with the Invariant Sections being @var{list their titles}, with
|
|
||||||
the Front-Cover Texts being @var{list}, and with the Back-Cover Texts
|
|
||||||
being @var{list}.
|
|
||||||
@end group
|
|
||||||
@end smallexample
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
@c Local Variables:
|
|
||||||
@c ispell-local-pdict: "ispell-dict"
|
|
||||||
@c End:
|
|
||||||
969
doc/haunt.texi
969
doc/haunt.texi
|
|
@ -1,969 +0,0 @@
|
||||||
\input texinfo
|
|
||||||
@c -*-texinfo-*-
|
|
||||||
|
|
||||||
@c %**start of header
|
|
||||||
@setfilename haunt.info
|
|
||||||
@documentencoding UTF-8
|
|
||||||
@settitle Haunt Reference Manual
|
|
||||||
@c %**end of header
|
|
||||||
|
|
||||||
@include version.texi
|
|
||||||
|
|
||||||
@copying
|
|
||||||
Copyright @copyright{} 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''.
|
|
||||||
@end copying
|
|
||||||
|
|
||||||
@dircategory Web development
|
|
||||||
@direntry
|
|
||||||
* Haunt: (haunt). Haunt, the functional static site generator.
|
|
||||||
@end direntry
|
|
||||||
|
|
||||||
@titlepage
|
|
||||||
@title Haunt Reference Manual
|
|
||||||
@subtitle Using Haunt
|
|
||||||
@author The Haunt Developers
|
|
||||||
|
|
||||||
@page
|
|
||||||
@vskip 0pt plus 1filll
|
|
||||||
Edition @value{EDITION} @*
|
|
||||||
@value{UPDATED} @*
|
|
||||||
|
|
||||||
@insertcopying
|
|
||||||
@end titlepage
|
|
||||||
|
|
||||||
@contents
|
|
||||||
|
|
||||||
@node Top
|
|
||||||
@top Haunt
|
|
||||||
|
|
||||||
This document describes Haunt version @value{VERSION}, an extensible,
|
|
||||||
functional static site generator.
|
|
||||||
|
|
||||||
@menu
|
|
||||||
* 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.
|
|
||||||
|
|
||||||
@detailmenu
|
|
||||||
--- The Detailed Node Listing ---
|
|
||||||
|
|
||||||
Installation
|
|
||||||
|
|
||||||
* Downloading:: Downloading the source code.
|
|
||||||
* Requirements:: Software needed to build and run Haunt.
|
|
||||||
* Building:: Building from source code.
|
|
||||||
|
|
||||||
@end detailmenu
|
|
||||||
@end menu
|
|
||||||
|
|
||||||
@node Introduction
|
|
||||||
@chapter 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 @emph{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!
|
|
||||||
|
|
||||||
@node Installation
|
|
||||||
@chapter Installation
|
|
||||||
|
|
||||||
@menu
|
|
||||||
* Downloading:: Downloading the source code.
|
|
||||||
* Requirements:: Software needed to build and run Haunt.
|
|
||||||
* Building:: Building from source code.
|
|
||||||
@end menu
|
|
||||||
|
|
||||||
@node Downloading
|
|
||||||
@section Downloading
|
|
||||||
|
|
||||||
Official Haunt source code release tarballs can be found under Releases
|
|
||||||
in @url{https://dthompson.us/projects/haunt.html, Haunt's website},
|
|
||||||
along with their associated checksums.
|
|
||||||
|
|
||||||
@node Requirements
|
|
||||||
@section Requirements
|
|
||||||
|
|
||||||
Haunt depends on the following packages:
|
|
||||||
|
|
||||||
@itemize
|
|
||||||
@item
|
|
||||||
@url{https://gnu.org/software/guile, GNU Guile} version 2.0.11 or
|
|
||||||
later
|
|
||||||
@end itemize
|
|
||||||
|
|
||||||
The following dependencies are optional:
|
|
||||||
|
|
||||||
@itemize
|
|
||||||
@item
|
|
||||||
@url{http://www.nongnu.org/guile-reader/, Guile-Reader} version 0.6 or
|
|
||||||
later (for Skribe support)
|
|
||||||
@item
|
|
||||||
@url{https://github.com/OrangeShark/guile-commonmark, guile-commonmark}
|
|
||||||
version 0.1 or later (for CommonMark support)
|
|
||||||
@end itemize
|
|
||||||
|
|
||||||
@node Building
|
|
||||||
@section Building
|
|
||||||
|
|
||||||
Haunt uses the standard GNU build system, so the basic installation
|
|
||||||
procedure looks like this:
|
|
||||||
|
|
||||||
@example
|
|
||||||
./configure
|
|
||||||
make
|
|
||||||
make install
|
|
||||||
@end example
|
|
||||||
|
|
||||||
@node Tutorial
|
|
||||||
@chapter 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:
|
|
||||||
|
|
||||||
@example
|
|
||||||
mkdir haunt-tutorial
|
|
||||||
cd haunt-tutorial
|
|
||||||
@end example
|
|
||||||
|
|
||||||
Next, create the site configuration file @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:
|
|
||||||
|
|
||||||
@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)))
|
|
||||||
@end example
|
|
||||||
|
|
||||||
Haunt represents the full configuration of the website using the
|
|
||||||
@code{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 @file{haunt.scm} file, the next
|
|
||||||
step is to create a @file{posts} directory and populate it with
|
|
||||||
articles to publish. Put the text below into a file named
|
|
||||||
@file{posts/hello.skr}:
|
|
||||||
|
|
||||||
@example
|
|
||||||
(post
|
|
||||||
:title "Hello, World!"
|
|
||||||
:date (make-date* 2015 10 15)
|
|
||||||
:tags '("hello")
|
|
||||||
|
|
||||||
(h1 [Hello, World!])
|
|
||||||
|
|
||||||
(p [This is my very first Skribe document!]))
|
|
||||||
@end example
|
|
||||||
|
|
||||||
This is a
|
|
||||||
@url{http://www.nongnu.org/skribilo/doc/user-3.html#skribe-syntax,
|
|
||||||
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 @command{haunt build} to compile all of the
|
|
||||||
HTML pages. To view the results, run @command{haunt serve} and visit
|
|
||||||
@url{http://localhost:8080} in a web browser. @command{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
|
|
||||||
@file{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 @file{haunt.scm} file
|
|
||||||
specifies two additional builders for Atom feeds. The
|
|
||||||
@code{atom-feed} builder creates a feed of all posts located at
|
|
||||||
@url{http://localhost:8080/feed.xml}. The @code{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 @url{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
|
|
||||||
@command{haunt build} every after each edit is tedious. To address
|
|
||||||
this, run @command{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.
|
|
||||||
|
|
||||||
@node Command-line Interface
|
|
||||||
@chapter Command-line Interface
|
|
||||||
|
|
||||||
@menu
|
|
||||||
* Invoking haunt build:: Build the website.
|
|
||||||
* Invoking haunt serve:: Serve the website over HTTP.
|
|
||||||
@end menu
|
|
||||||
|
|
||||||
The Haunt command-line interface is composed of many subcommands. The
|
|
||||||
general syntax for all Haunt commands is:
|
|
||||||
|
|
||||||
@example
|
|
||||||
haunt @var{subcommand} @var{options}@dots{}
|
|
||||||
@end example
|
|
||||||
|
|
||||||
@node Invoking haunt build
|
|
||||||
@section Invoking @command{haunt build}
|
|
||||||
|
|
||||||
The @command{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,
|
|
||||||
@pxref{Sites}.
|
|
||||||
|
|
||||||
Example:
|
|
||||||
|
|
||||||
@example
|
|
||||||
haunt build --config=haunt.scm
|
|
||||||
@end example
|
|
||||||
|
|
||||||
@table @code
|
|
||||||
|
|
||||||
@item --config=@var{configuration-file}
|
|
||||||
@itemx -c @var{configuration-file}
|
|
||||||
Load the Haunt site declaration from @var{configuration-file}.
|
|
||||||
|
|
||||||
@end table
|
|
||||||
|
|
||||||
@node Invoking haunt serve
|
|
||||||
@section Invoking @command{haunt serve}
|
|
||||||
|
|
||||||
The @command{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 @command{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
|
|
||||||
@url{http://localhost:8080}.
|
|
||||||
|
|
||||||
While developing, it is common to rebuild the site frequently to view
|
|
||||||
the results of incremental changes. Rather than manually running
|
|
||||||
@command{haunt build} (@ref{Invoking haunt build}) each time changes
|
|
||||||
are made, the @code{--watch} flag can be used to automatically rebuild
|
|
||||||
the site when a source file changes on disk.
|
|
||||||
|
|
||||||
@table @code
|
|
||||||
|
|
||||||
@item --config=@var{configuration-file}
|
|
||||||
@itemx -c @var{configuration-file}
|
|
||||||
Load the Haunt site declaration from @var{configuration-file}.
|
|
||||||
|
|
||||||
@item --port=@var{port}
|
|
||||||
@itemx -p @var{port}
|
|
||||||
|
|
||||||
Listen for HTTP requests on @var{port}.
|
|
||||||
|
|
||||||
@item --watch
|
|
||||||
@itemx -w
|
|
||||||
|
|
||||||
Automatically rebuild the site when source files change.
|
|
||||||
|
|
||||||
@end table
|
|
||||||
|
|
||||||
@node Programming Interface
|
|
||||||
@chapter Programming Interface
|
|
||||||
|
|
||||||
@menu
|
|
||||||
* 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.
|
|
||||||
@end menu
|
|
||||||
|
|
||||||
Haunt is a fully-programmable system composed of several Guile Scheme
|
|
||||||
modules. This section documents the public API.
|
|
||||||
|
|
||||||
@node Sites
|
|
||||||
@section Sites
|
|
||||||
|
|
||||||
@example
|
|
||||||
(use-modules (haunt site))
|
|
||||||
@end example
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
@deffn {Scheme Procedure} site [#:title "This Place is Haunted"] @
|
|
||||||
[#:domain "example.com"] [#:posts-directory "posts"] @
|
|
||||||
[#:file-filter @code{default-file-filter}] @
|
|
||||||
[#:build-directory "site"] [#:default-metadata '()] @
|
|
||||||
[#:make-slug @code{post-slug}] [#:readers '()] @
|
|
||||||
[#:builders '()]
|
|
||||||
Create a new site object. All arguments are optional:
|
|
||||||
|
|
||||||
@table @var
|
|
||||||
|
|
||||||
@item title
|
|
||||||
The name of the site.
|
|
||||||
|
|
||||||
@item posts-directory
|
|
||||||
The directory where posts are found.
|
|
||||||
|
|
||||||
@item file-filter
|
|
||||||
A predicate procedure that returns @code{#f} when a post file should
|
|
||||||
be ignored, and @code{#t} otherwise. Emacs temporary files are
|
|
||||||
ignored by default.
|
|
||||||
|
|
||||||
@item build-directory
|
|
||||||
The directory that generated pages are stored in.
|
|
||||||
|
|
||||||
@item default-metadata
|
|
||||||
An alist of arbitrary default metadata for posts whose keys are
|
|
||||||
symbols.
|
|
||||||
|
|
||||||
@item make-slug
|
|
||||||
A procedure generating a file name slug from a post.
|
|
||||||
|
|
||||||
@item readers
|
|
||||||
A list of reader objects for processing posts.
|
|
||||||
|
|
||||||
@item builders
|
|
||||||
A list of procedures for building pages from posts.
|
|
||||||
|
|
||||||
@end table
|
|
||||||
|
|
||||||
@end deffn
|
|
||||||
|
|
||||||
@deffn {Scheme Procedure} site? @var{obj}
|
|
||||||
Return @code{#t} if @var{obj} is a site object.
|
|
||||||
@end deffn
|
|
||||||
|
|
||||||
@deffn {Scheme Procedure} site-title @var{site}
|
|
||||||
Return the title of @var{site}.
|
|
||||||
@end deffn
|
|
||||||
|
|
||||||
@deffn {Scheme Procedure} site-domain @var{site}
|
|
||||||
Return the domain of @var{site}.
|
|
||||||
@end deffn
|
|
||||||
|
|
||||||
@deffn {Scheme Procedure} site-posts-directory @var{site}
|
|
||||||
Return the posts directory for @var{site}.
|
|
||||||
@end deffn
|
|
||||||
|
|
||||||
@deffn {Scheme Procedure} site-file-filter @var{site}
|
|
||||||
Return the file filter procedure for @var{site}.
|
|
||||||
@end deffn
|
|
||||||
|
|
||||||
@deffn {Scheme Procedure} site-build-directory @var{site}
|
|
||||||
Return the build directory of @var{site}.
|
|
||||||
@end deffn
|
|
||||||
|
|
||||||
@deffn {Scheme Procedure} site-make-slug @var{site}
|
|
||||||
Return the slug constructor for @var{site}.
|
|
||||||
@end deffn
|
|
||||||
|
|
||||||
@deffn {Scheme Procedure} site-readers @var{site}
|
|
||||||
Return the list of reader procedures for @var{site}.
|
|
||||||
@end deffn
|
|
||||||
|
|
||||||
@deffn {Scheme Procedure} site-builders @var{site}
|
|
||||||
Return the list of builder procedures for @var{site}.
|
|
||||||
@end deffn
|
|
||||||
|
|
||||||
@node Posts
|
|
||||||
@section Posts
|
|
||||||
|
|
||||||
@example
|
|
||||||
(use-modules (haunt post))
|
|
||||||
@end example
|
|
||||||
|
|
||||||
Posts represent the articles that are kept in a site's post directory
|
|
||||||
and written in a markup format that Haunt can
|
|
||||||
understand. @pxref{Readers}) for how files on disk can be transformed
|
|
||||||
into posts.
|
|
||||||
|
|
||||||
@deffn {Scheme Procedure} make-post @var{file-name} @var{metadata} @var{sxml}
|
|
||||||
Create a new post object that represents the contents of the file
|
|
||||||
@var{file-name}. The body of the post, @var{sxml}, is represented as
|
|
||||||
an SXML tree (@pxref{SXML, SXML,, guile, GNU Guile Reference Manual})
|
|
||||||
and the metadata is an association list (@pxref{Association Lists,
|
|
||||||
Association Lists,, guile, GNU Guile Reference Manual}) of arbitrary
|
|
||||||
key/value pairs.
|
|
||||||
@end deffn
|
|
||||||
|
|
||||||
@deffn {Scheme Procedure} post? @var{object}
|
|
||||||
Return @code{#t} if @var{object} is a post.
|
|
||||||
@end deffn
|
|
||||||
|
|
||||||
@deffn {Scheme Procedure} post-file-name @var{post}
|
|
||||||
Return the file name for @var{post}.
|
|
||||||
@end deffn
|
|
||||||
|
|
||||||
@deffn {Scheme Procedure} post-metadata @var{post}
|
|
||||||
Return the metadata association list for @var{post}.
|
|
||||||
@end deffn
|
|
||||||
|
|
||||||
@deffn {Scheme Procedure} post-sxml @var{post}
|
|
||||||
Return the SXML tree for @var{post}.
|
|
||||||
@end deffn
|
|
||||||
|
|
||||||
@deffn {Scheme Procedure} post-ref @var{post} @var{key}
|
|
||||||
Return the metadata value corresponding to @var{key} within
|
|
||||||
@var{post}.
|
|
||||||
@end deffn
|
|
||||||
|
|
||||||
@deffn {Scheme Procedure} post-slug @var{post}
|
|
||||||
Transform the title of @var{post} into a URL slug suitable for the
|
|
||||||
file name of a web page.
|
|
||||||
@end deffn
|
|
||||||
|
|
||||||
@defvr {Scheme Variable} %default-date
|
|
||||||
The default date of a post when no other date is specified in the
|
|
||||||
metadata association list.
|
|
||||||
@end defvr
|
|
||||||
|
|
||||||
@deffn {Scheme Procedure} post-date @var{post}
|
|
||||||
Return the date for @var{post}, or @code{%default-date} if no date is
|
|
||||||
specified.
|
|
||||||
@end deffn
|
|
||||||
|
|
||||||
@deffn {Scheme Procedure} posts/reverse-chronological @var{posts}
|
|
||||||
Sort @var{posts}, a list of posts, in reverse chronological order.
|
|
||||||
@end deffn
|
|
||||||
|
|
||||||
@deffn {Scheme Procedure} posts/group-by-tag @var{posts}
|
|
||||||
Create an association list of tags mapped to the posts in the list
|
|
||||||
@var{posts} that used them.
|
|
||||||
@end deffn
|
|
||||||
|
|
||||||
@node Readers
|
|
||||||
@section Readers
|
|
||||||
|
|
||||||
@menu
|
|
||||||
* Reader:: Reader interface and basic readers
|
|
||||||
* Texinfo:: Texinfo reader
|
|
||||||
* Skribe:: Skribe reader
|
|
||||||
* CommonMark:: CommonMark reader
|
|
||||||
@end menu
|
|
||||||
|
|
||||||
@node Reader
|
|
||||||
@subsection Reader
|
|
||||||
@example
|
|
||||||
(use-modules (haunt reader))
|
|
||||||
@end example
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
@deffn {Scheme Procedure} make-reader @var{matcher} @var{proc}
|
|
||||||
Create a new reader. The reader is to be activated when
|
|
||||||
@var{matcher}, a procedure that accepts a file name as its only
|
|
||||||
argument, returns @code{#t}. When a post file matches, the procedure
|
|
||||||
@var{proc}, which also accepts a file name as its only argument, reads
|
|
||||||
the contents and returns a post object (@pxref{Posts}).
|
|
||||||
@end deffn
|
|
||||||
|
|
||||||
@deffn {Scheme Procedure} reader? @var{object}
|
|
||||||
Return @code{#t} if @var{object} is a reader.
|
|
||||||
@end deffn
|
|
||||||
|
|
||||||
@deffn {Scheme Procedure} reader-matcher @var{reader}
|
|
||||||
Return the match procedure for @var{reader}.
|
|
||||||
@end deffn
|
|
||||||
|
|
||||||
@deffn {Scheme Procedure} reader-proc @var{reader}
|
|
||||||
Return the read procedure for @var{reader}.
|
|
||||||
@end deffn
|
|
||||||
|
|
||||||
@deffn {Scheme Procedure} reader-match? @var{reader} @var{file-name}
|
|
||||||
Return @code{#t} if @var{file-name} is a file supported by
|
|
||||||
@var{reader}.
|
|
||||||
@end deffn
|
|
||||||
|
|
||||||
@deffn {Scheme Procedure} read-post @var{reader} @var{file-name} [@var{default-metadata}]
|
|
||||||
Read a post object from @var{file-name} using @var{reader}, merging
|
|
||||||
its metadata with @var{default-metadata}, or the empty list if not
|
|
||||||
specified.
|
|
||||||
@end deffn
|
|
||||||
|
|
||||||
@deffn {Scheme Procedure} read-posts @var{directory} @var{keep?} @var{readers} [@var{default-metadata}]
|
|
||||||
Read all of the files in @var{directory} that match @var{keep?} as
|
|
||||||
post objects. The @var{readers} list must contain a matching reader
|
|
||||||
for every post.
|
|
||||||
@end deffn
|
|
||||||
|
|
||||||
@deffn {Scheme Procedure} make-file-extension-matcher @var{ext}
|
|
||||||
Create a procedure that returns @code{#t} when a file name ends with
|
|
||||||
``.ext''.
|
|
||||||
@end deffn
|
|
||||||
|
|
||||||
@defvr {Scheme Procedure} sxml-reader
|
|
||||||
A basic reader for posts written as Scheme code that evaluates to an
|
|
||||||
an association list. The special key @code{content} contains the post
|
|
||||||
body as an SXML tree.
|
|
||||||
|
|
||||||
Example:
|
|
||||||
|
|
||||||
@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."))))
|
|
||||||
@end example
|
|
||||||
|
|
||||||
@end defvr
|
|
||||||
|
|
||||||
@defvr {Scheme Procedure} html-reader
|
|
||||||
A basic reader for posts written in plain ol' HTML. Metadata is
|
|
||||||
encoded as the @code{key: value} pairs, one per line, at the beginning
|
|
||||||
of the file. A line with the @code{---} sentinel marks the end of the
|
|
||||||
metadata section and the rest of the file is encoded as HTML.
|
|
||||||
|
|
||||||
Example:
|
|
||||||
|
|
||||||
@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>
|
|
||||||
@end example
|
|
||||||
|
|
||||||
@end defvr
|
|
||||||
|
|
||||||
@node Texinfo
|
|
||||||
@subsection Texinfo
|
|
||||||
@example
|
|
||||||
(use-modules (haunt reader texinfo))
|
|
||||||
@end example
|
|
||||||
|
|
||||||
@defvr {Scheme Procedure} texinfo-reader
|
|
||||||
A reader for posts written in texinfo, the official documentation format
|
|
||||||
of the GNU project. Metadata is encoded as @code{key: value} pairs, one
|
|
||||||
per line, at the beginning of the file. A line with the @code{---}
|
|
||||||
sentinel marks the end of the metadata section and the rest of the file
|
|
||||||
is encoded as HTML.
|
|
||||||
|
|
||||||
Example:
|
|
||||||
|
|
||||||
@example
|
|
||||||
title: Hello, Texi!
|
|
||||||
date: 2016-08-20 12:00
|
|
||||||
tags: texinfo, foo
|
|
||||||
---
|
|
||||||
|
|
||||||
@@emph@{Texinfo@} is the official documentation format of the
|
|
||||||
@@url@{http://www.gnu.org/, GNU project@}. It was invented by Richard
|
|
||||||
Stallman and Bob Chassell many years ago, loosely based on Brian
|
|
||||||
Reid's Scribe and other formatting languages of the time. It is
|
|
||||||
used by many non-GNU projects as well.
|
|
||||||
@end example
|
|
||||||
|
|
||||||
@end defvr
|
|
||||||
|
|
||||||
@node Skribe
|
|
||||||
@subsection Skribe
|
|
||||||
@example
|
|
||||||
(use-modules (haunt reader skribe))
|
|
||||||
@end example
|
|
||||||
|
|
||||||
@defvr {Scheme Procedure} skribe-reader
|
|
||||||
A reader for posts written in Skribe, a markup language with the full power
|
|
||||||
of Scheme. Skribe posts are created with the @code{post} expression with
|
|
||||||
metadata encoded as @code{:key expression} pairs at the beginning of the
|
|
||||||
@code{post} expression. After the metadata section, the rest of the @code{post}
|
|
||||||
expression is encoded as HTML.
|
|
||||||
|
|
||||||
Example:
|
|
||||||
|
|
||||||
@example
|
|
||||||
(post
|
|
||||||
:title "Hello, Skribe!"
|
|
||||||
:date (make-date* 2016 08 20 12 00)
|
|
||||||
:tags '("skribe" "foo" "baz")
|
|
||||||
|
|
||||||
(h2 [This is a Skribe post])
|
|
||||||
|
|
||||||
(p [Skribe is a ,(em [really]) cool document authoring format
|
|
||||||
that provides all the power of Scheme whilst giving the user
|
|
||||||
a means to write literal text without stuffing it into a
|
|
||||||
string literal. If this sort of thing suits you, be sure to
|
|
||||||
check out ,(anchor "Skribilo"
|
|
||||||
"http://www.nongnu.org/skribilo/"), too.]))
|
|
||||||
@end example
|
|
||||||
|
|
||||||
@end defvr
|
|
||||||
|
|
||||||
@node CommonMark
|
|
||||||
@subsection CommonMark
|
|
||||||
@example
|
|
||||||
(use-modules (haunt reader commonmark))
|
|
||||||
@end example
|
|
||||||
|
|
||||||
@defvr {Scheme Procedure} commonmark-reader
|
|
||||||
A reader for posts written in CommonMark, a fully specified variant of
|
|
||||||
Markdown. Metadata is encoded as @code{key: value} pairs, one per line,
|
|
||||||
at the beginning of the file. A line with the @code{---} sentinel marks
|
|
||||||
the end of the metadata section and the rest of the file is encoded as HTML.
|
|
||||||
|
|
||||||
Example:
|
|
||||||
|
|
||||||
@example
|
|
||||||
title: Hello, CommonMark!
|
|
||||||
date: 2016-08-20 12:00
|
|
||||||
tags: markdown, commonmark
|
|
||||||
---
|
|
||||||
|
|
||||||
## This is a CommonMark post
|
|
||||||
|
|
||||||
CommonMark is a **strongly** defined, *highly* compatible
|
|
||||||
specification of Markdown, learn more about CommomMark
|
|
||||||
[here](http://commonmark.org/).
|
|
||||||
@end example
|
|
||||||
|
|
||||||
@end defvr
|
|
||||||
|
|
||||||
@node Pages
|
|
||||||
@section Pages
|
|
||||||
|
|
||||||
@example
|
|
||||||
(use-modules (haunt page))
|
|
||||||
@end example
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
@deffn {Scheme Procedure} make-page @var{file-name} @var{contents} @var{writer}
|
|
||||||
Create a new page object. The string @var{file-name} specifies where
|
|
||||||
the page should be written to in the file system. The procedure
|
|
||||||
@var{writer} is responsible for serializing @var{contents}.
|
|
||||||
@end deffn
|
|
||||||
|
|
||||||
@deffn {Scheme Procedure} page? @var{object}
|
|
||||||
Return @code{#t} if @var{object} is a page object.
|
|
||||||
@end deffn
|
|
||||||
|
|
||||||
@deffn {Scheme Procedure} page-file-name @var{page}
|
|
||||||
Return the file name string for @var{page}.
|
|
||||||
@end deffn
|
|
||||||
|
|
||||||
@deffn {Scheme Procedure} page-contents @var{page}
|
|
||||||
Return the contents of @var{page}.
|
|
||||||
@end deffn
|
|
||||||
|
|
||||||
@deffn {Scheme Procedure} page-writer @var{page}
|
|
||||||
Return the writer procedure @var{page}.
|
|
||||||
@end deffn
|
|
||||||
|
|
||||||
@deffn {Scheme Procedure} write-page @var{page} @var{output-directory}
|
|
||||||
Write @var{page} to @var{output-directory}.
|
|
||||||
@end deffn
|
|
||||||
|
|
||||||
@node Assets
|
|
||||||
@section Assets
|
|
||||||
|
|
||||||
@example
|
|
||||||
(use-modules (haunt asset))
|
|
||||||
@end example
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
@deffn {Scheme Procedure} make-asset @var{source} @var{target}
|
|
||||||
Create a new asset object. The @var{source} and @var{target}
|
|
||||||
arguments are file names that are relative to a site source and target
|
|
||||||
directory, respectively (@pxref{Sites}).
|
|
||||||
@end deffn
|
|
||||||
|
|
||||||
@deffn {Scheme Procedure} asset? @var{object}
|
|
||||||
Return @code{#t} if @var{object} is an asset object.
|
|
||||||
@end deffn
|
|
||||||
|
|
||||||
@deffn {Scheme Procedure} asset-source @var{asset}
|
|
||||||
Return the source file name for @var{asset}.
|
|
||||||
@end deffn
|
|
||||||
|
|
||||||
@deffn {Scheme Procedure} asset-target @var{asset}
|
|
||||||
Return the target file name for @var{asset}.
|
|
||||||
@end deffn
|
|
||||||
|
|
||||||
@deffn {Scheme Procedure} install-asset @var{asset} @var{prefix}
|
|
||||||
Install the source file of @var{asset} into the target directory
|
|
||||||
within @var{prefix}.
|
|
||||||
@end deffn
|
|
||||||
|
|
||||||
@deffn {Scheme Procedure} directory-assets @var{directory} @var{keep?} @var{dest}
|
|
||||||
Create a list of asset objects to be stored within @var{dest} for all
|
|
||||||
files in @var{directory} that match @var{keep?}, recursively.
|
|
||||||
@end deffn
|
|
||||||
|
|
||||||
@node Builders
|
|
||||||
@section Builders
|
|
||||||
|
|
||||||
@menu
|
|
||||||
* Static Assets:: Images, CSS, JavaScript, etc.
|
|
||||||
* Blog:: Dear diary...
|
|
||||||
* Atom:: Atom feeds.
|
|
||||||
@end menu
|
|
||||||
|
|
||||||
Builders are procedures that return one or more page objects
|
|
||||||
(@pxref{Pages}) when applied. A builder accepts two arguments: A site
|
|
||||||
(@pxref{Sites}) and a list of posts (@pxref{Posts}).
|
|
||||||
|
|
||||||
Haunt comes with a few convenient builders to help users who want to
|
|
||||||
create a simple blog with an Atom feed.
|
|
||||||
|
|
||||||
@node Static Assets
|
|
||||||
@subsection Static Assets
|
|
||||||
|
|
||||||
@example
|
|
||||||
(use-modules (haunt builder assets))
|
|
||||||
@end example
|
|
||||||
|
|
||||||
@deffn {Scheme Procedure} static-directory @var{directory} @
|
|
||||||
[@var{dest} @var{directory}]
|
|
||||||
|
|
||||||
Create a builder procedure that recursively copies all of the files in
|
|
||||||
@var{directory}, a file names relative to a site's source directory,
|
|
||||||
and copies them into @var{dest}, a prefix relative to a site's target
|
|
||||||
output directory. By default, @var{dest} is @var{directory}.
|
|
||||||
@end deffn
|
|
||||||
|
|
||||||
@node Blog
|
|
||||||
@subsection Blog
|
|
||||||
|
|
||||||
@example
|
|
||||||
(use-modules (haunt builder blog))
|
|
||||||
@end example
|
|
||||||
|
|
||||||
@deffn {Scheme Procedure} theme [#:name #:layout #:post-template #:collection-template]
|
|
||||||
Create a new theme named @var{name}.
|
|
||||||
|
|
||||||
The procedure @var{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 @var{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 @var{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.
|
|
||||||
@end deffn
|
|
||||||
|
|
||||||
@deffn {Scheme Procedure} theme? @var{object}
|
|
||||||
Return @code{#t} if @var{object} is a theme object.
|
|
||||||
@end deffn
|
|
||||||
|
|
||||||
@deffn {Scheme Procedure} blog [#:theme #:prefix #:collections]
|
|
||||||
Create a builder procedure that transforms a list of posts into pages
|
|
||||||
decorated by @var{theme}, a theme object, whose URLs start with
|
|
||||||
@var{prefix}.
|
|
||||||
|
|
||||||
Additionally, this builder creates pages that aggregate previews of
|
|
||||||
many posts corresponding to what is specified in the list
|
|
||||||
@var{collections}. Each collection is a three element list in the
|
|
||||||
form @code{(title file-name filter)}.
|
|
||||||
|
|
||||||
@table @var
|
|
||||||
|
|
||||||
@item title
|
|
||||||
The human readable name of the collection.
|
|
||||||
|
|
||||||
@item file-name
|
|
||||||
The HTML file that will contain the rendered collection.
|
|
||||||
|
|
||||||
@item 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.
|
|
||||||
|
|
||||||
@end table
|
|
||||||
|
|
||||||
By default, a single collection is created that lists posts in reverse
|
|
||||||
chronological order and writes to @file{index.html}.
|
|
||||||
|
|
||||||
The default theme is intended only for testing purposes.
|
|
||||||
|
|
||||||
@end deffn
|
|
||||||
|
|
||||||
@node Atom
|
|
||||||
@subsection Atom
|
|
||||||
|
|
||||||
@example
|
|
||||||
(use-modules (haunt builder atom))
|
|
||||||
@end example
|
|
||||||
|
|
||||||
@deffn {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:
|
|
||||||
|
|
||||||
@table @var
|
|
||||||
|
|
||||||
@item file-name:
|
|
||||||
The page file name. The default is @file{feed.xml}.
|
|
||||||
|
|
||||||
@item subtitle
|
|
||||||
The feed subtitle. The default is ``Recent Posts''.
|
|
||||||
|
|
||||||
@item 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.
|
|
||||||
|
|
||||||
@item max-entries
|
|
||||||
The maximum number of posts to render in the feed. The default is 20.
|
|
||||||
@end table
|
|
||||||
|
|
||||||
@end deffn
|
|
||||||
|
|
||||||
@deffn {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:
|
|
||||||
|
|
||||||
@table @var
|
|
||||||
|
|
||||||
@item prefix
|
|
||||||
The directory in which to write the feeds. The default is
|
|
||||||
@file{feeds/tags}.
|
|
||||||
|
|
||||||
@item 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.
|
|
||||||
|
|
||||||
@item max-entries
|
|
||||||
The maximum number of posts to render in each feed. The default is
|
|
||||||
20.
|
|
||||||
|
|
||||||
@end table
|
|
||||||
|
|
||||||
@end deffn
|
|
||||||
|
|
||||||
@node Contributing
|
|
||||||
@chapter Contributing
|
|
||||||
|
|
||||||
@c *********************************************************************
|
|
||||||
@node GNU Free Documentation License
|
|
||||||
@appendix GNU Free Documentation License
|
|
||||||
|
|
||||||
@include fdl-1.3.texi
|
|
||||||
|
|
||||||
@c *********************************************************************
|
|
||||||
@node Concept Index
|
|
||||||
@unnumbered Concept Index
|
|
||||||
@printindex cp
|
|
||||||
|
|
||||||
@node Programming Index
|
|
||||||
@unnumbered Programming Index
|
|
||||||
@syncodeindex tp fn
|
|
||||||
@syncodeindex vr fn
|
|
||||||
@printindex fn
|
|
||||||
|
|
||||||
@bye
|
|
||||||
|
|
||||||
@c Local Variables:
|
|
||||||
@c ispell-local-dictionary: "american";
|
|
||||||
@c End:
|
|
||||||
|
|
@ -1,24 +0,0 @@
|
||||||
## Haunt --- Static site generator for GNU Guile
|
|
||||||
## Copyright © 2015 David Thompson <davet@gnu.org>
|
|
||||||
##
|
|
||||||
## This file is part of Haunt.
|
|
||||||
##
|
|
||||||
## Haunt is free software; you can redistribute it and/or modify it
|
|
||||||
## under the terms of the GNU General Public License as published by
|
|
||||||
## the Free Software Foundation; either version 3 of the License, or
|
|
||||||
## (at your option) any later version.
|
|
||||||
##
|
|
||||||
## Haunt is distributed in the hope that it will be useful, but
|
|
||||||
## WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
||||||
## General Public License for more details.
|
|
||||||
##
|
|
||||||
## You should have received a copy of the GNU General Public License
|
|
||||||
## along with Haunt. If not, see <http://www.gnu.org/licenses/>.
|
|
||||||
|
|
||||||
exampledir = $(pkgdatadir)/example
|
|
||||||
nobase_dist_example_DATA = \
|
|
||||||
haunt.scm \
|
|
||||||
images/guile-banner.small.png \
|
|
||||||
posts/foo.sxml \
|
|
||||||
posts/bar.html
|
|
||||||
|
|
@ -1,19 +1,16 @@
|
||||||
(use-modules (haunt asset)
|
(use-modules (haunt site)
|
||||||
|
(haunt reader)
|
||||||
|
(haunt asset)
|
||||||
(haunt builder blog)
|
(haunt builder blog)
|
||||||
(haunt builder atom)
|
(haunt builder atom)
|
||||||
(haunt builder assets)
|
(haunt builder assets))
|
||||||
(haunt reader)
|
|
||||||
(haunt reader skribe)
|
|
||||||
(haunt reader texinfo)
|
|
||||||
(haunt reader commonmark)
|
|
||||||
(haunt site))
|
|
||||||
|
|
||||||
(site #:title "Built with Guile"
|
(site #:title "Built with Guile"
|
||||||
#:domain "example.com"
|
#:domain "example.com"
|
||||||
#:default-metadata
|
#:default-metadata
|
||||||
'((author . "Eva Luator")
|
'((author . "Eva Luator")
|
||||||
(email . "eva@example.com"))
|
(email . "eva@example.com"))
|
||||||
#:readers (list commonmark-reader texinfo-reader skribe-reader sxml-reader html-reader)
|
#:readers (list sxml-reader html-reader)
|
||||||
#:builders (list (blog)
|
#:builders (list (blog)
|
||||||
(atom-feed)
|
(atom-feed)
|
||||||
(atom-feeds-by-tag)
|
(atom-feeds-by-tag)
|
||||||
|
|
|
||||||
|
|
@ -1,29 +0,0 @@
|
||||||
(post
|
|
||||||
:title "Hello, Skribe!"
|
|
||||||
:date (make-date* 2015 10 09 23 00)
|
|
||||||
:tags '("foo" "bar" "baz")
|
|
||||||
|
|
||||||
(h1 [Hello!])
|
|
||||||
|
|
||||||
(p [This is a Skribe document!])
|
|
||||||
|
|
||||||
(p [Skribe is a ,(em [really]) cool document authoring format that
|
|
||||||
provides all the power of Scheme whilst giving the user a
|
|
||||||
means to write literal text without stuffing it into a string
|
|
||||||
literal. If this sort of thing suits you, be sure to check out
|
|
||||||
,(anchor "Skribilo" "http://www.nongnu.org/skribilo/"), too.])
|
|
||||||
|
|
||||||
(p [Here's a simple list generated by Scheme code:])
|
|
||||||
|
|
||||||
(ul (map li '("foo" "bar" "baz")))
|
|
||||||
|
|
||||||
(p [And here's a code snippet of how I build Haunt using GNU Guix:])
|
|
||||||
|
|
||||||
(source-code
|
|
||||||
"guix environment -l guix.scm
|
|
||||||
./configure
|
|
||||||
make")
|
|
||||||
|
|
||||||
(p [And finally, here's an image:])
|
|
||||||
|
|
||||||
(image "/images/guile-banner.small.png"))
|
|
||||||
|
|
@ -1,20 +0,0 @@
|
||||||
title: Hello, Markdown!
|
|
||||||
date: 2016-08-18 18:00
|
|
||||||
tags: frob, markdown
|
|
||||||
---
|
|
||||||
|
|
||||||
# This is a Markdown post
|
|
||||||
|
|
||||||
Markdown support is brought to you by
|
|
||||||
[guile-commonmark](https://github.com/OrangeShark/guile-commonmark)!
|
|
||||||
|
|
||||||
Code snippet:
|
|
||||||
|
|
||||||
```scheme
|
|
||||||
;; Just gonna snooze for a bit...
|
|
||||||
((lambda (f) (f f)) (lambda (f) (f f)))
|
|
||||||
```
|
|
||||||
|
|
||||||
## Subheading
|
|
||||||
|
|
||||||
You can't be a real static site generator without Markdown support!
|
|
||||||
|
|
@ -1,32 +0,0 @@
|
||||||
title: Hello, Texi!
|
|
||||||
date: 2015-10-15 22:00
|
|
||||||
tags: foo, bar
|
|
||||||
---
|
|
||||||
|
|
||||||
This is a test of the @emph{texinfo} reader for Haunt. I sure hope it
|
|
||||||
works well. Here is a URL to the @url{http://haunt.dthompson.us,
|
|
||||||
Haunt home page}.
|
|
||||||
|
|
||||||
@example
|
|
||||||
(use-modules (haunt asset)
|
|
||||||
(haunt builder blog)
|
|
||||||
(haunt builder atom)
|
|
||||||
(haunt builder assets)
|
|
||||||
(haunt reader)
|
|
||||||
(haunt reader skribe)
|
|
||||||
(haunt reader texinfo)
|
|
||||||
(haunt site))
|
|
||||||
|
|
||||||
(site #:title "Built with Guile"
|
|
||||||
#:domain "example.com"
|
|
||||||
#:default-metadata
|
|
||||||
'((author . "Eva Luator")
|
|
||||||
(email . "eva@@example.com"))
|
|
||||||
#:readers (list texinfo-reader skribe-reader sxml-reader html-reader)
|
|
||||||
#:builders (list (blog)
|
|
||||||
(atom-feed)
|
|
||||||
(atom-feeds-by-tag)
|
|
||||||
(static-directory "images")))
|
|
||||||
@end example
|
|
||||||
|
|
||||||
This is another paragraph.
|
|
||||||
|
|
@ -1,6 +1,5 @@
|
||||||
;;; Haunt --- Static site generator for GNU Guile
|
;;; Haunt --- Static site generator for GNU Guile
|
||||||
;;; Copyright © 2015 David Thompson <davet@gnu.org>
|
;;; Copyright © 2015 David Thompson <davet@gnu.org>
|
||||||
;;; Copyright © 2016 Christopher Allan Webber <cwebber@dustycloud.org>
|
|
||||||
;;;
|
;;;
|
||||||
;;; This file is part of Haunt.
|
;;; This file is part of Haunt.
|
||||||
;;;
|
;;;
|
||||||
|
|
@ -24,7 +23,6 @@
|
||||||
;;; Code:
|
;;; Code:
|
||||||
|
|
||||||
(define-module (haunt builder atom)
|
(define-module (haunt builder atom)
|
||||||
#:use-module (srfi srfi-9)
|
|
||||||
#:use-module (srfi srfi-19)
|
#:use-module (srfi srfi-19)
|
||||||
#:use-module (srfi srfi-26)
|
#:use-module (srfi srfi-26)
|
||||||
#:use-module (ice-9 match)
|
#:use-module (ice-9 match)
|
||||||
|
|
@ -34,132 +32,31 @@
|
||||||
#:use-module (haunt page)
|
#:use-module (haunt page)
|
||||||
#:use-module (haunt utils)
|
#:use-module (haunt utils)
|
||||||
#:use-module (haunt html)
|
#:use-module (haunt html)
|
||||||
#:use-module (haunt serve mime-types)
|
#:export (atom-feed
|
||||||
#:use-module (web uri)
|
|
||||||
#:export (make-enclosure
|
|
||||||
enclosure?
|
|
||||||
enclosure-title
|
|
||||||
enclosure-url
|
|
||||||
enclosure-extra
|
|
||||||
enclosure-mime-type
|
|
||||||
|
|
||||||
atom-feed
|
|
||||||
atom-feeds-by-tag))
|
atom-feeds-by-tag))
|
||||||
|
|
||||||
(define-record-type <enclosure>
|
|
||||||
(make-enclosure title url extra)
|
|
||||||
enclosure?
|
|
||||||
(title enclosure-title)
|
|
||||||
(url enclosure-url)
|
|
||||||
(extra enclosure-extra))
|
|
||||||
|
|
||||||
(define (enclosure-mime-type enclosure)
|
|
||||||
(mime-type (enclosure-url enclosure)))
|
|
||||||
|
|
||||||
(define char-set:enclosure-key
|
|
||||||
(char-set-union char-set:letter+digit
|
|
||||||
(char-set-delete char-set:punctuation #\: #\")
|
|
||||||
(char-set-delete char-set:symbol #\=)))
|
|
||||||
|
|
||||||
(define (parse-enclosure s)
|
|
||||||
(call-with-input-string s
|
|
||||||
(lambda (port)
|
|
||||||
(define (assert-char char)
|
|
||||||
(let ((c (read-char port)))
|
|
||||||
(unless (eqv? c char)
|
|
||||||
(error "enclosure: parse: expected" char "got" c))))
|
|
||||||
(define (whitespace? char)
|
|
||||||
(char-set-contains? char-set:whitespace char))
|
|
||||||
(define (consume-whitespace)
|
|
||||||
(match (peek-char port)
|
|
||||||
((? eof-object?) *unspecified*)
|
|
||||||
((? whitespace?)
|
|
||||||
(read-char port)
|
|
||||||
(consume-whitespace))
|
|
||||||
(_ *unspecified*)))
|
|
||||||
(define (read-escape-character)
|
|
||||||
(match (read-char port)
|
|
||||||
(#\" #\")
|
|
||||||
(#\\ #\\)
|
|
||||||
(char (error "enclosure: parse: invalid escape character:" char))))
|
|
||||||
(define (read-unquoted-string)
|
|
||||||
(list->string
|
|
||||||
(let loop ()
|
|
||||||
(let ((c (peek-char port)))
|
|
||||||
(cond
|
|
||||||
((eof-object? c)
|
|
||||||
'())
|
|
||||||
((char-set-contains? char-set:enclosure-key c)
|
|
||||||
(read-char port)
|
|
||||||
(cons c (loop)))
|
|
||||||
(else
|
|
||||||
'()))))))
|
|
||||||
(define (read-string)
|
|
||||||
(if (eqv? (peek-char port) #\")
|
|
||||||
(begin
|
|
||||||
(assert-char #\")
|
|
||||||
(list->string
|
|
||||||
(let loop ()
|
|
||||||
(match (read-char port)
|
|
||||||
((? eof-object?)
|
|
||||||
(error "enclosure: parse: EOF while reading string"))
|
|
||||||
(#\" '())
|
|
||||||
(#\\ (cons (read-escape-character) (loop)))
|
|
||||||
(char (cons char (loop)))))))
|
|
||||||
(read-unquoted-string)))
|
|
||||||
(define (read-key)
|
|
||||||
(string->symbol (read-unquoted-string)))
|
|
||||||
(let loop ((attrs '()))
|
|
||||||
(consume-whitespace)
|
|
||||||
(if (eof-object? (peek-char port))
|
|
||||||
(make-enclosure (assq-ref attrs 'title)
|
|
||||||
(assq-ref attrs 'url)
|
|
||||||
(let loop ((attrs attrs))
|
|
||||||
(match attrs
|
|
||||||
(() '())
|
|
||||||
((((or 'title 'url) . _) . rest)
|
|
||||||
(loop rest))
|
|
||||||
((attr . rest)
|
|
||||||
(cons attr (loop rest))))))
|
|
||||||
(let ((key (read-key)))
|
|
||||||
(assert-char #\:)
|
|
||||||
(loop (cons (cons key (read-string)) attrs))))))))
|
|
||||||
|
|
||||||
(register-metadata-parser! 'enclosure parse-enclosure)
|
|
||||||
|
|
||||||
(define (sxml->xml* sxml port)
|
(define (sxml->xml* sxml port)
|
||||||
"Write SXML to PORT, preceded by an <?xml> tag."
|
"Write SXML to PORT, preceded by an <?xml> tag."
|
||||||
(display "<?xml version=\"1.0\" encoding=\"utf-8\"?>" port)
|
(display "<?xml version=\"1.0\" encoding=\"utf-8\"?>" port)
|
||||||
(sxml->xml sxml port))
|
(sxml->xml sxml port))
|
||||||
|
|
||||||
(define (date->string* date)
|
(define (date->string* date)
|
||||||
"Convert date to RFC-3339 formatted string."
|
"Convert date to ISO-8601 formatted string."
|
||||||
(date->string date "~Y-~m-~dT~H:~M:~SZ"))
|
(date->string date "~4"))
|
||||||
|
|
||||||
(define* (post->atom-entry site post)
|
(define (post->atom-entry site post)
|
||||||
"Convert POST into an Atom <entry> XML node."
|
"Convert POST into an Atom <entry> XML node."
|
||||||
(let ((uri (uri->string (site-post-url site post))))
|
`(entry
|
||||||
`(entry
|
(title ,(post-ref post 'title))
|
||||||
(title ,(post-ref post 'title))
|
(author
|
||||||
(id ,uri)
|
(name ,(post-ref post 'author))
|
||||||
(author
|
,(let ((email (post-ref post 'email)))
|
||||||
(name ,(post-ref post 'author))
|
(if email `(email ,email) '())))
|
||||||
,(let ((email (post-ref post 'email)))
|
(updated ,(date->string* (post-date post)))
|
||||||
(if email `(email ,email) '())))
|
(link (@ (href ,(string-append "/" (site-post-slug site post) ".html"))
|
||||||
(updated ,(date->string* (post-date post)))
|
(rel "alternate")))
|
||||||
(link (@ (href ,uri) (rel "alternate")))
|
(summary (@ (type "html"))
|
||||||
(summary (@ (type "html"))
|
,(sxml->html-string (post-sxml post)))))
|
||||||
,(sxml->html-string (post-sxml post)))
|
|
||||||
,@(map (lambda (enclosure)
|
|
||||||
`(link (@ (rel "enclosure")
|
|
||||||
(title ,(enclosure-title enclosure))
|
|
||||||
(href ,(enclosure-url enclosure))
|
|
||||||
(type ,(enclosure-mime-type enclosure))
|
|
||||||
,@(map (match-lambda
|
|
||||||
((key . value)
|
|
||||||
(list key value)))
|
|
||||||
(enclosure-extra enclosure)))))
|
|
||||||
(post-ref-all post 'enclosure)))))
|
|
||||||
|
|
||||||
(define* (atom-feed #:key
|
(define* (atom-feed #:key
|
||||||
(file-name "feed.xml")
|
(file-name "feed.xml")
|
||||||
|
|
@ -174,23 +71,17 @@ SUBTITLE: The feed subtitle
|
||||||
FILTER: The procedure called to manipulate the posts list before rendering
|
FILTER: The procedure called to manipulate the posts list before rendering
|
||||||
MAX-ENTRIES: The maximum number of posts to render in the feed"
|
MAX-ENTRIES: The maximum number of posts to render in the feed"
|
||||||
(lambda (site posts)
|
(lambda (site posts)
|
||||||
(let ((uri (uri->string
|
(make-page file-name
|
||||||
(build-uri (site-scheme site)
|
`(feed (@ (xmlns "http://www.w3.org/2005/Atom"))
|
||||||
#:host (site-domain site)
|
(title ,(site-title site))
|
||||||
#:path (string-append "/" file-name)))))
|
(subtitle ,subtitle)
|
||||||
(make-page file-name
|
(updated ,(date->string* (current-date)))
|
||||||
`(feed (@ (xmlns "http://www.w3.org/2005/Atom"))
|
(link (@ (href ,(string-append "/" file-name))
|
||||||
(title ,(site-title site))
|
(rel "self")))
|
||||||
(id ,uri)
|
(link (@ (href ,(site-domain site))))
|
||||||
(subtitle ,subtitle)
|
,@(map (cut post->atom-entry site <>)
|
||||||
(updated ,(date->string* (current-date)))
|
(take-up-to max-entries (filter posts))))
|
||||||
(link (@ (href ,(string-append (site-domain site)
|
sxml->xml*)))
|
||||||
"/" file-name))
|
|
||||||
(rel "self")))
|
|
||||||
(link (@ (href ,(site-domain site))))
|
|
||||||
,@(map (cut post->atom-entry site <>)
|
|
||||||
(take-up-to max-entries (filter posts))))
|
|
||||||
sxml->xml*))))
|
|
||||||
|
|
||||||
(define* (atom-feeds-by-tag #:key
|
(define* (atom-feeds-by-tag #:key
|
||||||
(prefix "feeds/tags")
|
(prefix "feeds/tags")
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,5 @@
|
||||||
;;; Haunt --- Static site generator for GNU Guile
|
;;; Haunt --- Static site generator for GNU Guile
|
||||||
;;; Copyright © 2015 David Thompson <davet@gnu.org>
|
;;; Copyright © 2015 David Thompson <davet@gnu.org>
|
||||||
;;; Copyright © 2016 Christopher Allan Webber <cwebber@dustycloud.org>
|
|
||||||
;;;
|
;;;
|
||||||
;;; This file is part of Haunt.
|
;;; This file is part of Haunt.
|
||||||
;;;
|
;;;
|
||||||
|
|
@ -37,10 +36,8 @@
|
||||||
theme-name
|
theme-name
|
||||||
theme-layout
|
theme-layout
|
||||||
theme-post-template
|
theme-post-template
|
||||||
theme-collection-template
|
theme-list-template
|
||||||
with-layout
|
with-layout
|
||||||
render-post
|
|
||||||
render-collection
|
|
||||||
|
|
||||||
date->string*
|
date->string*
|
||||||
|
|
||||||
|
|
@ -54,37 +51,11 @@
|
||||||
(post-template theme-post-template)
|
(post-template theme-post-template)
|
||||||
(collection-template theme-collection-template))
|
(collection-template theme-collection-template))
|
||||||
|
|
||||||
(define (ugly-default-layout site title body)
|
|
||||||
`((doctype "html")
|
|
||||||
(head
|
|
||||||
(meta (@ (charset "utf-8")))
|
|
||||||
(title ,(string-append title " — " (site-title site))))
|
|
||||||
(body
|
|
||||||
(h1 ,(site-title site))
|
|
||||||
,body)))
|
|
||||||
|
|
||||||
(define (ugly-default-post-template post)
|
|
||||||
`((h2 ,(post-ref post 'title))
|
|
||||||
(h3 "by " ,(post-ref post 'author)
|
|
||||||
" — " ,(date->string* (post-date post)))
|
|
||||||
(div ,(post-sxml post))))
|
|
||||||
|
|
||||||
(define (ugly-default-collection-template site title posts)
|
|
||||||
`((h3 ,title)
|
|
||||||
(ul
|
|
||||||
,@(map (lambda (post)
|
|
||||||
`(li
|
|
||||||
(a (@ (href ,(site-post-path site post)))
|
|
||||||
,(post-ref post 'title)
|
|
||||||
" — "
|
|
||||||
,(date->string* (post-date post)))))
|
|
||||||
posts))))
|
|
||||||
|
|
||||||
(define* (theme #:key
|
(define* (theme #:key
|
||||||
(name "Untitled")
|
(name "Untitled")
|
||||||
(layout ugly-default-layout)
|
layout
|
||||||
(post-template ugly-default-post-template)
|
post-template
|
||||||
(collection-template ugly-default-collection-template))
|
collection-template)
|
||||||
(make-theme name layout post-template collection-template))
|
(make-theme name layout post-template collection-template))
|
||||||
|
|
||||||
(define (with-layout theme site title body)
|
(define (with-layout theme site title body)
|
||||||
|
|
@ -95,8 +66,8 @@
|
||||||
(body ((theme-post-template theme) post)))
|
(body ((theme-post-template theme) post)))
|
||||||
(with-layout theme site title body)))
|
(with-layout theme site title body)))
|
||||||
|
|
||||||
(define (render-collection theme site title posts)
|
(define (render-collection theme site title posts prefix)
|
||||||
(let ((body ((theme-collection-template theme) site title posts)))
|
(let ((body ((theme-collection-template theme) site title posts prefix)))
|
||||||
(with-layout theme site title body)))
|
(with-layout theme site title body)))
|
||||||
|
|
||||||
(define (date->string* date)
|
(define (date->string* date)
|
||||||
|
|
@ -105,32 +76,60 @@
|
||||||
|
|
||||||
(define ugly-theme
|
(define ugly-theme
|
||||||
(theme #:name "Ugly"
|
(theme #:name "Ugly"
|
||||||
#:layout ugly-default-layout
|
#:layout
|
||||||
#:post-template ugly-default-post-template
|
(lambda (site title body)
|
||||||
#:collection-template ugly-default-collection-template))
|
`((doctype "html")
|
||||||
|
(head
|
||||||
|
(meta (@ (charset "utf-8")))
|
||||||
|
(title ,(string-append title " — " (site-title site))))
|
||||||
|
(body
|
||||||
|
(h1 ,(site-title site))
|
||||||
|
,body)))
|
||||||
|
#:post-template
|
||||||
|
(lambda (post)
|
||||||
|
`((h2 ,(post-ref post 'title))
|
||||||
|
(h3 "by " ,(post-ref post 'author)
|
||||||
|
" — " ,(date->string* (post-date post)))
|
||||||
|
(div ,(post-sxml post))))
|
||||||
|
#:collection-template
|
||||||
|
(lambda (site title posts prefix)
|
||||||
|
(define (post-uri post)
|
||||||
|
(string-append "/" (or prefix "")
|
||||||
|
(site-post-slug site post) ".html"))
|
||||||
|
|
||||||
|
`((h3 ,title)
|
||||||
|
(ul
|
||||||
|
,@(map (lambda (post)
|
||||||
|
`(li
|
||||||
|
(a (@ (href ,(post-uri post)))
|
||||||
|
,(post-ref post 'title)
|
||||||
|
" — "
|
||||||
|
,(date->string* (post-date post)))))
|
||||||
|
posts))))))
|
||||||
|
|
||||||
(define* (blog #:key (theme ugly-theme) prefix
|
(define* (blog #:key (theme ugly-theme) prefix
|
||||||
(collections
|
(collections
|
||||||
`(("Recent Posts" "index.html" ,posts/reverse-chronological))))
|
`(("Recent Posts" "index.html" ,posts/reverse-chronological))))
|
||||||
"Return a procedure that transforms a list of posts into pages
|
"Return a procedure that transforms a list of posts into pages
|
||||||
decorated by THEME. The collection listing URL starts with PREFIX, and
|
decorated by THEME, whose URLs start with PREFIX."
|
||||||
the individual posts URLs start with POST-PREFIX."
|
(define (make-file-name base-name)
|
||||||
(define (make-file-name prefix base-name)
|
|
||||||
(if prefix
|
(if prefix
|
||||||
(string-append prefix "/" base-name)
|
(string-append prefix "/" base-name)
|
||||||
base-name))
|
base-name))
|
||||||
|
|
||||||
(lambda (site posts)
|
(lambda (site posts)
|
||||||
(define (post->page post)
|
(define (post->page post)
|
||||||
(make-page (site-post-relative-path site post)
|
(let ((base-name (string-append (site-post-slug site post)
|
||||||
(render-post theme site post)
|
".html")))
|
||||||
sxml->html))
|
(make-page (make-file-name base-name)
|
||||||
|
(render-post theme site post)
|
||||||
|
sxml->html)))
|
||||||
|
|
||||||
(define collection->page
|
(define collection->page
|
||||||
(match-lambda
|
(match-lambda
|
||||||
((title file-name filter)
|
((title file-name filter)
|
||||||
(make-page (make-file-name prefix file-name)
|
(make-page (make-file-name file-name)
|
||||||
(render-collection theme site title (filter posts))
|
(render-collection theme site title (filter posts) prefix)
|
||||||
sxml->html))))
|
sxml->html))))
|
||||||
|
|
||||||
(append (map post->page posts)
|
(append (map post->page posts)
|
||||||
|
|
|
||||||
|
|
@ -1,104 +0,0 @@
|
||||||
;;; Haunt --- Static site generator for GNU Guile
|
|
||||||
;;; Copyright © 2018 Christopher Lemmer Webber <cwebber@dustycloud.org>
|
|
||||||
;;;
|
|
||||||
;;; This file is part of Haunt.
|
|
||||||
;;;
|
|
||||||
;;; Haunt is free software; you can redistribute it and/or modify it
|
|
||||||
;;; under the terms of the GNU General Public License as published by
|
|
||||||
;;; the Free Software Foundation; either version 3 of the License, or
|
|
||||||
;;; (at your option) any later version.
|
|
||||||
;;;
|
|
||||||
;;; Haunt is distributed in the hope that it will be useful, but
|
|
||||||
;;; WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
||||||
;;; General Public License for more details.
|
|
||||||
;;;
|
|
||||||
;;; You should have received a copy of the GNU General Public License
|
|
||||||
;;; along with Haunt. If not, see <http://www.gnu.org/licenses/>.
|
|
||||||
|
|
||||||
;;; Commentary:
|
|
||||||
;;
|
|
||||||
;; RSS feed builder.
|
|
||||||
;;
|
|
||||||
;;; Code:
|
|
||||||
|
|
||||||
(define-module (haunt builder rss)
|
|
||||||
#:use-module (srfi srfi-19)
|
|
||||||
#:use-module (srfi srfi-26)
|
|
||||||
#:use-module (ice-9 match)
|
|
||||||
#:use-module (sxml simple)
|
|
||||||
#:use-module (haunt site)
|
|
||||||
#:use-module (haunt post)
|
|
||||||
#:use-module (haunt page)
|
|
||||||
#:use-module (haunt utils)
|
|
||||||
#:use-module (haunt html)
|
|
||||||
#:use-module (haunt serve mime-types)
|
|
||||||
#:use-module (haunt builder atom)
|
|
||||||
#:export (rss-feed))
|
|
||||||
|
|
||||||
;; Reader beware: this isn't as nice as atom.scm, because rss isn't
|
|
||||||
;; as nice as atom. Worse beats better on the play field again...
|
|
||||||
|
|
||||||
;; RFC 822 dates are inferior to ISO 8601, but it's
|
|
||||||
;; what RSS wants, so...
|
|
||||||
(define (date->rfc822-str date)
|
|
||||||
(date->string date "~a, ~d ~b ~Y ~T ~z"))
|
|
||||||
|
|
||||||
(define (sxml->xml* sxml port)
|
|
||||||
"Write SXML to PORT, preceded by an <?xml> tag."
|
|
||||||
(display "<?xml version=\"1.0\" encoding=\"utf-8\"?>" port)
|
|
||||||
(sxml->xml sxml port))
|
|
||||||
|
|
||||||
(define* (post->rss-item site post)
|
|
||||||
"Convert POST into an RSS <item> node."
|
|
||||||
`(item
|
|
||||||
(title ,(post-ref post 'title))
|
|
||||||
;; Looks like: <author>lawyer@boyer.net (Lawyer Boyer)</author>
|
|
||||||
(author
|
|
||||||
,(let ((email (post-ref post 'email))
|
|
||||||
(author (post-ref post 'author)))
|
|
||||||
(string-append (if email
|
|
||||||
(string-append email " ")
|
|
||||||
"")
|
|
||||||
(if author
|
|
||||||
(string-append "(" author ")")
|
|
||||||
""))))
|
|
||||||
(pubDate ,(date->rfc822-str (post-date post)))
|
|
||||||
(link (@ (href ,(site-post-url site post))
|
|
||||||
(rel "alternate")))
|
|
||||||
(description ,(sxml->html-string (post-sxml post)))
|
|
||||||
,@(map (lambda (enclosure)
|
|
||||||
`(enclosure (@ (title ,(enclosure-title enclosure))
|
|
||||||
(url ,(enclosure-url enclosure))
|
|
||||||
(type ,(enclosure-mime-type enclosure))
|
|
||||||
,@(map (match-lambda
|
|
||||||
((key . value)
|
|
||||||
(list key value)))
|
|
||||||
(enclosure-extra enclosure)))))
|
|
||||||
(post-ref-all post 'enclosure))))
|
|
||||||
|
|
||||||
(define* (rss-feed #:key
|
|
||||||
(file-name "rss-feed.xml")
|
|
||||||
(subtitle "Recent Posts")
|
|
||||||
(filter posts/reverse-chronological)
|
|
||||||
(max-entries 20))
|
|
||||||
"Return a builder procedure that renders a list of posts as an RSS
|
|
||||||
feed. All arguments are optional:
|
|
||||||
|
|
||||||
FILE-NAME: The page file name
|
|
||||||
SUBTITLE: The feed subtitle
|
|
||||||
FILTER: The procedure called to manipulate the posts list before rendering
|
|
||||||
MAX-ENTRIES: The maximum number of posts to render in the feed"
|
|
||||||
(lambda (site posts)
|
|
||||||
(make-page file-name
|
|
||||||
`(rss (@ (version "2.0"))
|
|
||||||
(channel
|
|
||||||
(title ,(site-title site))
|
|
||||||
;; It looks like RSS's description and atom's subtitle
|
|
||||||
;; are equivalent?
|
|
||||||
(description ,subtitle)
|
|
||||||
(pubDate ,(date->rfc822-str (current-date)))
|
|
||||||
(link (@ (href ,(site-domain site))))
|
|
||||||
,@(map (cut post->rss-item site <>)
|
|
||||||
(take-up-to max-entries (filter posts)))))
|
|
||||||
sxml->xml*)))
|
|
||||||
|
|
@ -57,6 +57,7 @@
|
||||||
(alist->hash-table
|
(alist->hash-table
|
||||||
'((#\" . "quot")
|
'((#\" . "quot")
|
||||||
(#\& . "amp")
|
(#\& . "amp")
|
||||||
|
(#\' . "apos")
|
||||||
(#\< . "lt")
|
(#\< . "lt")
|
||||||
(#\> . "gt"))))
|
(#\> . "gt"))))
|
||||||
|
|
||||||
|
|
@ -112,6 +113,9 @@ list ATTRS and the child nodes in BODY."
|
||||||
(() *unspecified*)
|
(() *unspecified*)
|
||||||
(('doctype type)
|
(('doctype type)
|
||||||
(doctype->html type port))
|
(doctype->html type port))
|
||||||
|
;; Unescaped, raw HTML output.
|
||||||
|
(('raw html)
|
||||||
|
(display html port))
|
||||||
(((? symbol? tag) ('@ attrs ...) body ...)
|
(((? symbol? tag) ('@ attrs ...) body ...)
|
||||||
(element->html tag attrs body port))
|
(element->html tag attrs body port))
|
||||||
(((? symbol? tag) body ...)
|
(((? symbol? tag) body ...)
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,5 @@
|
||||||
;;; Haunt --- Static site generator for GNU Guile
|
;;; Haunt --- Static site generator for GNU Guile
|
||||||
;;; Copyright © 2015 David Thompson <davet@gnu.org>
|
;;; Copyright © 2015 David Thompson <davet@gnu.org>
|
||||||
;;; Copyright © 2016 Christopher Allan Webber <cwebber@dustycloud.org>
|
|
||||||
;;;
|
;;;
|
||||||
;;; This file is part of Haunt.
|
;;; This file is part of Haunt.
|
||||||
;;;
|
;;;
|
||||||
|
|
@ -24,8 +23,6 @@
|
||||||
;;; Code:
|
;;; Code:
|
||||||
|
|
||||||
(define-module (haunt post)
|
(define-module (haunt post)
|
||||||
#:use-module (ice-9 match)
|
|
||||||
#:use-module (ice-9 rdelim)
|
|
||||||
#:use-module (srfi srfi-1)
|
#:use-module (srfi srfi-1)
|
||||||
#:use-module (srfi srfi-9)
|
#:use-module (srfi srfi-9)
|
||||||
#:use-module (srfi srfi-19)
|
#:use-module (srfi srfi-19)
|
||||||
|
|
@ -36,16 +33,14 @@
|
||||||
post-sxml
|
post-sxml
|
||||||
post-metadata
|
post-metadata
|
||||||
post-ref
|
post-ref
|
||||||
post-ref-all
|
|
||||||
post-slug
|
post-slug
|
||||||
%default-date
|
%default-date
|
||||||
post-date
|
post-date
|
||||||
posts/reverse-chronological
|
posts/reverse-chronological
|
||||||
posts/group-by-tag
|
posts/group-by-tag
|
||||||
|
|
||||||
register-metadata-parser!
|
register-metdata-parser!
|
||||||
parse-metadata
|
parse-metadata))
|
||||||
read-metadata-headers))
|
|
||||||
|
|
||||||
(define-record-type <post>
|
(define-record-type <post>
|
||||||
(make-post file-name metadata sxml)
|
(make-post file-name metadata sxml)
|
||||||
|
|
@ -58,24 +53,13 @@
|
||||||
"Return the metadata corresponding to KEY within POST."
|
"Return the metadata corresponding to KEY within POST."
|
||||||
(assq-ref (post-metadata post) key))
|
(assq-ref (post-metadata post) key))
|
||||||
|
|
||||||
(define (post-ref-all post key)
|
|
||||||
"Return a list of all metadata values for KEY within POST."
|
|
||||||
(filter-map (match-lambda
|
|
||||||
((k . v)
|
|
||||||
(and (eq? key k) v)))
|
|
||||||
(post-metadata post)))
|
|
||||||
|
|
||||||
(define char-set:slug
|
|
||||||
(char-set-union char-set:letter+digit (char-set #\-)))
|
|
||||||
|
|
||||||
(define (post-slug post)
|
(define (post-slug post)
|
||||||
"Transform the title of POST into a URL slug."
|
"Transform the title of POST into a URL slug."
|
||||||
(or (post-ref post 'slug)
|
(string-join (map (lambda (s)
|
||||||
(string-join (map (lambda (s)
|
(string-filter char-set:letter+digit s))
|
||||||
(string-filter char-set:slug s))
|
(string-split (string-downcase (post-ref post 'title))
|
||||||
(string-split (string-downcase (post-ref post 'title))
|
char-set:whitespace))
|
||||||
char-set:whitespace))
|
"-"))
|
||||||
"-")))
|
|
||||||
|
|
||||||
(define %default-date
|
(define %default-date
|
||||||
(make-date 0 0 0 0 1 1 1970 0)) ; UNIX epoch
|
(make-date 0 0 0 0 1 1 1970 0)) ; UNIX epoch
|
||||||
|
|
@ -123,20 +107,6 @@ specified."
|
||||||
(define (parse-metadata key value)
|
(define (parse-metadata key value)
|
||||||
((metadata-parser key) value))
|
((metadata-parser key) value))
|
||||||
|
|
||||||
(define (read-metadata-headers port)
|
|
||||||
(let loop ((metadata '()))
|
|
||||||
(let ((line (read-line port)))
|
|
||||||
(cond
|
|
||||||
((eof-object? line)
|
|
||||||
(error "end of file while reading metadata: " (port-filename port)))
|
|
||||||
((string=? line "---")
|
|
||||||
metadata)
|
|
||||||
(else
|
|
||||||
(match (map string-trim-both (string-split-at line #\:))
|
|
||||||
(((= string->symbol key) value)
|
|
||||||
(loop (alist-cons key (parse-metadata key value) metadata)))
|
|
||||||
(_ (error "invalid metadata format: " line))))))))
|
|
||||||
|
|
||||||
(register-metadata-parser!
|
(register-metadata-parser!
|
||||||
'tags
|
'tags
|
||||||
(lambda (str)
|
(lambda (str)
|
||||||
|
|
|
||||||
|
|
@ -30,7 +30,7 @@
|
||||||
#:use-module (ice-9 ftw)
|
#:use-module (ice-9 ftw)
|
||||||
#:use-module (ice-9 match)
|
#:use-module (ice-9 match)
|
||||||
#:use-module (ice-9 regex)
|
#:use-module (ice-9 regex)
|
||||||
#:use-module (sxml simple)
|
#:use-module (ice-9 rdelim)
|
||||||
#:use-module (haunt post)
|
#:use-module (haunt post)
|
||||||
#:use-module (haunt utils)
|
#:use-module (haunt utils)
|
||||||
#:export (make-reader
|
#:export (make-reader
|
||||||
|
|
@ -104,18 +104,18 @@ post."
|
||||||
(assq-ref contents 'content))))))
|
(assq-ref contents 'content))))))
|
||||||
|
|
||||||
(define (read-html-post port)
|
(define (read-html-post port)
|
||||||
(values (read-metadata-headers port)
|
(let loop ((metadata '()))
|
||||||
(let loop ()
|
(let ((line (read-line port)))
|
||||||
(let ((next-char (peek-char port)))
|
(cond
|
||||||
(cond
|
((eof-object? line)
|
||||||
((eof-object? next-char)
|
(error "end of file while reading metadata: " (port-filename port)))
|
||||||
'())
|
((string=? line "---")
|
||||||
((char-set-contains? char-set:whitespace next-char)
|
(values metadata `(raw ,(read-string port))))
|
||||||
(read-char port)
|
(else
|
||||||
(loop))
|
(match (map string-trim-both (string-split-at line #\:))
|
||||||
(else
|
(((= string->symbol key) value)
|
||||||
(match (xml->sxml port)
|
(loop (alist-cons key (parse-metadata key value) metadata)))
|
||||||
(('*TOP* sxml) (cons sxml (loop))))))))))
|
(_ (error "invalid metadata format: " line))))))))
|
||||||
|
|
||||||
(define html-reader
|
(define html-reader
|
||||||
(make-reader (make-file-extension-matcher "html")
|
(make-reader (make-file-extension-matcher "html")
|
||||||
|
|
|
||||||
|
|
@ -1,37 +0,0 @@
|
||||||
;;; Haunt --- Static site generator for GNU Guile
|
|
||||||
;;; Copyright © 2016 Erik Edrosa <erik.edrosa@gmail.com>
|
|
||||||
;;;
|
|
||||||
;;; This file is part of Haunt.
|
|
||||||
;;;
|
|
||||||
;;; Haunt is free software; you can redistribute it and/or modify it
|
|
||||||
;;; under the terms of the GNU General Public License as published by
|
|
||||||
;;; the Free Software Foundation; either version 3 of the License, or
|
|
||||||
;;; (at your option) any later version.
|
|
||||||
;;;
|
|
||||||
;;; Haunt is distributed in the hope that it will be useful, but
|
|
||||||
;;; WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
||||||
;;; General Public License for more details.
|
|
||||||
;;;
|
|
||||||
;;; You should have received a copy of the GNU General Public License
|
|
||||||
;;; along with Haunt. If not, see <http://www.gnu.org/licenses/>.
|
|
||||||
|
|
||||||
;;; Commentary:
|
|
||||||
;;
|
|
||||||
;; CommonMark post reader.
|
|
||||||
;;
|
|
||||||
;;; Code:
|
|
||||||
|
|
||||||
(define-module (haunt reader commonmark)
|
|
||||||
#:use-module (commonmark)
|
|
||||||
#:use-module (haunt post)
|
|
||||||
#:use-module (haunt reader)
|
|
||||||
#:export (commonmark-reader))
|
|
||||||
|
|
||||||
(define commonmark-reader
|
|
||||||
(make-reader (make-file-extension-matcher "md")
|
|
||||||
(lambda (file)
|
|
||||||
(call-with-input-file file
|
|
||||||
(lambda (port)
|
|
||||||
(values (read-metadata-headers port)
|
|
||||||
(commonmark->sxml port)))))))
|
|
||||||
|
|
@ -1,44 +0,0 @@
|
||||||
;;; Haunt --- Static site generator for GNU Guile
|
|
||||||
;;; Copyright © 2015 David Thompson <davet@gnu.org>
|
|
||||||
;;;
|
|
||||||
;;; This file is part of Haunt.
|
|
||||||
;;;
|
|
||||||
;;; Haunt is free software; you can redistribute it and/or modify it
|
|
||||||
;;; under the terms of the GNU General Public License as published by
|
|
||||||
;;; the Free Software Foundation; either version 3 of the License, or
|
|
||||||
;;; (at your option) any later version.
|
|
||||||
;;;
|
|
||||||
;;; Haunt is distributed in the hope that it will be useful, but
|
|
||||||
;;; WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
||||||
;;; General Public License for more details.
|
|
||||||
;;;
|
|
||||||
;;; You should have received a copy of the GNU General Public License
|
|
||||||
;;; along with Haunt. If not, see <http://www.gnu.org/licenses/>.
|
|
||||||
|
|
||||||
;;; Commentary:
|
|
||||||
;;
|
|
||||||
;; Skribe post reader.
|
|
||||||
;;
|
|
||||||
;;; Code:
|
|
||||||
|
|
||||||
(define-module (haunt reader skribe)
|
|
||||||
#:use-module (haunt reader)
|
|
||||||
#:use-module (haunt skribe)
|
|
||||||
#:use-module (haunt skribe utils)
|
|
||||||
#:use-module (haunt utils)
|
|
||||||
#:export (make-skribe-reader
|
|
||||||
skribe-reader))
|
|
||||||
|
|
||||||
(define* (make-skribe-reader #:key (modules '((haunt skribe utils))))
|
|
||||||
"Return a new Skribe post reader that imports MODULES by default
|
|
||||||
before reading a document."
|
|
||||||
(make-reader (make-file-extension-matcher "skr")
|
|
||||||
(lambda (file)
|
|
||||||
(let ((file (absolute-file-name file)))
|
|
||||||
(save-module-excursion
|
|
||||||
(lambda ()
|
|
||||||
(set-current-module (make-user-module modules))
|
|
||||||
(load file %skribe-reader)))))))
|
|
||||||
|
|
||||||
(define skribe-reader (make-skribe-reader))
|
|
||||||
|
|
@ -1,42 +0,0 @@
|
||||||
;;; Haunt --- Static site generator for GNU Guile
|
|
||||||
;;; Copyright © 2015 David Thompson <davet@gnu.org>
|
|
||||||
;;;
|
|
||||||
;;; This file is part of Haunt.
|
|
||||||
;;;
|
|
||||||
;;; Haunt is free software; you can redistribute it and/or modify it
|
|
||||||
;;; under the terms of the GNU General Public License as published by
|
|
||||||
;;; the Free Software Foundation; either version 3 of the License, or
|
|
||||||
;;; (at your option) any later version.
|
|
||||||
;;;
|
|
||||||
;;; Haunt is distributed in the hope that it will be useful, but
|
|
||||||
;;; WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
||||||
;;; General Public License for more details.
|
|
||||||
;;;
|
|
||||||
;;; You should have received a copy of the GNU General Public License
|
|
||||||
;;; along with Haunt. If not, see <http://www.gnu.org/licenses/>.
|
|
||||||
|
|
||||||
;;; Commentary:
|
|
||||||
;;
|
|
||||||
;; Texinfo post reader.
|
|
||||||
;;
|
|
||||||
;;; Code:
|
|
||||||
|
|
||||||
(define-module (haunt reader texinfo)
|
|
||||||
#:use-module (texinfo)
|
|
||||||
#:use-module (texinfo html)
|
|
||||||
#:use-module (haunt post)
|
|
||||||
#:use-module (haunt reader)
|
|
||||||
#:use-module (haunt utils)
|
|
||||||
#:export (texinfo-reader))
|
|
||||||
|
|
||||||
(define texi->shtml
|
|
||||||
(compose stexi->shtml texi-fragment->stexi))
|
|
||||||
|
|
||||||
(define texinfo-reader
|
|
||||||
(make-reader (make-file-extension-matcher "texi")
|
|
||||||
(lambda (file)
|
|
||||||
(call-with-input-file file
|
|
||||||
(lambda (port)
|
|
||||||
(values (read-metadata-headers port)
|
|
||||||
(texi->shtml port)))))))
|
|
||||||
|
|
@ -539,10 +539,16 @@
|
||||||
("vrml" . x-world/x-vrml)
|
("vrml" . x-world/x-vrml)
|
||||||
("wrl" . x-world/x-vrml))))
|
("wrl" . x-world/x-vrml))))
|
||||||
|
|
||||||
(define (file-extension file)
|
(define %file-ext-regexp
|
||||||
"Return the extension of FILE or #f if there is none."
|
(make-regexp "(\\.(.*)|[~%])$"))
|
||||||
(let ((dot (string-rindex file #\.)))
|
|
||||||
(and dot (substring file (+ 1 dot) (string-length file)))))
|
(define (file-extension file-name)
|
||||||
|
"Return the file extension for FILE-NAME, or #f if one is not
|
||||||
|
found."
|
||||||
|
(and=> (regexp-exec %file-ext-regexp file-name)
|
||||||
|
(lambda (match)
|
||||||
|
(or (match:substring match 2)
|
||||||
|
(match:substring match 1)))))
|
||||||
|
|
||||||
(define (mime-type file-name)
|
(define (mime-type file-name)
|
||||||
"Guess the MIME type for FILE-NAME based upon its file extension."
|
"Guess the MIME type for FILE-NAME based upon its file extension."
|
||||||
|
|
|
||||||
|
|
@ -33,37 +33,30 @@
|
||||||
#:use-module (haunt page)
|
#:use-module (haunt page)
|
||||||
#:use-module (haunt post)
|
#:use-module (haunt post)
|
||||||
#:use-module (haunt asset)
|
#:use-module (haunt asset)
|
||||||
#:use-module (web uri)
|
|
||||||
#:export (site
|
#:export (site
|
||||||
site?
|
site?
|
||||||
site-title
|
site-title
|
||||||
site-domain
|
site-domain
|
||||||
site-scheme
|
|
||||||
site-posts-directory
|
site-posts-directory
|
||||||
site-posts-output-directory
|
|
||||||
site-file-filter
|
site-file-filter
|
||||||
site-build-directory
|
site-build-directory
|
||||||
site-default-metadata
|
site-default-metadata
|
||||||
site-make-slug
|
site-make-slug
|
||||||
site-readers
|
site-readers
|
||||||
site-builders
|
site-builders
|
||||||
site-post-path
|
site-post-slug
|
||||||
site-post-relative-path
|
|
||||||
site-post-url
|
|
||||||
build-site
|
build-site
|
||||||
|
|
||||||
make-file-filter
|
make-file-filter
|
||||||
default-file-filter))
|
default-file-filter))
|
||||||
|
|
||||||
(define-record-type <site>
|
(define-record-type <site>
|
||||||
(make-site title domain scheme posts-directory posts-output-directory file-filter
|
(make-site title domain posts-directory file-filter build-directory
|
||||||
build-directory default-metadata make-slug readers builders)
|
default-metadata make-slug readers builders)
|
||||||
site?
|
site?
|
||||||
(title site-title)
|
(title site-title)
|
||||||
(domain site-domain)
|
(domain site-domain)
|
||||||
(scheme site-scheme) ; https or http
|
|
||||||
(posts-directory site-posts-directory)
|
(posts-directory site-posts-directory)
|
||||||
(posts-output-directory site-posts-output-directory)
|
|
||||||
(file-filter site-file-filter)
|
(file-filter site-file-filter)
|
||||||
(build-directory site-build-directory)
|
(build-directory site-build-directory)
|
||||||
(default-metadata site-default-metadata)
|
(default-metadata site-default-metadata)
|
||||||
|
|
@ -74,9 +67,7 @@
|
||||||
(define* (site #:key
|
(define* (site #:key
|
||||||
(title "This Place is Haunted")
|
(title "This Place is Haunted")
|
||||||
(domain "example.com")
|
(domain "example.com")
|
||||||
(scheme 'https)
|
|
||||||
(posts-directory "posts")
|
(posts-directory "posts")
|
||||||
(posts-output-directory "")
|
|
||||||
(file-filter default-file-filter)
|
(file-filter default-file-filter)
|
||||||
(build-directory "site")
|
(build-directory "site")
|
||||||
(default-metadata '())
|
(default-metadata '())
|
||||||
|
|
@ -86,10 +77,7 @@
|
||||||
"Create a new site object. All arguments are optional:
|
"Create a new site object. All arguments are optional:
|
||||||
|
|
||||||
TITLE: The name of the site
|
TITLE: The name of the site
|
||||||
DOMAIN: The domain that will host the site
|
|
||||||
SCHEME: Either 'https' or 'http' ('https' by default)
|
|
||||||
POSTS-DIRECTORY: The directory where posts are found
|
POSTS-DIRECTORY: The directory where posts are found
|
||||||
POSTS-OUTPUT-DIRECTORY: The directory to store the built posts in
|
|
||||||
FILE-FILTER: A predicate procedure that returns #f when a post file
|
FILE-FILTER: A predicate procedure that returns #f when a post file
|
||||||
should be ignored, and #f otherwise. Emacs temp files are ignored by
|
should be ignored, and #f otherwise. Emacs temp files are ignored by
|
||||||
default.
|
default.
|
||||||
|
|
@ -99,33 +87,13 @@ whose keys are symbols
|
||||||
MAKE-SLUG: A procedure generating a file name slug from a post
|
MAKE-SLUG: A procedure generating a file name slug from a post
|
||||||
READERS: A list of reader objects for processing posts
|
READERS: A list of reader objects for processing posts
|
||||||
BUILDERS: A list of procedures for building pages from posts"
|
BUILDERS: A list of procedures for building pages from posts"
|
||||||
(make-site title domain scheme posts-directory posts-output-directory file-filter
|
(make-site title domain posts-directory file-filter build-directory
|
||||||
build-directory default-metadata make-slug readers builders))
|
default-metadata make-slug readers builders))
|
||||||
|
|
||||||
(define (site-post-slug site post)
|
(define (site-post-slug site post)
|
||||||
"Return a slug string for POST using the slug generator for SITE."
|
"Return a slug string for POST using the slug generator for SITE."
|
||||||
((site-make-slug site) post))
|
((site-make-slug site) post))
|
||||||
|
|
||||||
(define (site-post-relative-path site post)
|
|
||||||
"Return a relative path to a POST, without the preceding slash `/'."
|
|
||||||
(let ((base-path (string-trim-right (site-posts-output-directory site)
|
|
||||||
(lambda (c) (equal? c #\/)))))
|
|
||||||
(string-append (if (equal? base-path "")
|
|
||||||
""
|
|
||||||
(string-append base-path "/"))
|
|
||||||
(site-post-slug site post)
|
|
||||||
".html")))
|
|
||||||
|
|
||||||
(define (site-post-path site post)
|
|
||||||
"Return a path to a POST, with the preceding slash `/'."
|
|
||||||
(string-append "/" (site-post-relative-path site post)))
|
|
||||||
|
|
||||||
(define (site-post-url site post)
|
|
||||||
"Return a full URL to a POST."
|
|
||||||
(build-uri (site-scheme site)
|
|
||||||
#:host (site-domain site)
|
|
||||||
#:path (site-post-path site post)))
|
|
||||||
|
|
||||||
(define (build-site site)
|
(define (build-site site)
|
||||||
"Build SITE in the appropriate build directory."
|
"Build SITE in the appropriate build directory."
|
||||||
(let ((posts (if (file-exists? (site-posts-directory site))
|
(let ((posts (if (file-exists? (site-posts-directory site))
|
||||||
|
|
|
||||||
|
|
@ -1,84 +0,0 @@
|
||||||
;;; Haunt --- Static site generator for GNU Guile
|
|
||||||
;;; Copyright © 2015 David Thompson <davet@gnu.org>
|
|
||||||
;;; Copyright 2005, 2006 Ludovic Courtès <ludovic.courtes@laas.fr>
|
|
||||||
;;;
|
|
||||||
;;; This file is part of Haunt.
|
|
||||||
;;;
|
|
||||||
;;; Haunt is free software; you can redistribute it and/or modify it
|
|
||||||
;;; under the terms of the GNU General Public License as published by
|
|
||||||
;;; the Free Software Foundation; either version 3 of the License, or
|
|
||||||
;;; (at your option) any later version.
|
|
||||||
;;;
|
|
||||||
;;; Haunt is distributed in the hope that it will be useful, but
|
|
||||||
;;; WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
||||||
;;; General Public License for more details.
|
|
||||||
;;;
|
|
||||||
;;; You should have received a copy of the GNU General Public License
|
|
||||||
;;; along with Haunt. If not, see <http://www.gnu.org/licenses/>.
|
|
||||||
|
|
||||||
;;; Commentary:
|
|
||||||
;;
|
|
||||||
;; Skribe reader.
|
|
||||||
;; Much code taken from the excellent Skribilo project.
|
|
||||||
;;
|
|
||||||
;;; Code:
|
|
||||||
|
|
||||||
(define-module (haunt skribe)
|
|
||||||
#:use-module ((system reader) #:renamer (symbol-prefix-proc 'r:))
|
|
||||||
#:export (%skribe-reader))
|
|
||||||
|
|
||||||
;; Taken from Skribilo
|
|
||||||
(define (make-colon-free-token-reader tr)
|
|
||||||
;; Stolen from `guile-reader' 0.3.
|
|
||||||
"If token reader @var{tr} handles the @code{:} (colon) character, remove it
|
|
||||||
from its specification and return the new token reader."
|
|
||||||
(let* ((spec (r:token-reader-specification tr))
|
|
||||||
(proc (r:token-reader-procedure tr)))
|
|
||||||
(r:make-token-reader (filter (lambda (chr)
|
|
||||||
(not (char=? chr #\:)))
|
|
||||||
spec)
|
|
||||||
proc)))
|
|
||||||
|
|
||||||
(define &sharp-reader
|
|
||||||
;; The reader for what comes after a `#' character.
|
|
||||||
(let* ((dsssl-keyword-reader ;; keywords à la `#!key'
|
|
||||||
(r:make-token-reader #\!
|
|
||||||
(r:token-reader-procedure
|
|
||||||
(r:standard-token-reader 'keyword)))))
|
|
||||||
(r:make-reader (cons dsssl-keyword-reader
|
|
||||||
(map r:standard-token-reader
|
|
||||||
'(character srfi-4 vector
|
|
||||||
number+radix boolean
|
|
||||||
srfi30-block-comment
|
|
||||||
srfi62-sexp-comment)))
|
|
||||||
#f ;; use default fault handler
|
|
||||||
'reader/record-positions)))
|
|
||||||
|
|
||||||
(define (make-skribe-reader)
|
|
||||||
(let ((colon-keywords ;; keywords à la `:key' fashion
|
|
||||||
(r:make-token-reader #\:
|
|
||||||
(r:token-reader-procedure
|
|
||||||
(r:standard-token-reader 'keyword))))
|
|
||||||
(symbol-misc-chars-tr
|
|
||||||
;; Make sure `:' is handled only by the keyword token reader.
|
|
||||||
(make-colon-free-token-reader
|
|
||||||
(r:standard-token-reader 'r6rs-symbol-misc-chars))))
|
|
||||||
|
|
||||||
;; Note: we use the `r6rs-symbol-*' and `r6rs-number' token readers since
|
|
||||||
;; they consider square brackets as delimiters.
|
|
||||||
(r:make-reader (cons* (r:make-token-reader #\# &sharp-reader)
|
|
||||||
colon-keywords
|
|
||||||
symbol-misc-chars-tr
|
|
||||||
(map r:standard-token-reader
|
|
||||||
`(whitespace
|
|
||||||
sexp string r6rs-number
|
|
||||||
r6rs-symbol-lower-case
|
|
||||||
r6rs-symbol-upper-case
|
|
||||||
quote-quasiquote-unquote
|
|
||||||
semicolon-comment
|
|
||||||
skribe-exp)))
|
|
||||||
#f ;; use the default fault handler
|
|
||||||
'reader/record-positions)))
|
|
||||||
|
|
||||||
(define %skribe-reader (make-skribe-reader))
|
|
||||||
|
|
@ -1,89 +0,0 @@
|
||||||
;;; Haunt --- Static site generator for GNU Guile
|
|
||||||
;;; Copyright © 2015 David Thompson <davet@gnu.org>
|
|
||||||
;;;
|
|
||||||
;;; This file is part of Haunt.
|
|
||||||
;;;
|
|
||||||
;;; Haunt is free software; you can redistribute it and/or modify it
|
|
||||||
;;; under the terms of the GNU General Public License as published by
|
|
||||||
;;; the Free Software Foundation; either version 3 of the License, or
|
|
||||||
;;; (at your option) any later version.
|
|
||||||
;;;
|
|
||||||
;;; Haunt is distributed in the hope that it will be useful, but
|
|
||||||
;;; WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
||||||
;;; General Public License for more details.
|
|
||||||
;;;
|
|
||||||
;;; You should have received a copy of the GNU General Public License
|
|
||||||
;;; along with Haunt. If not, see <http://www.gnu.org/licenses/>.
|
|
||||||
|
|
||||||
;;; Commentary:
|
|
||||||
;;
|
|
||||||
;; Skribe helper procedures.
|
|
||||||
;;
|
|
||||||
;;; Code:
|
|
||||||
|
|
||||||
(define-module (haunt skribe utils)
|
|
||||||
#:use-module (ice-9 match)
|
|
||||||
#:use-module (srfi srfi-1)
|
|
||||||
#:use-module (srfi srfi-19)
|
|
||||||
#:export (post
|
|
||||||
|
|
||||||
p blockquote em
|
|
||||||
h1 h2 h3 h4 h5 h6
|
|
||||||
section
|
|
||||||
nav aside
|
|
||||||
code pre strong
|
|
||||||
ul ol li dl dt dd
|
|
||||||
anchor
|
|
||||||
image
|
|
||||||
source-code
|
|
||||||
|
|
||||||
make-date*))
|
|
||||||
|
|
||||||
(define (post . metadata+sxml)
|
|
||||||
"Create a new Skribe post by parsing out the metadata and SXML
|
|
||||||
contents from METADATA+SXML."
|
|
||||||
(let loop ((stuff metadata+sxml)
|
|
||||||
(metadata '()))
|
|
||||||
(match stuff
|
|
||||||
(() (values metadata '()))
|
|
||||||
(((and (? keyword?) (= keyword->symbol key)) value . rest)
|
|
||||||
(loop rest (alist-cons key value metadata)))
|
|
||||||
(_ (values metadata stuff)))))
|
|
||||||
|
|
||||||
;; Basic SXML constructors.
|
|
||||||
(define-syntax-rule (define-simple-sxml-constructors tag ...)
|
|
||||||
(begin
|
|
||||||
(define (tag . contents)
|
|
||||||
`(tag ,@contents)) ...))
|
|
||||||
|
|
||||||
(define-simple-sxml-constructors
|
|
||||||
p blockquote
|
|
||||||
em strong
|
|
||||||
code samp pre kbd var
|
|
||||||
cite dfn abbr
|
|
||||||
h1 h2 h3 h4 h5 h6
|
|
||||||
section
|
|
||||||
nav aside
|
|
||||||
ul ol li dl dt dd)
|
|
||||||
|
|
||||||
(define (anchor text uri)
|
|
||||||
"Return an anchor SXML node that contains TEXT and points to to URI."
|
|
||||||
`(a (@ (href ,uri)) ,text))
|
|
||||||
|
|
||||||
(define* (image uri #:key (alt-text ""))
|
|
||||||
"Return an image SXML node that points to a URI for an image.
|
|
||||||
Optionally, the ALT-TEXT keyword argument may be a string that
|
|
||||||
contains a description of the image."
|
|
||||||
`(img (@ (src ,uri) (alt ,alt-text))))
|
|
||||||
|
|
||||||
(define (source-code . code)
|
|
||||||
"Return an SXML node that wraps CODE in a 'pre' and 'code' tag to
|
|
||||||
create a code block."
|
|
||||||
`(pre (code ,code)))
|
|
||||||
|
|
||||||
(define* (make-date* year month day #:optional (hour 0) (minute 0))
|
|
||||||
"Create a SRFI-19 date for the given YEAR, MONTH, DAY, HOUR (24-hour
|
|
||||||
format), and MINUTE."
|
|
||||||
(let ((tzoffset (tm:gmtoff (localtime (time-second (current-time))))))
|
|
||||||
(make-date 0 0 minute hour day month year tzoffset)))
|
|
||||||
|
|
@ -124,9 +124,6 @@ There is NO WARRANTY, to the extent permitted by law.~%"
|
||||||
(apply command-main args))))
|
(apply command-main args))))
|
||||||
|
|
||||||
(define* (haunt-main arg0 . args)
|
(define* (haunt-main arg0 . args)
|
||||||
;; Add haunt site directory to Guile's load path so that user's can
|
|
||||||
;; easily import their own modules.
|
|
||||||
(add-to-load-path (getcwd))
|
|
||||||
(setlocale LC_ALL "")
|
(setlocale LC_ALL "")
|
||||||
(match args
|
(match args
|
||||||
(()
|
(()
|
||||||
|
|
|
||||||
|
|
@ -28,7 +28,6 @@
|
||||||
#:use-module (ice-9 match)
|
#:use-module (ice-9 match)
|
||||||
#:use-module (ice-9 format)
|
#:use-module (ice-9 format)
|
||||||
#:use-module (ice-9 ftw)
|
#:use-module (ice-9 ftw)
|
||||||
#:use-module (ice-9 threads)
|
|
||||||
#:use-module (haunt site)
|
#:use-module (haunt site)
|
||||||
#:use-module (haunt config)
|
#:use-module (haunt config)
|
||||||
#:use-module (haunt ui)
|
#:use-module (haunt ui)
|
||||||
|
|
@ -71,19 +70,6 @@ Start an HTTP server for the current site.~%")
|
||||||
(cons '(port . 8080)
|
(cons '(port . 8080)
|
||||||
%default-common-options))
|
%default-common-options))
|
||||||
|
|
||||||
(define (call-with-error-handling thunk)
|
|
||||||
(catch #t
|
|
||||||
thunk
|
|
||||||
(lambda (key . args)
|
|
||||||
(let ((cep (current-error-port))
|
|
||||||
(stack (make-stack #t 1)))
|
|
||||||
(display "ERROR: site rebuild failed\n\n" cep)
|
|
||||||
(display "Backtrace:\n" cep)
|
|
||||||
(display-backtrace stack cep)
|
|
||||||
(newline cep)
|
|
||||||
(apply display-error (stack-ref stack 0) cep args)
|
|
||||||
(newline cep)))))
|
|
||||||
|
|
||||||
;; XXX: Make this less naive.
|
;; XXX: Make this less naive.
|
||||||
(define (watch config-file check-dir? check-file?)
|
(define (watch config-file check-dir? check-file?)
|
||||||
"Watch the current working directory for changes to any of its files
|
"Watch the current working directory for changes to any of its files
|
||||||
|
|
@ -114,9 +100,7 @@ site."
|
||||||
(let loop ((time (current-time)))
|
(let loop ((time (current-time)))
|
||||||
(when (any-files-changed? time)
|
(when (any-files-changed? time)
|
||||||
(display "rebuilding...\n")
|
(display "rebuilding...\n")
|
||||||
(call-with-error-handling
|
(build-site (load-config config-file)))
|
||||||
(lambda ()
|
|
||||||
(build-site (load-config config-file)))))
|
|
||||||
(let ((next-time (current-time)))
|
(let ((next-time (current-time)))
|
||||||
(sleep 1)
|
(sleep 1)
|
||||||
(loop next-time))))
|
(loop next-time))))
|
||||||
|
|
@ -141,4 +125,4 @@ site."
|
||||||
(string-prefix? (string-append cwd "/" build-dir) dir))))
|
(string-prefix? (string-append cwd "/" build-dir) dir))))
|
||||||
(site-file-filter site)))))
|
(site-file-filter site)))))
|
||||||
|
|
||||||
(serve doc-root #:open-params `(#:port ,port))))
|
(serve doc-root)))
|
||||||
|
|
|
||||||
|
|
@ -38,8 +38,7 @@
|
||||||
delete-file-recursively
|
delete-file-recursively
|
||||||
mkdir-p
|
mkdir-p
|
||||||
string->date*
|
string->date*
|
||||||
take-up-to
|
take-up-to))
|
||||||
make-user-module))
|
|
||||||
|
|
||||||
(define* (flatten lst #:optional depth)
|
(define* (flatten lst #:optional depth)
|
||||||
"Return a list that recursively concatenates the sub-lists of LST,
|
"Return a list that recursively concatenates the sub-lists of LST,
|
||||||
|
|
@ -57,18 +56,9 @@ flattened."
|
||||||
lst)))
|
lst)))
|
||||||
|
|
||||||
(define (flat-map proc . lsts)
|
(define (flat-map proc . lsts)
|
||||||
"Apply PROC to each element of each list in LSTS and return a new
|
|
||||||
list in which nested lists are concatenated into the result.
|
|
||||||
|
|
||||||
For example, the list (1 2 (3)) would be flattened to (1 2 3)."
|
|
||||||
(flatten (apply map proc lsts) 1))
|
(flatten (apply map proc lsts) 1))
|
||||||
|
|
||||||
(define (string-split-at str char-pred)
|
(define (string-split-at str char-pred)
|
||||||
"Split STR at the first character that matches CHAR-PRED and return
|
|
||||||
a list of one or two strings. Two strings are returned if the string
|
|
||||||
was able to be split, with the character matching CHAR-PRED removed.
|
|
||||||
A list containing only STR is returned if CHAR-PRED does not match any
|
|
||||||
charcter."
|
|
||||||
(let ((i (string-index str char-pred)))
|
(let ((i (string-index str char-pred)))
|
||||||
(if i
|
(if i
|
||||||
(list (string-take str i)
|
(list (string-take str i)
|
||||||
|
|
@ -77,20 +67,15 @@ charcter."
|
||||||
|
|
||||||
(define (file-name-components file-name)
|
(define (file-name-components file-name)
|
||||||
"Split FILE-NAME into the components delimited by '/'."
|
"Split FILE-NAME into the components delimited by '/'."
|
||||||
(match file-name
|
(if (string-null? file-name)
|
||||||
("" '())
|
'()
|
||||||
("/" '(""))
|
(string-split file-name #\/)))
|
||||||
(_ (remove string-null? (string-split file-name #\/)))))
|
|
||||||
|
|
||||||
(define (join-file-name-components components)
|
(define (join-file-name-components components)
|
||||||
"Join COMPONENTS into a file name string."
|
"Join COMPONENTS into a file name string."
|
||||||
(string-join components "/" 'prefix))
|
(string-join components "/"))
|
||||||
|
|
||||||
(define (absolute-file-name file-name)
|
(define (absolute-file-name file-name)
|
||||||
"Return a an absolute file name string relative to the current
|
|
||||||
working directory for FILE-NAME, a relative file name string. If
|
|
||||||
FILE-NAME happens to already be absolute, FILE-NAME is returned
|
|
||||||
as-is."
|
|
||||||
(if (absolute-file-name? file-name)
|
(if (absolute-file-name? file-name)
|
||||||
file-name
|
file-name
|
||||||
(string-append (getcwd) "/" file-name)))
|
(string-append (getcwd) "/" file-name)))
|
||||||
|
|
@ -161,11 +146,3 @@ are fewer than N elements."
|
||||||
(() '())
|
(() '())
|
||||||
((head . tail)
|
((head . tail)
|
||||||
(cons head (take-up-to (1- n) tail))))))
|
(cons head (take-up-to (1- n) tail))))))
|
||||||
|
|
||||||
(define (make-user-module modules)
|
|
||||||
"Return a new user module with the additional MODULES loaded."
|
|
||||||
(let ((module (make-fresh-user-module)))
|
|
||||||
(for-each (lambda (iface)
|
|
||||||
(module-use! module (resolve-interface iface)))
|
|
||||||
modules)
|
|
||||||
module))
|
|
||||||
|
|
|
||||||
|
|
@ -20,11 +20,11 @@
|
||||||
;;
|
;;
|
||||||
;; GNU Guix development package. To build and install, run:
|
;; GNU Guix development package. To build and install, run:
|
||||||
;;
|
;;
|
||||||
;; guix package -f guix.scm
|
;; guix package -e '(primitive-load "package.scm")'
|
||||||
;;
|
;;
|
||||||
;; To use as the basis for a development environment, run:
|
;; To use as the basis for a development environment, run:
|
||||||
;;
|
;;
|
||||||
;; guix environment -l guix.scm
|
;; guix environment -l package.scm
|
||||||
;;
|
;;
|
||||||
;;; Code:
|
;;; Code:
|
||||||
|
|
||||||
|
|
@ -34,22 +34,19 @@
|
||||||
(guix build-system gnu)
|
(guix build-system gnu)
|
||||||
(gnu packages)
|
(gnu packages)
|
||||||
(gnu packages autotools)
|
(gnu packages autotools)
|
||||||
(gnu packages guile)
|
(gnu packages guile))
|
||||||
(gnu packages guile-xyz)
|
|
||||||
(gnu packages pkg-config)
|
|
||||||
(gnu packages texinfo))
|
|
||||||
|
|
||||||
(package
|
(package
|
||||||
(name "haunt")
|
(name "haunt")
|
||||||
(version "0.2")
|
(version "0.1")
|
||||||
(source (origin
|
(source (origin
|
||||||
(method git-fetch)
|
(method git-fetch)
|
||||||
(uri (git-reference
|
(uri (git-reference
|
||||||
(url "git://dthompson.us/haunt.git")
|
(url "git://dthompson.us/haunt.git")
|
||||||
(commit "f0a7c2b14a201448432d3564d851ee0686d5b1b1")))
|
(commit "f012747")))
|
||||||
(sha256
|
(sha256
|
||||||
(base32
|
(base32
|
||||||
"1dnzsw18blhr8admw48zbl3ilz3iiqmb149i37y820h0imqfli0v"))))
|
"0gj4xw79g3q87m6js0mbvv437zf7df5d2xg4sx65mpgc85j7zafs"))))
|
||||||
(build-system gnu-build-system)
|
(build-system gnu-build-system)
|
||||||
(arguments
|
(arguments
|
||||||
'(#:phases
|
'(#:phases
|
||||||
|
|
@ -58,14 +55,9 @@
|
||||||
(lambda _ (zero? (system* "sh" "bootstrap")))))))
|
(lambda _ (zero? (system* "sh" "bootstrap")))))))
|
||||||
(native-inputs
|
(native-inputs
|
||||||
`(("autoconf" ,autoconf)
|
`(("autoconf" ,autoconf)
|
||||||
("automake" ,automake)
|
("automake" ,automake)))
|
||||||
("pkg-config" ,pkg-config)
|
|
||||||
("texinfo" ,texinfo)))
|
|
||||||
(inputs
|
(inputs
|
||||||
`(("guile" ,guile-2.2)))
|
`(("guile" ,guile-2.0)))
|
||||||
(propagated-inputs
|
|
||||||
`(("guile-commonmark" ,guile-commonmark)
|
|
||||||
("guile-reader" ,guile-reader)))
|
|
||||||
(synopsis "Functional static site generator")
|
(synopsis "Functional static site generator")
|
||||||
(description "Haunt is a static site generator written in Guile
|
(description "Haunt is a static site generator written in Guile
|
||||||
Scheme. Haunt features a functional build system and an extensible
|
Scheme. Haunt features a functional build system and an extensible
|
||||||
23
test-env.in
23
test-env.in
|
|
@ -1,23 +0,0 @@
|
||||||
#!/bin/sh
|
|
||||||
|
|
||||||
# Haunt --- Static site generator for GNU Guile
|
|
||||||
# Copyright © 2015 David Thompson <davet@gnu.org>
|
|
||||||
#
|
|
||||||
# This file is part of Haunt.
|
|
||||||
#
|
|
||||||
# Haunt is free software; you can redistribute it and/or modify it
|
|
||||||
# under the terms of the GNU General Public License as published by
|
|
||||||
# the Free Software Foundation; either version 3 of the License, or
|
|
||||||
# (at your option) any later version.
|
|
||||||
#
|
|
||||||
# Haunt is distributed in the hope that it will be useful, but WITHOUT
|
|
||||||
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
|
|
||||||
# or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
|
|
||||||
# License for more details.
|
|
||||||
#
|
|
||||||
# You should have received a copy of the GNU General Public License
|
|
||||||
# along with Haunt. If not, see <http://www.gnu.org/licenses/>.
|
|
||||||
|
|
||||||
"@abs_top_builddir@/pre-inst-env" "$@"
|
|
||||||
|
|
||||||
exit $?
|
|
||||||
|
|
@ -1,85 +0,0 @@
|
||||||
;;; Haunt --- Static site generator for GNU Guile
|
|
||||||
;;; Copyright © 2015 David Thompson <davet@gnu.org>
|
|
||||||
;;;
|
|
||||||
;;; This file is part of Haunt.
|
|
||||||
;;;
|
|
||||||
;;; Haunt is free software; you can redistribute it and/or modify it
|
|
||||||
;;; under the terms of the GNU General Public License as published by
|
|
||||||
;;; the Free Software Foundation; either version 3 of the License, or
|
|
||||||
;;; (at your option) any later version.
|
|
||||||
;;;
|
|
||||||
;;; Haunt is distributed in the hope that it will be useful, but
|
|
||||||
;;; WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
||||||
;;; General Public License for more details.
|
|
||||||
;;;
|
|
||||||
;;; You should have received a copy of the GNU General Public License
|
|
||||||
;;; along with Haunt. If not, see <http://www.gnu.org/licenses/>.
|
|
||||||
|
|
||||||
(define-module (test-post)
|
|
||||||
#:use-module (srfi srfi-19)
|
|
||||||
#:use-module (srfi srfi-64)
|
|
||||||
#:use-module (haunt post))
|
|
||||||
|
|
||||||
(test-begin "post")
|
|
||||||
|
|
||||||
(define (make-date* year month day)
|
|
||||||
(make-date 0 0 0 0 day month year 0))
|
|
||||||
|
|
||||||
(define %tzoffset
|
|
||||||
(date-zone-offset (string->date "2015-09-05" "~Y~m~d")))
|
|
||||||
|
|
||||||
(test-equal "post-ref"
|
|
||||||
'(hello test)
|
|
||||||
(post-ref (make-post "foo.skr" '((tags hello test)) '()) 'tags))
|
|
||||||
|
|
||||||
(test-equal "post-slug"
|
|
||||||
"hello-world"
|
|
||||||
(post-slug (make-post "foo.skr" '((title . "Hello, world!")) '())))
|
|
||||||
|
|
||||||
(test-equal "post-date, no date metadata"
|
|
||||||
%default-date
|
|
||||||
(post-date (make-post "foo.skr" '() '())))
|
|
||||||
|
|
||||||
(let ((date (make-date* 2015 10 15)))
|
|
||||||
(test-equal "post-date, date metadata"
|
|
||||||
date
|
|
||||||
(post-date (make-post "foo.skr" `((date . ,date)) '()))))
|
|
||||||
|
|
||||||
(let ((oldest (make-post "foo.skr" `((date . ,(make-date* 2015 10 13))) '()))
|
|
||||||
(newest (make-post "bar.skr" `((date . ,(make-date* 2015 10 15))) '()))
|
|
||||||
(middle (make-post "baz.skr" `((date . ,(make-date* 2015 10 14))) '())))
|
|
||||||
(test-equal "posts/reverse-chronological"
|
|
||||||
(list newest middle oldest)
|
|
||||||
(posts/reverse-chronological (list oldest newest middle))))
|
|
||||||
|
|
||||||
(let ((foo-post (make-post "foo.skr" '((tags "foo")) '()))
|
|
||||||
(another-foo-post (make-post "another-foo.skr" '((tags "foo")) '()))
|
|
||||||
(bar-post (make-post "bar.skr" '((tags "bar")) '())))
|
|
||||||
(test-equal "posts/group-by-tag"
|
|
||||||
`(("foo" ,foo-post ,another-foo-post) ("bar" ,bar-post))
|
|
||||||
(posts/group-by-tag (list another-foo-post foo-post bar-post))))
|
|
||||||
|
|
||||||
(test-equal "parse-metadata, tags"
|
|
||||||
'("foo" "bar" "baz")
|
|
||||||
(parse-metadata 'tags "foo, bar, baz"))
|
|
||||||
|
|
||||||
(test-equal "parse-metadata, date"
|
|
||||||
(make-date 0 0 30 22 15 10 2015 %tzoffset)
|
|
||||||
(parse-metadata 'date "2015-10-15 22:30"))
|
|
||||||
|
|
||||||
(test-equal "read-metadata-headers"
|
|
||||||
`((tags "foo" "bar" "baz")
|
|
||||||
(date . ,(make-date 0 0 30 22 15 10 2015 %tzoffset))
|
|
||||||
(title . "Hello, World!"))
|
|
||||||
(pk 'meta (call-with-input-string "title: Hello, World!
|
|
||||||
date: 2015-10-15 22:30
|
|
||||||
tags: foo, bar, baz
|
|
||||||
---
|
|
||||||
"
|
|
||||||
read-metadata-headers)))
|
|
||||||
|
|
||||||
(test-end)
|
|
||||||
|
|
||||||
|
|
||||||
(exit (zero? (test-runner-fail-count (test-runner-current))))
|
|
||||||
|
|
@ -1,86 +0,0 @@
|
||||||
;;; Haunt --- Static site generator for GNU Guile
|
|
||||||
;;; Copyright © 2015 David Thompson <davet@gnu.org>
|
|
||||||
;;;
|
|
||||||
;;; This file is part of Haunt.
|
|
||||||
;;;
|
|
||||||
;;; Haunt is free software; you can redistribute it and/or modify it
|
|
||||||
;;; under the terms of the GNU General Public License as published by
|
|
||||||
;;; the Free Software Foundation; either version 3 of the License, or
|
|
||||||
;;; (at your option) any later version.
|
|
||||||
;;;
|
|
||||||
;;; Haunt is distributed in the hope that it will be useful, but
|
|
||||||
;;; WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
||||||
;;; General Public License for more details.
|
|
||||||
;;;
|
|
||||||
;;; You should have received a copy of the GNU General Public License
|
|
||||||
;;; along with Haunt. If not, see <http://www.gnu.org/licenses/>.
|
|
||||||
|
|
||||||
(define-module (test-utils)
|
|
||||||
#:use-module (srfi srfi-19)
|
|
||||||
#:use-module (srfi srfi-64)
|
|
||||||
#:use-module (haunt utils))
|
|
||||||
|
|
||||||
(test-begin "utils")
|
|
||||||
|
|
||||||
(test-equal "flatten, all"
|
|
||||||
'(1 2 3 4 5 6)
|
|
||||||
(flatten '(1 (2 3 (4) (5 (6))))))
|
|
||||||
|
|
||||||
(test-equal "flatten, limited depth"
|
|
||||||
'(1 2 3 4 5 (6))
|
|
||||||
(flatten '(1 (2 3 (4) (5 (6)))) 2))
|
|
||||||
|
|
||||||
(test-equal "flat-map"
|
|
||||||
'(5 7 9)
|
|
||||||
(flat-map (compose list +) '(1 2 3) '(4 5 6)))
|
|
||||||
|
|
||||||
(test-equal "string-split-at, no match"
|
|
||||||
'("foo")
|
|
||||||
(string-split-at "foo" #\z))
|
|
||||||
|
|
||||||
(test-equal "string-split-at, match"
|
|
||||||
'("foo" "bar")
|
|
||||||
(string-split-at "foo/bar" #\/))
|
|
||||||
|
|
||||||
(test-equal "file-name-components, empty string"
|
|
||||||
'()
|
|
||||||
(file-name-components ""))
|
|
||||||
|
|
||||||
(test-equal "file-name-components, root directory"
|
|
||||||
'("")
|
|
||||||
(file-name-components "/"))
|
|
||||||
|
|
||||||
(test-equal "file-name-components, full file name"
|
|
||||||
'("share" "haunt")
|
|
||||||
(file-name-components "/share/haunt"))
|
|
||||||
|
|
||||||
(test-equal "join-file-name-components"
|
|
||||||
"/share/haunt/info/haunt.info"
|
|
||||||
(join-file-name-components '("share" "haunt" "info" "haunt.info")))
|
|
||||||
|
|
||||||
(test-equal "absolute-file-name, already absolute"
|
|
||||||
"/share/haunt"
|
|
||||||
(absolute-file-name "/share/haunt"))
|
|
||||||
|
|
||||||
(test-equal "absolute-file-name, relative file name"
|
|
||||||
(string-append (getcwd) "/share/haunt")
|
|
||||||
(absolute-file-name "share/haunt"))
|
|
||||||
|
|
||||||
(test-equal "take-up-to, less than n elements"
|
|
||||||
'(1 2 3)
|
|
||||||
(take-up-to 4 '(1 2 3)))
|
|
||||||
|
|
||||||
(test-equal "take-up-to, more than n elements"
|
|
||||||
'(1 2)
|
|
||||||
(take-up-to 2 '(1 2 3)))
|
|
||||||
|
|
||||||
(test-equal "string->date*"
|
|
||||||
(make-date 0 0 15 06 05 09 2015
|
|
||||||
(date-zone-offset (string->date "2015-09-05" "~Y~m~d")))
|
|
||||||
(string->date* "2015-09-05 06:15"))
|
|
||||||
|
|
||||||
(test-end)
|
|
||||||
|
|
||||||
|
|
||||||
(exit (zero? (test-runner-fail-count (test-runner-current))))
|
|
||||||
|
|
@ -0,0 +1,2 @@
|
||||||
|
publish:
|
||||||
|
rsync -P -rvz --delete site/ blog@dthompson.us:/var/www/haunt --cvs-exclude
|
||||||
|
|
@ -1,28 +0,0 @@
|
||||||
## Haunt --- Static site generator for GNU Guile
|
|
||||||
## Copyright © 2015 David Thompson <davet@gnu.org>
|
|
||||||
##
|
|
||||||
## This file is part of Haunt.
|
|
||||||
##
|
|
||||||
## Haunt is free software; you can redistribute it and/or modify it
|
|
||||||
## under the terms of the GNU General Public License as published by
|
|
||||||
## the Free Software Foundation; either version 3 of the License, or
|
|
||||||
## (at your option) any later version.
|
|
||||||
##
|
|
||||||
## Haunt is distributed in the hope that it will be useful, but
|
|
||||||
## WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
||||||
## General Public License for more details.
|
|
||||||
##
|
|
||||||
## You should have received a copy of the GNU General Public License
|
|
||||||
## along with Haunt. If not, see <http://www.gnu.org/licenses/>.
|
|
||||||
|
|
||||||
dist_noinst_DATA = \
|
|
||||||
haunt.scm \
|
|
||||||
css/main.css \
|
|
||||||
css/reset.css \
|
|
||||||
images/haunt.png \
|
|
||||||
js/piwik.js \
|
|
||||||
posts/0.1-release.sxml
|
|
||||||
|
|
||||||
publish:
|
|
||||||
rsync -P -rvz --delete site/ blog@dthompson.us:/var/www/haunt --cvs-exclude
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
;;; Haunt --- Static site generator for GNU Guile
|
;;; Haunt --- Static site generator for GNU Guile
|
||||||
;;; Copyright © 2016 David Thompson <davet@gnu.org>
|
;;; Copyright © 2015 David Thompson <davet@gnu.org>
|
||||||
;;;
|
;;;
|
||||||
;;; This file is part of Haunt.
|
;;; This file is part of Haunt.
|
||||||
;;;
|
;;;
|
||||||
|
|
@ -18,8 +18,6 @@
|
||||||
|
|
||||||
(use-modules (haunt site)
|
(use-modules (haunt site)
|
||||||
(haunt reader)
|
(haunt reader)
|
||||||
(haunt reader skribe)
|
|
||||||
(haunt reader commonmark)
|
|
||||||
(haunt asset)
|
(haunt asset)
|
||||||
(haunt page)
|
(haunt page)
|
||||||
(haunt post)
|
(haunt post)
|
||||||
|
|
@ -34,21 +32,15 @@
|
||||||
(web uri))
|
(web uri))
|
||||||
|
|
||||||
(define %releases
|
(define %releases
|
||||||
'(("0.2.1" #t)
|
'(("0.1" "1f751f234e382ed0f13d79e4c106373e9ae55c23")))
|
||||||
("0.2" #t)
|
|
||||||
("0.1" #f)))
|
|
||||||
|
|
||||||
(define (tarball-url version)
|
(define (tarball-url version)
|
||||||
(string-append "http://files.dthompson.us/haunt/haunt-"
|
(string-append "http://files.dthompson.us/haunt/haunt-"
|
||||||
version ".tar.gz"))
|
version ".tar.gz"))
|
||||||
|
|
||||||
(define (tarball-signature-url version)
|
|
||||||
(string-append "http://files.dthompson.us/haunt/haunt-"
|
|
||||||
version ".tar.gz.sig"))
|
|
||||||
|
|
||||||
(define %download-button
|
(define %download-button
|
||||||
(match %releases
|
(match %releases
|
||||||
(((version _) . _)
|
(((version sha1) . _)
|
||||||
`(a (@ (class "btn btn-primary btn-lg")
|
`(a (@ (class "btn btn-primary btn-lg")
|
||||||
(role "button")
|
(role "button")
|
||||||
(href ,(tarball-url version)))
|
(href ,(tarball-url version)))
|
||||||
|
|
@ -76,13 +68,6 @@
|
||||||
'(a (@ (href "https://creativecommons.org/licenses/by-sa/4.0/"))
|
'(a (@ (href "https://creativecommons.org/licenses/by-sa/4.0/"))
|
||||||
"Creative Commons Attribution Share-Alike 4.0 International"))
|
"Creative Commons Attribution Share-Alike 4.0 International"))
|
||||||
|
|
||||||
(define %piwik-code
|
|
||||||
'((script (@ (type "text/javascript") (src "/js/piwik.js")))
|
|
||||||
(noscript
|
|
||||||
(p (img (@ (src "//stats.dthompson.us/piwik.php?idsite=3")
|
|
||||||
(style "border:0;")
|
|
||||||
(alt "")))))))
|
|
||||||
|
|
||||||
(define haunt-theme
|
(define haunt-theme
|
||||||
(theme #:name "Haunt"
|
(theme #:name "Haunt"
|
||||||
#:layout
|
#:layout
|
||||||
|
|
@ -92,21 +77,19 @@
|
||||||
(meta (@ (charset "utf-8")))
|
(meta (@ (charset "utf-8")))
|
||||||
(title ,(string-append title " — " (site-title site)))
|
(title ,(string-append title " — " (site-title site)))
|
||||||
,(stylesheet "reset")
|
,(stylesheet "reset")
|
||||||
,(stylesheet "main")
|
,(stylesheet "main"))
|
||||||
,%piwik-code)
|
|
||||||
(body
|
(body
|
||||||
(header (@ (class "navbar"))
|
(header (@ (class "navbar"))
|
||||||
(div (@ (class "container"))
|
(div (@ (class "container"))
|
||||||
(ul
|
(ul
|
||||||
(li ,(anchor "home" "/"))
|
(li ,(anchor "home" "/"))
|
||||||
(li ,(anchor "downloads" "/downloads.html"))
|
(li ,(anchor "downloads" "/downloads.html"))
|
||||||
(li ,(anchor "docs" "/manual/index.html"))
|
|
||||||
(li ,(anchor "git"
|
(li ,(anchor "git"
|
||||||
"https://git.dthompson.us/haunt.git")))))
|
"https://git.dthompson.us/haunt.git")))))
|
||||||
(div (@ (class "container"))
|
(div (@ (class "container"))
|
||||||
,body
|
,body
|
||||||
(footer (@ (class "text-center"))
|
(footer (@ (class "text-center"))
|
||||||
(p (small "Copyright © 2016 David Thompson"))
|
(p (small "Copyright © 2015 David Thompson"))
|
||||||
(p
|
(p
|
||||||
(small "The text and images on this site are free
|
(small "The text and images on this site are free
|
||||||
culture works available under the " ,%cc-by-sa-link " license.")))))))
|
culture works available under the " ,%cc-by-sa-link " license.")))))))
|
||||||
|
|
@ -117,7 +100,11 @@ culture works available under the " ,%cc-by-sa-link " license.")))))))
|
||||||
" — " ,(date->string* (post-date post)))
|
" — " ,(date->string* (post-date post)))
|
||||||
(div ,(post-sxml post))))
|
(div ,(post-sxml post))))
|
||||||
#:collection-template
|
#:collection-template
|
||||||
(lambda (site title posts)
|
(lambda (site title posts prefix)
|
||||||
|
(define (post-uri post)
|
||||||
|
(string-append "/" (or prefix "")
|
||||||
|
(site-post-slug site post) ".html"))
|
||||||
|
|
||||||
`(,(jumbotron
|
`(,(jumbotron
|
||||||
`((p "Haunt is a simple, functional, hackable static site
|
`((p "Haunt is a simple, functional, hackable static site
|
||||||
generator written in Guile Scheme that gives authors the ability to
|
generator written in Guile Scheme that gives authors the ability to
|
||||||
|
|
@ -160,21 +147,12 @@ without needing to upload the generated files to a web server.")
|
||||||
(ul
|
(ul
|
||||||
,@(map (lambda (post)
|
,@(map (lambda (post)
|
||||||
`(li
|
`(li
|
||||||
(a (@ (href ,(site-post-path site post)))
|
(a (@ (href ,(post-uri post)))
|
||||||
,(post-ref post 'title)
|
,(post-ref post 'title)
|
||||||
" — "
|
" — "
|
||||||
,(date->string* (post-date post)))))
|
,(date->string* (post-date post)))))
|
||||||
(posts/reverse-chronological posts)))
|
(posts/reverse-chronological posts)))
|
||||||
|
|
||||||
(h2 "License")
|
|
||||||
(p "Haunt is "
|
|
||||||
(a (@ (href "https://www.gnu.org/philosophy/free-sw.html"))
|
|
||||||
"Free Software")
|
|
||||||
" available under the "
|
|
||||||
(a (@ (href "https://www.gnu.org/licenses/gpl.html"))
|
|
||||||
"GNU General Public License")
|
|
||||||
" version 3 or later.")
|
|
||||||
|
|
||||||
(h2 "Contributing")
|
(h2 "Contributing")
|
||||||
(p "Patches to fix bugs or add new functionality are
|
(p "Patches to fix bugs or add new functionality are
|
||||||
highly encouraged. In lieu of a mailing list, please send patches
|
highly encouraged. In lieu of a mailing list, please send patches
|
||||||
|
|
@ -187,20 +165,21 @@ the official git repository:")
|
||||||
|
|
||||||
(define (downloads-page site posts)
|
(define (downloads-page site posts)
|
||||||
(define body
|
(define body
|
||||||
`((h2 "Downloads")
|
`(,(jumbotron
|
||||||
|
`(,%download-button
|
||||||
|
(p (small "SHA1 checksum: "
|
||||||
|
,(match %releases (((_ sha1) . _) sha1))))))
|
||||||
|
(h2 "Downloads")
|
||||||
(table (@ (class "table"))
|
(table (@ (class "table"))
|
||||||
(thead
|
(thead
|
||||||
(tr (th "Source") (th "GPG signature")))
|
(tr (th "Source") (th "SHA1")))
|
||||||
(tbody
|
(tbody
|
||||||
,(map (match-lambda
|
,(map (match-lambda
|
||||||
((version signature?)
|
((version sha1)
|
||||||
(let ((tarball-name (string-append "haunt-" version ".tar.gz")))
|
`(tr
|
||||||
`(tr
|
(td (a (@ (href ,(tarball-url version)))
|
||||||
(td (a (@ (href ,(tarball-url version))) ,tarball-name))
|
,(string-append "haunt-" version ".tar.gz")))
|
||||||
(td ,(if signature?
|
(td ,sha1))))
|
||||||
`(a (@ (href ,(tarball-signature-url version)))
|
|
||||||
,(string-append tarball-name ".sig"))
|
|
||||||
""))))))
|
|
||||||
%releases)))))
|
%releases)))))
|
||||||
|
|
||||||
(make-page "downloads.html"
|
(make-page "downloads.html"
|
||||||
|
|
@ -215,12 +194,10 @@ the official git repository:")
|
||||||
#:default-metadata
|
#:default-metadata
|
||||||
'((author . "David Thompson")
|
'((author . "David Thompson")
|
||||||
(email . "davet@gnu.org"))
|
(email . "davet@gnu.org"))
|
||||||
#:readers (list sxml-reader skribe-reader commonmark-reader)
|
#:readers (list sxml-reader html-reader)
|
||||||
#:builders (list (blog #:theme haunt-theme #:collections %collections)
|
#:builders (list (blog #:theme haunt-theme #:collections %collections)
|
||||||
(atom-feed)
|
(atom-feed)
|
||||||
(atom-feeds-by-tag)
|
(atom-feeds-by-tag)
|
||||||
downloads-page
|
downloads-page
|
||||||
(static-directory "images")
|
(static-directory "images")
|
||||||
(static-directory "css")
|
(static-directory "css")))
|
||||||
(static-directory "js")
|
|
||||||
(static-directory "manual")))
|
|
||||||
|
|
|
||||||
|
|
@ -1,30 +0,0 @@
|
||||||
/*
|
|
||||||
* |@licstart The following is the entire license notice for the JavaScript code in this page.|
|
|
||||||
*
|
|
||||||
* Copyright 2012 Matthieu Aubry.
|
|
||||||
*
|
|
||||||
* This program is free software: you can redistribute it and/or
|
|
||||||
* modify it under the terms of the GNU General Public License as
|
|
||||||
* published by the Free Software Foundation, either version 3 of the
|
|
||||||
* License, or (at your option) any later version.
|
|
||||||
*
|
|
||||||
* This program is distributed in the hope that it will be useful, but
|
|
||||||
* WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
||||||
* General Public License for more details.
|
|
||||||
*
|
|
||||||
* You should have received a copy of the GNU General Public License
|
|
||||||
* along with this program. If not, see http://www.gnu.org/licenses/.
|
|
||||||
*
|
|
||||||
* |@licend The above is the entire license notice for the JavaScript code in this page.|
|
|
||||||
*/
|
|
||||||
var _paq = _paq || [];
|
|
||||||
_paq.push(['trackPageView']);
|
|
||||||
_paq.push(['enableLinkTracking']);
|
|
||||||
(function() {
|
|
||||||
var u="//stats.dthompson.us/";
|
|
||||||
_paq.push(['setTrackerUrl', u+'piwik.php']);
|
|
||||||
_paq.push(['setSiteId', 3]);
|
|
||||||
var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
|
|
||||||
g.type='text/javascript'; g.async=true; g.defer=true; g.src=u+'piwik.js'; s.parentNode.insertBefore(g,s);
|
|
||||||
})();
|
|
||||||
|
|
@ -1,115 +0,0 @@
|
||||||
<!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.3, 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.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}
|
|
||||||
-->
|
|
||||||
</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>
|
|
||||||
|
|
@ -1,130 +0,0 @@
|
||||||
<!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.3, 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.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}
|
|
||||||
-->
|
|
||||||
</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>
|
|
||||||
|
|
@ -1,145 +0,0 @@
|
||||||
<!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.3, 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.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}
|
|
||||||
-->
|
|
||||||
</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>
|
|
||||||
|
|
@ -1,89 +0,0 @@
|
||||||
<!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.3, 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.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}
|
|
||||||
-->
|
|
||||||
</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>
|
|
||||||
|
|
@ -1,82 +0,0 @@
|
||||||
<!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.3, 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.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}
|
|
||||||
-->
|
|
||||||
</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>
|
|
||||||
|
|
@ -1,87 +0,0 @@
|
||||||
<!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.3, 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.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}
|
|
||||||
-->
|
|
||||||
</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>
|
|
||||||
|
|
@ -1,100 +0,0 @@
|
||||||
<!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.3, http://www.gnu.org/software/texinfo/ -->
|
|
||||||
<head>
|
|
||||||
<title>Haunt Reference Manual: CommonMark</title>
|
|
||||||
|
|
||||||
<meta name="description" content="Haunt Reference Manual: CommonMark">
|
|
||||||
<meta name="keywords" content="Haunt Reference Manual: CommonMark">
|
|
||||||
<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="Readers.html#Readers" rel="up" title="Readers">
|
|
||||||
<link href="Pages.html#Pages" rel="next" title="Pages">
|
|
||||||
<link href="Skribe.html#Skribe" rel="prev" title="Skribe">
|
|
||||||
<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.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}
|
|
||||||
-->
|
|
||||||
</style>
|
|
||||||
|
|
||||||
|
|
||||||
</head>
|
|
||||||
|
|
||||||
<body lang="en">
|
|
||||||
<a name="CommonMark"></a>
|
|
||||||
<div class="header">
|
|
||||||
<p>
|
|
||||||
Previous: <a href="Skribe.html#Skribe" accesskey="p" rel="prev">Skribe</a>, Up: <a href="Readers.html#Readers" accesskey="u" rel="up">Readers</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="CommonMark-1"></a>
|
|
||||||
<h4 class="subsection">5.3.4 CommonMark</h4>
|
|
||||||
<div class="example">
|
|
||||||
<pre class="example">(use-modules (haunt reader commonmark))
|
|
||||||
</pre></div>
|
|
||||||
|
|
||||||
<dl>
|
|
||||||
<dt><a name="index-commonmark_002dreader"></a>Scheme Procedure: <strong>commonmark-reader</strong></dt>
|
|
||||||
<dd><p>A reader for posts written in CommonMark, a fully specified variant of
|
|
||||||
Markdown. Metadata is encoded as <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: Hello, CommonMark!
|
|
||||||
date: 2016-08-20 12:00
|
|
||||||
tags: markdown, commonmark
|
|
||||||
---
|
|
||||||
|
|
||||||
## This is a CommonMark post
|
|
||||||
|
|
||||||
CommonMark is a **strongly** defined, *highly* compatible
|
|
||||||
specification of Markdown, learn more about CommomMark
|
|
||||||
[here](http://commonmark.org/).
|
|
||||||
</pre></div>
|
|
||||||
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
|
|
@ -1,73 +0,0 @@
|
||||||
<!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.3, 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.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}
|
|
||||||
-->
|
|
||||||
</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>
|
|
||||||
|
|
@ -1,73 +0,0 @@
|
||||||
<!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.3, 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.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}
|
|
||||||
-->
|
|
||||||
</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>
|
|
||||||
|
|
@ -1,77 +0,0 @@
|
||||||
<!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.3, 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.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}
|
|
||||||
-->
|
|
||||||
</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>
|
|
||||||
|
|
@ -1,547 +0,0 @@
|
||||||
<!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.3, 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.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}
|
|
||||||
-->
|
|
||||||
</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>
|
|
||||||
|
|
@ -1,82 +0,0 @@
|
||||||
<!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.3, 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.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}
|
|
||||||
-->
|
|
||||||
</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>
|
|
||||||
|
|
@ -1,137 +0,0 @@
|
||||||
<!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.3, 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.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}
|
|
||||||
-->
|
|
||||||
</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>
|
|
||||||
|
|
@ -1,92 +0,0 @@
|
||||||
<!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.3, 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.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}
|
|
||||||
-->
|
|
||||||
</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>
|
|
||||||
|
|
@ -1,107 +0,0 @@
|
||||||
<!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.3, 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.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}
|
|
||||||
-->
|
|
||||||
</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>
|
|
||||||
|
|
@ -1,114 +0,0 @@
|
||||||
<!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.3, 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="CommonMark.html#CommonMark" rel="prev" title="CommonMark">
|
|
||||||
<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.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}
|
|
||||||
-->
|
|
||||||
</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>
|
|
||||||
|
|
@ -1,151 +0,0 @@
|
||||||
<!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.3, 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.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}
|
|
||||||
-->
|
|
||||||
</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_002ddate"></a>Scheme Procedure: <strong>post-date</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>
|
|
||||||
|
|
@ -1,215 +0,0 @@
|
||||||
<!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.3, 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.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}
|
|
||||||
-->
|
|
||||||
</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-C"><b>C</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-C">C</a></th><td></td><td></td></tr>
|
|
||||||
<tr><td></td><td valign="top"><a href="CommonMark.html#index-commonmark_002dreader"><code>commonmark-reader</code></a>:</td><td> </td><td valign="top"><a href="CommonMark.html#CommonMark">CommonMark</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="Reader.html#index-html_002dreader"><code>html-reader</code></a>:</td><td> </td><td valign="top"><a href="Reader.html#Reader">Reader</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="Reader.html#index-make_002dfile_002dextension_002dmatcher"><code>make-file-extension-matcher</code></a>:</td><td> </td><td valign="top"><a href="Reader.html#Reader">Reader</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="Reader.html#index-make_002dreader"><code>make-reader</code></a>:</td><td> </td><td valign="top"><a href="Reader.html#Reader">Reader</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_002ddate"><code>post-date</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="Reader.html#index-read_002dpost"><code>read-post</code></a>:</td><td> </td><td valign="top"><a href="Reader.html#Reader">Reader</a></td></tr>
|
|
||||||
<tr><td></td><td valign="top"><a href="Reader.html#index-read_002dposts"><code>read-posts</code></a>:</td><td> </td><td valign="top"><a href="Reader.html#Reader">Reader</a></td></tr>
|
|
||||||
<tr><td></td><td valign="top"><a href="Reader.html#index-reader_002dmatch_003f"><code>reader-match?</code></a>:</td><td> </td><td valign="top"><a href="Reader.html#Reader">Reader</a></td></tr>
|
|
||||||
<tr><td></td><td valign="top"><a href="Reader.html#index-reader_002dmatcher"><code>reader-matcher</code></a>:</td><td> </td><td valign="top"><a href="Reader.html#Reader">Reader</a></td></tr>
|
|
||||||
<tr><td></td><td valign="top"><a href="Reader.html#index-reader_002dproc"><code>reader-proc</code></a>:</td><td> </td><td valign="top"><a href="Reader.html#Reader">Reader</a></td></tr>
|
|
||||||
<tr><td></td><td valign="top"><a href="Reader.html#index-reader_003f"><code>reader?</code></a>:</td><td> </td><td valign="top"><a href="Reader.html#Reader">Reader</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="Skribe.html#index-skribe_002dreader"><code>skribe-reader</code></a>:</td><td> </td><td valign="top"><a href="Skribe.html#Skribe">Skribe</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="Reader.html#index-sxml_002dreader"><code>sxml-reader</code></a>:</td><td> </td><td valign="top"><a href="Reader.html#Reader">Reader</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="Texinfo.html#index-texinfo_002dreader"><code>texinfo-reader</code></a>:</td><td> </td><td valign="top"><a href="Texinfo.html#Texinfo">Texinfo</a></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-C"><b>C</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>
|
|
||||||
|
|
@ -1,91 +0,0 @@
|
||||||
<!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.3, 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.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}
|
|
||||||
-->
|
|
||||||
</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>
|
|
||||||
|
|
@ -1,179 +0,0 @@
|
||||||
<!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.3, http://www.gnu.org/software/texinfo/ -->
|
|
||||||
<head>
|
|
||||||
<title>Haunt Reference Manual: Reader</title>
|
|
||||||
|
|
||||||
<meta name="description" content="Haunt Reference Manual: Reader">
|
|
||||||
<meta name="keywords" content="Haunt Reference Manual: Reader">
|
|
||||||
<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="Readers.html#Readers" rel="up" title="Readers">
|
|
||||||
<link href="Texinfo.html#Texinfo" rel="next" title="Texinfo">
|
|
||||||
<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.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}
|
|
||||||
-->
|
|
||||||
</style>
|
|
||||||
|
|
||||||
|
|
||||||
</head>
|
|
||||||
|
|
||||||
<body lang="en">
|
|
||||||
<a name="Reader"></a>
|
|
||||||
<div class="header">
|
|
||||||
<p>
|
|
||||||
Next: <a href="Texinfo.html#Texinfo" accesskey="n" rel="next">Texinfo</a>, Up: <a href="Readers.html#Readers" accesskey="u" rel="up">Readers</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="Reader-1"></a>
|
|
||||||
<h4 class="subsection">5.3.1 Reader</h4>
|
|
||||||
<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_002dproc"></a>Scheme Procedure: <strong>reader-proc</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="Texinfo.html#Texinfo" accesskey="n" rel="next">Texinfo</a>, Up: <a href="Readers.html#Readers" accesskey="u" rel="up">Readers</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>
|
|
||||||
|
|
@ -1,84 +0,0 @@
|
||||||
<!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.3, 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="Reader.html#Reader" rel="next" title="Reader">
|
|
||||||
<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.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}
|
|
||||||
-->
|
|
||||||
</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>
|
|
||||||
|
|
||||||
<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>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
|
|
@ -1,89 +0,0 @@
|
||||||
<!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.3, 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.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}
|
|
||||||
-->
|
|
||||||
</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><li> <a href="https://github.com/OrangeShark/guile-commonmark">guile-commonmark</a>
|
|
||||||
version 0.1 or later (for CommonMark support)
|
|
||||||
</li></ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
|
|
@ -1,176 +0,0 @@
|
||||||
<!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.3, 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.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}
|
|
||||||
-->
|
|
||||||
</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>
|
|
||||||
|
|
@ -1,104 +0,0 @@
|
||||||
<!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.3, http://www.gnu.org/software/texinfo/ -->
|
|
||||||
<head>
|
|
||||||
<title>Haunt Reference Manual: Skribe</title>
|
|
||||||
|
|
||||||
<meta name="description" content="Haunt Reference Manual: Skribe">
|
|
||||||
<meta name="keywords" content="Haunt Reference Manual: Skribe">
|
|
||||||
<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="Readers.html#Readers" rel="up" title="Readers">
|
|
||||||
<link href="CommonMark.html#CommonMark" rel="next" title="CommonMark">
|
|
||||||
<link href="Texinfo.html#Texinfo" rel="prev" title="Texinfo">
|
|
||||||
<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.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}
|
|
||||||
-->
|
|
||||||
</style>
|
|
||||||
|
|
||||||
|
|
||||||
</head>
|
|
||||||
|
|
||||||
<body lang="en">
|
|
||||||
<a name="Skribe"></a>
|
|
||||||
<div class="header">
|
|
||||||
<p>
|
|
||||||
Next: <a href="CommonMark.html#CommonMark" accesskey="n" rel="next">CommonMark</a>, Previous: <a href="Texinfo.html#Texinfo" accesskey="p" rel="prev">Texinfo</a>, Up: <a href="Readers.html#Readers" accesskey="u" rel="up">Readers</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="Skribe-1"></a>
|
|
||||||
<h4 class="subsection">5.3.3 Skribe</h4>
|
|
||||||
<div class="example">
|
|
||||||
<pre class="example">(use-modules (haunt reader skribe))
|
|
||||||
</pre></div>
|
|
||||||
|
|
||||||
<dl>
|
|
||||||
<dt><a name="index-skribe_002dreader"></a>Scheme Procedure: <strong>skribe-reader</strong></dt>
|
|
||||||
<dd><p>A reader for posts written in Skribe, a markup language with the full power
|
|
||||||
of Scheme. Skribe posts are created with the <code>post</code> expression with
|
|
||||||
metadata encoded as <code>:key expression</code> pairs at the beginning of the
|
|
||||||
<code>post</code> expression. After the metadata section, the rest of the <code>post</code>
|
|
||||||
expression is encoded as HTML.
|
|
||||||
</p>
|
|
||||||
<p>Example:
|
|
||||||
</p>
|
|
||||||
<div class="example">
|
|
||||||
<pre class="example">(post
|
|
||||||
:title "Hello, Skribe!"
|
|
||||||
:date (make-date* 2016 08 20 12 00)
|
|
||||||
:tags '("skribe" "foo" "baz")
|
|
||||||
|
|
||||||
(h2 [This is a Skribe post])
|
|
||||||
|
|
||||||
(p [Skribe is a ,(em [really]) cool document authoring format
|
|
||||||
that provides all the power of Scheme whilst giving the user
|
|
||||||
a means to write literal text without stuffing it into a
|
|
||||||
string literal. If this sort of thing suits you, be sure to
|
|
||||||
check out ,(anchor "Skribilo"
|
|
||||||
"http://www.nongnu.org/skribilo/"), too.]))
|
|
||||||
</pre></div>
|
|
||||||
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
|
|
@ -1,86 +0,0 @@
|
||||||
<!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.3, 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.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}
|
|
||||||
-->
|
|
||||||
</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>
|
|
||||||
|
|
@ -1,101 +0,0 @@
|
||||||
<!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.3, http://www.gnu.org/software/texinfo/ -->
|
|
||||||
<head>
|
|
||||||
<title>Haunt Reference Manual: Texinfo</title>
|
|
||||||
|
|
||||||
<meta name="description" content="Haunt Reference Manual: Texinfo">
|
|
||||||
<meta name="keywords" content="Haunt Reference Manual: Texinfo">
|
|
||||||
<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="Readers.html#Readers" rel="up" title="Readers">
|
|
||||||
<link href="Skribe.html#Skribe" rel="next" title="Skribe">
|
|
||||||
<link href="Reader.html#Reader" rel="prev" title="Reader">
|
|
||||||
<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.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}
|
|
||||||
-->
|
|
||||||
</style>
|
|
||||||
|
|
||||||
|
|
||||||
</head>
|
|
||||||
|
|
||||||
<body lang="en">
|
|
||||||
<a name="Texinfo"></a>
|
|
||||||
<div class="header">
|
|
||||||
<p>
|
|
||||||
Next: <a href="Skribe.html#Skribe" accesskey="n" rel="next">Skribe</a>, Previous: <a href="Reader.html#Reader" accesskey="p" rel="prev">Reader</a>, Up: <a href="Readers.html#Readers" accesskey="u" rel="up">Readers</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="Texinfo-1"></a>
|
|
||||||
<h4 class="subsection">5.3.2 Texinfo</h4>
|
|
||||||
<div class="example">
|
|
||||||
<pre class="example">(use-modules (haunt reader texinfo))
|
|
||||||
</pre></div>
|
|
||||||
|
|
||||||
<dl>
|
|
||||||
<dt><a name="index-texinfo_002dreader"></a>Scheme Procedure: <strong>texinfo-reader</strong></dt>
|
|
||||||
<dd><p>A reader for posts written in texinfo, the official documentation format
|
|
||||||
of the GNU project. Metadata is encoded as <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: Hello, Texi!
|
|
||||||
date: 2016-08-20 12:00
|
|
||||||
tags: texinfo, foo
|
|
||||||
---
|
|
||||||
|
|
||||||
@emph{Texinfo} is the official documentation format of the
|
|
||||||
@url{http://www.gnu.org/, GNU project}. It was invented by Richard
|
|
||||||
Stallman and Bob Chassell many years ago, loosely based on Brian
|
|
||||||
Reid's Scribe and other formatting languages of the time. It is
|
|
||||||
used by many non-GNU projects as well.
|
|
||||||
</pre></div>
|
|
||||||
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
|
|
@ -1,169 +0,0 @@
|
||||||
<!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.3, 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.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}
|
|
||||||
-->
|
|
||||||
</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>
|
|
||||||
|
|
@ -1,170 +0,0 @@
|
||||||
<!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.3, 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.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}
|
|
||||||
-->
|
|
||||||
</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>
|
|
||||||
<ul class="no-bullet">
|
|
||||||
<li><a name="toc-Reader-1" href="Reader.html#Reader">5.3.1 Reader</a></li>
|
|
||||||
<li><a name="toc-Texinfo-1" href="Texinfo.html#Texinfo">5.3.2 Texinfo</a></li>
|
|
||||||
<li><a name="toc-Skribe-1" href="Skribe.html#Skribe">5.3.3 Skribe</a></li>
|
|
||||||
<li><a name="toc-CommonMark-1" href="CommonMark.html#CommonMark">5.3.4 CommonMark</a></li>
|
|
||||||
</ul></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.1, 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>
|
|
||||||
|
|
@ -1,38 +0,0 @@
|
||||||
(post
|
|
||||||
:title "Haunt 0.2 released"
|
|
||||||
:date (make-date* 2016 04 24)
|
|
||||||
:tags '("release")
|
|
||||||
:summary "Haunt 0.2 released"
|
|
||||||
|
|
||||||
(p [I am pleased to announce the release of Haunt version 0.2. This
|
|
||||||
release features new readers for the ]
|
|
||||||
(anchor "Texinfo" "http://www.gnu.org/software/texinfo/")
|
|
||||||
[ and ] (anchor "Skribe" "http://www.nongnu.org/skribilo/")
|
|
||||||
[ markup formats, an Info manual, small improvements to the Atom
|
|
||||||
and blog builders, and bug fixes.])
|
|
||||||
|
|
||||||
(p [New reader modules:]
|
|
||||||
(ul (li (code [(haunt reader skribe)]))
|
|
||||||
(li (code [(haunt reader texinfo)]))))
|
|
||||||
|
|
||||||
(p [Bug fixes:]
|
|
||||||
(ul (li (anchor "builder: atom: Allow atom feeds to correctly set the blog prefix."
|
|
||||||
"https://git.dthompson.us/haunt.git/commit/ed1602dc36444bcf1023926854a2cb01b5199e7e"))
|
|
||||||
(li (anchor "build: Allow building with Guile 2.2."
|
|
||||||
"https://git.dthompson.us/haunt.git/commit/5373877f989689209616109b13fd471b2d093b5f"))
|
|
||||||
(li (anchor "post: Allow dashes in slugs."
|
|
||||||
"https://git.dthompson.us/haunt.git/commit/a37c3cd58525be76705ea930551f3935a232790e"))
|
|
||||||
(li (anchor "serve: Catch exceptions when rebuilding site."
|
|
||||||
"https://git.dthompson.us/haunt.git/commit/0d67128c3da6413546015fa9092a0017f50d46b9"))))
|
|
||||||
|
|
||||||
(p [A special thank you to Christopher Webber and Mathieu Lirzin for
|
|
||||||
contributing to this release!])
|
|
||||||
|
|
||||||
(p [Source tarball: ]
|
|
||||||
(anchor "haunt-0.2.tar.gz"
|
|
||||||
"https://files.dthompson.us/haunt/haunt-0.2.tar.gz"))
|
|
||||||
(p [GPG signature: ]
|
|
||||||
(anchor "haunt-0.2.tar.gz.sig"
|
|
||||||
"https://files.dthompson.us/haunt/haunt-0.2.tar.gz.sig"))
|
|
||||||
|
|
||||||
(p [Happy haunting!]))
|
|
||||||
|
|
@ -1,24 +0,0 @@
|
||||||
title: Haunt 0.2.1 released
|
|
||||||
date: 2017-01-23 08:00:00
|
|
||||||
tags: release
|
|
||||||
summary: Haunt 0.2.1 released
|
|
||||||
---
|
|
||||||
|
|
||||||
I am pleased to announce the release of Haunt version 0.2.1. This
|
|
||||||
release features a new reader for the
|
|
||||||
[Markdown](http://commonmark.org/) format via
|
|
||||||
[guile-commonmark](https://github.com/OrangeShark/guile-commonmark) as
|
|
||||||
well as small improvements to the Atom feed generator and
|
|
||||||
documentation.
|
|
||||||
|
|
||||||
The new Commonmark reader can be found in the `(haunt reader
|
|
||||||
commonmark)` module.
|
|
||||||
|
|
||||||
Thank you to Erik Edrosa, Ludovic Courtès, and Vladimir Zhbanov for
|
|
||||||
contributing to this release.
|
|
||||||
|
|
||||||
Source tarball: [haunt-0.2.1.tar.gz](https://files.dthompson.us/haunt/haunt-0.2.1.tar.gz.sig)
|
|
||||||
|
|
||||||
GPG signature [haunt-0.2.1.tar.gz.sig](https://files.dthompson.us/haunt/haunt-0.2.1.tar.gz.sig)
|
|
||||||
|
|
||||||
Happy haunting!
|
|
||||||
Loading…
Reference in New Issue