The nuclblog Reference Manual

Child Components

version (file).
readme (file).
news (file).
license (file).
changelog (file).
defpackage.lisp (file).
utilities.lisp (file).
nuclblog.lisp (file).
links.lisp (file).
pages.lisp (file).
handlers.lisp (file).
css (module).

3 Modules

Modules are listed depth-first from the system components tree.

nuclblog/css

3.1 `nuclblog/css`

Source: nuclblog.asd.
Parent Component: nuclblog (system).
Child Component: nuclblog-css (file).

4 Files

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

Lisp
Static

4.1.1 `nuclblog/nuclblog.asd`

Source: nuclblog.asd.
Parent Component: nuclblog (system).
ASDF Systems: nuclblog.

4.1.2 `nuclblog/defpackage.lisp`

Source: nuclblog.asd.
Parent Component: nuclblog (system).
Packages: nuclblog.

4.1.3 `nuclblog/utilities.lisp`

Dependency

defpackage.lisp (file).

Source

Parent Component

nuclblog (system).

Internals

concatenate-url (function).
make-keyword (function).
with-html (macro).
with-html-page (macro).
with-unique-names (macro).
with-xml (macro).
with-xml-output-to-string (macro).

4.1.4 `nuclblog/nuclblog.lisp`

Dependencies

defpackage.lisp (file).
utilities.lisp (file).

Source

Parent Component

nuclblog (system).

Public Interface

authorized-blog (class).
blog (class).
blog-entries (reader method).
(setf blog-entries) (writer method).
blog-realm (reader method).
(setf blog-realm) (writer method).
shared-initialize (method).

Internals

*blog-dispatch-blogs* (special variable).
*entries-file-lock* (special variable).
*entries-lock* (special variable).
*login-page-function* (special variable).
add-user (method).
blog-banner (reader method).
(setf blog-banner) (writer method).
blog-blog-links (reader method).
(setf blog-blog-links) (writer method).
blog-buttons (reader method).
(setf blog-buttons) (writer method).
blog-categories (reader method).
(setf blog-categories) (writer method).
blog-dispatch (generic function).
blog-entry (class).
blog-entry-category (reader method).
(setf blog-entry-category) (writer method).
blog-entry-contents (reader method).
(setf blog-entry-contents) (writer method).
blog-entry-display (generic function).
blog-entry-number (reader method).
(setf blog-entry-number) (writer method).
blog-entry-revised-time (reader method).
(setf blog-entry-revised-time) (writer method).
blog-entry-storage-path (reader method).
(setf blog-entry-storage-path) (writer method).
blog-entry-time (reader method).
(setf blog-entry-time) (writer method).
blog-entry-title (reader method).
(setf blog-entry-title) (writer method).
blog-entry-trackbacks (reader method).
(setf blog-entry-trackbacks) (writer method).
blog-entry-user (reader method).
(setf blog-entry-user) (writer method).
blog-footer (reader method).
(setf blog-footer) (writer method).
blog-handler-alist (reader method).
(setf blog-handler-alist) (writer method).
blog-hostname (reader method).
(setf blog-hostname) (writer method).
blog-logo-img-url (reader method).
(setf blog-logo-img-url) (writer method).
blog-owner-email (reader method).
(setf blog-owner-email) (writer method).
blog-page-css (reader method).
(setf blog-page-css) (writer method).
blog-short-name (reader method).
(setf blog-short-name) (writer method).
blog-ssl-port (reader method).
(setf blog-ssl-port) (writer method).
blog-subtitle (reader method).
(setf blog-subtitle) (writer method).
blog-title (reader method).
(setf blog-title) (writer method).
blog-uri-handler (class).
blog-uri-handler-handler (reader method).
(setf blog-uri-handler-handler) (writer method).
blog-uri-handler-require-authorization (reader method).
(setf blog-uri-handler-require-authorization) (writer method).
blog-uri-handler-uri (reader method).
(setf blog-uri-handler-uri) (writer method).
blog-url-root (reader method).
(setf blog-url-root) (writer method).
blog-use-ssl-p (reader method).
(setf blog-use-ssl-p) (writer method).
create-blog-entry (function).
define-authorized-blog-handler (macro).
define-blog-handler (macro).
delete-blog-entry (function).
get-blog-entries (function).
get-entry (function).
get-next-entry-number (function).
read-blog-entries (generic function).
sorted-blog-entries (function).
store-blog-entries (method).

4.1.5 `nuclblog/links.lisp`

Dependencies

defpackage.lisp (file).
utilities.lisp (file).
nuclblog.lisp (file).

Source

Parent Component

nuclblog (system).

Internals

blog-archives-url (method).
blog-css-url (method).
blog-delete-entry-url (method).
blog-display-entry-url (method).
blog-edit-entry-url (method).
blog-email-redirect-url (method).
blog-login-url (method).
blog-logout-url (method).
blog-new-category-url (method).
blog-new-entry-url (method).
blog-rss-url (method).
blog-trackback-url (method).
get-protocol (function).
make-archives-url (function).
make-delete-entry-url (function).
make-edit-entry-url (function).
make-entry-url (function).
make-full-entry-url (function).
make-full-root-url (function).
parse-host-name-and-port (function).

4.1.6 `nuclblog/pages.lisp`

Dependencies

defpackage.lisp (file).
utilities.lisp (file).
nuclblog.lisp (file).
links.lisp (file).

Source

Parent Component

nuclblog (system).

Public Interface

banner (generic function).
footer (generic function).

Internals

