The coleslaw Reference Manual

This is the coleslaw Reference Manual, version 0.9.7, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 21:05:53 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 coleslaw

Flexible Lisp Blogware

Author

Brit Butler <>

License

BSD

Version

0.9.7

Dependencies
  • closure-template (system).
  • 3bmd (system).
  • 3bmd-ext-code-blocks (system).
  • alexandria (system).
  • local-time (system).
  • inferior-shell (system).
  • cl-fad (system).
  • cl-ppcre (system).
  • closer-mop (system).
  • cl-unicode (system).
  • uiop (system).
Source

coleslaw.asd.

Child Components

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


3.1 Lisp


3.1.1 coleslaw/coleslaw.asd

Source

coleslaw.asd.

Parent Component

coleslaw (system).

ASDF Systems

coleslaw.


3.1.2 coleslaw/coleslaw-conf.lisp

Source

coleslaw.asd.

Parent Component

coleslaw (system).

Packages

coleslaw-conf.

Public Interface

*basedir* (special variable).


3.1.3 coleslaw/packages.lisp

Dependency

coleslaw-conf.lisp (file).

Source

coleslaw.asd.

Parent Component

coleslaw (system).

Packages

coleslaw.


3.1.4 coleslaw/util.lisp

Dependency

packages.lisp (file).

Source

coleslaw.asd.

Parent Component

coleslaw (system).

Public Interface
Internals

3.1.5 coleslaw/config.lisp

Dependency

util.lisp (file).

Source

coleslaw.asd.

Parent Component

coleslaw (system).

Public Interface
Internals

3.1.6 coleslaw/themes.lisp

Dependency

config.lisp (file).

Source

coleslaw.asd.

Parent Component

coleslaw (system).

Public Interface
Internals

3.1.7 coleslaw/documents.lisp

Dependency

themes.lisp (file).

Source

coleslaw.asd.

Parent Component

coleslaw (system).

Public Interface
Internals

3.1.8 coleslaw/content.lisp

Dependency

documents.lisp (file).

Source

coleslaw.asd.

Parent Component

coleslaw (system).

Public Interface
Internals

3.1.9 coleslaw/posts.lisp

Dependency

content.lisp (file).

Source

coleslaw.asd.

Parent Component

coleslaw (system).

Public Interface
Internals

3.1.10 coleslaw/indexes.lisp

Dependency

posts.lisp (file).

Source

coleslaw.asd.

Parent Component

coleslaw (system).

Public Interface
Internals

3.1.11 coleslaw/feeds.lisp

Dependency

indexes.lisp (file).

Source

coleslaw.asd.

Parent Component

coleslaw (system).

Public Interface
Internals

3.1.12 coleslaw/coleslaw.lisp

Dependency

feeds.lisp (file).

Source

coleslaw.asd.

Parent Component

