Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the nuclblog Reference Manual, version 0.5, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 11:50:42 2020 GMT+0.
| • Introduction | What nuclblog is all about | |
| • Systems | The systems documentation | |
| • Modules | The modules documentation | |
| • Files | The files documentation | |
| • Packages | The packages documentation | |
| • Definitions | The symbols documentation | |
| • Indexes | Concepts, functions, variables and data types |
nuclblog Cyrus Harmon Thu Dec 20 09:16:27 2007 nuclblog is a blog engine written in Common Lisp. nuclblog aims to be a clean, relatively lightweight blog engine based on the hunchentoot web server. To install it you need to do/get the following: 1. Prerequisites: * hunchentoot * cl-who * cl-store and for the demo: * ch-asdf 2. Install the nuclblog.asd file Install the nuclblog.asd file in the usual place .asd files go on your system (e.g., /usr/local/lib/sbcl/site-systems) 3. SSL edit demo/ssl/openssl.config and then: To create a new cert: cd demo/ssl openssl genrsa -out key.pem 1024 openssl req -config openssl.config -new -key key.pem -out request.pem openssl req -x509 -days 365 -key key.pem -in request.pem -out certificate.pem 4. Running the demo execute the following: (asdf:oos 'asdf:load-op :nuclblog-demo) (nuclblog-demo:start-services) or (nuclblog-demo:start-services :use-ssl t) (nuclblog::add-user nuclblog-demo::*blog* "demo" "demo") and you should be ready to go! 5. Acknowledgments Thanks to Brian Mastenbrook for his cl-blog which served as inspiration for this project. Thanks to Edi Weitz for his wonderful hunchentoot, cl-who, drakma, among others, projects.
Next: Modules, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
| • The nuclblog system |
Cyrus Harmon <ch-lisp@bobobeach.com>
BSD
0.5
nuclblog.asd (file)
Modules are listed depth-first from the system components tree.
| • The nuclblog/css module |
nuclblog (system)
css/
nuclblog-css (file)
Files are sorted by type and then listed depth-first from the systems components trees.
| • Lisp files | ||
| • Static files |
Next: Static files, Previous: Files, Up: Files [Contents][Index]
Next: The nuclblog/defpackage․lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
nuclblog.asd
nuclblog (system)
Next: The nuclblog/utilities․lisp file, Previous: The nuclblog․asd file, Up: Lisp files [Contents][Index]
Next: The nuclblog/nuclblog․lisp file, Previous: The nuclblog/defpackage․lisp file, Up: Lisp files [Contents][Index]
defpackage.lisp (file)
nuclblog (system)
utilities.lisp
Next: The nuclblog/links․lisp file, Previous: The nuclblog/utilities․lisp file, Up: Lisp files [Contents][Index]
nuclblog (system)
nuclblog.lisp
Next: The nuclblog/pages․lisp file, Previous: The nuclblog/nuclblog․lisp file, Up: Lisp files [Contents][Index]
nuclblog (system)
links.lisp
Next: The nuclblog/handlers․lisp file, Previous: The nuclblog/links․lisp file, Up: Lisp files [Contents][Index]
nuclblog (system)
pages.lisp
Previous: The nuclblog/pages․lisp file, Up: Lisp files [Contents][Index]
nuclblog (system)
handlers.lisp
define-blog-handlers (function)
Previous: Lisp files, Up: Files [Contents][Index]
| • The nuclblog/version file | ||
| • The nuclblog/readme file | ||
| • The nuclblog/news file | ||
| • The nuclblog/license file | ||
| • The nuclblog/changelog file | ||
| • The nuclblog/css/nuclblog-css file |
Next: The nuclblog/readme file, Previous: Static files, Up: Static files [Contents][Index]
nuclblog (system)
version.lisp-expr
Next: The nuclblog/news file, Previous: The nuclblog/version file, Up: Static files [Contents][Index]
nuclblog (system)
README
Next: The nuclblog/license file, Previous: The nuclblog/readme file, Up: Static files [Contents][Index]
nuclblog (system)
NEWS
Next: The nuclblog/changelog file, Previous: The nuclblog/news file, Up: Static files [Contents][Index]
nuclblog (system)
LICENSE
Next: The nuclblog/css/nuclblog-css file, Previous: The nuclblog/license file, Up: Static files [Contents][Index]
nuclblog (system)
ChangeLog
Previous: The nuclblog/changelog file, Up: Static files [Contents][Index]
css (module)
css/nuclblog.css
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
| • The nuclblog package |
defpackage.lisp (file)
blog
Definitions are sorted by export status, category, package, and then by lexicographic order.
| • Exported definitions | ||
| • Internal definitions |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
| • Exported functions | ||
| • Exported generic functions | ||
| • Exported classes |
Next: Exported generic functions, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
Defines the easy handlers for a given blog.
handlers.lisp (file)
Next: Exported classes, Previous: Exported functions, Up: Exported definitions [Contents][Index]
pages.lisp (file)
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.
nuclblog.lisp (file)
A realm to manage users and passwords for the blog.
nuclblog.lisp (file)
pages.lisp (file)
Previous: Exported generic functions, Up: Exported definitions [Contents][Index]
nuclblog.lisp (file)
blog (class)
blog-dispatch (method)
Objects of this class represent nuclblog instances.
nuclblog.lisp (file)
standard-object (class)
authorized-blog (class)
An abbreviated name for this blog.
:short-name
blog-short-name (generic function)
(setf blog-short-name) (generic function)
The title of this blog.
:title
blog-title (generic function)
(setf blog-title) (generic function)
The subtitle of this blog.
:subtitle
blog-subtitle (generic function)
(setf blog-subtitle) (generic function)
A function to be used as the banner (or NIL).
:banner
blog-banner (generic function)
(setf blog-banner) (generic function)
A function to be used as the footer (or NIL).
:footer
blog-footer (generic function)
(setf blog-footer) (generic function)
The URL of the logo for this blog.
:logo-img-url
blog-logo-img-url (generic function)
(setf blog-logo-img-url) (generic function)
The email address of the owner of this blog.
:owner-email
blog-owner-email (generic function)
(setf blog-owner-email) (generic function)
A URL to the CSS style to load for the pages for this blog.
:page-css
blog-page-css (generic function)
(setf blog-page-css) (generic function)
A list of the categories of the
possible categories for entries in this blog.
:categories
blog-categories (generic function)
(setf blog-categories) (generic function)
The hostname for this blog. Prepended to the suffixes of various blog-related URLs
:hostname
blog-hostname (generic function)
(setf blog-hostname) (generic function)
The URL for the root of this
blog. Prepended to the suffixes of various blog-related URLs
:url-root
blog-url-root (generic function)
(setf blog-url-root) (generic function)
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
blog-buttons (generic function)
(setf blog-buttons) (generic function)
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.
blog-entries (generic function)
(setf blog-entries) (generic function)
The path to the file to store
the blog entries. This should be replaced with something more
flexible.
:entry-storage-path
blog-entry-storage-path (generic function)
(setf blog-entry-storage-path) (generic function)
A realm to manage users and passwords for the blog.
:realm
blog-realm (generic function)
(setf blog-realm) (generic function)
An alist of (URL . function) pairs for use by the blog-dispatcher.
:handler-alist
blog-handler-alist (generic function)
(setf blog-handler-alist) (generic function)
If non-nil, use https pages for authorized blog pages.
:use-ssl
blog-use-ssl-p (generic function)
(setf blog-use-ssl-p) (generic function)
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
blog-ssl-port (generic function)
(setf blog-ssl-port) (generic function)
(Currently unused) slot for outgoing links for this blog.
:blog-links
blog-blog-links (generic function)
(setf blog-blog-links) (generic function)
Previous: Exported definitions, Up: Definitions [Contents][Index]
| • Internal special variables | ||
| • Internal macros | ||
| • Internal functions | ||
| • Internal generic functions | ||
| • Internal classes |
Next: Internal macros, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
nuclblog.lisp (file)
nuclblog.lisp (file)
nuclblog.lisp (file)
nuclblog.lisp (file)
handlers.lisp (file)
Next: Internal functions, Previous: Internal special variables, Up: Internal definitions [Contents][Index]
pages.lisp (file)
nuclblog.lisp (file)
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.
nuclblog.lisp (file)
pages.lisp (file)
Executes BODY inside a cl-who:with-html-output body.
utilities.lisp (file)
Executes BODY inside a cl-who:wtih-html-output-to-string body, directing the output to *standard-output* and setting :prologue to t.
utilities.lisp (file)
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).
utilities.lisp (file)
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.
utilities.lisp (file)
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.
utilities.lisp (file)
Next: Internal generic functions, Previous: Internal macros, Up: Internal definitions [Contents][Index]
pages.lisp (file)
handlers.lisp (file)
handlers.lisp (file)
handlers.lisp (file)
handlers.lisp (file)
handlers.lisp (file)
handlers.lisp (file)
handlers.lisp (file)
handlers.lisp (file)
handlers.lisp (file)
handlers.lisp (file)
pages.lisp (file)
handlers.lisp (file)
pages.lisp (file)
pages.lisp (file)
handlers.lisp (file)
Concatenates strings. In theory, this could be smarter about checking validity of URLs, fixing redundant slashes, etc...
utilities.lisp (file)
nuclblog.lisp (file)
nuclblog.lisp (file)
Outputs html for a blog entry.
handlers.lisp (file)
pages.lisp (file)
Outputs RSS 2.0 for a given blog entry.
handlers.lisp (file)
nuclblog.lisp (file)
nuclblog.lisp (file)
nuclblog.lisp (file)
links.lisp (file)
pages.lisp (file)
links.lisp (file)
links.lisp (file)
links.lisp (file)
links.lisp (file)
links.lisp (file)
links.lisp (file)
utilities.lisp (file)
handlers.lisp (file)
pages.lisp (file)
links.lisp (file)
pages.lisp (file)
nuclblog.lisp (file)
Next: Internal classes, Previous: Internal functions, Up: Internal definitions [Contents][Index]
nuclblog.lisp (file)
links.lisp (file)
A function to be used as the banner (or NIL).
nuclblog.lisp (file)
(Currently unused) slot for outgoing links for this blog.
nuclblog.lisp (file)
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.
nuclblog.lisp (file)
A list of the categories of the
possible categories for entries in this blog.
nuclblog.lisp (file)
links.lisp (file)
links.lisp (file)
The dispatch (generic) function for the blog
handlers. This should be added to the hunchentoot:*dispatch-table*.
nuclblog.lisp (file)
links.lisp (file)
links.lisp (file)
links.lisp (file)
automatically generated reader method
nuclblog.lisp (file)
automatically generated writer method
nuclblog.lisp (file)
automatically generated reader method
nuclblog.lisp (file)
automatically generated writer method
nuclblog.lisp (file)
nuclblog.lisp (file)
handlers.lisp (file)
automatically generated reader method
nuclblog.lisp (file)
automatically generated writer method
nuclblog.lisp (file)
automatically generated reader method
nuclblog.lisp (file)
automatically generated writer method
nuclblog.lisp (file)
The path to the file to store
the blog entries. This should be replaced with something more
flexible.
nuclblog.lisp (file)
automatically generated reader method
nuclblog.lisp (file)
automatically generated writer method
nuclblog.lisp (file)
automatically generated reader method
nuclblog.lisp (file)
automatically generated writer method
nuclblog.lisp (file)
automatically generated reader method
nuclblog.lisp (file)
automatically generated writer method
nuclblog.lisp (file)
automatically generated reader method
nuclblog.lisp (file)
automatically generated writer method
nuclblog.lisp (file)
A function to be used as the footer (or NIL).
nuclblog.lisp (file)
An alist of (URL . function) pairs for use by the blog-dispatcher.
nuclblog.lisp (file)
The hostname for this blog. Prepended to the suffixes of various blog-related URLs
nuclblog.lisp (file)
handlers.lisp (file)
handlers.lisp (file)
links.lisp (file)
The URL of the logo for this blog.
nuclblog.lisp (file)
links.lisp (file)
links.lisp (file)
links.lisp (file)
The email address of the owner of this blog.
nuclblog.lisp (file)
A URL to the CSS style to load for the pages for this blog.
nuclblog.lisp (file)
links.lisp (file)
An abbreviated name for this blog.
nuclblog.lisp (file)
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.
nuclblog.lisp (file)
The subtitle of this blog.
nuclblog.lisp (file)
The title of this blog.
nuclblog.lisp (file)
links.lisp (file)
automatically generated reader method
nuclblog.lisp (file)
automatically generated writer method
nuclblog.lisp (file)
automatically generated reader method
nuclblog.lisp (file)
automatically generated writer method
nuclblog.lisp (file)
automatically generated reader method
nuclblog.lisp (file)
automatically generated writer method
nuclblog.lisp (file)
The URL for the root of this
blog. Prepended to the suffixes of various blog-related URLs
nuclblog.lisp (file)
If non-nil, use https pages for authorized blog pages.
nuclblog.lisp (file)
handlers.lisp (file)
handlers.lisp (file)
pages.lisp (file)
nuclblog.lisp (file)
nuclblog.lisp (file)
Previous: Internal generic functions, Up: Internal definitions [Contents][Index]
nuclblog.lisp (file)
standard-object (class)
:category
blog-entry-category (generic function)
(setf blog-entry-category) (generic function)
:user
blog-entry-user (generic function)
(setf blog-entry-user) (generic function)
:number
blog-entry-number (generic function)
(setf blog-entry-number) (generic function)
:title
blog-entry-title (generic function)
(setf blog-entry-title) (generic function)
:time
blog-entry-time (generic function)
(setf blog-entry-time) (generic function)
:revised-time
0
blog-entry-revised-time (generic function)
(setf blog-entry-revised-time) (generic function)
:contents
blog-entry-contents (generic function)
(setf blog-entry-contents) (generic function)
:trackbacks
blog-entry-trackbacks (generic function)
(setf blog-entry-trackbacks) (generic function)
nuclblog.lisp (file)
standard-object (class)
:uri
blog-uri-handler-uri (generic function)
(setf blog-uri-handler-uri) (generic function)
:handler
blog-uri-handler-handler (generic function)
(setf blog-uri-handler-handler) (generic function)
:require-authorization
blog-uri-handler-require-authorization (generic function)
(setf blog-uri-handler-require-authorization) (generic function)
Previous: Definitions, Up: Top [Contents][Index]
| • Concept index | ||
| • Function index | ||
| • Variable index | ||
| • Data type index |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
| Jump to: | F L M N S |
|---|
| Jump to: | F L M N S |
|---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
| 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 |
|---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
| 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 |
|---|
Previous: Variable index, Up: Indexes [Contents][Index]
| Jump to: | A B C N P S |
|---|
| Jump to: | A B C N P S |
|---|