archives-url (function).
blog-page (function).
box (macro).
buttons (function).
categories (function).
entry-link (function).
main-nav (function).
nav (function).
nav-boxes (generic function).
recent-entries (function).
with-blog-page (macro).

4.1.7 `nuclblog/handlers.lisp`

Dependencies

defpackage.lisp (file).
utilities.lisp (file).
nuclblog.lisp (file).
links.lisp (file).
pages.lisp (file).

Source

Parent Component

nuclblog (system).

Public Interface

define-blog-handlers (function).

Internals

*tag-state* (special variable).
blog-archives (function).
blog-archives-rss (function).
blog-delete (function).
blog-display (function).
blog-edit (function).
blog-entry-display (method).
blog-index-display (method).
blog-index-entry-display (method).
blog-login (function).
blog-login-page (function).
blog-logout (function).
blog-main (function).
blog-new (function).
blog-status (function).
channel-rss (function).
check-password (method).
entry-contents-html (method).
entry-html (function).
entry-rss (function).
markdown* (function).

4.2 Static

nuclblog/version
nuclblog/README
nuclblog/NEWS
nuclblog/LICENSE
nuclblog/ChangeLog
nuclblog/css/nuclblog-css

4.2.1 `nuclblog/version`

Source: nuclblog.asd.
Parent Component: nuclblog (system).

4.2.2 `nuclblog/README`

Source: nuclblog.asd.
Parent Component: nuclblog (system).

4.2.3 `nuclblog/NEWS`

Source: nuclblog.asd.
Parent Component: nuclblog (system).

4.2.4 `nuclblog/LICENSE`

Source: nuclblog.asd.
Parent Component: nuclblog (system).

4.2.5 `nuclblog/ChangeLog`

Source: nuclblog.asd.
Parent Component: nuclblog (system).

4.2.6 `nuclblog/css/nuclblog-css`

Source: nuclblog.asd.
Parent Component: css (module).

5 Packages

Packages are listed by definition order.

nuclblog

5.1 `nuclblog`

Source

defpackage.lisp.

Nickname

blog

Use List

cl-who.
common-lisp.
hunchentoot.

Public Interface

authorized-blog (class).
banner (generic function).
blog (class).
blog-entries (generic reader).
(setf blog-entries) (generic writer).
blog-realm (generic reader).
(setf blog-realm) (generic writer).
define-blog-handlers (function).
footer (generic function).

Internals

*blog-dispatch-blogs* (special variable).
*entries-file-lock* (special variable).
*entries-lock* (special variable).
*login-page-function* (special variable).
*tag-state* (special variable).
add-user (generic function).
archives-url (function).
blog-archives (function).
blog-archives-rss (function).
blog-archives-url (generic function).
blog-banner (generic reader).
(setf blog-banner) (generic writer).
blog-blog-links (generic reader).
(setf blog-blog-links) (generic writer).
blog-buttons (generic reader).
(setf blog-buttons) (generic writer).
blog-categories (generic reader).
(setf blog-categories) (generic writer).
blog-css-url (generic function).
blog-delete (function).
blog-delete-entry-url (generic function).
blog-dispatch (generic function).
blog-display (function).
blog-display-entry-url (generic function).
blog-edit (function).
blog-edit-entry-url (generic function).
blog-email-redirect-url (generic function).
blog-entry (class).
blog-entry-category (generic reader).
(setf blog-entry-category) (generic writer).
blog-entry-contents (generic reader).
(setf blog-entry-contents) (generic writer).
blog-entry-display (generic function).
blog-entry-number (generic reader).
(setf blog-entry-number) (generic writer).
blog-entry-revised-time (generic reader).
(setf blog-entry-revised-time) (generic writer).
blog-entry-storage-path (generic reader).
(setf blog-entry-storage-path) (generic writer).
blog-entry-time (generic reader).
(setf blog-entry-time) (generic writer).
blog-entry-title (generic reader).
(setf blog-entry-title) (generic writer).
blog-entry-trackbacks (generic reader).
(setf blog-entry-trackbacks) (generic writer).
blog-entry-user (generic reader).
(setf blog-entry-user) (generic writer).
blog-footer (generic reader).
(setf blog-footer) (generic writer).
blog-handler-alist (generic reader).
(setf blog-handler-alist) (generic writer).
blog-hostname (generic reader).
(setf blog-hostname) (generic writer).
blog-index-display (generic function).
blog-index-entry-display (generic function).
blog-login (function).
blog-login-page (function).
blog-login-url (generic function).
blog-logo-img-url (generic reader).
(setf blog-logo-img-url) (generic writer).
blog-logout (function).
blog-logout-url (generic function).
blog-main (function).
blog-new (function).
blog-new-category-url (generic function).
blog-new-entry-url (generic function).
blog-owner-email (generic reader).
(setf blog-owner-email) (generic writer).
blog-page (function).
blog-page-css (generic reader).
(setf blog-page-css) (generic writer).
blog-rss-url (generic function).
blog-short-name (generic reader).
(setf blog-short-name) (generic writer).
blog-ssl-port (generic reader).
(setf blog-ssl-port) (generic writer).
blog-status (function).
blog-subtitle (generic reader).
(setf blog-subtitle) (generic writer).
blog-title (generic reader).
(setf blog-title) (generic writer).
blog-trackback-url (generic function).
blog-uri-handler (class).
blog-uri-handler-handler (generic reader).
(setf blog-uri-handler-handler) (generic writer).
blog-uri-handler-require-authorization (generic reader).
(setf blog-uri-handler-require-authorization) (generic writer).
blog-uri-handler-uri (generic reader).
(setf blog-uri-handler-uri) (generic writer).
blog-url-root (generic reader).
(setf blog-url-root) (generic writer).
blog-use-ssl-p (generic reader).
(setf blog-use-ssl-p) (generic writer).
box (macro).
buttons (function).
categories (function).
channel-rss (function).
check-password (generic function).
concatenate-url (function).
create-blog-entry (function).
define-authorized-blog-handler (macro).
define-blog-handler (macro).
delete-blog-entry (function).
entry-contents-html (generic function).
entry-html (function).
entry-link (function).
entry-rss (function).
get-blog-entries (function).
get-entry (function).
get-next-entry-number (function).
get-protocol (function).
main-nav (function).
make-archives-url (function).
make-delete-entry-url (function).
make-edit-entry-url (function).
make-entry-url (function).
make-full-entry-url (function).
make-full-root-url (function).
make-keyword (function).
markdown* (function).
nav (function).
nav-boxes (generic function).
parse-host-name-and-port (function).
read-blog-entries (generic function).
recent-entries (function).
sorted-blog-entries (function).
store-blog-entries (generic function).
with-blog-page (macro).
with-html (macro).
with-html-page (macro).
with-unique-names (macro).
with-xml (macro).
with-xml-output-to-string (macro).