coleslaw (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 coleslaw-conf

Source

coleslaw-conf.lisp.

Use List

common-lisp.

Public Interface

*basedir* (special variable).


4.2 coleslaw

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

Source

packages.lisp.

Use List

common-lisp.

Public Interface
Internals

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


5.1 Public Interface


5.1.1 Special variables

Special Variable: *basedir*

A pathname pointing to Coleslaw’s top level directory.

Package

coleslaw-conf.

Source

coleslaw-conf.lisp.

Special Variable: *config*

A variable to store the blog configuration and plugin settings.

Package

coleslaw.

Source

config.lisp.


5.1.2 Macros

Macro: assert-field (field-name content)
Package

coleslaw.

Source

util.lisp.


5.1.3 Ordinary functions

Function: add-document (document)

Add DOCUMENT to the in-memory database. Error if a matching entry is present.

Package

coleslaw.

Source

documents.lisp.

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.

Function: delete-document (document)

Given a DOCUMENT, delete it from the in-memory database.

Package

coleslaw.

Source

documents.lisp.

Function: find-all (doc-type &optional matches-p)

Return a list of all instances of a given DOC-TYPE.

Package

coleslaw.

Source

documents.lisp.

Function: find-content-by-path (path)

Find the CONTENT corresponding to the file at PATH.

Package

coleslaw.

Source

content.lisp.

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.

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.

Function: page-ext (config)

Get page extension, and allow for an extensionless system.

Package

coleslaw.

Source

config.lisp.

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.

Function: purge-all (doc-type)

Remove all instances of DOC-TYPE from memory.

Package

coleslaw.

Source

documents.lisp.

Function: theme-fn (name &optional package)

Find the symbol NAME inside PACKAGE which defaults to the theme package.

Package

coleslaw.

Source

themes.lisp.

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.


5.1.4 Generic functions

Generic Reader: author (object)
Package

coleslaw.

Methods
Reader Method: author ((blog blog))

automatically generated reader method

Source

config.lisp.

Target Slot

author.

Generic Reader: author-of (object)
Package

coleslaw.

Methods
Reader Method: author-of ((post post))

automatically generated reader method

Source

posts.lisp.

Target Slot

author.

Generic Reader: content-text (object)
Package

coleslaw.

Methods
Reader Method: content-text ((content content))

automatically generated reader method

Source

content.lisp.

Target Slot

text.

Generic Function: deploy (staging)

Deploy the STAGING build to the directory specified in the config.

Package

coleslaw.

Source

coleslaw.lisp.

Methods
Method: deploy (staging)

By default, do nothing

Generic Reader: deploy-dir (object)
Package

coleslaw.

Methods
Reader Method: deploy-dir ((config blog))
Source

config.lisp.

Target Slot

deploy-dir.

Generic Function: discover (doc-type)

Load all documents of the given DOC-TYPE into memory.

Package

coleslaw.

Source

documents.lisp.

Methods
Method: discover ((doc-type (eql #<standard-class coleslaw::tag-feed>)))
Source

feeds.lisp.

Method: discover ((doc-type (eql #<standard-class coleslaw::feed>)))
Source

feeds.lisp.

Method: discover ((doc-type (eql #<standard-class coleslaw::numeric-index>)))
Source

indexes.lisp.

Method: discover ((doc-type (eql #<standard-class coleslaw::month-index>)))
Source

indexes.lisp.

Method: discover ((doc-type (eql #<standard-class coleslaw::tag-index>)))
Source

indexes.lisp.

Method: discover :before (doc-type)
Method: discover (doc-type)
Generic Reader: domain (object)
Package

coleslaw.

Methods
Reader Method: domain ((blog blog))

automatically generated reader method

Source

config.lisp.

Target Slot

domain.

Generic Reader: page-url (document)

The relative URL to the DOCUMENT.

Package

coleslaw.

Source

documents.lisp.

Methods
Reader Method: page-url ((index index))

automatically generated reader method

Source

indexes.lisp.

Target Slot

url.

Reader Method: page-url ((content content))

automatically generated reader method

Source

content.lisp.

Target Slot

url.

Generic Function: publish (doc-type)

Write pages to disk for all documents of the given DOC-TYPE.

Package

coleslaw.

Source

documents.lisp.

Methods
Method: publish ((doc-type (eql #<standard-class coleslaw::tag-feed>)))
Source

feeds.lisp.

Method: publish ((doc-type (eql #<standard-class coleslaw::feed>)))
Source

feeds.lisp.

Method: publish ((doc-type (eql #<standard-class coleslaw::numeric-index>)))
Source

indexes.lisp.

Method: publish ((doc-type (eql #<standard-class coleslaw::month-index>)))
Source

indexes.lisp.

Method: publish ((doc-type (eql #<standard-class coleslaw::tag-index>)))
Source

indexes.lisp.

Method: publish ((doc-type (eql #<standard-class coleslaw:post>)))
Source

posts.lisp.

Generic Function: render (document &key prev next &allow-other-keys)

Render the given DOCUMENT to HTML.

Package

coleslaw.

Source

documents.lisp.

Methods
Method: render ((object index) &key prev next)
Source

indexes.lisp.

Method: render ((object post) &key prev next)
Source

posts.lisp.

Generic Function: render-text (text format)

Render TEXT of the given FORMAT to HTML for display.

Package

coleslaw.

Source

content.lisp.

Methods
Method: render-text (text (format (eql :html)))
Method: render-text (text (format (eql :md)))
Generic Reader: repo-dir (object)
Package

coleslaw.

Methods
Reader Method: repo-dir ((config blog))
Source

config.lisp.

Target Slot

repo.

Generic Writer: (setf repo-dir) (object)
Package

coleslaw.

Methods
Writer Method: (setf repo-dir) ((blog blog))

automatically generated writer method

Source

config.lisp.

Target Slot

repo.

Generic Reader: staging-dir (object)
Package

coleslaw.

Methods
Reader Method: staging-dir ((config blog))
Source

config.lisp.

Target Slot

staging-dir.

Generic Reader: title (object)
Package

coleslaw.

Methods
Reader Method: title ((blog blog))

automatically generated reader method

Source

config.lisp.

Target Slot

title.

Generic Reader: title-of (object)
Package

coleslaw.

Methods
Reader Method: title-of ((index index))

automatically generated reader method

Source

indexes.lisp.

Target Slot

title.

Reader Method: title-of ((post post))

automatically generated reader method

Source

posts.lisp.

Target Slot

title.


5.1.5 Standalone methods

Method: initialize-instance :after ((object content) &key)
Source

content.lisp.

Method: initialize-instance :after ((object post) &key)
Source

posts.lisp.

Method: initialize-instance :after ((object index) &key slug)
Source

indexes.lisp.

Method: initialize-instance :after ((tag tag) &key)
Source

content.lisp.


5.1.6 Conditions

Condition: plugin-conf-error

Condition to signal when the plugin is misconfigured.

Package

coleslaw.

Source

config.lisp.

Direct superclasses

condition.

Direct methods
Direct slots
Slot: plugin
Initargs

:plugin

Readers

plugin.

Writers

This slot is read-only.

Slot: message
Initargs

:message

Readers

message.

Writers

This slot is read-only.


5.1.7 Classes

Class: content
Package

coleslaw.

Source

content.lisp.

Direct subclasses

post.

Direct methods
Direct Default Initargs
InitargValue
:tagsnil
:datenil
Direct slots
Slot: url
Initargs

:url

Readers

page-url.

Writers

This slot is read-only.

Slot: date
Initargs

:date

Readers

content-date.

Writers

This slot is read-only.

Slot: file
Initargs

:file

Readers

content-file.

Writers

This slot is read-only.

Slot: tags
Initargs

:tags

Readers

content-tags.

Writers

This slot is read-only.

Slot: text
Initargs

:text

Readers

content-text.

Writers

This slot is read-only.

Class: index
Package

coleslaw.

Source

indexes.lisp.

Direct subclasses
Direct methods
Direct slots
Slot: url
Initargs

:url

Readers

page-url.

Writers

This slot is read-only.

Slot: name
Initargs

:name

Readers

index-name.

Writers

This slot is read-only.

Slot: title
Initargs

:title

Readers

title-of.

Writers

This slot is read-only.

Slot: content
Initargs

:content

Readers

index-content.

Writers

This slot is read-only.

Class: post
Package

coleslaw.

Source

posts.lisp.

Direct superclasses

content.

Direct methods
Direct Default Initargs
InitargValue
:authornil
:excerptnil
Direct slots
Slot: title
Initargs

:title

Readers

title-of.

Writers

This slot is read-only.

Slot: author
Initargs

:author

Readers

author-of.

Writers

This slot is read-only.

Slot: excerpt
Initargs

:excerpt

Readers

excerpt-of.

Writers

This slot is read-only.

Slot: format
Package

common-lisp.

Initargs

:format

Readers

post-format.

Writers

This slot is read-only.


5.2 Internals


5.2.1 Special variables

Special Variable: *all-months*

The list of months in which content was authored.

Package

coleslaw.

Source

indexes.lisp.

Special Variable: *all-tags*

The list of tags which content has been tagged with.

Package

coleslaw.

Source

indexes.lisp.

Special Variable: *injections*

A list that stores pairs of (string . predicate) to inject in the page.

Package

coleslaw.

Source

themes.lisp.

Special Variable: *last-revision*

The git revision prior to the last push. For use with GET-UPDATED-FILES.

Package

coleslaw.

Source

coleslaw.lisp.

Special Variable: *site*

An in-memory database to hold all site documents, keyed on relative URLs.

Package

coleslaw.

Source

documents.lisp.


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.

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.

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.


5.2.3 Ordinary functions

Function: all-months ()

Retrieve a list of all months with published content.

Package

coleslaw.

Source

indexes.lisp.

Function: all-subclasses (class)

Return a list of all the subclasses of CLASS.

Package

coleslaw.

Source

util.lisp.

Function: all-tags ()

Retrieve a list of all tags used in content.

Package

coleslaw.

Source

indexes.lisp.

Function: app-path (path &rest args)

Return a relative path beneath coleslaw.

Package

coleslaw.

Source

util.lisp.

Function: by-date (content)

Sort CONTENT in reverse chronological order.

Package

coleslaw.

Source

content.lisp.

Function: class-name-p (name class)

True if the specified string is the name of the class provided

Package

coleslaw.

Source

util.lisp.

Function: compile-blog (staging)

Compile the blog to a STAGING directory as specified in .coleslawrc.

Package

coleslaw.

Source

coleslaw.lisp.

Function: compile-theme (theme)

Locate and compile the templates for the given THEME.

Package

coleslaw.

Source

themes.lisp.

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.

Function: construct (class-name args)

Create an instance of CLASS-NAME with the given ARGS.

Package

coleslaw.

Source

util.lisp.

Function: dir-slot-reader (config name)

Take CONFIG and NAME, and return a directory pathname for the matching SLOT.

Package

coleslaw.

Source

config.lisp.

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.

Function: enable-plugin (name args)

Given a plugin, NAME, compile+load it and call its ENABLE function with ARGS.

Package

coleslaw.

Source

config.lisp.

Function: exit ()

Exit the lisp system returning a 0 status code.

Package

coleslaw.

Source

util.lisp.

Function: find-injections (content)

Iterate over *INJECTIONS* collecting any that should be added to CONTENT.

Package

coleslaw.

Source

themes.lisp.

Function: find-theme (theme)

Find the theme prefering themes in the local repo.

Package

coleslaw.

Source

themes.lisp.

Function: fmt (fmt-str args)

A convenient FORMAT interface for string building.

Package

coleslaw.

Source

util.lisp.

Function: get-route (doc-type)

Return the route format string for DOC-TYPE.

Package

coleslaw.

Source

documents.lisp.

Function: index-by-month (month content)

Return an index of all CONTENT matching the given MONTH.

Package

coleslaw.

Source

indexes.lisp.

Function: index-by-n (i content)

Return the index for the Ith page of CONTENT in reverse chronological order.

Package

coleslaw.

Source

indexes.lisp.

Function: index-by-tag (tag content)

Return an index of all CONTENT matching the given TAG.

Package

coleslaw.

Source

indexes.lisp.

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.

Function: load-content ()

Load all content stored in the blog’s repo.

Package

coleslaw.

Source

coleslaw.lisp.

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.

Function: make-tag (str)

Takes a string and returns a TAG instance with a name and slug.

Package

coleslaw.

Source

content.lisp.

Function: month-p (month obj)

Test if OBJ was written in MONTH.

Package

coleslaw.

Source

content.lisp.

Function: parse-initarg (line)

Given a metadata header, LINE, parse an initarg name/value pair from it.

Package

coleslaw.

Source

content.lisp.

Function: parse-metadata (stream)

Given a STREAM, parse metadata from it or signal an appropriate condition.

Package

coleslaw.

Source

content.lisp.

Function: read-content (file)

Returns a plist of metadata from FILE with :text holding the content.

Package

coleslaw.

Source

content.lisp.

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.

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.

Function: repo-path (path &rest args)

Return a relative path beneath the repo being processed.

Package

coleslaw.

Source

util.lisp.

Function: run-lines (dir &rest programs)

Runs some programs, in a directory.

Package

coleslaw.

Source

util.lisp.

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.

Function: slug-char-p (char &key allowed-chars)

Determine if CHAR is a valid slug (i.e. URL) character.

Package

coleslaw.

Source

content.lisp.

Function: slugify (string)

Return a version of STRING suitable for use as a URL.

Package

coleslaw.

Source

content.lisp.

Function: tag-p (tag obj)

Test if OBJ is tagged with TAG.

Package

coleslaw.

Source

content.lisp.

Function: tag-slug= (a b)

Test if the slugs for tag A and B are equal.

Package

coleslaw.

Source

content.lisp.

Function: take-up-to (n seq)

Take elements from SEQ until all elements or N have been taken.

Package

coleslaw.

Source

util.lisp.

Function: theme-package (name)

Find the package matching the theme NAME or signal THEME-DOES-NOT-EXIST.

Package

coleslaw.

Source

themes.lisp.

Function: unicode-space-p (char)

Determine if CHAR is a kind of whitespace by unicode category means.

Package

coleslaw.

Source

content.lisp.

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.

Update the symlink at PATH to point to TARGET.

Package

coleslaw.

Source

coleslaw.lisp.

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.


5.2.4 Generic functions

Generic Reader: charset (object)
Package

coleslaw.

Methods
Reader Method: charset ((blog blog))

automatically generated reader method

Source

config.lisp.

Target Slot

charset.

Generic Reader: content-date (object)
Package

coleslaw.

Methods
Reader Method: content-date ((content content))

automatically generated reader method

Source

content.lisp.

Target Slot

date.

Generic Reader: content-file (object)
Package

coleslaw.

Methods
Reader Method: content-file ((content content))

automatically generated reader method

Source

content.lisp.

Target Slot

file.

Generic Reader: content-tags (object)
Package

coleslaw.

Methods
Reader Method: content-tags ((content content))

automatically generated reader method

Source

content.lisp.

Target Slot

tags.

Generic Reader: dir (condition)
Package

coleslaw.

Methods
Reader Method: dir ((condition directory-does-not-exist))
Source

util.lisp.

Target Slot

directory.

Generic Reader: excerpt-of (object)
Package

coleslaw.

Methods
Reader Method: excerpt-of ((post post))

automatically generated reader method

Source

posts.lisp.

Target Slot

excerpt.

Generic Reader: excerpt-sep (object)
Package

coleslaw.

Methods
Reader Method: excerpt-sep ((blog blog))

automatically generated reader method

Source

config.lisp.

Target Slot

excerpt-sep.

Generic Reader: feed-format (object)
Package

coleslaw.

Methods
Reader Method: feed-format ((base-feed base-feed))

automatically generated reader method

Source

feeds.lisp.

Target Slot

format.

Generic Reader: feeds (object)
Package

coleslaw.

Methods
Reader Method: feeds ((blog blog))

automatically generated reader method

Source

config.lisp.

Target Slot

feeds.

Generic Reader: index-content (object)
Package

coleslaw.

Methods
Reader Method: index-content ((index index))

automatically generated reader method

Source

indexes.lisp.

Target Slot

content.

Generic Reader: index-ext (object)
Package

coleslaw.

Methods
Reader Method: index-ext ((blog blog))

automatically generated reader method

Source

config.lisp.

Target Slot

index-ext.

Generic Reader: index-name (object)
Package

coleslaw.

Methods
Reader Method: index-name ((index index))

automatically generated reader method

Source

indexes.lisp.

Target Slot

name.

Generic Reader: lang (object)
Package

coleslaw.

Methods
Reader Method: lang ((blog blog))

automatically generated reader method

Source

config.lisp.

Target Slot

lang.

Generic Reader: license (object)
Package

coleslaw.

Methods
Reader Method: license ((blog blog))

automatically generated reader method

Source

config.lisp.

Target Slot

license.

Generic Reader: message (condition)
Package

coleslaw.

Methods
Reader Method: message ((condition plugin-conf-error))
Source

config.lisp.

Target Slot

message.

Generic Reader: missing-field-field-name (condition)
Package

coleslaw.

Methods
Reader Method: missing-field-field-name ((condition field-missing))
Source

util.lisp.

Target Slot

field-name.

Generic Reader: missing-field-file (condition)
Package

coleslaw.

Methods
Reader Method: missing-field-file ((condition field-missing))
Source

util.lisp.

Target Slot

file.

Generic Reader: name-fn (object)
Package

coleslaw.

Methods
Reader Method: name-fn ((blog blog))

automatically generated reader method

Source

config.lisp.

Target Slot

name-fn.

Generic Reader: page-ext-intolerant (object)
Package

coleslaw.

Methods
Reader Method: page-ext-intolerant ((blog blog))

automatically generated reader method

Source

config.lisp.

Target Slot

page-ext.

Generic Reader: plugin (condition)
Package

coleslaw.

Methods
Reader Method: plugin ((condition plugin-conf-error))
Source

config.lisp.

Target Slot

plugin.

Generic Reader: plugins (object)
Package

coleslaw.

Methods
Reader Method: plugins ((blog blog))

automatically generated reader method

Source

config.lisp.

Target Slot

plugins.

Generic Reader: post-format (object)
Package

coleslaw.

Methods
Reader Method: post-format ((post post))

automatically generated reader method

Source

posts.lisp.

Target Slot

format.

Generic Reader: routing (object)
Package

coleslaw.

Methods
Reader Method: routing ((blog blog))

automatically generated reader method

Source

config.lisp.

Target Slot

routing.

Generic Reader: separator (object)
Package

coleslaw.

Methods
Reader Method: separator ((blog blog))

automatically generated reader method

Source

config.lisp.

Target Slot

separator.

Generic Reader: sitenav (object)
Package

coleslaw.

Methods
Reader Method: sitenav ((blog blog))

automatically generated reader method

Source

config.lisp.

Target Slot

sitenav.

Generic Reader: tag-name (object)
Package

coleslaw.

Methods
Reader Method: tag-name ((tag tag))

automatically generated reader method

Source

content.lisp.

Target Slot

name.

Generic Reader: tag-slug (object)
Package

coleslaw.

Methods
Reader Method: tag-slug ((tag tag))

automatically generated reader method

Source

content.lisp.

Target Slot

slug.

Generic Reader: theme (object)
Package

coleslaw.

Methods
Reader Method: theme ((condition theme-does-not-exist))
Source

themes.lisp.

Target Slot

theme.

Reader Method: theme ((blog blog))

automatically generated reader method

Source

config.lisp.

Target Slot

theme.


5.2.5 Conditions

Condition: coleslaw-condition
Package

coleslaw.

Source

util.lisp.

Direct superclasses

condition.

Direct subclasses

field-missing.

Condition: directory-does-not-exist
Package

coleslaw.

Source

util.lisp.

Direct superclasses

error.

Direct methods

dir.

Direct slots
Slot: directory
Package

common-lisp.

Initargs

:dir

Readers

dir.

Writers

This slot is read-only.

Condition: field-missing
Package

coleslaw.

Source

util.lisp.

Direct superclasses
Direct methods
Direct slots
Slot: field-name
Initargs

:field-name

Readers

missing-field-field-name.

Writers

This slot is read-only.

Slot: file

The path of the file where the field is missing.

Initargs

:file

Readers

missing-field-file.

Writers

This slot is read-only.

Condition: theme-does-not-exist
Package

coleslaw.

Source

themes.lisp.

Direct superclasses

error.

Direct methods

theme.

Direct slots
Slot: theme
Initargs

:theme

Readers

theme.

Writers

This slot is read-only.


5.2.6 Classes

Class: base-feed
Package

coleslaw.

Source

feeds.lisp.

Direct subclasses
Direct methods

feed-format.

Direct slots
Slot: format
Package

common-lisp.

Initargs

:format

Readers

feed-format.

Writers

This slot is read-only.

Class: blog
Package

coleslaw.

Source

config.lisp.

Direct methods
Direct Default Initargs
InitargValue
:feedsnil
:licensenil
:plugins(quote ((rsync -avz --delete --exclude .git/ --exclude .gitignore --copy-links)))
:sitenavnil
:excerpt-sep<!--more-->
:name-fn(quote identity)
:charsetutf-8
:langen
:page-exthtml
:separator;;;;;
:staging-dir/tmp/coleslaw
:index-exthtml
Direct slots
Slot: author
Initargs

:author

Readers

author.

Writers

This slot is read-only.

Slot: charset
Initargs

:charset

Readers

charset.

Writers

This slot is read-only.

Slot: deploy-dir
Initargs

:deploy-dir

Readers

deploy-dir.

Writers

This slot is read-only.

Slot: domain
Initargs

:domain

Readers

domain.

Writers

This slot is read-only.

Slot: excerpt-sep
Initargs

:excerpt-sep

Readers

excerpt-sep.

Writers

This slot is read-only.

Slot: feeds
Initargs

:feeds

Readers

feeds.

Writers

This slot is read-only.

Slot: name-fn
Initargs

:name-fn

Readers

name-fn.

Writers

This slot is read-only.

Slot: lang
Initargs

:lang

Readers

lang.

Writers

This slot is read-only.

Slot: license
Initargs

:license

Readers

license.

Writers

This slot is read-only.

Slot: page-ext
Initargs

:page-ext

Readers

page-ext-intolerant.

Writers

This slot is read-only.

Slot: plugins
Initargs

:plugins

Readers

plugins.

Writers

This slot is read-only.

Slot: repo
Initargs

:repo

Readers

repo-dir.

Writers

(setf repo-dir).

Slot: routing
Initargs

:routing

Readers

routing.

Writers

This slot is read-only.

Slot: separator
Initargs

:separator

Readers

separator.

Writers

This slot is read-only.

Slot: sitenav
Initargs

:sitenav

Readers

sitenav.

Writers

This slot is read-only.

Slot: staging-dir
Initargs

:staging-dir

Readers

staging-dir.

Writers

This slot is read-only.

Slot: theme
Initargs

:theme

Readers

theme.

Writers

This slot is read-only.

Slot: title
Initargs

:title

Readers

title.

Writers

This slot is read-only.

Slot: index-ext
Initargs

:index-ext

Readers

index-ext.

Writers

This slot is read-only.

Class: feed
Package

coleslaw.

Source

feeds.lisp.

Direct superclasses
Class: month-index
Package

coleslaw.

Source

indexes.lisp.

Direct superclasses

index.

Class: numeric-index
Package

coleslaw.

Source

indexes.lisp.

Direct superclasses

index.

Class: tag
Package

coleslaw.

Source

content.lisp.

Direct methods
Direct slots
Slot: name
Initargs

:name

Readers

tag-name.

Writers

This slot is read-only.

Slot: slug
Initargs

:slug

Readers

tag-slug.

Writers

This slot is read-only.

Slot: url
Initargs

:url

Class: tag-feed
Package

coleslaw.

Source

feeds.lisp.

Direct superclasses
Class: tag-index
Package

coleslaw.

Source

indexes.lisp.

Direct superclasses

index.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
A   B   C   D   E   F   G   I   L   M   N   P   R   S   T   U   W  
Index Entry  Section

(
(setf repo-dir): Public generic functions
(setf repo-dir): Public generic functions

A
add-document: Public ordinary functions
add-injection: Public ordinary functions
all-months: Private ordinary functions
all-subclasses: Private ordinary functions
all-tags: Private ordinary functions
app-path: Private ordinary functions
assert-field: Public macros
author: Public generic functions
author: Public generic functions
author-of: Public generic functions
author-of: Public generic functions

B
by-date: Private ordinary functions

C
charset: Private generic functions
charset: Private generic functions
class-name-p: Private ordinary functions
compile-blog: Private ordinary functions
compile-theme: Private ordinary functions
compute-url: Private ordinary functions
construct: Private ordinary functions
content-date: Private generic functions
content-date: Private generic functions
content-file: Private generic functions
content-file: Private generic functions
content-tags: Private generic functions
content-tags: Private generic functions
content-text: Public generic functions
content-text: Public generic functions

D
delete-document: Public ordinary functions
deploy: Public generic functions
deploy: Public generic functions
deploy-dir: Public generic functions
deploy-dir: Public generic functions
dir: Private generic functions
dir: Private generic functions
dir-slot-reader: Private ordinary functions
discover: Public generic functions
discover: Public generic functions
discover: Public generic functions
discover: Public generic functions
discover: Public generic functions
discover: Public generic functions
discover: Public generic functions
discover: Public generic functions
discover-config-path: Private ordinary functions
do-files: Private macros
do-subclasses: Private macros
domain: Public generic functions
domain: Public generic functions

E
enable-plugin: Private ordinary functions
excerpt-of: Private generic functions
excerpt-of: Private generic functions
excerpt-sep: Private generic functions
excerpt-sep: Private generic functions
exit: Private ordinary functions

F
feed-format: Private generic functions
feed-format: Private generic functions
feeds: Private generic functions
feeds: Private generic functions
find-all: Public ordinary functions
find-content-by-path: Public ordinary functions
find-injections: Private ordinary functions
find-theme: Private ordinary functions
fmt: Private ordinary functions
Function, add-document: Public ordinary functions
Function, add-injection: Public ordinary functions
Function, all-months: Private ordinary functions
Function, all-subclasses: Private ordinary functions
Function, all-tags: Private ordinary functions
Function, app-path: Private ordinary functions
Function, by-date: Private ordinary functions
Function, class-name-p: Private ordinary functions
Function, compile-blog: Private ordinary functions
Function, compile-theme: Private ordinary functions
Function, compute-url: Private ordinary functions
Function, construct: Private ordinary functions
Function, delete-document: Public ordinary functions
Function, dir-slot-reader: Private ordinary functions
Function, discover-config-path: Private ordinary functions
Function, enable-plugin: Private ordinary functions
Function, exit: Private ordinary functions
Function, find-all: Public ordinary functions
Function, find-content-by-path: Public ordinary functions
Function, find-injections: Private ordinary functions
Function, find-theme: Private ordinary functions
Function, fmt: Private ordinary functions
Function, get-route: Private ordinary functions
Function, get-updated-files: Public ordinary functions
Function, index-by-month: Private ordinary functions
Function, index-by-n: Private ordinary functions
Function, index-by-tag: Private ordinary functions
Function, load-config: Private ordinary functions
Function, load-content: Private ordinary functions
Function, load-plugins: Private ordinary functions
Function, main: Public ordinary functions
Function, make-tag: Private ordinary functions
Function, month-p: Private ordinary functions
Function, page-ext: Public ordinary functions
Function, parse-initarg: Private ordinary functions
Function, parse-metadata: Private ordinary functions
Function, preview: Public ordinary functions
Function, purge-all: Public ordinary functions
Function, read-content: Private ordinary functions
Function, rel-path: Private ordinary functions
Function, render-page: Private ordinary functions
Function, repo-path: Private ordinary functions
Function, run-lines: Private ordinary functions
Function, run-program: Private ordinary functions
Function, slug-char-p: Private ordinary functions
Function, slugify: Private ordinary functions
Function, tag-p: Private ordinary functions
Function, tag-slug=: Private ordinary functions
Function, take-up-to: Private ordinary functions
Function, theme-fn: Public ordinary functions
Function, theme-package: Private ordinary functions
Function, unicode-space-p: Private ordinary functions
Function, update-content-metadata: Private ordinary functions
Function, update-symlink: Private ordinary functions
Function, write-document: Public ordinary functions
Function, write-file: Private ordinary functions

G
Generic Function, (setf repo-dir): Public generic functions
Generic Function, author: Public generic functions
Generic Function, author-of: Public generic functions
Generic Function, charset: Private generic functions
Generic Function, content-date: Private generic functions
Generic Function, content-file: Private generic functions
Generic Function, content-tags: Private generic functions
Generic Function, content-text: Public generic functions
Generic Function, deploy: Public generic functions
Generic Function, deploy-dir: Public generic functions
Generic Function, dir: Private generic functions
Generic Function, discover: Public generic functions
Generic Function, domain: Public generic functions
Generic Function, excerpt-of: Private generic functions
Generic Function, excerpt-sep: Private generic functions
Generic Function, feed-format: Private generic functions
Generic Function, feeds: Private generic functions
Generic Function, index-content: Private generic functions
Generic Function, index-ext: Private generic functions
Generic Function, index-name: Private generic functions
Generic Function, lang: Private generic functions
Generic Function, license: Private generic functions
Generic Function, message: Private generic functions
Generic Function, missing-field-field-name: Private generic functions
Generic Function, missing-field-file: Private generic functions
Generic Function, name-fn: Private generic functions
Generic Function, page-ext-intolerant: Private generic functions
Generic Function, page-url: Public generic functions
Generic Function, plugin: Private generic functions
Generic Function, plugins: Private generic functions
Generic Function, post-format: Private generic functions
Generic Function, publish: Public generic functions
Generic Function, render: Public generic functions
Generic Function, render-text: Public generic functions
Generic Function, repo-dir: Public generic functions
Generic Function, routing: Private generic functions
Generic Function, separator: Private generic functions
Generic Function, sitenav: Private generic functions
Generic Function, staging-dir: Public generic functions
Generic Function, tag-name: Private generic functions
Generic Function, tag-slug: Private generic functions
Generic Function, theme: Private generic functions
Generic Function, title: Public generic functions
Generic Function, title-of: Public generic functions
get-route: Private ordinary functions
get-updated-files: Public ordinary functions

I
index-by-month: Private ordinary functions
index-by-n: Private ordinary functions
index-by-tag: Private ordinary functions
index-content: Private generic functions
index-content: Private generic functions
index-ext: Private generic functions
index-ext: Private generic functions
index-name: Private generic functions
index-name: Private generic functions
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods

L
lang: Private generic functions
lang: Private generic functions
license: Private generic functions
license: Private generic functions
load-config: Private ordinary functions
load-content: Private ordinary functions
load-plugins: Private ordinary functions

M
Macro, assert-field: Public macros
Macro, do-files: Private macros
Macro, do-subclasses: Private macros
Macro, with-current-directory: Private macros
main: Public ordinary functions
make-tag: Private ordinary functions
message: Private generic functions
message: Private generic functions
Method, (setf repo-dir): Public generic functions
Method, author: Public generic functions
Method, author-of: Public generic functions
Method, charset: Private generic functions
Method, content-date: Private generic functions
Method, content-file: Private generic functions
Method, content-tags: Private generic functions
Method, content-text: Public generic functions
Method, deploy: Public generic functions
Method, deploy-dir: Public generic functions
Method, dir: Private generic functions
Method, discover: Public generic functions
Method, discover: Public generic functions
Method, discover: Public generic functions
Method, discover: Public generic functions
Method, discover: Public generic functions
Method, discover: Public generic functions
Method, discover: Public generic functions
Method, domain: Public generic functions
Method, excerpt-of: Private generic functions
Method, excerpt-sep: Private generic functions
Method, feed-format: Private generic functions
Method, feeds: Private generic functions
Method, index-content: Private generic functions
Method, index-ext: Private generic functions
Method, index-name: Private generic functions
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, lang: Private generic functions
Method, license: Private generic functions
Method, message: Private generic functions
Method, missing-field-field-name: Private generic functions
Method, missing-field-file: Private generic functions
Method, name-fn: Private generic functions
Method, page-ext-intolerant: Private generic functions
Method, page-url: Public generic functions
Method, page-url: Public generic functions
Method, plugin: Private generic functions
Method, plugins: Private generic functions
Method, post-format: Private generic functions
Method, publish: Public generic functions
Method, publish: Public generic functions
Method, publish: Public generic functions
Method, publish: Public generic functions
Method, publish: Public generic functions
Method, publish: Public generic functions
Method, render: Public generic functions
Method, render: Public generic functions
Method, render-text: Public generic functions
Method, render-text: Public generic functions
Method, repo-dir: Public generic functions
Method, routing: Private generic functions
Method, separator: Private generic functions
Method, sitenav: Private generic functions
Method, staging-dir: Public generic functions
Method, tag-name: Private generic functions
Method, tag-slug: Private generic functions
Method, theme: Private generic functions
Method, theme: Private generic functions
Method, title: Public generic functions
Method, title-of: Public generic functions
Method, title-of: Public generic functions
missing-field-field-name: Private generic functions
missing-field-field-name: Private generic functions
missing-field-file: Private generic functions
missing-field-file: Private generic functions
month-p: Private ordinary functions

N
name-fn: Private generic functions
name-fn: Private generic functions

P
page-ext: Public ordinary functions
page-ext-intolerant: Private generic functions
page-ext-intolerant: Private generic functions
page-url: Public generic functions
page-url: Public generic functions
page-url: Public generic functions
parse-initarg: Private ordinary functions
parse-metadata: Private ordinary functions
plugin: Private generic functions
plugin: Private generic functions
plugins: Private generic functions
plugins: Private generic functions
post-format: Private generic functions
post-format: Private generic functions
preview: Public ordinary functions
publish: Public generic functions
publish: Public generic functions
publish: Public generic functions
publish: Public generic functions
publish: Public generic functions
publish: Public generic functions
publish: Public generic functions
purge-all: Public ordinary functions

R
read-content: Private ordinary functions
rel-path: Private ordinary functions
render: Public generic functions
render: Public generic functions
render: Public generic functions
render-page: Private ordinary functions
render-text: Public generic functions
render-text: Public generic functions
render-text: Public generic functions
repo-dir: Public generic functions
repo-dir: Public generic functions
repo-path: Private ordinary functions
routing: Private generic functions
routing: Private generic functions
run-lines: Private ordinary functions
run-program: Private ordinary functions

S
separator: Private generic functions
separator: Private generic functions
sitenav: Private generic functions
sitenav: Private generic functions
slug-char-p: Private ordinary functions
slugify: Private ordinary functions
staging-dir: Public generic functions
staging-dir: Public generic functions

T
tag-name: Private generic functions
tag-name: Private generic functions
tag-p: Private ordinary functions
tag-slug: Private generic functions
tag-slug: Private generic functions
tag-slug=: Private ordinary functions
take-up-to: Private ordinary functions
theme: Private generic functions
theme: Private generic functions
theme: Private generic functions
theme-fn: Public ordinary functions
theme-package: Private ordinary functions
title: Public generic functions
title: Public generic functions
title-of: Public generic functions
title-of: Public generic functions
title-of: Public generic functions

U
unicode-space-p: Private ordinary functions
update-content-metadata: Private ordinary functions
update-symlink: Private ordinary functions

W
with-current-directory: Private macros
write-document: Public ordinary functions
write-file: Private ordinary functions


A.3 Variables

Jump to:   *  
A   C   D   E   F   I   L   M   N   P   R   S   T   U  
Index Entry  Section

*
*all-months*: Private special variables
*all-tags*: Private special variables
*basedir*: Public special variables
*config*: Public special variables
*injections*: Private special variables
*last-revision*: Private special variables
*site*: Private special variables

A
author: Public classes
author: Private classes

C
charset: Private classes
content: Public classes

D
date: Public classes
deploy-dir: Private classes
directory: Private conditions
domain: Private classes

E
excerpt: Public classes
excerpt-sep: Private classes

F
feeds: Private classes
field-name: Private conditions
file: Public classes
file: Private conditions
format: Public classes
format: Private classes

I
index-ext: Private classes

L
lang: Private classes
license: Private classes

M
message: Public conditions

N
name: Public classes
name: Private classes
name-fn: Private classes

P
page-ext: Private classes
plugin: Public conditions
plugins: Private classes

R
repo: Private classes
routing: Private classes

S
separator: Private classes
sitenav: Private classes
Slot, author: Public classes
Slot, author: Private classes
Slot, charset: Private classes
Slot, content: Public classes
Slot, date: Public classes
Slot, deploy-dir: Private classes
Slot, directory: Private conditions
Slot, domain: Private classes
Slot, excerpt: Public classes
Slot, excerpt-sep: Private classes
Slot, feeds: Private classes
Slot, field-name: Private conditions
Slot, file: Public classes
Slot, file: Private conditions
Slot, format: Public classes
Slot, format: Private classes
Slot, index-ext: Private classes
Slot, lang: Private classes
Slot, license: Private classes
Slot, message: Public conditions
Slot, name: Public classes
Slot, name: Private classes
Slot, name-fn: Private classes
Slot, page-ext: Private classes
Slot, plugin: Public conditions
Slot, plugins: Private classes
Slot, repo: Private classes
Slot, routing: Private classes
Slot, separator: Private classes
Slot, sitenav: Private classes
Slot, slug: Private classes
Slot, staging-dir: Private classes
Slot, tags: Public classes
Slot, text: Public classes
Slot, theme: Private conditions
Slot, theme: Private classes
Slot, title: Public classes
Slot, title: Public classes
Slot, title: Private classes
Slot, url: Public classes
Slot, url: Public classes
Slot, url: Private classes
slug: Private classes
Special Variable, *all-months*: Private special variables
Special Variable, *all-tags*: Private special variables
Special Variable, *basedir*: Public special variables
Special Variable, *config*: Public special variables
Special Variable, *injections*: Private special variables
Special Variable, *last-revision*: Private special variables
Special Variable, *site*: Private special variables
staging-dir: Private classes

T
tags: Public classes
text: Public classes
theme: Private conditions
theme: Private classes
title: Public classes
title: Public classes
title: Private classes

U
url: Public classes
url: Public classes
url: Private classes


A.4 Data types

Jump to:   B   C   D   F   I   M   N   P   S   T   U  
Index Entry  Section

B
base-feed: Private classes
blog: Private classes

C
Class, base-feed: Private classes
Class, blog: Private classes
Class, content: Public classes
Class, feed: Private classes
Class, index: Public classes
Class, month-index: Private classes
Class, numeric-index: Private classes
Class, post: Public classes
Class, tag: Private classes
Class, tag-feed: Private classes
Class, tag-index: Private classes
coleslaw: The coleslaw system
coleslaw: The coleslaw package
coleslaw-condition: Private conditions
coleslaw-conf: The coleslaw-conf package
coleslaw-conf.lisp: The coleslaw/coleslaw-conf․lisp file
coleslaw.asd: The coleslaw/coleslaw․asd file
coleslaw.lisp: The coleslaw/coleslaw․lisp file
Condition, coleslaw-condition: Private conditions
Condition, directory-does-not-exist: Private conditions
Condition, field-missing: Private conditions
Condition, plugin-conf-error: Public conditions
Condition, theme-does-not-exist: Private conditions
config.lisp: The coleslaw/config․lisp file
content: Public classes
content.lisp: The coleslaw/content․lisp file

D
directory-does-not-exist: Private conditions
documents.lisp: The coleslaw/documents․lisp file

F
feed: Private classes
feeds.lisp: The coleslaw/feeds․lisp file
field-missing: Private conditions
File, coleslaw-conf.lisp: The coleslaw/coleslaw-conf․lisp file
File, coleslaw.asd: The coleslaw/coleslaw․asd file
File, coleslaw.lisp: The coleslaw/coleslaw․lisp file
File, config.lisp: The coleslaw/config․lisp file
File, content.lisp: The coleslaw/content․lisp file
File, documents.lisp: The coleslaw/documents․lisp file
File, feeds.lisp: The coleslaw/feeds․lisp file
File, indexes.lisp: The coleslaw/indexes․lisp file
File, packages.lisp: The coleslaw/packages․lisp file
File, posts.lisp: The coleslaw/posts․lisp file
File, themes.lisp: The coleslaw/themes․lisp file
File, util.lisp: The coleslaw/util․lisp file

I
index: Public classes
indexes.lisp: The coleslaw/indexes․lisp file

M
month-index: Private classes

N
numeric-index: Private classes

P
Package, coleslaw: The coleslaw package
Package, coleslaw-conf: The coleslaw-conf package
packages.lisp: The coleslaw/packages․lisp file
plugin-conf-error: Public conditions
post: Public classes
posts.lisp: The coleslaw/posts․lisp file

S
System, coleslaw: The coleslaw system

T
tag: Private classes
tag-feed: Private classes
tag-index: Private classes
theme-does-not-exist: Private conditions
themes.lisp: The coleslaw/themes․lisp file

U
util.lisp: The coleslaw/util․lisp file