The coleslaw Reference Manual
Table of Contents
The coleslaw Reference Manual
This is the coleslaw Reference Manual, version 0.9.7,
generated automatically by Declt version 2.4 "Will Decker"
on Wed Jun 20 11:37:04 2018 GMT+0.
1 Introduction
coleslaw

Czeslaw Milosz was the writer-in-residence at UNC c. 1992.
I used to see him all the time at the Hardback Cafe, always sitting at a two-top
drinking coffee, reading, writing, eating chips and salsa. I remember a gentleness
behind the enormous bushy eyebrows and that we called him Coleslaw. - anon
Coleslaw is Flexible Lisp Blogware similar to Frog, Jekyll, or Hakyll.
Have questions? Come talk to us on IRC in #coleslaw on Freenode!
Features
Example Sites
See the wiki for a list of coleslaw-powered blogs.
Hacking
A core goal of coleslaw is to be both pleasant to read and easy to
hack on and extend. If you want to understand the internals and bend
coleslaw to do new and interesting things, I strongly encourage you
to read the Hacker's Guide to Coleslaw. You'll find some
current TODO items towards the bottom.
Installation
Coleslaw should run on any conforming Common Lisp implementation but
testing is primarily done on SBCL and
CCL.
Coleslaw can either be run manually on a local machine or
triggered automatically on git push to a server. If you want a
server install, run these commands on your server after setting up a
git bare repo.
Otherwise, run the commands on your local machine.
- Install a Common Lisp implementation (we recommend SBCL) and
Quicklisp.
- Place a config file for coleslaw in your
$HOME
directory. If you
want to run multiple blogs with coleslaw, you can keep each blog's
config file in that blog's repo. Feel free to copy and edit the
example config or consult the config docs
to create one from scratch.
- This step depends on whether you're setting up a local or server install.
- Optionally, point the web server of your liking at your config-specified
:deploy-dir
. Or "deploy-dir/.curr" if the versioned
plugin is enabled.
Now just write posts, git commit and build by hand or by push.
The Content Format
Coleslaw expects content to have a file extension matching the class
of the content. (I.e. .post
for blog posts, .page
for static
pages, etc.)
There should also be a metadata header on all files
starting and ending with the config-specified :separator
, ";;;;;" by
default. Example:
;;;;;
title: foo
tags: bar, baz
date: yyyy-mm-dd hh:mm:ss
format: html (for raw html) or md (for markdown)
excerpt: Can also be extracted from content (see :excerpt-sep config param)
;;;;;
your post
Posts require the title:
and format:
fields.
Pages require the title:
and url:
fields.
To omit a field, simply do not have the line present, empty lines and
fields (e.g. "tags:" followed by whitespace) will be ignored.
Theming
Two themes are provided: hyde, the default, and readable (based on
bootswatch readable).
A guide to creating themes for coleslaw lives
here.
2 Systems
The main system appears first, followed by any subsystem dependency.
2.1 coleslaw
- Author
Brit Butler <redline6561@gmail.com>
- License
BSD
- Description
Flexible Lisp Blogware
- Version
0.9.7
- Dependencies
- coleslaw-conf (system)
- closure-template
- 3bmd
- 3bmd-ext-code-blocks
- alexandria
- local-time
- inferior-shell
- cl-fad
- cl-ppcre
- closer-mop
- cl-unicode
- Source
coleslaw.asd (file)
- Components
-
2.2 coleslaw-conf
- Author
Brit Butler <redline6561@gmail.com>
- License
BSD
- Description
Configuration variable for Coleslaw, Flexible Lisp Blogware
- Version
0.9.7
- Source
coleslaw-conf.asd (file)
- Component
coleslaw-conf.lisp (file)
3 Files
Files are sorted by type and then listed depth-first from the systems
components trees.
3.1 Lisp
3.1.1 coleslaw.asd
- Location
/home/quickref/quicklisp/dists/quicklisp/software/coleslaw-20171130-git/coleslaw.asd
- Systems
coleslaw (system)
3.1.2 coleslaw-conf.asd
- Location
/home/quickref/quicklisp/dists/quicklisp/software/coleslaw-20171130-git/coleslaw-conf.asd
- Systems
coleslaw-conf (system)
3.1.3 coleslaw/packages.lisp
- Parent
coleslaw (system)
- Location
packages.lisp
- Packages
coleslaw
3.1.4 coleslaw/util.lisp
- Dependency
packages.lisp (file)
- Parent
coleslaw (system)
- Location
util.lisp
- Exported Definitions
-
- Internal Definitions
-
3.1.5 coleslaw/config.lisp
- Dependency
util.lisp (file)
- Parent
coleslaw (system)
- Location
config.lisp
- Exported Definitions
-
- Internal Definitions
-
3.1.6 coleslaw/themes.lisp
- Dependency
config.lisp (file)
- Parent
coleslaw (system)
- Location
themes.lisp
- Exported Definitions
-
- Internal Definitions
-
3.1.7 coleslaw/documents.lisp
- Dependency
themes.lisp (file)
- Parent
coleslaw (system)
- Location
documents.lisp
- Exported Definitions
-
- Internal Definitions
-
3.1.8 coleslaw/content.lisp
- Dependency
documents.lisp (file)
- Parent
coleslaw (system)
- Location
content.lisp
- Exported Definitions
-
- Internal Definitions
-
3.1.9 coleslaw/posts.lisp
- Dependency
content.lisp (file)
- Parent
coleslaw (system)
- Location
posts.lisp
- Exported Definitions
-
- Internal Definitions
-
3.1.10 coleslaw/indexes.lisp
- Dependency
posts.lisp (file)
- Parent
coleslaw (system)
- Location
indexes.lisp
- Exported Definitions
-
- Internal Definitions
-
3.1.11 coleslaw/feeds.lisp
- Dependency
indexes.lisp (file)
- Parent
coleslaw (system)
- Location
feeds.lisp
- Exported Definitions
-
- Internal Definitions
-
3.1.12 coleslaw/coleslaw.lisp
- Dependency
feeds.lisp (file)
- Parent
coleslaw (system)
- Location
coleslaw.lisp
- Exported Definitions
-
- Internal Definitions
-
3.1.13 coleslaw-conf/coleslaw-conf.lisp
- Parent
coleslaw-conf (system)
- Location
coleslaw-conf.lisp
- Packages
coleslaw-conf
- Exported Definitions
-
4 Packages
Packages are listed by definition order.
4.1 coleslaw
Homepage: <a href="http://github.com/redline6561/coleslaw">Github</a>
- Source
packages.lisp (file)
- Use List
common-lisp
- Exported Definitions
-
- Internal Definitions
-
4.2 coleslaw-conf
- Source
coleslaw-conf.lisp (file)
- Use List
common-lisp
- Exported Definitions
-
5 Definitions
Definitions are sorted by export status, category, package, and then by
lexicographic order.
5.1 Exported definitions
5.1.1 Special variables
- Special Variable: *basedir*
-
- Package
coleslaw-conf
- Source
coleslaw-conf.lisp (file)
- Special Variable: *config*
-
A variable to store the blog configuration and plugin settings.
- Package
coleslaw
- Source
config.lisp (file)
5.1.2 Macros
- Macro: assert-field FIELD-NAME CONTENT
-
- Package
coleslaw
- Source
util.lisp (file)
5.1.3 Functions
- Function: add-document DOCUMENT
-
Add DOCUMENT to the in-memory database. Error if a matching entry is present.
- Package
coleslaw
- Source
documents.lisp (file)
- Function: add-injection INJECTION LOCATION
-
Adds an INJECTION to a given LOCATION for rendering. The INJECTION should be a
function that takes a DOCUMENT and returns NIL or a STRING for template insertion.
- Package
coleslaw
- Source
themes.lisp (file)
- Function: delete-document DOCUMENT
-
Given a DOCUMENT, delete it from the in-memory database.
- Package
coleslaw
- Source
documents.lisp (file)
- Function: find-all DOC-TYPE
-
Return a list of all instances of a given DOC-TYPE.
- Package
coleslaw
- Source
documents.lisp (file)
- Function: find-content-by-path PATH
-
Find the CONTENT corresponding to the file at PATH.
- Package
coleslaw
- Source
content.lisp (file)
- Function: get-updated-files &optional REVISION
-
Return a plist of (file-status file-name) for files that were changed
in the git repo since REVISION.
- Package
coleslaw
- Source
util.lisp (file)
- Function: main REPO-DIR &optional OLDREV
-
Load the user’s config file, then compile and deploy the blog stored
in REPO-DIR. Optionally, OLDREV is the revision prior to the last push.
- Package
coleslaw
- Source
coleslaw.lisp (file)
- Function: preview PATH &optional CONTENT-TYPE
-
Render the content at PATH under user’s configured repo and save it to
~/tmp.html. Load the user’s config and theme if necessary.
- Package
coleslaw
- Source
coleslaw.lisp (file)
- Function: purge-all DOC-TYPE
-
Remove all instances of DOC-TYPE from memory.
- Package
coleslaw
- Source
documents.lisp (file)
- Function: set-basedir PATHNAME
-
- Package
coleslaw-conf
- Source
coleslaw-conf.lisp (file)
- Function: theme-fn NAME &optional PACKAGE
-
Find the symbol NAME inside PACKAGE which defaults to the theme package.
- Package
coleslaw
- Source
themes.lisp (file)
- Function: write-document DOCUMENT &optional THEME-FN &rest RENDER-ARGS
-
Write the given DOCUMENT to disk as HTML. If THEME-FN is present,
use it as the template passing any RENDER-ARGS.
- Package
coleslaw
- Source
documents.lisp (file)
5.1.4 Generic functions
- Generic Function: author OBJECT
-
- Package
coleslaw
- Methods
- Method: author (BLOG blog)
-
automatically generated reader method
- Source
config.lisp (file)
- Generic Function: author-of OBJECT
-
- Package
coleslaw
- Methods
- Method: author-of (POST post)
-
automatically generated reader method
- Source
posts.lisp (file)
- Generic Function: content-text OBJECT
-
- Package
coleslaw
- Methods
- Method: content-text (CONTENT content)
-
automatically generated reader method
- Source
content.lisp (file)
- Generic Function: deploy STAGING
-
Deploy the STAGING build to the directory specified in the config.
- Package
coleslaw
- Source
coleslaw.lisp (file)
- Methods
- Method: deploy STAGING
-
- Generic Function: deploy-dir OBJECT
-
- Package
coleslaw
- Methods
- Method: deploy-dir (CONFIG blog)
-
- Source
config.lisp (file)
- Generic Function: discover DOC-TYPE
-
Load all documents of the given DOC-TYPE into memory.
- Package
coleslaw
- Source
documents.lisp (file)
- Methods
- Method: discover (DOC-TYPE (eql #<standard-class coleslaw::tag-feed>))
-
- Source
feeds.lisp (file)
- Method: discover (DOC-TYPE (eql #<standard-class coleslaw::feed>))
-
- Source
feeds.lisp (file)
- Method: discover (DOC-TYPE (eql #<standard-class coleslaw::numeric-index>))
-
- Source
indexes.lisp (file)
- Method: discover (DOC-TYPE (eql #<standard-class coleslaw::month-index>))
-
- Source
indexes.lisp (file)
- Method: discover (DOC-TYPE (eql #<standard-class coleslaw::tag-index>))
-
- Source
indexes.lisp (file)
- Method: discover DOC-TYPE before
-
- Method: discover DOC-TYPE
-
- Generic Function: domain OBJECT
-
- Package
coleslaw
- Methods
- Method: domain (BLOG blog)
-
automatically generated reader method
- Source
config.lisp (file)
- Generic Function: page-ext OBJECT
-
- Package
coleslaw
- Methods
- Method: page-ext (BLOG blog)
-
automatically generated reader method
- Source
config.lisp (file)
- Generic Function: page-url DOCUMENT
-
The relative URL to the DOCUMENT.
- Package
coleslaw
- Source
documents.lisp (file)
- Methods
- Method: page-url (INDEX index)
-
automatically generated reader method
- Source
indexes.lisp (file)
- Method: page-url (CONTENT content)
-
automatically generated reader method
- Source
content.lisp (file)
- Generic Function: publish DOC-TYPE
-
Write pages to disk for all documents of the given DOC-TYPE.
- Package
coleslaw
- Source
documents.lisp (file)
- Methods
- Method: publish (DOC-TYPE (eql #<standard-class coleslaw::tag-feed>))
-
- Source
feeds.lisp (file)
- Method: publish (DOC-TYPE (eql #<standard-class coleslaw::feed>))
-
- Source
feeds.lisp (file)
- Method: publish (DOC-TYPE (eql #<standard-class coleslaw::numeric-index>))
-
- Source
indexes.lisp (file)
- Method: publish (DOC-TYPE (eql #<standard-class coleslaw::month-index>))
-
- Source
indexes.lisp (file)
- Method: publish (DOC-TYPE (eql #<standard-class coleslaw::tag-index>))
-
- Source
indexes.lisp (file)
- Method: publish (DOC-TYPE (eql #<standard-class coleslaw:post>))
-
- Source
posts.lisp (file)
- Generic Function: render DOCUMENT &key PREV NEXT &allow-other-keys
-
Render the given DOCUMENT to HTML.
- Package
coleslaw
- Source
documents.lisp (file)
- Methods
- Method: render (OBJECT index) &key PREV NEXT
-
- Source
indexes.lisp (file)
- Method: render (OBJECT post) &key PREV NEXT
-
- Source
posts.lisp (file)
- Generic Function: render-text TEXT FORMAT
-
Render TEXT of the given FORMAT to HTML for display.
- Package
coleslaw
- Source
content.lisp (file)
- Methods
- Method: render-text TEXT (FORMAT (eql html))
-
- Method: render-text TEXT (FORMAT (eql md))
-
- Generic Function: repo-dir OBJECT
-
- Generic Function: (setf repo-dir) NEW-VALUE OBJECT
-
- Package
coleslaw
- Methods
- Method: repo-dir (CONFIG blog)
-
- Source
config.lisp (file)
- Method: (setf repo-dir) NEW-VALUE (BLOG blog)
-
automatically generated writer method
- Source
config.lisp (file)
- Generic Function: staging-dir OBJECT
-
- Package
coleslaw
- Methods
- Method: staging-dir (CONFIG blog)
-
- Source
config.lisp (file)
- Generic Function: title OBJECT
-
- Package
coleslaw
- Methods
- Method: title (BLOG blog)
-
automatically generated reader method
- Source
config.lisp (file)
- Generic Function: title-of OBJECT
-
- Package
coleslaw
- Methods
- Method: title-of (INDEX index)
-
automatically generated reader method
- Source
indexes.lisp (file)
- Method: title-of (POST post)
-
automatically generated reader method
- Source
posts.lisp (file)
5.1.5 Conditions
- Condition: plugin-conf-error ()
-
Condition to signal when the plugin is misconfigured.
- Package
coleslaw
- Source
config.lisp (file)
- Direct superclasses
condition (condition)
- Direct methods
-
- Direct slots
- Slot: plugin
-
- Initargs
:plugin
- Readers
plugin (generic function)
- Slot: message
-
- Initargs
:message
- Readers
message (generic function)
5.1.6 Classes
- Class: content ()
-
- Package
coleslaw
- Source
content.lisp (file)
- Direct superclasses
standard-object (class)
- Direct subclasses
post (class)
- Direct methods
-
- Direct slots
- Slot: url
-
- Initargs
:url
- Readers
page-url (generic function)
- Slot: date
-
- Initargs
:date
- Readers
content-date (generic function)
- Slot: file
-
- Initargs
:file
- Readers
content-file (generic function)
- Slot: tags
-
- Initargs
:tags
- Readers
content-tags (generic function)
- Slot: text
-
- Initargs
:text
- Readers
content-text (generic function)
- Direct Default Initargs
Initarg | Value |
:tags | nil |
:date | nil |
- Class: index ()
-
- Package
coleslaw
- Source
indexes.lisp (file)
- Direct superclasses
standard-object (class)
- Direct subclasses
-
- Direct methods
-
- Direct slots
- Slot: url
-
- Initargs
:url
- Readers
page-url (generic function)
- Slot: name
-
- Initargs
:name
- Readers
index-name (generic function)
- Slot: title
-
- Initargs
:title
- Readers
title-of (generic function)
- Slot: content
-
- Initargs
:content
- Readers
index-content (generic function)
- Class: post ()
-
- Package
coleslaw
- Source
posts.lisp (file)
- Direct superclasses
content (class)
- Direct methods
-
- Direct slots
- Slot: title
-
- Initargs
:title
- Readers
title-of (generic function)
- Slot: author
-
- Initargs
:author
- Readers
author-of (generic function)
- Slot: excerpt
-
- Initargs
:excerpt
- Readers
excerpt-of (generic function)
- Slot: format
-
- Initargs
:format
- Readers
post-format (generic function)
- Direct Default Initargs
Initarg | Value |
:author | nil |
:excerpt | nil |
5.2 Internal definitions
5.2.1 Special variables
- Special Variable: *all-months*
-
The list of months in which content was authored.
- Package
coleslaw
- Source
indexes.lisp (file)
- Special Variable: *all-tags*
-
The list of tags which content has been tagged with.
- Package
coleslaw
- Source
indexes.lisp (file)
- Special Variable: *injections*
-
A list that stores pairs of (string . predicate) to inject in the page.
- Package
coleslaw
- Source
themes.lisp (file)
- Special Variable: *last-revision*
-
The git revision prior to the last push. For use with GET-UPDATED-FILES.
- Package
coleslaw
- Source
coleslaw.lisp (file)
- Special Variable: *site*
-
An in-memory database to hold all site documents, keyed on relative URLs.
- Package
coleslaw
- Source
documents.lisp (file)
5.2.2 Macros
- Macro: do-files (VAR PATH &optional EXTENSION) &body BODY
-
For each file under PATH, run BODY. If EXTENSION is provided, only run
BODY on files that match the given extension.
- Package
coleslaw
- Source
util.lisp (file)
- Macro: do-subclasses (VAR CLASS) &body BODY
-
Iterate over the subclasses of CLASS performing BODY with VAR
lexically bound to the current subclass.
- Package
coleslaw
- Source
util.lisp (file)
- Macro: with-current-directory PATH &body BODY
-
Change the current directory to PATH and execute BODY in
an UNWIND-PROTECT, then change back to the current directory.
- Package
coleslaw
- Source
util.lisp (file)
5.2.3 Functions
- Function: all-months ()
-
Retrieve a list of all months with published content.
- Package
coleslaw
- Source
indexes.lisp (file)
- Function: all-subclasses CLASS
-
Return a list of all the subclasses of CLASS.
- Package
coleslaw
- Source
util.lisp (file)
- Function: all-tags ()
-
Retrieve a list of all tags used in content.
- Package
coleslaw
- Source
indexes.lisp (file)
- Function: app-path PATH &rest ARGS
-
Return a relative path beneath coleslaw.
- Package
coleslaw
- Source
util.lisp (file)
- Function: by-date CONTENT
-
Sort CONTENT in reverse chronological order.
- Package
coleslaw
- Source
content.lisp (file)
- Function: compile-blog STAGING
-
Compile the blog to a STAGING directory as specified in .coleslawrc.
- Package
coleslaw
- Source
coleslaw.lisp (file)
- Function: compile-theme THEME
-
Locate and compile the templates for the given THEME.
- Package
coleslaw
- Source
themes.lisp (file)
- Function: compute-url DOCUMENT UNIQUE-ID &optional CLASS
-
Compute the relative URL for a DOCUMENT based on its UNIQUE-ID. If CLASS
is provided, it overrides the route used.
- Package
coleslaw
- Source
documents.lisp (file)
- Function: construct CLASS-NAME ARGS
-
Create an instance of CLASS-NAME with the given ARGS.
- Package
coleslaw
- Source
util.lisp (file)
- Function: dir-slot-reader CONFIG NAME
-
Take CONFIG and NAME, and return a directory pathname for the matching SLOT.
- Package
coleslaw
- Source
config.lisp (file)
- Function: discover-config-path REPO-PATH
-
Check the supplied REPO-PATH for a .coleslawrc and if one
doesn’t exist, use the .coleslawrc in the home directory.
- Package
coleslaw
- Source
config.lisp (file)
- Function: enable-plugin NAME ARGS
-
Given a plugin, NAME, compile+load it and call its ENABLE function with ARGS.
- Package
coleslaw
- Source
config.lisp (file)
- Function: exit ()
-
Exit the lisp system returning a 0 status code.
- Package
coleslaw
- Source
util.lisp (file)
- Function: find-injections CONTENT
-
Iterate over *INJECTIONS* collecting any that should be added to CONTENT.
- Package
coleslaw
- Source
themes.lisp (file)
- Function: find-theme THEME
-
Find the theme prefering themes in the local repo.
- Package
coleslaw
- Source
themes.lisp (file)
- Function: fmt FMT-STR ARGS
-
A convenient FORMAT interface for string building.
- Package
coleslaw
- Source
util.lisp (file)
- Function: get-route DOC-TYPE
-
Return the route format string for DOC-TYPE.
- Package
coleslaw
- Source
documents.lisp (file)
- Function: index-by-month MONTH CONTENT
-
Return an index of all CONTENT matching the given MONTH.
- Package
coleslaw
- Source
indexes.lisp (file)
- Function: index-by-n I CONTENT
-
Return the index for the Ith page of CONTENT in reverse chronological order.
- Package
coleslaw
- Source
indexes.lisp (file)
- Function: index-by-tag TAG CONTENT
-
Return an index of all CONTENT matching the given TAG.
- Package
coleslaw
- Source
indexes.lisp (file)
- Function: load-config &optional REPO-DIR
-
Find and load the coleslaw configuration from .coleslawrc. REPO-DIR will be
preferred over the home directory if provided.
- Package
coleslaw
- Source
config.lisp (file)
- Function: load-content ()
-
Load all content stored in the blog’s repo.
- Package
coleslaw
- Source
coleslaw.lisp (file)
- Function: load-plugins PLUGINS
-
Compile and load the listed PLUGINS. It is expected that matching *.lisp files
are in the plugins folder in coleslaw’s source directory.
- Package
coleslaw
- Source
config.lisp (file)
- Function: make-tag STR
-
Takes a string and returns a TAG instance with a name and slug.
- Package
coleslaw
- Source
content.lisp (file)
- Function: month-p MONTH OBJ
-
Test if OBJ was written in MONTH.
- Package
coleslaw
- Source
content.lisp (file)
- Function: parse-initarg LINE
-
Given a metadata header, LINE, parse an initarg name/value pair from it.
- Package
coleslaw
- Source
content.lisp (file)
- Function: parse-metadata STREAM
-
Given a STREAM, parse metadata from it or signal an appropriate condition.
- Package
coleslaw
- Source
content.lisp (file)
- Function: read-content FILE
-
Returns a plist of metadata from FILE with :text holding the content.
- Package
coleslaw
- Source
content.lisp (file)
- Function: rel-path BASE PATH &rest ARGS
-
Take a relative PATH and return the corresponding pathname beneath BASE.
If ARGS is provided, use (fmt path args) as the value of PATH.
- Package
coleslaw
- Source
util.lisp (file)
- Function: render-page CONTENT &optional THEME-FN &rest RENDER-ARGS
-
Render the given CONTENT to HTML using THEME-FN if supplied.
Additional args to render CONTENT can be passed via RENDER-ARGS.
- Package
coleslaw
- Source
coleslaw.lisp (file)
- Function: repo-path PATH &rest ARGS
-
Return a relative path beneath the repo being processed.
- Package
coleslaw
- Source
util.lisp (file)
- Function: run-program PROGRAM &rest ARGS
-
Take a PROGRAM and execute the corresponding shell command. If ARGS is provided,
use (fmt program args) as the value of PROGRAM.
- Package
coleslaw
- Source
util.lisp (file)
- Function: slug-char-p CHAR &key ALLOWED-CHARS
-
Determine if CHAR is a valid slug (i.e. URL) character.
- Package
coleslaw
- Source
content.lisp (file)
- Function: slugify STRING
-
Return a version of STRING suitable for use as a URL.
- Package
coleslaw
- Source
content.lisp (file)
- Function: tag-p TAG OBJ
-
Test if OBJ is tagged with TAG.
- Package
coleslaw
- Source
content.lisp (file)
- Function: tag-slug= A B
-
Test if the slugs for tag A and B are equal.
- Package
coleslaw
- Source
content.lisp (file)
- Function: take-up-to N SEQ
-
Take elements from SEQ until all elements or N have been taken.
- Package
coleslaw
- Source
util.lisp (file)
- Function: theme-package NAME
-
Find the package matching the theme NAME or signal THEME-DOES-NOT-EXIST.
- Package
coleslaw
- Source
themes.lisp (file)
- Function: unicode-space-p CHAR
-
Determine if CHAR is a kind of whitespace by unicode category means.
- Package
coleslaw
- Source
content.lisp (file)
- Function: update-content-metadata ()
-
Set *ALL-TAGS* and *ALL-MONTHS* to the union of all tags and months
of content loaded in the DB.
- Package
coleslaw
- Source
indexes.lisp (file)
- Function: update-symlink PATH TARGET
-
Update the symlink at PATH to point to TARGET.
- Package
coleslaw
- Source
coleslaw.lisp (file)
- Function: write-file PATH TEXT
-
Write the given TEXT to PATH. PATH is overwritten if it exists and created
along with any missing parent directories otherwise.
- Package
coleslaw
- Source
util.lisp (file)
5.2.4 Generic functions
- Generic Function: charset OBJECT
-
- Package
coleslaw
- Methods
- Method: charset (BLOG blog)
-
automatically generated reader method
- Source
config.lisp (file)
- Generic Function: content-date OBJECT
-
- Package
coleslaw
- Methods
- Method: content-date (CONTENT content)
-
automatically generated reader method
- Source
content.lisp (file)
- Generic Function: content-file OBJECT
-
- Package
coleslaw
- Methods
- Method: content-file (CONTENT content)
-
automatically generated reader method
- Source
content.lisp (file)
- Generic Function: content-tags OBJECT
-
- Package
coleslaw
- Methods
- Method: content-tags (CONTENT content)
-
automatically generated reader method
- Source
content.lisp (file)
- Generic Function: dir CONDITION
-
- Package
coleslaw
- Methods
- Method: dir (CONDITION directory-does-not-exist)
-
- Source
util.lisp (file)
- Generic Function: excerpt-of OBJECT
-
- Package
coleslaw
- Methods
- Method: excerpt-of (POST post)
-
automatically generated reader method
- Source
posts.lisp (file)
- Generic Function: excerpt-sep OBJECT
-
- Package
coleslaw
- Methods
- Method: excerpt-sep (BLOG blog)
-
automatically generated reader method
- Source
config.lisp (file)
- Generic Function: feed-format OBJECT
-
- Package
coleslaw
- Methods
- Method: feed-format (BASE-FEED base-feed)
-
automatically generated reader method
- Source
feeds.lisp (file)
- Generic Function: feeds OBJECT
-
- Package
coleslaw
- Methods
- Method: feeds (BLOG blog)
-
automatically generated reader method
- Source
config.lisp (file)
- Generic Function: index-content OBJECT
-
- Package
coleslaw
- Methods
- Method: index-content (INDEX index)
-
automatically generated reader method
- Source
indexes.lisp (file)
- Generic Function: index-name OBJECT
-
- Package
coleslaw
- Methods
- Method: index-name (INDEX index)
-
automatically generated reader method
- Source
indexes.lisp (file)
- Generic Function: lang OBJECT
-
- Package
coleslaw
- Methods
- Method: lang (BLOG blog)
-
automatically generated reader method
- Source
config.lisp (file)
- Generic Function: license OBJECT
-
- Package
coleslaw
- Methods
- Method: license (BLOG blog)
-
automatically generated reader method
- Source
config.lisp (file)
- Generic Function: message CONDITION
-
- Package
coleslaw
- Methods
- Method: message (CONDITION plugin-conf-error)
-
- Source
config.lisp (file)
- Generic Function: missing-field-field-name CONDITION
-
- Package
coleslaw
- Methods
- Method: missing-field-field-name (CONDITION field-missing)
-
- Source
util.lisp (file)
- Generic Function: missing-field-file CONDITION
-
- Package
coleslaw
- Methods
- Method: missing-field-file (CONDITION field-missing)
-
- Source
util.lisp (file)
- Generic Function: plugin CONDITION
-
- Package
coleslaw
- Methods
- Method: plugin (CONDITION plugin-conf-error)
-
- Source
config.lisp (file)
- Generic Function: plugins OBJECT
-
- Package
coleslaw
- Methods
- Method: plugins (BLOG blog)
-
automatically generated reader method
- Source
config.lisp (file)
- Generic Function: post-format OBJECT
-
- Package
coleslaw
- Methods
- Method: post-format (POST post)
-
automatically generated reader method
- Source
posts.lisp (file)
- Generic Function: routing OBJECT
-
- Package
coleslaw
- Methods
- Method: routing (BLOG blog)
-
automatically generated reader method
- Source
config.lisp (file)
- Generic Function: separator OBJECT
-
- Package
coleslaw
- Methods
- Method: separator (BLOG blog)
-
automatically generated reader method
- Source
config.lisp (file)
- Generic Function: sitenav OBJECT
-
- Package
coleslaw
- Methods
- Method: sitenav (BLOG blog)
-
automatically generated reader method
- Source
config.lisp (file)
- Generic Function: tag-name OBJECT
-
- Package
coleslaw
- Methods
- Method: tag-name (TAG tag)
-
automatically generated reader method
- Source
content.lisp (file)
- Generic Function: tag-slug OBJECT
-
- Package
coleslaw
- Methods
- Method: tag-slug (TAG tag)
-
automatically generated reader method
- Source
content.lisp (file)
- Generic Function: theme OBJECT
-
- Package
coleslaw
- Methods
- Method: theme (CONDITION theme-does-not-exist)
-
- Source
themes.lisp (file)
- Method: theme (BLOG blog)
-
automatically generated reader method
- Source
config.lisp (file)
5.2.5 Conditions
- Condition: coleslaw-condition ()
-
- Package
coleslaw
- Source
util.lisp (file)
- Direct superclasses
condition (condition)
- Direct subclasses
field-missing (condition)
- Condition: directory-does-not-exist ()
-
- Package
coleslaw
- Source
util.lisp (file)
- Direct superclasses
error (condition)
- Direct methods
dir (method)
- Direct slots
- Slot: directory
-
- Initargs
:dir
- Readers
dir (generic function)
- Condition: field-missing ()
-
- Package
coleslaw
- Source
util.lisp (file)
- Direct superclasses
-
- Direct methods
-
- Direct slots
- Slot: field-name
-
- Initargs
:field-name
- Readers
missing-field-field-name (generic function)
- Slot: file
-
The path of the file where the field is missing.
- Initargs
:file
- Readers
missing-field-file (generic function)
- Condition: theme-does-not-exist ()
-
- Package
coleslaw
- Source
themes.lisp (file)
- Direct superclasses
error (condition)
- Direct methods
theme (method)
- Direct slots
- Slot: theme
-
- Initargs
:theme
- Readers
theme (generic function)
5.2.6 Classes
- Class: base-feed ()
-
- Package
coleslaw
- Source
feeds.lisp (file)
- Direct superclasses
standard-object (class)
- Direct subclasses
-
- Direct methods
feed-format (method)
- Direct slots
- Slot: format
-
- Initargs
:format
- Readers
feed-format (generic function)
- Class: blog ()
-
- Package
coleslaw
- Source
config.lisp (file)
- Direct superclasses
standard-object (class)
- Direct methods
-
- Direct slots
- Slot: author
-
- Initargs
:author
- Readers
author (generic function)
- Slot: charset
-
- Initargs
:charset
- Readers
charset (generic function)
- Slot: deploy-dir
-
- Initargs
:deploy-dir
- Readers
deploy-dir (generic function)
- Slot: domain
-
- Initargs
:domain
- Readers
domain (generic function)
- Slot: excerpt-sep
-
- Initargs
:excerpt-sep
- Readers
excerpt-sep (generic function)
- Slot: feeds
-
- Initargs
:feeds
- Readers
feeds (generic function)
- Slot: lang
-
- Initargs
:lang
- Readers
lang (generic function)
- Slot: license
-
- Initargs
:license
- Readers
license (generic function)
- Slot: page-ext
-
- Initargs
:page-ext
- Readers
page-ext (generic function)
- Slot: plugins
-
- Initargs
:plugins
- Readers
plugins (generic function)
- Slot: repo
-
- Initargs
:repo
- Readers
repo-dir (generic function)
- Writers
(setf repo-dir) (generic function)
- Slot: routing
-
- Initargs
:routing
- Readers
routing (generic function)
- Slot: separator
-
- Initargs
:separator
- Readers
separator (generic function)
- Slot: sitenav
-
- Initargs
:sitenav
- Readers
sitenav (generic function)
- Slot: staging-dir
-
- Initargs
:staging-dir
- Readers
staging-dir (generic function)
- Slot: theme
-
- Initargs
:theme
- Readers
theme (generic function)
- Slot: title
-
- Initargs
:title
- Readers
title (generic function)
- Direct Default Initargs
Initarg | Value |
:feeds | nil |
:license | nil |
:plugins | nil |
:sitenav | nil |
:excerpt-sep | "<!--more-->" |
:charset | "utf-8" |
:lang | "en" |
:page-ext | "html" |
:separator | ";;;;;" |
:staging-dir | "/tmp/coleslaw" |
- Class: feed ()
-
- Package
coleslaw
- Source
feeds.lisp (file)
- Direct superclasses
-
- Class: month-index ()
-
- Package
coleslaw
- Source
indexes.lisp (file)
- Direct superclasses
index (class)
- Class: numeric-index ()
-
- Package
coleslaw
- Source
indexes.lisp (file)
- Direct superclasses
index (class)
- Class: tag ()
-
- Package
coleslaw
- Source
content.lisp (file)
- Direct superclasses
standard-object (class)
- Direct methods
-
- Direct slots
- Slot: name
-
- Initargs
:name
- Readers
tag-name (generic function)
- Slot: slug
-
- Initargs
:slug
- Readers
tag-slug (generic function)
- Slot: url
-
- Initargs
:url
- Class: tag-feed ()
-
- Package
coleslaw
- Source
feeds.lisp (file)
- Direct superclasses
-
- Class: tag-index ()
-
- Package
coleslaw
- Source
indexes.lisp (file)
- Direct superclasses
index (class)
Appendix A Indexes
A.1 Concepts
| Index Entry | | Section |
|
C | | |
| coleslaw-conf.asd: | | The coleslaw-conf<dot>asd file |
| coleslaw-conf/coleslaw-conf.lisp: | | The coleslaw-conf/coleslaw-conf<dot>lisp file |
| coleslaw.asd: | | The coleslaw<dot>asd file |
| coleslaw/coleslaw.lisp: | | The coleslaw/coleslaw<dot>lisp file |
| coleslaw/config.lisp: | | The coleslaw/config<dot>lisp file |
| coleslaw/content.lisp: | | The coleslaw/content<dot>lisp file |
| coleslaw/documents.lisp: | | The coleslaw/documents<dot>lisp file |
| coleslaw/feeds.lisp: | | The coleslaw/feeds<dot>lisp file |
| coleslaw/indexes.lisp: | | The coleslaw/indexes<dot>lisp file |
| coleslaw/packages.lisp: | | The coleslaw/packages<dot>lisp file |
| coleslaw/posts.lisp: | | The coleslaw/posts<dot>lisp file |
| coleslaw/themes.lisp: | | The coleslaw/themes<dot>lisp file |
| coleslaw/util.lisp: | | The coleslaw/util<dot>lisp file |
|
F | | |
| File, Lisp, coleslaw-conf.asd: | | The coleslaw-conf<dot>asd file |
| File, Lisp, coleslaw-conf/coleslaw-conf.lisp: | | The coleslaw-conf/coleslaw-conf<dot>lisp file |
| File, Lisp, coleslaw.asd: | | The coleslaw<dot>asd file |
| File, Lisp, coleslaw/coleslaw.lisp: | | The coleslaw/coleslaw<dot>lisp file |
| File, Lisp, coleslaw/config.lisp: | | The coleslaw/config<dot>lisp file |
| File, Lisp, coleslaw/content.lisp: | | The coleslaw/content<dot>lisp file |
| File, Lisp, coleslaw/documents.lisp: | | The coleslaw/documents<dot>lisp file |
| File, Lisp, coleslaw/feeds.lisp: | | The coleslaw/feeds<dot>lisp file |
| File, Lisp, coleslaw/indexes.lisp: | | The coleslaw/indexes<dot>lisp file |
| File, Lisp, coleslaw/packages.lisp: | | The coleslaw/packages<dot>lisp file |
| File, Lisp, coleslaw/posts.lisp: | | The coleslaw/posts<dot>lisp file |
| File, Lisp, coleslaw/themes.lisp: | | The coleslaw/themes<dot>lisp file |
| File, Lisp, coleslaw/util.lisp: | | The coleslaw/util<dot>lisp file |
|
L | | |
| Lisp File, coleslaw-conf.asd: | | The coleslaw-conf<dot>asd file |
| Lisp File, coleslaw-conf/coleslaw-conf.lisp: | | The coleslaw-conf/coleslaw-conf<dot>lisp file |
| Lisp File, coleslaw.asd: | | The coleslaw<dot>asd file |
| Lisp File, coleslaw/coleslaw.lisp: | | The coleslaw/coleslaw<dot>lisp file |
| Lisp File, coleslaw/config.lisp: | | The coleslaw/config<dot>lisp file |
| Lisp File, coleslaw/content.lisp: | | The coleslaw/content<dot>lisp file |
| Lisp File, coleslaw/documents.lisp: | | The coleslaw/documents<dot>lisp file |
| Lisp File, coleslaw/feeds.lisp: | | The coleslaw/feeds<dot>lisp file |
| Lisp File, coleslaw/indexes.lisp: | | The coleslaw/indexes<dot>lisp file |
| Lisp File, coleslaw/packages.lisp: | | The coleslaw/packages<dot>lisp file |
| Lisp File, coleslaw/posts.lisp: | | The coleslaw/posts<dot>lisp file |
| Lisp File, coleslaw/themes.lisp: | | The coleslaw/themes<dot>lisp file |
| Lisp File, coleslaw/util.lisp: | | The coleslaw/util<dot>lisp file |
|
A.2 Functions
| Index Entry | | Section |
|
( | | |
| (setf repo-dir) : | | Exported generic functions |
| (setf repo-dir) : | | Exported generic functions |
|
A | | |
| add-document : | | Exported functions |
| add-injection : | | Exported functions |
| all-months : | | Internal functions |
| all-subclasses : | | Internal functions |
| all-tags : | | Internal functions |
| app-path : | | Internal functions |
| assert-field : | | Exported macros |
| author : | | Exported generic functions |
| author : | | Exported generic functions |
| author-of : | | Exported generic functions |
| author-of : | | Exported generic functions |
|
B | | |
| by-date : | | Internal functions |
|
C | | |
| charset : | | Internal generic functions |
| charset : | | Internal generic functions |
| compile-blog : | | Internal functions |
| compile-theme : | | Internal functions |
| compute-url : | | Internal functions |
| construct : | | Internal functions |
| content-date : | | Internal generic functions |
| content-date : | | Internal generic functions |
| content-file : | | Internal generic functions |
| content-file : | | Internal generic functions |
| content-tags : | | Internal generic functions |
| content-tags : | | Internal generic functions |
| content-text : | | Exported generic functions |
| content-text : | | Exported generic functions |
|
D | | |
| delete-document : | | Exported functions |
| deploy : | | Exported generic functions |
| deploy : | | Exported generic functions |
| deploy-dir : | | Exported generic functions |
| deploy-dir : | | Exported generic functions |
| dir : | | Internal generic functions |
| dir : | | Internal generic functions |
| dir-slot-reader : | | Internal functions |
| discover : | | Exported generic functions |
| discover : | | Exported generic functions |
| discover : | | Exported generic functions |
| discover : | | Exported generic functions |
| discover : | | Exported generic functions |
| discover : | | Exported generic functions |
| discover : | | Exported generic functions |
| discover : | | Exported generic functions |
| discover-config-path : | | Internal functions |
| do-files : | | Internal macros |
| do-subclasses : | | Internal macros |
| domain : | | Exported generic functions |
| domain : | | Exported generic functions |
|
E | | |
| enable-plugin : | | Internal functions |
| excerpt-of : | | Internal generic functions |
| excerpt-of : | | Internal generic functions |
| excerpt-sep : | | Internal generic functions |
| excerpt-sep : | | Internal generic functions |
| exit : | | Internal functions |
|
F | | |
| feed-format : | | Internal generic functions |
| feed-format : | | Internal generic functions |
| feeds : | | Internal generic functions |
| feeds : | | Internal generic functions |
| find-all : | | Exported functions |
| find-content-by-path : | | Exported functions |
| find-injections : | | Internal functions |
| find-theme : | | Internal functions |
| fmt : | | Internal functions |
| Function, add-document : | | Exported functions |
| Function, add-injection : | | Exported functions |
| Function, all-months : | | Internal functions |
| Function, all-subclasses : | | Internal functions |
| Function, all-tags : | | Internal functions |
| Function, app-path : | | Internal functions |
| Function, by-date : | | Internal functions |
| Function, compile-blog : | | Internal functions |
| Function, compile-theme : | | Internal functions |
| Function, compute-url : | | Internal functions |
| Function, construct : | | Internal functions |
| Function, delete-document : | | Exported functions |
| Function, dir-slot-reader : | | Internal functions |
| Function, discover-config-path : | | Internal functions |
| Function, enable-plugin : | | Internal functions |
| Function, exit : | | Internal functions |
| Function, find-all : | | Exported functions |
| Function, find-content-by-path : | | Exported functions |
| Function, find-injections : | | Internal functions |
| Function, find-theme : | | Internal functions |
| Function, fmt : | | Internal functions |
| Function, get-route : | | Internal functions |
| Function, get-updated-files : | | Exported functions |
| Function, index-by-month : | | Internal functions |
| Function, index-by-n : | | Internal functions |
| Function, index-by-tag : | | Internal functions |
| Function, load-config : | | Internal functions |
| Function, load-content : | | Internal functions |
| Function, load-plugins : | | Internal functions |
| Function, main : | | Exported functions |
| Function, make-tag : | | Internal functions |
| Function, month-p : | | Internal functions |
| Function, parse-initarg : | | Internal functions |
| Function, parse-metadata : | | Internal functions |
| Function, preview : | | Exported functions |
| Function, purge-all : | | Exported functions |
| Function, read-content : | | Internal functions |
| Function, rel-path : | | Internal functions |
| Function, render-page : | | Internal functions |
| Function, repo-path : | | Internal functions |
| Function, run-program : | | Internal functions |
| Function, set-basedir : | | Exported functions |
| Function, slug-char-p : | | Internal functions |
| Function, slugify : | | Internal functions |
| Function, tag-p : | | Internal functions |
| Function, tag-slug= : | | Internal functions |
| Function, take-up-to : | | Internal functions |
| Function, theme-fn : | | Exported functions |
| Function, theme-package : | | Internal functions |
| Function, unicode-space-p : | | Internal functions |
| Function, update-content-metadata : | | Internal functions |
| Function, update-symlink : | | Internal functions |
| Function, write-document : | | Exported functions |
| Function, write-file : | | Internal functions |
|
G | | |
| Generic Function, (setf repo-dir) : | | Exported generic functions |
| Generic Function, author : | | Exported generic functions |
| Generic Function, author-of : | | Exported generic functions |
| Generic Function, charset : | | Internal generic functions |
| Generic Function, content-date : | | Internal generic functions |
| Generic Function, content-file : | | Internal generic functions |
| Generic Function, content-tags : | | Internal generic functions |
| Generic Function, content-text : | | Exported generic functions |
| Generic Function, deploy : | | Exported generic functions |
| Generic Function, deploy-dir : | | Exported generic functions |
| Generic Function, dir : | | Internal generic functions |
| Generic Function, discover : | | Exported generic functions |
| Generic Function, domain : | | Exported generic functions |
| Generic Function, excerpt-of : | | Internal generic functions |
| Generic Function, excerpt-sep : | | Internal generic functions |
| Generic Function, feed-format : | | Internal generic functions |
| Generic Function, feeds : | | Internal generic functions |
| Generic Function, index-content : | | Internal generic functions |
| Generic Function, index-name : | | Internal generic functions |
| Generic Function, lang : | | Internal generic functions |
| Generic Function, license : | | Internal generic functions |
| Generic Function, message : | | Internal generic functions |
| Generic Function, missing-field-field-name : | | Internal generic functions |
| Generic Function, missing-field-file : | | Internal generic functions |
| Generic Function, page-ext : | | Exported generic functions |
| Generic Function, page-url : | | Exported generic functions |
| Generic Function, plugin : | | Internal generic functions |
| Generic Function, plugins : | | Internal generic functions |
| Generic Function, post-format : | | Internal generic functions |
| Generic Function, publish : | | Exported generic functions |
| Generic Function, render : | | Exported generic functions |
| Generic Function, render-text : | | Exported generic functions |
| Generic Function, repo-dir : | | Exported generic functions |
| Generic Function, routing : | | Internal generic functions |
| Generic Function, separator : | | Internal generic functions |
| Generic Function, sitenav : | | Internal generic functions |
| Generic Function, staging-dir : | | Exported generic functions |
| Generic Function, tag-name : | | Internal generic functions |
| Generic Function, tag-slug : | | Internal generic functions |
| Generic Function, theme : | | Internal generic functions |
| Generic Function, title : | | Exported generic functions |
| Generic Function, title-of : | | Exported generic functions |
| get-route : | | Internal functions |
| get-updated-files : | | Exported functions |
|
I | | |
| index-by-month : | | Internal functions |
| index-by-n : | | Internal functions |
| index-by-tag : | | Internal functions |
| index-content : | | Internal generic functions |
| index-content : | | Internal generic functions |
| index-name : | | Internal generic functions |
| index-name : | | Internal generic functions |
|
L | | |
| lang : | | Internal generic functions |
| lang : | | Internal generic functions |
| license : | | Internal generic functions |
| license : | | Internal generic functions |
| load-config : | | Internal functions |
| load-content : | | Internal functions |
| load-plugins : | | Internal functions |
|
M | | |
| Macro, assert-field : | | Exported macros |
| Macro, do-files : | | Internal macros |
| Macro, do-subclasses : | | Internal macros |
| Macro, with-current-directory : | | Internal macros |
| main : | | Exported functions |
| make-tag : | | Internal functions |
| message : | | Internal generic functions |
| message : | | Internal generic functions |
| Method, (setf repo-dir) : | | Exported generic functions |
| Method, author : | | Exported generic functions |
| Method, author-of : | | Exported generic functions |
| Method, charset : | | Internal generic functions |
| Method, content-date : | | Internal generic functions |
| Method, content-file : | | Internal generic functions |
| Method, content-tags : | | Internal generic functions |
| Method, content-text : | | Exported generic functions |
| Method, deploy : | | Exported generic functions |
| Method, deploy-dir : | | Exported generic functions |
| Method, dir : | | Internal generic functions |
| Method, discover : | | Exported generic functions |
| Method, discover : | | Exported generic functions |
| Method, discover : | | Exported generic functions |
| Method, discover : | | Exported generic functions |
| Method, discover : | | Exported generic functions |
| Method, discover : | | Exported generic functions |
| Method, discover : | | Exported generic functions |
| Method, domain : | | Exported generic functions |
| Method, excerpt-of : | | Internal generic functions |
| Method, excerpt-sep : | | Internal generic functions |
| Method, feed-format : | | Internal generic functions |
| Method, feeds : | | Internal generic functions |
| Method, index-content : | | Internal generic functions |
| Method, index-name : | | Internal generic functions |
| Method, lang : | | Internal generic functions |
| Method, license : | | Internal generic functions |
| Method, message : | | Internal generic functions |
| Method, missing-field-field-name : | | Internal generic functions |
| Method, missing-field-file : | | Internal generic functions |
| Method, page-ext : | | Exported generic functions |
| Method, page-url : | | Exported generic functions |
| Method, page-url : | | Exported generic functions |
| Method, plugin : | | Internal generic functions |
| Method, plugins : | | Internal generic functions |
| Method, post-format : | | Internal generic functions |
| Method, publish : | | Exported generic functions |
| Method, publish : | | Exported generic functions |
| Method, publish : | | Exported generic functions |
| Method, publish : | | Exported generic functions |
| Method, publish : | | Exported generic functions |
| Method, publish : | | Exported generic functions |
| Method, render : | | Exported generic functions |
| Method, render : | | Exported generic functions |
| Method, render-text : | | Exported generic functions |
| Method, render-text : | | Exported generic functions |
| Method, repo-dir : | | Exported generic functions |
| Method, routing : | | Internal generic functions |
| Method, separator : | | Internal generic functions |
| Method, sitenav : | | Internal generic functions |
| Method, staging-dir : | | Exported generic functions |
| Method, tag-name : | | Internal generic functions |
| Method, tag-slug : | | Internal generic functions |
| Method, theme : | | Internal generic functions |
| Method, theme : | | Internal generic functions |
| Method, title : | | Exported generic functions |
| Method, title-of : | | Exported generic functions |
| Method, title-of : | | Exported generic functions |
| missing-field-field-name : | | Internal generic functions |
| missing-field-field-name : | | Internal generic functions |
| missing-field-file : | | Internal generic functions |
| missing-field-file : | | Internal generic functions |
| month-p : | | Internal functions |
|
P | | |
| page-ext : | | Exported generic functions |
| page-ext : | | Exported generic functions |
| page-url : | | Exported generic functions |
| page-url : | | Exported generic functions |
| page-url : | | Exported generic functions |
| parse-initarg : | | Internal functions |
| parse-metadata : | | Internal functions |
| plugin : | | Internal generic functions |
| plugin : | | Internal generic functions |
| plugins : | | Internal generic functions |
| plugins : | | Internal generic functions |
| post-format : | | Internal generic functions |
| post-format : | | Internal generic functions |
| preview : | | Exported functions |
| publish : | | Exported generic functions |
| publish : | | Exported generic functions |
| publish : | | Exported generic functions |
| publish : | | Exported generic functions |
| publish : | | Exported generic functions |
| publish : | | Exported generic functions |
| publish : | | Exported generic functions |
| purge-all : | | Exported functions |
|
R | | |
| read-content : | | Internal functions |
| rel-path : | | Internal functions |
| render : | | Exported generic functions |
| render : | | Exported generic functions |
| render : | | Exported generic functions |
| render-page : | | Internal functions |
| render-text : | | Exported generic functions |
| render-text : | | Exported generic functions |
| render-text : | | Exported generic functions |
| repo-dir : | | Exported generic functions |
| repo-dir : | | Exported generic functions |
| repo-path : | | Internal functions |
| routing : | | Internal generic functions |
| routing : | | Internal generic functions |
| run-program : | | Internal functions |
|
S | | |
| separator : | | Internal generic functions |
| separator : | | Internal generic functions |
| set-basedir : | | Exported functions |
| sitenav : | | Internal generic functions |
| sitenav : | | Internal generic functions |
| slug-char-p : | | Internal functions |
| slugify : | | Internal functions |
| staging-dir : | | Exported generic functions |
| staging-dir : | | Exported generic functions |
|
T | | |
| tag-name : | | Internal generic functions |
| tag-name : | | Internal generic functions |
| tag-p : | | Internal functions |
| tag-slug : | | Internal generic functions |
| tag-slug : | | Internal generic functions |
| tag-slug= : | | Internal functions |
| take-up-to : | | Internal functions |
| theme : | | Internal generic functions |
| theme : | | Internal generic functions |
| theme : | | Internal generic functions |
| theme-fn : | | Exported functions |
| theme-package : | | Internal functions |
| title : | | Exported generic functions |
| title : | | Exported generic functions |
| title-of : | | Exported generic functions |
| title-of : | | Exported generic functions |
| title-of : | | Exported generic functions |
|
U | | |
| unicode-space-p : | | Internal functions |
| update-content-metadata : | | Internal functions |
| update-symlink : | | Internal functions |
|
W | | |
| with-current-directory : | | Internal macros |
| write-document : | | Exported functions |
| write-file : | | Internal functions |
|
A.3 Variables
| Index Entry | | Section |
|
* | | |
| *all-months* : | | Internal special variables |
| *all-tags* : | | Internal special variables |
| *basedir* : | | Exported special variables |
| *config* : | | Exported special variables |
| *injections* : | | Internal special variables |
| *last-revision* : | | Internal special variables |
| *site* : | | Internal special variables |
|
A | | |
| author : | | Exported classes |
| author : | | Internal classes |
|
C | | |
| charset : | | Internal classes |
| content : | | Exported classes |
|
D | | |
| date : | | Exported classes |
| deploy-dir : | | Internal classes |
| directory : | | Internal conditions |
| domain : | | Internal classes |
|
E | | |
| excerpt : | | Exported classes |
| excerpt-sep : | | Internal classes |
|
F | | |
| feeds : | | Internal classes |
| field-name : | | Internal conditions |
| file : | | Exported classes |
| file : | | Internal conditions |
| format : | | Exported classes |
| format : | | Internal classes |
|
L | | |
| lang : | | Internal classes |
| license : | | Internal classes |
|
M | | |
| message : | | Exported conditions |
|
N | | |
| name : | | Exported classes |
| name : | | Internal classes |
|
P | | |
| page-ext : | | Internal classes |
| plugin : | | Exported conditions |
| plugins : | | Internal classes |
|
R | | |
| repo : | | Internal classes |
| routing : | | Internal classes |
|
S | | |
| separator : | | Internal classes |
| sitenav : | | Internal classes |
| Slot, author : | | Exported classes |
| Slot, author : | | Internal classes |
| Slot, charset : | | Internal classes |
| Slot, content : | | Exported classes |
| Slot, date : | | Exported classes |
| Slot, deploy-dir : | | Internal classes |
| Slot, directory : | | Internal conditions |
| Slot, domain : | | Internal classes |
| Slot, excerpt : | | Exported classes |
| Slot, excerpt-sep : | | Internal classes |
| Slot, feeds : | | Internal classes |
| Slot, field-name : | | Internal conditions |
| Slot, file : | | Exported classes |
| Slot, file : | | Internal conditions |
| Slot, format : | | Exported classes |
| Slot, format : | | Internal classes |
| Slot, lang : | | Internal classes |
| Slot, license : | | Internal classes |
| Slot, message : | | Exported conditions |
| Slot, name : | | Exported classes |
| Slot, name : | | Internal classes |
| Slot, page-ext : | | Internal classes |
| Slot, plugin : | | Exported conditions |
| Slot, plugins : | | Internal classes |
| Slot, repo : | | Internal classes |
| Slot, routing : | | Internal classes |
| Slot, separator : | | Internal classes |
| Slot, sitenav : | | Internal classes |
| Slot, slug : | | Internal classes |
| Slot, staging-dir : | | Internal classes |
| Slot, tags : | | Exported classes |
| Slot, text : | | Exported classes |
| Slot, theme : | | Internal conditions |
| Slot, theme : | | Internal classes |
| Slot, title : | | Exported classes |
| Slot, title : | | Exported classes |
| Slot, title : | | Internal classes |
| Slot, url : | | Exported classes |
| Slot, url : | | Exported classes |
| Slot, url : | | Internal classes |
| slug : | | Internal classes |
| Special Variable, *all-months* : | | Internal special variables |
| Special Variable, *all-tags* : | | Internal special variables |
| Special Variable, *basedir* : | | Exported special variables |
| Special Variable, *config* : | | Exported special variables |
| Special Variable, *injections* : | | Internal special variables |
| Special Variable, *last-revision* : | | Internal special variables |
| Special Variable, *site* : | | Internal special variables |
| staging-dir : | | Internal classes |
|
T | | |
| tags : | | Exported classes |
| text : | | Exported classes |
| theme : | | Internal conditions |
| theme : | | Internal classes |
| title : | | Exported classes |
| title : | | Exported classes |
| title : | | Internal classes |
|
U | | |
| url : | | Exported classes |
| url : | | Exported classes |
| url : | | Internal classes |
|
A.4 Data types
| Index Entry | | Section |
|
B | | |
| base-feed : | | Internal classes |
| blog : | | Internal classes |
|
C | | |
| Class, base-feed : | | Internal classes |
| Class, blog : | | Internal classes |
| Class, content : | | Exported classes |
| Class, feed : | | Internal classes |
| Class, index : | | Exported classes |
| Class, month-index : | | Internal classes |
| Class, numeric-index : | | Internal classes |
| Class, post : | | Exported classes |
| Class, tag : | | Internal classes |
| Class, tag-feed : | | Internal classes |
| Class, tag-index : | | Internal classes |
| coleslaw : | | The coleslaw system |
| coleslaw : | | The coleslaw package |
| coleslaw-condition : | | Internal conditions |
| coleslaw-conf : | | The coleslaw-conf system |
| coleslaw-conf : | | The coleslaw-conf package |
| Condition, coleslaw-condition : | | Internal conditions |
| Condition, directory-does-not-exist : | | Internal conditions |
| Condition, field-missing : | | Internal conditions |
| Condition, plugin-conf-error : | | Exported conditions |
| Condition, theme-does-not-exist : | | Internal conditions |
| content : | | Exported classes |
|
D | | |
| directory-does-not-exist : | | Internal conditions |
|
F | | |
| feed : | | Internal classes |
| field-missing : | | Internal conditions |
|
I | | |
| index : | | Exported classes |
|
M | | |
| month-index : | | Internal classes |
|
N | | |
| numeric-index : | | Internal classes |
|
P | | |
| Package, coleslaw : | | The coleslaw package |
| Package, coleslaw-conf : | | The coleslaw-conf package |
| plugin-conf-error : | | Exported conditions |
| post : | | Exported classes |
|
S | | |
| System, coleslaw : | | The coleslaw system |
| System, coleslaw-conf : | | The coleslaw-conf system |
|
T | | |
| tag : | | Internal classes |
| tag-feed : | | Internal classes |
| tag-index : | | Internal classes |
| theme-does-not-exist : | | Internal conditions |
|