6 Definitions

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

Public Interface
Internals

6.1 Public Interface

Ordinary functions
Generic functions
Standalone methods
Classes

6.1.1 Ordinary functions

Function: define-blog-handlers (blog) ¶

Defines the easy handlers for a given blog.

Package: nuclblog.
Source: handlers.lisp.

6.1.2 Generic functions

Generic Function: banner (blog) ¶

Package

Source

pages.lisp.

Methods

Method: banner (blog) ¶

Generic Reader: blog-entries (object) ¶

Generic Writer: (setf blog-entries) (object) ¶

Package

Methods

Reader Method: blog-entries ((blog blog)) ¶

Writer Method: (setf blog-entries) ((blog blog)) ¶

A list of the entries for this blog. This
should eventually be changed to something more flexible to allow for other representations of blog entries.

Source: nuclblog.lisp.
Target Slot: entries.

Generic Reader: blog-realm (object) ¶

Generic Writer: (setf blog-realm) (object) ¶

Package

Methods

Reader Method: blog-realm ((blog blog)) ¶

Writer Method: (setf blog-realm) ((blog blog)) ¶

A realm to manage users and passwords for the blog.

Source: nuclblog.lisp.
Target Slot: realm.

Generic Function: footer (blog) ¶

Package

Source

pages.lisp.

Methods

Method: footer (blog) ¶

6.1.3 Standalone methods

Method: shared-initialize :after ((blog blog) slot-names &rest initargs) ¶

Source: nuclblog.lisp.

6.1.4 Classes

Class: authorized-blog ¶

Package: nuclblog.
Source: nuclblog.lisp.
Direct superclasses: blog.
Direct methods: blog-dispatch.

Class: blog ¶

Objects of this class represent nuclblog instances.

Package

Source

Direct subclasses

authorized-blog.

Direct methods

add-user.
blog-archives-url.
(setf blog-banner).
blog-banner.
(setf blog-blog-links).
blog-blog-links.
(setf blog-buttons).
blog-buttons.
(setf blog-categories).
blog-categories.
blog-css-url.
blog-delete-entry-url.
blog-display-entry-url.
blog-edit-entry-url.
blog-email-redirect-url.
(setf blog-entries).
blog-entries.
(setf blog-entry-storage-path).
blog-entry-storage-path.
(setf blog-footer).
blog-footer.
(setf blog-handler-alist).
blog-handler-alist.
(setf blog-hostname).
blog-hostname.
blog-login-url.
(setf blog-logo-img-url).
blog-logo-img-url.
blog-logout-url.
blog-new-category-url.
blog-new-entry-url.
(setf blog-owner-email).
blog-owner-email.
(setf blog-page-css).
blog-page-css.
(setf blog-realm).
blog-realm.
blog-rss-url.
(setf blog-short-name).
blog-short-name.
(setf blog-ssl-port).
blog-ssl-port.
(setf blog-subtitle).
blog-subtitle.
(setf blog-title).
blog-title.
blog-trackback-url.
(setf blog-url-root).
blog-url-root.
(setf blog-use-ssl-p).
blog-use-ssl-p.
check-password.
nav-boxes.
shared-initialize.

Direct slots

Slot: short-name ¶

An abbreviated name for this blog.

Initargs: :short-name
Readers: blog-short-name.
Writers: (setf blog-short-name).

Slot: title ¶

The title of this blog.

Initargs: :title
Readers: blog-title.
Writers: (setf blog-title).

Slot: subtitle ¶

The subtitle of this blog.

Initargs: :subtitle
Readers: blog-subtitle.
Writers: (setf blog-subtitle).

Slot: banner ¶

A function to be used as the banner (or NIL).

Initargs: :banner
Readers: blog-banner.
Writers: (setf blog-banner).

Slot: footer ¶

A function to be used as the footer (or NIL).

Initargs: :footer
Readers: blog-footer.
Writers: (setf blog-footer).

Slot: logo-img-url ¶

The URL of the logo for this blog.

Initargs: :logo-img-url
Readers: blog-logo-img-url.
Writers: (setf blog-logo-img-url).

Slot: owner-email ¶

