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 3.0 "Montgomery Scott" on Wed Mar 25 17:51:42 2020 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?

• IRC in #coleslaw on Freenode!
• Subscribe to the mailing list coleslaw@common-lisp.net.

See the wiki for a list of coleslaw-powered blogs.

Coleslaw should run on any conforming Common Lisp implementations but testing is primarily done on SBCL and CCL.

Features

• Git for storage
• RSS/Atom feeds
• Themes
• A Plugin API and plugins for...

| plugins | plugins | plugins | |--------------------------------------------------------|----------------------------------------------|-------------------------------------------------------| | Sitemap generation | Incremental builds | Analytics via Google or Piwik | | Comments via Disqus | Comments via isso | Hosting via Amazon S3 | | Hosting via Github Pages | Embedding gfycats | Tweeting about new posts | | Mathjax | Posts in ReStructured Text | Wordpress import | | Pygments | colorize | |

Installation/Tutorial

Step 1: Install this library.

$ ros install coleslaw-org/coleslaw      # With [Roswell](https://roswell.github.io/)
$ export PATH="$HOME/.roswell/bin:$PATH" # If you haven't done this before for Roswell
or
CL-USER> (ql:quickload :coleslaw-cli)

Step 2: Initialize your blog repository.

$ mkdir yourblog ; cd yourblog
$ git init
$ coleslaw setup              # or
CL-USER> (coleslaw-cli:setup)

coleslaw setup / (coleslaw-cli:setup) will generate a .coleslawrc file in the current directory, which contains the configuration of the static website.

Step 3: Write a post file in the current directory. The file should contain a certain metadata, so use the coleslaw new command, which instantiates a correct file for you.

$ coleslaw new
Created a post 2017-11-06.post .
# or 
CL-USER> (coleslaw-cli:new "post")
Created a post 2017-11-06.post .

Step 4: Generate the site from those post files. The result goes to the staging directory specified in the .coleslawrc file. The staging directory is /tmp/coleslaw/ by default.

$ coleslaw          # or
$ coleslaw generate # or
$ coleslaw stage    # or
CL-USER> (coleslaw-cli:generate) ; or
CL-USER> (coleslaw-cli:stage)    ; --- these are all aliases

