This is the nuclblog Reference Manual, version 0.5, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed Mar 15 07:07:27 2023 GMT+0.
The main system appears first, followed by any subsystem dependency.
nuclblogCyrus Harmon <ch-lisp@bobobeach.com>
BSD
0.5
hunchentoot (system).
cl-who (system).
cl-store (system).
md5 (system).
bordeaux-threads (system).
hunchentoot-auth (system).
cl-markdown (system).
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).
Modules are listed depth-first from the system components tree.
Files are sorted by type and then listed depth-first from the systems components trees.
nuclblog/nuclblog.asdnuclblog/defpackage.lispnuclblog/utilities.lispnuclblog/nuclblog.lispnuclblog/links.lispnuclblog/pages.lispnuclblog/handlers.lispnuclblog/utilities.lispdefpackage.lisp (file).
nuclblog (system).
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).
nuclblog/nuclblog.lispdefpackage.lisp (file).
utilities.lisp (file).
nuclblog (system).
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).
*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).
nuclblog/links.lispdefpackage.lisp (file).
utilities.lisp (file).
nuclblog.lisp (file).
nuclblog (system).
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).
nuclblog/pages.lispdefpackage.lisp (file).
utilities.lisp (file).
nuclblog.lisp (file).
links.lisp (file).
nuclblog (system).
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).
nuclblog/handlers.lispdefpackage.lisp (file).
utilities.lisp (file).
nuclblog.lisp (file).
links.lisp (file).
pages.lisp (file).
nuclblog (system).
define-blog-handlers (function).
*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).
Packages are listed by definition order.
nuclblogblog
cl-who.
common-lisp.
hunchentoot.
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).
*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).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Defines the easy handlers for a given blog.
Objects of this class represent nuclblog instances.
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.
An abbreviated name for this blog.
:short-name
The title of this blog.
:title
The subtitle of this blog.
:subtitle
A function to be used as the banner (or NIL).
:banner
The URL of the logo for this blog.
:logo-img-url
The email address of the owner of this blog.
:owner-email
A URL to the CSS style to load for the pages for this blog.
:page-css
A list of the categories of the
possible categories for entries in this blog.
:categories
The hostname for this blog. Prepended to the suffixes of various blog-related URLs
:hostname
The URL for the root of this
blog. Prepended to the suffixes of various blog-related URLs
:url-root
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.
:buttons
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.
The path to the file to store
the blog entries. This should be replaced with something more
flexible.
:entry-storage-path
A realm to manage users and passwords for the blog.
:realm
An alist of (URL . function) pairs for use by the blog-dispatcher.
:handler-alist
If non-nil, use https pages for authorized blog pages.
:use-ssl
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.
:ssl-port
(Currently unused) slot for outgoing links for this blog.
:blog-links
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.
Executes BODY inside a cl-who:with-html-output body.
Executes BODY inside a cl-who:wtih-html-output-to-string body, directing the output to *standard-output* and setting :prologue to t.
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).
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.
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.
Concatenates strings. In theory, this could be smarter about checking validity of URLs, fixing redundant slashes, etc...
Outputs html for a blog entry.
Outputs RSS 2.0 for a given blog entry.
The dispatch (generic) function for the blog
handlers. This should be added to the hunchentoot:*dispatch-table*.
authorized-blog)) ¶blog-entry)) ¶automatically generated reader method
blog-entry)) ¶automatically generated writer method
blog-entry)) ¶automatically generated reader method
blog-entry)) ¶automatically generated writer method
blog-entry)) ¶automatically generated reader method
blog-entry)) ¶automatically generated writer method
blog-entry)) ¶automatically generated reader method
blog-entry)) ¶automatically generated writer method
blog-entry)) ¶automatically generated reader method
time.
blog-entry)) ¶automatically generated writer method
time.
blog-entry)) ¶automatically generated reader method
blog-entry)) ¶automatically generated writer method
blog-entry)) ¶automatically generated reader method
blog-entry)) ¶automatically generated writer method
blog-entry)) ¶automatically generated reader method
user.
blog-entry)) ¶automatically generated writer method
user.
blog-uri-handler)) ¶automatically generated reader method
blog-uri-handler)) ¶automatically generated writer method
blog-uri-handler)) ¶automatically generated reader method
blog-uri-handler)) ¶automatically generated writer method
blog-uri-handler)) ¶automatically generated reader method
uri.
blog-uri-handler)) ¶automatically generated writer method
uri.
(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.
:category
:user
common-lisp.
:number
:title
common-lisp.
:time
0
:revised-time
:contents
:trackbacks
| Jump to: | (
A B C D E F G M N P R S W |
|---|
| Jump to: | (
A B C D E F G M N P R S W |
|---|
| Jump to: | *
B C E F H L N O P R S T U |
|---|
| Jump to: | *
B C E F H L N O P R S T U |
|---|
| Jump to: | A B C D F H L M N P R S U V |
|---|
| Jump to: | A B C D F H L M N P R S U V |
|---|