The email address of the owner of this blog.

Initargs: :owner-email
Readers: blog-owner-email.
Writers: (setf blog-owner-email).

Slot: page-css ¶

A URL to the CSS style to load for the pages for this blog.

Initargs: :page-css
Readers: blog-page-css.
Writers: (setf blog-page-css).

Slot: categories ¶

A list of the categories of the
possible categories for entries in this blog.

Initargs: :categories
Readers: blog-categories.
Writers: (setf blog-categories).

Slot: hostname ¶

The hostname for this blog. Prepended to the suffixes of various blog-related URLs

Initargs: :hostname
Readers: blog-hostname.
Writers: (setf blog-hostname).

Slot: url-root ¶

The URL for the root of this
blog. Prepended to the suffixes of various blog-related URLs

Initargs: :url-root
Readers: blog-url-root.
Writers: (setf blog-url-root).

Slot: buttons ¶

A list of lambda-lists of the form (&key
href-url id img-url alt) that specifies the the buttons to be displayed on blog pages.

Initargs: :buttons
Readers: blog-buttons.
Writers: (setf blog-buttons).

Slot: entries ¶

A list of the entries for this blog. This
should eventually be changed to something more flexible to allow for other representations of blog entries.

Readers: blog-entries.
Writers: (setf blog-entries).

Slot: entry-storage-path ¶

The path to the file to store
the blog entries. This should be replaced with something more flexible.

Initargs: :entry-storage-path
Readers: blog-entry-storage-path.
Writers: (setf blog-entry-storage-path).

Slot: realm ¶

A realm to manage users and passwords for the blog.

Initargs: :realm
Readers: blog-realm.
Writers: (setf blog-realm).

Slot: handler-alist ¶

An alist of (URL . function) pairs for use by the blog-dispatcher.

Initargs: :handler-alist
Readers: blog-handler-alist.
Writers: (setf blog-handler-alist).

Slot: use-ssl-p ¶

If non-nil, use https pages for authorized blog pages.

Initargs: :use-ssl
Readers: blog-use-ssl-p.
Writers: (setf blog-use-ssl-p).

Slot: ssl-port ¶

If use-ssl-p is non-nil, the port on
which to use https links. If this is no port is explicitly specified and, presumably, the browser will use 443.

Initargs: :ssl-port
Readers: blog-ssl-port.
Writers: (setf blog-ssl-port).

Slot: blog-links ¶

(Currently unused) slot for outgoing links for this blog.

Initargs: :blog-links
Readers: blog-blog-links.
Writers: (setf blog-blog-links).

6.2 Internals

Special variables
Macros
Ordinary functions
Generic functions
Classes

6.2.1 Special variables

Special Variable: *blog-dispatch-blogs* ¶

Package: nuclblog.
Source: nuclblog.lisp.

Special Variable: *entries-file-lock* ¶

Package: nuclblog.
Source: nuclblog.lisp.

Special Variable: *entries-lock* ¶

Package: nuclblog.
Source: nuclblog.lisp.

Special Variable: *login-page-function* ¶

Package: nuclblog.
Source: nuclblog.lisp.

Special Variable: *tag-state* ¶

Package: nuclblog.
Source: handlers.lisp.

6.2.2 Macros

Macro: box ((&key class id) head &rest body) ¶

Package: nuclblog.
Source: pages.lisp.

Macro: define-authorized-blog-handler (description lambda-list blog-fn) ¶

Package: nuclblog.
Source: nuclblog.lisp.

Macro: define-blog-handler (description lambda-list blog-fn) ¶

Like define-easy-handler, except it takes a first argument
blog. If description is an atom, it is the blog for which the handler is to be defined. If it is a list, the first item is the blog, followed by the keyword args. The keyword :uri argument in the description will be appended to the blog-url-root of the specified blog. See define-easy-handler for further details.

A function designator to be funcalled is provided. This function is then called with the blog as the first argument and keyword arguments for each of the parameters in lambda-list. Note that the called function need not specify default values for the keyword parameters as those are established here.

Package: nuclblog.
Source: nuclblog.lisp.

Macro: with-blog-page (blog title &body body) ¶

Package: nuclblog.
Source: pages.lisp.

Macro: with-html (&body body) ¶

Executes BODY inside a cl-who:with-html-output body.

Package: nuclblog.
Source: utilities.lisp.

Macro: with-html-page (&body body) ¶

Executes BODY inside a cl-who:wtih-html-output-to-string body, directing the output to *standard-output* and setting :prologue to t.

Package: nuclblog.
Source: utilities.lisp.

Macro: with-unique-names ((&rest bindings) &body body) ¶

Syntax: WITH-UNIQUE-NAMES ( { var | (var x) }* ) declaration* form*

Executes a series of forms with each VAR bound to a fresh, uninterned symbol. The uninterned symbol is as if returned by a call to GENSYM with the string denoted by X - or, if X is not supplied, the string denoted by VAR - as argument.

The variable bindings created are lexical unless special declarations are specified. The scopes of the name bindings and declarations do not include the Xs.

The forms are evaluated in order, and the values of all but the last are discarded (that is, the body is an implicit PROGN).

Package: nuclblog.
Source: utilities.lisp.

Macro: with-xml (&body body) ¶

Executes BODY inside a cl-who:with-html-output body. This is a synonym for with-html, but it would be nice if this could automatically deal with turning off the tag downcasing, which it currently doesn’t.

Package: nuclblog.
Source: utilities.lisp.

Macro: with-xml-output-to-string ((&optional stream) &body body) ¶