Step 5: You can launch a web server to check the result on a browser. (Running a webserver sometimes has a benefit over just opening an html file, e.g. the relative links behaves differently on a file:/// protocol)

$ coleslaw preview     # or
CL-USER> (coleslaw-cli:preview)

Step 6: and watch the file system to automatically regenerate the site!

$ coleslaw watch          # or even better,
$ coleslaw watch-preview  # or, on REPL,
CL-USER> (coleslaw-cli:watch)      ;; watch-preview does not work on REPL right now

Step 7: When you think your article is publishable, run

$ coleslaw deploy             # or
CL-USER> (coleslaw-cli:deploy)

To move the contents in the staging dir to the deploy dir. By default, this deploy command uses rsync to sync the directories, where the deploy dir could be a remote directory on the server which is running your website. By using a plugin, you can customize this behavior e.g. running the deploy on gh-pages.

For further customization, e.g. adding a new plugin, developing a new plugin, changing the deploy option, or creating a new theme, see the config docs.

We provide three default themes: hyde, the default, and readable (based on bootswatch readable).

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.

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

• closure-template
• 3bmd
• 3bmd-ext-code-blocks
• alexandria
• local-time
• inferior-shell
• cl-fad
• cl-ppcre
• closer-mop
• cl-unicode
• uiop

Source

coleslaw.asd (file)

Components

• coleslaw-conf.lisp (file)
• packages.lisp (file)
• util.lisp (file)
• config.lisp (file)
• themes.lisp (file)
• documents.lisp (file)
• content.lisp (file)
• posts.lisp (file)
• indexes.lisp (file)
• feeds.lisp (file)
• coleslaw.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-20191130-git/coleslaw.asd

Systems

coleslaw (system)

3.1.2 coleslaw/coleslaw-conf.lisp

Parent

coleslaw (system)

Location

coleslaw-conf.lisp

Packages

coleslaw-conf

Exported Definitions

*basedir* (special variable)

3.1.3 coleslaw/packages.lisp

Dependency

coleslaw-conf.lisp (file)

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

• assert-field (macro)
• get-updated-files (function)

Internal Definitions

• all-subclasses (function)
• app-path (function)
• coleslaw-condition (condition)
• construct (function)
• dir (method)
• directory-does-not-exist (condition)
• do-files (macro)
• do-subclasses (macro)
• exit (function)
• field-missing (condition)
• fmt (function)
• missing-field-field-name (method)
• missing-field-file (method)
• rel-path (function)
• repo-path (function)
• run-program (function)
• take-up-to (function)
• with-current-directory (macro)
• write-file (function)

3.1.5 coleslaw/config.lisp

Dependency

util.lisp (file)

Parent

coleslaw (system)

Location

config.lisp

Exported Definitions

• *config* (special variable)
• author (method)
• deploy-dir (method)
• domain (method)
• page-ext (method)
• plugin-conf-error (condition)
• repo-dir (method)
• (setf repo-dir) (method)
• staging-dir (method)
• title (method)

Internal Definitions

• blog (class)
• charset (method)
• dir-slot-reader (function)
• discover-config-path (function)
• enable-plugin (function)
• excerpt-sep (method)
• feeds (method)
• lang (method)
• license (method)
• load-config (function)
• load-plugins (function)
• message (method)
• plugin (method)
• plugins (method)
• routing (method)
• separator (method)
• sitenav (method)
• theme (method)

3.1.6 coleslaw/themes.lisp

Dependency

config.lisp (file)

Parent

coleslaw (system)

Location

themes.lisp

Exported Definitions

• add-injection (function)
• theme-fn (function)

Internal Definitions

• *injections* (special variable)
• compile-theme (function)
• find-injections (function)
• find-theme (function)
• theme (method)
• theme-does-not-exist (condition)
• theme-package (function)

3.1.7 coleslaw/documents.lisp

Dependency

themes.lisp (file)

Parent

coleslaw (system)

Location

documents.lisp

Exported Definitions

• add-document (function)
• delete-document (function)
• discover (generic function)
• discover (method)
• discover (method)
• find-all (function)
• page-url (generic function)
• publish (generic function)
• purge-all (function)
• render (generic function)
• write-document (function)

Internal Definitions

• *site* (special variable)
• compute-url (function)
• get-route (function)

3.1.8 coleslaw/content.lisp

Dependency

documents.lisp (file)

Parent

coleslaw (system)

Location

content.lisp

Exported Definitions

• content (class)
• content-text (method)
• find-content-by-path (function)
• page-url (method)
• render-text (generic function)
• render-text (method)
• render-text (method)

Internal Definitions

• by-date (function)
• content-date (method)
• content-file (method)
• content-tags (method)
• make-tag (function)
• month-p (function)
• parse-initarg (function)
• parse-metadata (function)
• read-content (function)
• slug-char-p (function)
• slugify (function)
• tag (class)
• tag-name (method)
• tag-p (function)
• tag-slug (method)
• tag-slug= (function)
• unicode-space-p (function)

3.1.9 coleslaw/posts.lisp

Dependency

content.lisp (file)

Parent

coleslaw (system)

Location

posts.lisp

Exported Definitions

• author-of (method)
• post (class)
• publish (method)
• render (method)
• title-of (method)

Internal Definitions

• excerpt-of (method)
• post-format (method)

3.1.10 coleslaw/indexes.lisp

Dependency

posts.lisp (file)

Parent

coleslaw (system)

Location

indexes.lisp

Exported Definitions

• discover (method)
• discover (method)
• discover (method)
• index (class)
• page-url (method)
• publish (method)
• publish (method)
• publish (method)
• render (method)
• title-of (method)

Internal Definitions

• *all-months* (special variable)
• *all-tags* (special variable)
• all-months (function)
• all-tags (function)
• index-by-month (function)
• index-by-n (function)
• index-by-tag (function)
• index-content (method)
• index-name (method)
• month-index (class)
• numeric-index (class)
• tag-index (class)
• update-content-metadata (function)

3.1.11 coleslaw/feeds.lisp

Dependency

indexes.lisp (file)

Parent

coleslaw (system)

Location

feeds.lisp

Exported Definitions

• discover (method)
• discover (method)
• publish (method)
• publish (method)

Internal Definitions

• base-feed (class)
• feed (class)
• feed-format (method)
• tag-feed (class)

3.1.12 coleslaw/coleslaw.lisp

Dependency

feeds.lisp (file)

Parent

coleslaw (system)

Location

coleslaw.lisp

Exported Definitions

• deploy (generic function)
• deploy (method)
• main (function)
• preview (function)

Internal Definitions

• *last-revision* (special variable)
• compile-blog (function)
• load-content (function)
• render-page (function)
• update-symlink (function)

4 Packages

Packages are listed by definition order.

4.1 coleslaw-conf

Source

coleslaw-conf.lisp (file)

Use List

common-lisp

Exported Definitions

*basedir* (special variable)

4.2 coleslaw

Homepage: <a href="http://github.com/redline6561/coleslaw">Github</a>

Source

packages.lisp (file)

Use List

common-lisp

Exported Definitions

• *config* (special variable)
• add-document (function)
• add-injection (function)
• assert-field (macro)
• author (generic function)
• author (method)
• author-of (generic function)
• author-of (method)
• content (class)
• content-text (generic function)
• content-text (method)
• delete-document (function)
• deploy (generic function)
• deploy (method)
• deploy-dir (generic function)
• deploy-dir (method)
• discover (generic function)
• discover (method)
• discover (method)
• discover (method)
• discover (method)
• discover (method)
• discover (method)
• discover (method)
• domain (generic function)
• domain (method)
• find-all (function)
• find-content-by-path (function)
• get-updated-files (function)
• index (class)
• main (function)
• page-ext (generic function)
• page-ext (method)
• page-url (generic function)
• page-url (method)
• page-url (method)
• plugin-conf-error (condition)
• post (class)
• preview (function)
• publish (generic function)
• publish (method)
• publish (method)
• publish (method)
• publish (method)
• publish (method)
• publish (method)
• purge-all (function)
• render (generic function)
• render (method)
• render (method)
• render-text (generic function)
• render-text (method)
• render-text (method)
• repo-dir (generic function)
• repo-dir (method)
• (setf repo-dir) (method)
• (setf repo-dir) (generic function)
• staging-dir (generic function)
• staging-dir (method)
• theme-fn (function)
• title (generic function)
• title (method)
• title-of (generic function)
• title-of (method)
• title-of (method)
• write-document (function)

Internal Definitions

• *all-months* (special variable)
• *all-tags* (special variable)
• *injections* (special variable)
• *last-revision* (special variable)
• *site* (special variable)
• all-months (function)
• all-subclasses (function)
• all-tags (function)
• app-path (function)
• base-feed (class)
• blog (class)
• by-date (function)
• charset (generic function)
• charset (method)
• coleslaw-condition (condition)
• compile-blog (function)
• compile-theme (function)
• compute-url (function)
• construct (function)
• content-date (generic function)
• content-date (method)
• content-file (generic function)
• content-file (method)
• content-tags (generic function)
• content-tags (method)
• dir (generic function)
• dir (method)
• dir-slot-reader (function)
• directory-does-not-exist (condition)
• discover-config-path (function)
• do-files (macro)
• do-subclasses (macro)
• enable-plugin (function)
• excerpt-of (generic function)
• excerpt-of (method)
• excerpt-sep (generic function)
• excerpt-sep (method)
• exit (function)
• feed (class)
• feed-format (generic function)
• feed-format (method)
• feeds (generic function)
• feeds (method)
• field-missing (condition)
• find-injections (function)
• find-theme (function)
• fmt (function)
• get-route (function)
• index-by-month (function)
• index-by-n (function)
• index-by-tag (function)
• index-content (generic function)
• index-content (method)
• index-name (generic function)
• index-name (method)
• lang (generic function)
• lang (method)
• license (generic function)
• license (method)
• load-config (function)
• load-content (function)
• load-plugins (function)
• make-tag (function)
• message (generic function)
• message (method)
• missing-field-field-name (generic function)
• missing-field-field-name (method)
• missing-field-file (generic function)
• missing-field-file (method)
• month-index (class)
• month-p (function)
• numeric-index (class)
• parse-initarg (function)
• parse-metadata (function)
• plugin (generic function)
• plugin (method)
• plugins (generic function)
• plugins (method)
• post-format (generic function)
• post-format (method)
• read-content (function)
• rel-path (function)
• render-page (function)
• repo-path (function)
• routing (generic function)
• routing (method)
• run-program (function)
• separator (generic function)
• separator (method)
• sitenav (generic function)
• sitenav (method)
• slug-char-p (function)
• slugify (function)
• tag (class)
• tag-feed (class)
• tag-index (class)
• tag-name (generic function)
• tag-name (method)
• tag-p (function)
• tag-slug (generic function)
• tag-slug (method)
• tag-slug= (function)
• take-up-to (function)
• theme (generic function)
• theme (method)
• theme (method)
• theme-does-not-exist (condition)
• theme-package (function)
• unicode-space-p (function)
• update-content-metadata (function)
• update-symlink (function)
• with-current-directory (macro)
• write-file (function)

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*

A pathname pointing to Coleslaw’s top level directory.

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 &key OLDREV DEPLOY

Load the user’s config file, compile the blog in REPO-DIR into STAGING-DIR, and optionally deploy the blog to DEPLOY-DIR.
OLDREV – the git revision prior to the last push.
DEPLOY – when non-nil, perform the deploy. (default: t)

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

By default, do nothing

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

• message (method)
• plugin (method)

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

• initialize-instance (method)
• content-text (method)
• content-tags (method)
• content-file (method)
• content-date (method)
• page-url (method)

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

• tag-index (class)
• month-index (class)
• numeric-index (class)
• feed (class)
• tag-feed (class)

Direct methods

• render (method)
• initialize-instance (method)
• index-content (method)
• title-of (method)
• index-name (method)
• page-url (method)

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

• render (method)
• initialize-instance (method)
• post-format (method)
• excerpt-of (method)
• author-of (method)
• title-of (method)

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

• coleslaw-condition (condition)
• error (condition)

Direct methods

• missing-field-file (method)
• missing-field-field-name (method)

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

• feed (class)
• tag-feed (class)

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

• staging-dir (method)
• repo-dir (method)
• deploy-dir (method)
• title (method)
• theme (method)
• sitenav (method)
• separator (method)
• routing (method)
• repo-dir (method)
• plugins (method)
• page-ext (method)
• license (method)
• lang (method)
• feeds (method)
• excerpt-sep (method)
• domain (method)
• charset (method)
• author (method)

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	(quote ((coleslaw::rsync "-avz" "--delete" "--exclude" ".git/" "--exclude" ".gitignore" "--copy-links")))
: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

• base-feed (class)
• index (class)

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

• initialize-instance (method)
• tag-slug (method)
• tag-name (method)

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

• base-feed (class)
• index (class)

Class: tag-index ()

Package

coleslaw

Source

indexes.lisp (file)

Direct superclasses

index (class)

Appendix A Indexes

A.1 Concepts

A.2 Functions