This is the coleslaw Reference Manual, version 0.9.7, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 16:05:13 2024 GMT+0.
coleslaw/coleslaw.asdcoleslaw/coleslaw-conf.lispcoleslaw/packages.lispcoleslaw/util.lispcoleslaw/config.lispcoleslaw/themes.lispcoleslaw/documents.lispcoleslaw/content.lispcoleslaw/posts.lispcoleslaw/indexes.lispcoleslaw/feeds.lispcoleslaw/coleslaw.lispThe main system appears first, followed by any subsystem dependency.
coleslawFlexible Lisp Blogware
Brit Butler <redline6561@gmail.com>
BSD
0.9.7
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).
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).
Files are sorted by type and then listed depth-first from the systems components trees.
coleslaw/coleslaw.asdcoleslaw/coleslaw-conf.lispcoleslaw/packages.lispcoleslaw/util.lispcoleslaw/config.lispcoleslaw/themes.lispcoleslaw/documents.lispcoleslaw/content.lispcoleslaw/posts.lispcoleslaw/indexes.lispcoleslaw/feeds.lispcoleslaw/coleslaw.lispcoleslaw/coleslaw-conf.lispcoleslaw/packages.lispcoleslaw-conf.lisp (file).
coleslaw (system).
coleslaw/util.lisppackages.lisp (file).
coleslaw (system).
assert-field (macro).
get-updated-files (function).
all-subclasses (function).
app-path (function).
class-name-p (function).
coleslaw-condition (condition).
construct (function).
dir (reader method).
directory-does-not-exist (condition).
do-files (macro).
do-subclasses (macro).
exit (function).
field-missing (condition).
fmt (function).
missing-field-field-name (reader method).
missing-field-file (reader method).
rel-path (function).
repo-path (function).
run-lines (function).
run-program (function).
take-up-to (function).
with-current-directory (macro).
write-file (function).
coleslaw/config.lisputil.lisp (file).
coleslaw (system).
*config* (special variable).
author (reader method).
deploy-dir (reader method).
domain (reader method).
page-ext (reader method).
plugin-conf-error (condition).
repo-dir (reader method).
(setf repo-dir) (writer method).
staging-dir (reader method).
title (reader method).
blog (class).
charset (reader method).
dir-slot-reader (function).
discover-config-path (function).
enable-plugin (function).
excerpt-sep (reader method).
feeds (reader method).
lang (reader method).
license (reader method).
load-config (function).
load-plugins (function).
message (reader method).
name-fn (reader method).
plugin (reader method).
plugins (reader method).
routing (reader method).
separator (reader method).
sitenav (reader method).
theme (reader method).
coleslaw/themes.lispconfig.lisp (file).
coleslaw (system).
add-injection (function).
theme-fn (function).
*injections* (special variable).
compile-theme (function).
find-injections (function).
find-theme (function).
theme (reader method).
theme-does-not-exist (condition).
theme-package (function).
coleslaw/documents.lispthemes.lisp (file).
coleslaw (system).
add-document (function).
delete-document (function).
discover (generic function).
find-all (function).
page-url (generic reader).
publish (generic function).
purge-all (function).
render (generic function).
write-document (function).
*site* (special variable).
compute-url (function).
get-route (function).
coleslaw/content.lispdocuments.lisp (file).
coleslaw (system).
content (class).
content-text (reader method).
find-content-by-path (function).
initialize-instance (method).
initialize-instance (method).
page-url (reader method).
render-text (generic function).
by-date (function).
content-date (reader method).
content-file (reader method).
content-tags (reader 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 (reader method).
tag-p (function).
tag-slug (reader method).
tag-slug= (function).
unicode-space-p (function).
coleslaw/posts.lispcontent.lisp (file).
coleslaw (system).
excerpt-of (reader method).
post-format (reader method).
coleslaw/indexes.lispposts.lisp (file).
coleslaw (system).
*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 (reader method).
index-name (reader method).
month-index (class).
numeric-index (class).
tag-index (class).
update-content-metadata (function).
coleslaw/feeds.lispindexes.lisp (file).
coleslaw (system).
base-feed (class).
feed (class).
feed-format (reader method).
tag-feed (class).
coleslaw/coleslaw.lispfeeds.lisp (file).
coleslaw (system).
*last-revision* (special variable).
compile-blog (function).
load-content (function).
render-page (function).
update-symlink (function).
Packages are listed by definition order.
coleslawHomepage: <a href="http://github.com/redline6561/coleslaw">Github</a>
common-lisp.
*config* (special variable).
add-document (function).
add-injection (function).
assert-field (macro).
author (generic reader).
author-of (generic reader).
content (class).
content-text (generic reader).
delete-document (function).
deploy (generic function).
deploy-dir (generic reader).
discover (generic function).
domain (generic reader).
find-all (function).
find-content-by-path (function).
get-updated-files (function).
index (class).
main (function).
page-ext (generic reader).
page-url (generic reader).
plugin-conf-error (condition).
post (class).
preview (function).
publish (generic function).
purge-all (function).
render (generic function).
render-text (generic function).
repo-dir (generic reader).
(setf repo-dir) (generic writer).
staging-dir (generic reader).
theme-fn (function).
title (generic reader).
title-of (generic reader).
write-document (function).
*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 reader).
class-name-p (function).
coleslaw-condition (condition).
compile-blog (function).
compile-theme (function).
compute-url (function).
construct (function).
content-date (generic reader).
content-file (generic reader).
content-tags (generic reader).
dir (generic reader).
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 reader).
excerpt-sep (generic reader).
exit (function).
feed (class).
feed-format (generic reader).
feeds (generic reader).
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 reader).
index-name (generic reader).
lang (generic reader).
license (generic reader).
load-config (function).
load-content (function).
load-plugins (function).
make-tag (function).
message (generic reader).
missing-field-field-name (generic reader).
missing-field-file (generic reader).
month-index (class).
month-p (function).
name-fn (generic reader).
numeric-index (class).
parse-initarg (function).
parse-metadata (function).
plugin (generic reader).
plugins (generic reader).
post-format (generic reader).
read-content (function).
rel-path (function).
render-page (function).
repo-path (function).
routing (generic reader).
run-lines (function).
run-program (function).
separator (generic reader).
sitenav (generic reader).
slug-char-p (function).
slugify (function).
tag (class).
tag-feed (class).
tag-index (class).
tag-name (generic reader).
tag-p (function).
tag-slug (generic reader).
tag-slug= (function).
take-up-to (function).
theme (generic reader).
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).
Definitions are sorted by export status, category, package, and then by lexicographic order.
A pathname pointing to Coleslaw’s top level directory.
A variable to store the blog configuration and plugin settings.
Add DOCUMENT to the in-memory database. Error if a matching entry is present.
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.
Given a DOCUMENT, delete it from the in-memory database.
Return a list of all instances of a given DOC-TYPE.
Find the CONTENT corresponding to the file at PATH.
Return a plist of (file-status file-name) for files that were changed in the git repo since REVISION.
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)
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.
Remove all instances of DOC-TYPE from memory.
Find the symbol NAME inside PACKAGE which defaults to the theme package.
Write the given DOCUMENT to disk as HTML. If THEME-FN is present, use it as the template passing any RENDER-ARGS.
Deploy the STAGING build to the directory specified in the config.
By default, do nothing
Load all documents of the given DOC-TYPE into memory.
(eql #<standard-class coleslaw::tag-feed>))) ¶(eql #<standard-class coleslaw::feed>))) ¶(eql #<standard-class coleslaw::numeric-index>))) ¶(eql #<standard-class coleslaw::month-index>))) ¶(eql #<standard-class coleslaw::tag-index>))) ¶The relative URL to the DOCUMENT.
Write pages to disk for all documents of the given DOC-TYPE.
(eql #<standard-class coleslaw::tag-feed>))) ¶(eql #<standard-class coleslaw::feed>))) ¶(eql #<standard-class coleslaw::numeric-index>))) ¶(eql #<standard-class coleslaw::month-index>))) ¶(eql #<standard-class coleslaw::tag-index>))) ¶(eql #<standard-class coleslaw:post>))) ¶Render the given DOCUMENT to HTML.
Render TEXT of the given FORMAT to HTML for display.
Condition to signal when the plugin is misconfigured.
post.
| Initarg | Value |
|---|---|
:tags | nil |
:date | nil |
:date
This slot is read-only.
:file
This slot is read-only.
:tags
This slot is read-only.
:text
This slot is read-only.
The list of months in which content was authored.
The list of tags which content has been tagged with.
A list that stores pairs of (string . predicate) to inject in the page.
The git revision prior to the last push. For use with GET-UPDATED-FILES.
An in-memory database to hold all site documents, keyed on relative URLs.
For each file under PATH, run BODY. If EXTENSION is provided, only run BODY on files that match the given extension.
Iterate over the subclasses of CLASS performing BODY with VAR lexically bound to the current subclass.
Change the current directory to PATH and execute BODY in an UNWIND-PROTECT, then change back to the current directory.
Retrieve a list of all months with published content.
Return a list of all the subclasses of CLASS.
Retrieve a list of all tags used in content.
Return a relative path beneath coleslaw.
Sort CONTENT in reverse chronological order.
True if the specified string is the name of the class provided
Compile the blog to a STAGING directory as specified in .coleslawrc.
Locate and compile the templates for the given THEME.
Compute the relative URL for a DOCUMENT based on its UNIQUE-ID. If CLASS is provided, it overrides the route used.
Create an instance of CLASS-NAME with the given ARGS.
Take CONFIG and NAME, and return a directory pathname for the matching SLOT.
Check the supplied REPO-PATH for a .coleslawrc and if one doesn’t exist, use the .coleslawrc in the home directory.
Given a plugin, NAME, compile+load it and call its ENABLE function with ARGS.
Exit the lisp system returning a 0 status code.
Iterate over *INJECTIONS* collecting any that should be added to CONTENT.
Find the theme prefering themes in the local repo.
A convenient FORMAT interface for string building.
Return the route format string for DOC-TYPE.
Return an index of all CONTENT matching the given MONTH.
Return the index for the Ith page of CONTENT in reverse chronological order.
Return an index of all CONTENT matching the given TAG.
Find and load the coleslaw configuration from .coleslawrc. REPO-DIR will be preferred over the home directory if provided.
Load all content stored in the blog’s repo.
Compile and load the listed PLUGINS. It is expected that matching *.lisp files are in the plugins folder in coleslaw’s source directory.
Takes a string and returns a TAG instance with a name and slug.
Test if OBJ was written in MONTH.
Given a metadata header, LINE, parse an initarg name/value pair from it.
Given a STREAM, parse metadata from it or signal an appropriate condition.
Returns a plist of metadata from FILE with :text holding the content.
Take a relative PATH and return the corresponding pathname beneath BASE. If ARGS is provided, use (fmt path args) as the value of PATH.
Render the given CONTENT to HTML using THEME-FN if supplied. Additional args to render CONTENT can be passed via RENDER-ARGS.
Return a relative path beneath the repo being processed.
Runs some programs, in a directory.
Take a PROGRAM and execute the corresponding shell command. If ARGS is provided, use (fmt program args) as the value of PROGRAM.
Determine if CHAR is a valid slug (i.e. URL) character.
Return a version of STRING suitable for use as a URL.
Test if OBJ is tagged with TAG.
Test if the slugs for tag A and B are equal.
Take elements from SEQ until all elements or N have been taken.
Find the package matching the theme NAME or signal THEME-DOES-NOT-EXIST.
Determine if CHAR is a kind of whitespace by unicode category means.
Set *ALL-TAGS* and *ALL-MONTHS* to the union of all tags and months of content loaded in the DB.
Update the symlink at PATH to point to TARGET.
Write the given TEXT to PATH. PATH is overwritten if it exists and created along with any missing parent directories otherwise.
directory-does-not-exist)) ¶plugin-conf-error)) ¶field-missing)) ¶field-missing)) ¶plugin-conf-error)) ¶theme-does-not-exist)) ¶condition.
coleslaw-condition.
error.
:field-name
This slot is read-only.
The path of the file where the field is missing.
:file
This slot is read-only.
error.
common-lisp.
:format
This slot is read-only.
author.
charset.
deploy-dir.
domain.
excerpt-sep.
feeds.
lang.
license.
name-fn.
page-ext.
plugins.
repo-dir.
(setf repo-dir).
routing.
separator.
sitenav.
staging-dir.
theme.
title.
| Initarg | Value |
|---|---|
:feeds | nil |
:license | nil |
:plugins | (quote ((rsync -avz --delete --exclude .git/ --exclude .gitignore --copy-links))) |
:sitenav | nil |
:excerpt-sep | <!--more--> |
:name-fn | (quote identity) |
:charset | utf-8 |
:lang | en |
:page-ext | html |
:separator | ;;;;; |
:staging-dir | /tmp/coleslaw |
:deploy-dir
This slot is read-only.
:excerpt-sep
This slot is read-only.
:repo
:staging-dir
This slot is read-only.
| Jump to: | (
A B C D E F G I L M N P R S T U W |
|---|
| Jump to: | (
A B C D E F G I L M N P R S T U W |
|---|
| Jump to: | *
A C D E F L M N P R S T U |
|---|
| Jump to: | *
A C D E F L M N P R S T U |
|---|
| Jump to: | B C D F I M N P S T U |
|---|
| Jump to: | B C D F I M N P S T U |
|---|