Prints the <?xml...?> header to stream and Executes BODY inside of a cl-who:with-html-output-to-string block. There is some machinery to turn off downcasing of the tags, but I think this doesn’t work as I intended and should be removed.

Package: nuclblog.
Source: utilities.lisp.

6.2.3 Ordinary functions

Function: archives-url (blog &key category rss) ¶

Package: nuclblog.
Source: pages.lisp.

Function: blog-archives (blog &key category) ¶

Package: nuclblog.
Source: handlers.lisp.

Function: blog-archives-rss (blog &key limit category) ¶

Package: nuclblog.
Source: handlers.lisp.

Function: blog-delete (blog &key id user password) ¶

Package: nuclblog.
Source: handlers.lisp.

Function: blog-display (blog &key id) ¶

Package: nuclblog.
Source: handlers.lisp.

Function: blog-edit (blog &key id category content title user password) ¶

Package: nuclblog.
Source: handlers.lisp.

Function: blog-login (blog &key user password) ¶

Package: nuclblog.
Source: handlers.lisp.

Function: blog-login-page (blog &optional user password) ¶

Package: nuclblog.
Source: handlers.lisp.

Function: blog-logout (blog) ¶

Package: nuclblog.
Source: handlers.lisp.

Function: blog-main (blog) ¶

Package: nuclblog.
Source: handlers.lisp.

Function: blog-new (blog &key category content title user password) ¶

Package: nuclblog.
Source: handlers.lisp.

Function: blog-page (blog title body-function) ¶

Package: nuclblog.
Source: pages.lisp.

Function: blog-status (blog) ¶

Package: nuclblog.
Source: handlers.lisp.

Function: buttons (blog) ¶

Package: nuclblog.
Source: pages.lisp.

Function: categories (blog) ¶

Package: nuclblog.
Source: pages.lisp.

Function: channel-rss (blog &key limit category) ¶

Package: nuclblog.
Source: handlers.lisp.

Function: concatenate-url (base &rest strings) ¶

Concatenates strings. In theory, this could be smarter about checking validity of URLs, fixing redundant slashes, etc...

Package: nuclblog.
Source: utilities.lisp.

Function: create-blog-entry (blog category title contents user &key number time) ¶

Package: nuclblog.
Source: nuclblog.lisp.

Function: delete-blog-entry (blog number) ¶

Package: nuclblog.
Source: nuclblog.lisp.

Function: entry-html (blog entry) ¶

Outputs html for a blog entry.

Package: nuclblog.
Source: handlers.lisp.

Function: entry-link (blog entry) ¶

Package: nuclblog.
Source: pages.lisp.

Function: entry-rss (blog entry) ¶

Outputs RSS 2.0 for a given blog entry.

Package: nuclblog.
Source: handlers.lisp.

Function: get-blog-entries (blog &key category) ¶

Package: nuclblog.
Source: nuclblog.lisp.

Function: get-entry (number blog) ¶

Package: nuclblog.
Source: nuclblog.lisp.

Function: get-next-entry-number (blog) ¶

Package: nuclblog.
Source: nuclblog.lisp.

Function: get-protocol () ¶

Package: nuclblog.
Source: links.lisp.

Function: main-nav (blog) ¶

Package: nuclblog.
Source: pages.lisp.

Function: make-archives-url (blog category &key rss) ¶

Package: nuclblog.
Source: links.lisp.

Function: make-delete-entry-url (blog entry) ¶

Package: nuclblog.
Source: links.lisp.

Function: make-edit-entry-url (blog entry) ¶

Package: nuclblog.
Source: links.lisp.

Function: make-entry-url (blog entry) ¶

Package: nuclblog.
Source: links.lisp.

Function: make-full-entry-url (blog entry) ¶

Package: nuclblog.
Source: links.lisp.

Function: make-full-root-url (blog) ¶

Package: nuclblog.
Source: links.lisp.

Function: make-keyword (string) ¶

Package: nuclblog.
Source: utilities.lisp.

Function: markdown* (source) ¶

Package: nuclblog.
Source: handlers.lisp.

Function: nav (blog) ¶

Package: nuclblog.
Source: pages.lisp.

Function: parse-host-name-and-port (host-and-port) ¶

Package: nuclblog.
Source: links.lisp.

Function: recent-entries (blog) ¶

Package: nuclblog.
Source: pages.lisp.

Function: sorted-blog-entries (blog &key category) ¶

Package: nuclblog.
Source: nuclblog.lisp.

6.2.4 Generic functions

Generic Function: add-user (blog user password) ¶

Package

Methods

Method: add-user ((blog blog) user password) ¶

Source: nuclblog.lisp.

Generic Function: blog-archives-url (blog) ¶

Package

Methods

Method: blog-archives-url ((blog blog)) ¶

Source: links.lisp.

Generic Reader: blog-banner (object) ¶

Generic Writer: (setf blog-banner) (object) ¶

Package

Methods

Reader Method: blog-banner ((blog blog)) ¶

Writer Method: (setf blog-banner) ((blog blog)) ¶

A function to be used as the banner (or NIL).

Source: nuclblog.lisp.
Target Slot: banner.

Generic Reader: blog-blog-links (object) ¶

Generic Writer: (setf blog-blog-links) (object) ¶

Package

Methods

Reader Method: blog-blog-links ((blog blog)) ¶

Writer Method: (setf blog-blog-links) ((blog blog)) ¶

(Currently unused) slot for outgoing links for this blog.

Source: nuclblog.lisp.
Target Slot: blog-links.

Generic Reader: blog-buttons (object) ¶

Generic Writer: (setf blog-buttons) (object) ¶

Package

Methods

Reader Method: blog-buttons ((blog blog)) ¶

Writer Method: (setf blog-buttons) ((blog blog)) ¶

A list of lambda-lists of the form (&key
href-url id img-url alt) that specifies the the buttons to be displayed on blog pages.

Source: nuclblog.lisp.
Target Slot: buttons.

Generic Reader: blog-categories (object) ¶

Generic Writer: (setf blog-categories) (object) ¶

Package

Methods

Reader Method: blog-categories ((blog blog)) ¶

Writer Method: (setf blog-categories) ((blog blog)) ¶

A list of the categories of the
possible categories for entries in this blog.

Source: nuclblog.lisp.
Target Slot: categories.

Generic Function: blog-css-url (blog) ¶

Package

Methods

Method: blog-css-url ((blog blog)) ¶

Source: links.lisp.

Generic Function: blog-delete-entry-url (blog) ¶

Package

Methods

Method: blog-delete-entry-url ((blog blog)) ¶

Source: links.lisp.

Generic Function: blog-dispatch (request blog) ¶

The dispatch (generic) function for the blog
handlers. This should be added to the hunchentoot:*dispatch-table*.

Package

Source

Methods

Method: blog-dispatch (request (blog authorized-blog)) ¶

Method: blog-dispatch (request blog) ¶

Generic Function: blog-display-entry-url (blog) ¶

Package

Methods

Method: blog-display-entry-url ((blog blog)) ¶

Source: links.lisp.

Generic Function: blog-edit-entry-url (blog) ¶

Package

Methods

Method: blog-edit-entry-url ((blog blog)) ¶

Source: links.lisp.

Generic Function: blog-email-redirect-url (blog) ¶

Package

Methods

Method: blog-email-redirect-url ((blog blog)) ¶

Source: links.lisp.

Generic Reader: blog-entry-category (object) ¶

Package

Methods

Reader Method: blog-entry-category ((blog-entry blog-entry)) ¶

automatically generated reader method

Source: nuclblog.lisp.
Target Slot: category.

Generic Writer: (setf blog-entry-category) (object) ¶

Package

Methods

Writer Method: (setf blog-entry-category) ((blog-entry blog-entry)) ¶

automatically generated writer method

Source: nuclblog.lisp.
Target Slot: category.

Generic Reader: blog-entry-contents (object) ¶

Package

Methods

Reader Method: blog-entry-contents ((blog-entry blog-entry)) ¶

automatically generated reader method

Source: nuclblog.lisp.
Target Slot: contents.

Generic Writer: (setf blog-entry-contents) (object) ¶

Package

Methods

Writer Method: (setf blog-entry-contents) ((blog-entry blog-entry)) ¶

automatically generated writer method

Source: nuclblog.lisp.
Target Slot: contents.

Generic Function: blog-entry-display (blog entry) ¶

Package

Source

Methods

Method: blog-entry-display (blog entry) ¶

Source: handlers.lisp.

Generic Reader: blog-entry-number (object) ¶

Package

Methods

Reader Method: blog-entry-number ((blog-entry blog-entry)) ¶

automatically generated reader method

Source: nuclblog.lisp.
Target Slot: number.

Generic Writer: (setf blog-entry-number) (object) ¶

Package

Methods

Writer Method: (setf blog-entry-number) ((blog-entry blog-entry)) ¶

automatically generated writer method

Source: nuclblog.lisp.
Target Slot: number.

Generic Reader: blog-entry-revised-time (object) ¶

Package

Methods

Reader Method: blog-entry-revised-time ((blog-entry blog-entry)) ¶

automatically generated reader method

Source: nuclblog.lisp.
Target Slot: revised-time.

Generic Writer: (setf blog-entry-revised-time) (object) ¶

Package

Methods

Writer Method: (setf blog-entry-revised-time) ((blog-entry blog-entry)) ¶

automatically generated writer method

Source: nuclblog.lisp.
Target Slot: revised-time.

Generic Reader: blog-entry-storage-path (object) ¶

Generic Writer: (setf blog-entry-storage-path) (object) ¶

Package

Methods

Reader Method: blog-entry-storage-path ((blog blog)) ¶

Writer Method: (setf blog-entry-storage-path) ((blog blog)) ¶

The path to the file to store
the blog entries. This should be replaced with something more flexible.

Source: nuclblog.lisp.
Target Slot: entry-storage-path.

Generic Reader: blog-entry-time (object) ¶

Package

Methods

Reader Method: blog-entry-time ((blog-entry blog-entry)) ¶

automatically generated reader method

Source: nuclblog.lisp.
Target Slot: time.

Generic Writer: (setf blog-entry-time) (object) ¶

Package

Methods

Writer Method: (setf blog-entry-time) ((blog-entry blog-entry)) ¶

automatically generated writer method

Source: nuclblog.lisp.
Target Slot: time.

Generic Reader: blog-entry-title (object) ¶

Package

Methods

Reader Method: blog-entry-title ((blog-entry blog-entry)) ¶

automatically generated reader method

Source: nuclblog.lisp.
Target Slot: title.

Generic Writer: (setf blog-entry-title) (object) ¶

Package

Methods

Writer Method: (setf blog-entry-title) ((blog-entry blog-entry)) ¶

automatically generated writer method

Source: nuclblog.lisp.
Target Slot: title.

Generic Reader: blog-entry-trackbacks (object) ¶

Package

Methods

Reader Method: blog-entry-trackbacks ((blog-entry blog-entry)) ¶

automatically generated reader method

Source: nuclblog.lisp.
Target Slot: trackbacks.

Generic Writer: (setf blog-entry-trackbacks) (object) ¶

Package

Methods

Writer Method: (setf blog-entry-trackbacks) ((blog-entry blog-entry)) ¶

automatically generated writer method

Source: nuclblog.lisp.
Target Slot: trackbacks.

Generic Reader: blog-entry-user (object) ¶

Package

Methods

Reader Method: blog-entry-user ((blog-entry blog-entry)) ¶

automatically generated reader method

Source: nuclblog.lisp.
Target Slot: user.

Generic Writer: (setf blog-entry-user) (object) ¶

Package

Methods

Writer Method: (setf blog-entry-user) ((blog-entry blog-entry)) ¶

automatically generated writer method

Source: nuclblog.lisp.
Target Slot: user.

Generic Reader: blog-footer (object) ¶

Generic Writer: (setf blog-footer) (object) ¶

Package

Methods

Reader Method: blog-footer ((blog blog)) ¶

Writer Method: (setf blog-footer) ((blog blog)) ¶

A function to be used as the footer (or NIL).

Source: nuclblog.lisp.
Target Slot: footer.

Generic Reader: blog-handler-alist (object) ¶

Generic Writer: (setf blog-handler-alist) (object) ¶

Package

Methods

Reader Method: blog-handler-alist ((blog blog)) ¶

Writer Method: (setf blog-handler-alist) ((blog blog)) ¶

An alist of (URL . function) pairs for use by the blog-dispatcher.

Source: nuclblog.lisp.
Target Slot: handler-alist.

Generic Reader: blog-hostname (object) ¶

Generic Writer: (setf blog-hostname) (object) ¶

Package

Methods

Reader Method: blog-hostname ((blog blog)) ¶

Writer Method: (setf blog-hostname) ((blog blog)) ¶

The hostname for this blog. Prepended to the suffixes of various blog-related URLs

Source: nuclblog.lisp.
Target Slot: hostname.

Generic Function: blog-index-display (blog &key start end) ¶

Package

Methods

Method: blog-index-display (blog &key start end) ¶

Source: handlers.lisp.

Generic Function: blog-index-entry-display (blog entry) ¶

Package

Methods

Method: blog-index-entry-display (blog entry) ¶

Source: handlers.lisp.

Generic Function: blog-login-url (blog) ¶

Package

Methods

Method: blog-login-url ((blog blog)) ¶

Source: links.lisp.

Generic Reader: blog-logo-img-url (object) ¶

Generic Writer: (setf blog-logo-img-url) (object) ¶

Package

Methods

Reader Method: blog-logo-img-url ((blog blog)) ¶

Writer Method: (setf blog-logo-img-url) ((blog blog)) ¶

The URL of the logo for this blog.

Source: nuclblog.lisp.
Target Slot: logo-img-url.

Generic Function: blog-logout-url (blog) ¶

Package

Methods

Method: blog-logout-url ((blog blog)) ¶

Source: links.lisp.

Generic Function: blog-new-category-url (blog) ¶

Package

Methods

Method: blog-new-category-url ((blog blog)) ¶

Source: links.lisp.

Generic Function: blog-new-entry-url (blog) ¶

Package

Methods

Method: blog-new-entry-url ((blog blog)) ¶

Source: links.lisp.

Generic Reader: blog-owner-email (object) ¶

Generic Writer: (setf blog-owner-email) (object) ¶

Package

Methods

Reader Method: blog-owner-email ((blog blog)) ¶

Writer Method: (setf blog-owner-email) ((blog blog)) ¶

The email address of the owner of this blog.

Source: nuclblog.lisp.
Target Slot: owner-email.

Generic Reader: blog-page-css (object) ¶

Generic Writer: (setf blog-page-css) (object) ¶

Package

Methods

Reader Method: blog-page-css ((blog blog)) ¶

Writer Method: (setf blog-page-css) ((blog blog)) ¶

A URL to the CSS style to load for the pages for this blog.

Source: nuclblog.lisp.
Target Slot: page-css.

Generic Function: blog-rss-url (blog) ¶

Package

Methods

Method: blog-rss-url ((blog blog)) ¶

Source: links.lisp.

Generic Reader: blog-short-name (object) ¶

Generic Writer: (setf blog-short-name) (object) ¶

Package

Methods

Reader Method: blog-short-name ((blog blog)) ¶

Writer Method: (setf blog-short-name) ((blog blog)) ¶

An abbreviated name for this blog.

Source: nuclblog.lisp.
Target Slot: short-name.

Generic Reader: blog-ssl-port (object) ¶

Generic Writer: (setf blog-ssl-port) (object) ¶

Package

Methods

Reader Method: blog-ssl-port ((blog blog)) ¶

Writer Method: (setf blog-ssl-port) ((blog blog)) ¶

If use-ssl-p is non-nil, the port on
which to use https links. If this is no port is explicitly specified and, presumably, the browser will use 443.

Source: nuclblog.lisp.
Target Slot: ssl-port.

Generic Reader: blog-subtitle (object) ¶

Generic Writer: (setf blog-subtitle) (object) ¶

Package

Methods

Reader Method: blog-subtitle ((blog blog)) ¶

Writer Method: (setf blog-subtitle) ((blog blog)) ¶

The subtitle of this blog.

Source: nuclblog.lisp.
Target Slot: subtitle.

Generic Reader: blog-title (object) ¶

Generic Writer: (setf blog-title) (object) ¶

Package

Methods

Reader Method: blog-title ((blog blog)) ¶

Writer Method: (setf blog-title) ((blog blog)) ¶

The title of this blog.

Source: nuclblog.lisp.
Target Slot: title.

Generic Function: blog-trackback-url (blog) ¶

Package

Methods

Method: blog-trackback-url ((blog blog)) ¶

Source: links.lisp.

Generic Reader: blog-uri-handler-handler (object) ¶

Package

Methods

Reader Method: blog-uri-handler-handler ((blog-uri-handler blog-uri-handler)) ¶

automatically generated reader method

Source: nuclblog.lisp.
Target Slot: handler.

Generic Writer: (setf blog-uri-handler-handler) (object) ¶

Package

Methods

Writer Method: (setf blog-uri-handler-handler) ((blog-uri-handler blog-uri-handler)) ¶

automatically generated writer method

Source: nuclblog.lisp.
Target Slot: handler.

Generic Reader: blog-uri-handler-require-authorization (object) ¶

Package

Methods

Reader Method: blog-uri-handler-require-authorization ((blog-uri-handler blog-uri-handler)) ¶

automatically generated reader method

Source: nuclblog.lisp.
Target Slot: require-authorization.

Generic Writer: (setf blog-uri-handler-require-authorization) (object) ¶

Package

Methods

Writer Method: (setf blog-uri-handler-require-authorization) ((blog-uri-handler blog-uri-handler)) ¶

automatically generated writer method

Source: nuclblog.lisp.
Target Slot: require-authorization.

Generic Reader: blog-uri-handler-uri (object) ¶

Package

Methods

Reader Method: blog-uri-handler-uri ((blog-uri-handler blog-uri-handler)) ¶

automatically generated reader method

Source: nuclblog.lisp.
Target Slot: uri.

Generic Writer: (setf blog-uri-handler-uri) (object) ¶

Package

Methods

Writer Method: (setf blog-uri-handler-uri) ((blog-uri-handler blog-uri-handler)) ¶

automatically generated writer method

Source: nuclblog.lisp.
Target Slot: uri.

Generic Reader: blog-url-root (object) ¶

Generic Writer: (setf blog-url-root) (object) ¶

Package

Methods

Reader Method: blog-url-root ((blog blog)) ¶

Writer Method: (setf blog-url-root) ((blog blog)) ¶

The URL for the root of this
blog. Prepended to the suffixes of various blog-related URLs

Source: nuclblog.lisp.
Target Slot: url-root.

Generic Reader: blog-use-ssl-p (object) ¶

Generic Writer: (setf blog-use-ssl-p) (object) ¶

Package

Methods

Reader Method: blog-use-ssl-p ((blog blog)) ¶

Writer Method: (setf blog-use-ssl-p) ((blog blog)) ¶

If non-nil, use https pages for authorized blog pages.

Source: nuclblog.lisp.
Target Slot: use-ssl-p.

Generic Function: check-password (blog user password) ¶

Package

Methods

Method: check-password ((blog blog) user password) ¶

Source: handlers.lisp.

Generic Function: entry-contents-html (blog entry) ¶

Package

Methods

Method: entry-contents-html (blog entry) ¶

Source: handlers.lisp.

Generic Function: nav-boxes (blog) ¶

Package

Source

pages.lisp.

Methods

Method: nav-boxes ((blog blog)) ¶

Generic Function: read-blog-entries (blog &key path) ¶

Package

Source

Methods

Method: read-blog-entries (blog &key path) ¶

Generic Function: store-blog-entries (blog path) ¶

Package

Methods

Method: store-blog-entries (blog path) ¶

Source: nuclblog.lisp.

6.2.5 Classes

Class: blog-entry ¶

Package

Source

Direct methods

(setf blog-entry-category).
blog-entry-category.
(setf blog-entry-contents).
blog-entry-contents.
(setf blog-entry-number).
blog-entry-number.
(setf blog-entry-revised-time).
blog-entry-revised-time.
(setf blog-entry-time).
blog-entry-time.
(setf blog-entry-title).
blog-entry-title.
(setf blog-entry-trackbacks).
blog-entry-trackbacks.
(setf blog-entry-user).
blog-entry-user.

Direct slots

Slot: category ¶

Initargs: :category
Readers: blog-entry-category.
Writers: (setf blog-entry-category).

Slot: user ¶

Initargs: :user
Readers: blog-entry-user.
Writers: (setf blog-entry-user).

Slot: number ¶

Package: common-lisp.
Initargs: :number
Readers: blog-entry-number.
Writers: (setf blog-entry-number).

Slot: title ¶

Initargs: :title
Readers: blog-entry-title.
Writers: (setf blog-entry-title).

Slot: time ¶

Package: common-lisp.
Initargs: :time
Readers: blog-entry-time.
Writers: (setf blog-entry-time).

Slot: revised-time ¶

Initform: 0
Initargs: :revised-time
Readers: blog-entry-revised-time.
Writers: (setf blog-entry-revised-time).

Slot: contents ¶

Initargs: :contents
Readers: blog-entry-contents.
Writers: (setf blog-entry-contents).

Slot: trackbacks ¶

Initargs: :trackbacks
Readers: blog-entry-trackbacks.
Writers: (setf blog-entry-trackbacks).

Class: blog-uri-handler ¶

Package

Source