This is the macro-html Reference Manual, version 1.2, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 08 18:50:59 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
macro-html
HTML generation library. Aims to be fast, modular, cachable and concise. It does so by defining each tag as a macro which expands to code printing the respective HTML source. Also employs a DSL for element attributes.
Max Rottenkolber <max@mr.gy>
GNU AGPL
1.2
named-readtables
(system).
packages.lisp
(file).
macro-html.lisp
(file).
syntax.lisp
(file).
widgets.lisp
(file).
Files are sorted by type and then listed depth-first from the systems components trees.
macro-html/macro-html.asd
macro-html/packages.lisp
macro-html/macro-html.lisp
macro-html/syntax.lisp
macro-html/widgets.lisp
macro-html/macro-html.lisp
packages.lisp
(file).
macro-html
(system).
a
(macro).
abbr
(macro).
address
(macro).
area
(macro).
article
(macro).
aside
(macro).
audio
(macro).
b
(macro).
base
(macro).
bdi
(macro).
bdo
(macro).
blockquote
(macro).
body
(macro).
br
(macro).
button
(macro).
canvas
(macro).
caption
(macro).
cite
(macro).
code
(macro).
col
(macro).
colgroup
(macro).
command
(macro).
datalist
(macro).
dd
(macro).
del
(macro).
details
(macro).
dfn
(macro).
div
(macro).
dl
(macro).
dt
(macro).
em
(macro).
embed
(macro).
fieldset
(macro).
figcaption
(macro).
figure
(macro).
footer
(macro).
form
(macro).
h1
(macro).
h2
(macro).
h3
(macro).
h4
(macro).
h5
(macro).
h6
(macro).
head
(macro).
header
(macro).
hgroup
(macro).
hr
(macro).
html
(macro).
html-doctype
(function).
i
(macro).
iframe
(macro).
img
(macro).
input
(macro).
ins
(macro).
kbd
(macro).
keygen
(macro).
label
(macro).
legend
(macro).
li
(macro).
link
(macro).
map
(macro).
mark
(macro).
menu
(macro).
meta
(macro).
meter
(macro).
nav
(macro).
noscript
(macro).
object
(macro).
ol
(macro).
optgroup
(macro).
option
(macro).
output
(macro).
p
(macro).
param
(macro).
pre
(macro).
progress
(macro).
q
(macro).
rp
(macro).
rt
(macro).
ruby
(macro).
s
(macro).
samp
(macro).
script
(macro).
section
(macro).
select
(macro).
small
(macro).
source
(macro).
span
(macro).
strong
(macro).
style
(macro).
sub
(macro).
sup
(macro).
table
(macro).
tbody
(macro).
td
(macro).
text
(macro).
textarea
(macro).
tfoot
(macro).
th
(macro).
thead
(macro).
time
(macro).
title
(macro).
tr
(macro).
track
(macro).
u
(macro).
ul
(macro).
var
(macro).
video
(macro).
wbr
(macro).
*attribute-escapes*
(special variable).
*element-escapes*
(special variable).
*html-doctype*
(special variable).
*html-elements*
(special variable).
*html-single-elements*
(special variable).
define-element
(macro).
define-html-elements
(macro).
define-single-element
(macro).
element-attributes
(macro).
element-close
(function).
element-open
(macro).
escape-attribute
(function).
escape-char
(function).
escape-element
(function).
escape-string
(function).
parse-element-arguments
(function).
print-children
(macro).
read-attribute-set
(function).
to-string
(function).
macro-html/syntax.lisp
packages.lisp
(file).
macro-html.lisp
(file).
macro-html
(system).
macro-html/widgets.lisp
packages.lisp
(file).
macro-html.lisp
(file).
syntax.lisp
(file).
macro-html
(system).
html-widget-document
(function).
html-widget-form
(function).
html-widget-head
(function).
html-widget-input
(function).
html-widget-list
(function).
html-widget-meta
(function).
html-widget-select
(function).
html-widget-table
(function).
html-widget-textarea
(function).
*default-encoding*
(special variable).
*default-viewport*
(special variable).
html-select-options
(function).
option-fields
(function).
option-group-p
(function).
Packages are listed by definition order.
macro-html.widgets
HTML widget functions. All widgets print to {*standard-output*}.
common-lisp
.
editor-hints.named-readtables
.
macro-html
.
html-widget-document
(function).
html-widget-form
(function).
html-widget-head
(function).
html-widget-input
(function).
html-widget-list
(function).
html-widget-meta
(function).
html-widget-select
(function).
html-widget-table
(function).
html-widget-textarea
(function).
*default-encoding*
(special variable).
*default-viewport*
(special variable).
html-select-options
(function).
option-fields
(function).
option-group-p
(function).
macro-html
DSL for generating HTML documents.
common-lisp
.
editor-hints.named-readtables
.
a
(macro).
abbr
(macro).
address
(macro).
area
(macro).
article
(macro).
aside
(macro).
audio
(macro).
b
(macro).
base
(macro).
bdi
(macro).
bdo
(macro).
blockquote
(macro).
body
(macro).
br
(macro).
button
(macro).
canvas
(macro).
caption
(macro).
cite
(macro).
code
(macro).
col
(macro).
colgroup
(macro).
command
(macro).
datalist
(macro).
dd
(macro).
del
(macro).
details
(macro).
dfn
(macro).
div
(macro).
dl
(macro).
dt
(macro).
em
(macro).
embed
(macro).
fieldset
(macro).
figcaption
(macro).
figure
(macro).
footer
(macro).
form
(macro).
h1
(macro).
h2
(macro).
h3
(macro).
h4
(macro).
h5
(macro).
h6
(macro).
head
(macro).
header
(macro).
hgroup
(macro).
hr
(macro).
html
(macro).
html-doctype
(function).
i
(macro).
iframe
(macro).
img
(macro).
input
(macro).
ins
(macro).
kbd
(macro).
keygen
(macro).
label
(macro).
legend
(macro).
li
(macro).
link
(macro).
map
(macro).
mark
(macro).
menu
(macro).
meta
(macro).
meter
(macro).
nav
(macro).
noscript
(macro).
object
(macro).
ol
(macro).
optgroup
(macro).
option
(macro).
output
(macro).
p
(macro).
param
(macro).
pre
(macro).
progress
(macro).
q
(macro).
rp
(macro).
rt
(macro).
ruby
(macro).
s
(macro).
samp
(macro).
script
(macro).
section
(macro).
select
(macro).
small
(macro).
source
(macro).
span
(macro).
strong
(macro).
style
(macro).
sub
(macro).
sup
(macro).
table
(macro).
tbody
(macro).
td
(macro).
text
(macro).
textarea
(macro).
tfoot
(macro).
th
(macro).
thead
(macro).
time
(macro).
title
(macro).
tr
(macro).
track
(macro).
u
(macro).
ul
(macro).
var
(macro).
video
(macro).
wbr
(macro).
*attribute-escapes*
(special variable).
*element-escapes*
(special variable).
*html-doctype*
(special variable).
*html-elements*
(special variable).
*html-single-elements*
(special variable).
define-element
(macro).
define-html-elements
(macro).
define-single-element
(macro).
element-attributes
(macro).
element-close
(function).
element-open
(macro).
escape-attribute
(function).
escape-char
(function).
escape-element
(function).
escape-string
(function).
parse-element-arguments
(function).
print-children
(macro).
read-attribute-set
(function).
to-string
(function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Print TEXT-NODES as if they were arguments to a tag macro.
Prints HTML doctype.
*Arguments and Values:*
_title_—a _string_.
_body_—a _function designator_ for a _function_ that prints the
document body to {*standard-output*}.
_stylesheets_—a _list_ of _stylesheet designators_. A _stylesheet
designator_ is a _property list_ with the keys {:href} and {:media}
reflecting they keys of a {stylesheet} link.
_scripts_—a _list_ of _strings_ designating URIs to Javascript
programs.
_feeds_—a _list_ of _feed designators_. A _feed designator_ is a
_property list_ with the keys {:href}, {:type} and {:title} refecting
the keys of an {alternate} link.
_encoding_—a _keyword_ denoting a character encoding. The default is
{:utf-8}.
_viewport_—a _string_ denoting the value of a {viewport} meta attribute. the default is {"width=device-width, initial-scale=1"}.
*Description:*
{html-widget-document} produces a complete HTML document including a {head} section including elements declaring _title_, _stylesheets_, _scripts_, _feeds_, _encoding_ and _viewport_. The _body_ _function_ is called to produce the document body.
*Arguments and Values:*
_action_—a _string_ denoting a _form action_¹.
_fields_—a _function designator_ for a _function_ that prints the
form’s inputs to {*standard-output*}.
_method_—one of {"GET"} or {"POST"}. The default is {"GET"}.
_description_—a _string_. The default is {"Submit"}.
*Description:*
{html-widget-form} produces a {form} element with _fields_. The
resulting form will be bound to _action_ and use _method_. It will
also contain a submit button labeled with _description_.
*See Also:*
+ 1. [Form action](http://www.w3.org/TR/html5/forms.html#attr-fs-action)
*Arguments and Values:*
_title_—a _string_.
_stylesheets_—a _list_ of _stylesheet designators_. A _stylesheet
designator_ is a _property list_ with the keys {:href} and {:media}
reflecting they keys of a {stylesheet} link.
_scripts_—a _list_ of _strings_ designating URIs to Javascript
programs.
_feeds_—a _list_ of _feed designators_. A _feed designator_ is a
_property list_ with the keys {:href}, {:type} and {:title} refecting
the keys of an {alternate} link.
_encoding_—a _keyword_ denoting a character encoding. The default is
{:utf-8}.
_viewport_—a _string_ denoting the value of a {viewport} meta attribute. the default is {"width=device-width, initial-scale=1"}.
*Description:*
{html-widget-head} produces a {head} section including elements declaring _title_, _stylesheets_, _scripts_, _feeds_, _encoding_ and _viewport_.
*Arguments and Values:*
_name_, _label_—_strings_.
_type_—a _string_ denoting an _input type_¹. The default is
{"text"}.
*Description:*
{html-widget-input} produces an {input} element of _type_ with _name_
preceded by _label_.
*See Also:*
+ [Input type](http://www.w3.org/TR/html5/forms.html#attr-input-type)
*Arguments and Values:*
_list_—a _list_.
_type_—one of {:ordered}, {:unordered} and {:definitions}. The default
is {:unordered}.
_to-string_—a _function designator_. The default is {identity}.
*Description:*
{html-widget-list} produces an ordered, unordered or definition list
containing the items in _list_. _To-string_ is called on list items
before they are included in the list.
If _type_ is {:ordered} or {:unordered} an ordered or unordered list
is produced respectively, containing the elements of _list_.
If _type_ is {:definitions} a definition list is produced. _List_ must be a _list_ of two-element _lists_, the first and second elements being definition title and definition description respectively. {To-string} will be called with two arguments: {:title} or {:description} depending on the value type and the respective value of the two-element _list_.
*Arguments and Values:*
_content-type_—a _string_ denoting a MIME type. The default is
{"text/html"}.
_encoding_—a _keyword_ denoting a character encoding. The default is
{:utf-8}.
*Description:*
{html-widget-meta} produces a {meta} element declaring the _content-type_ and _encoding_ of a HTML document.
_options_::= {’(}{{}↓_option-group_ | ↓_option_{\}}\*{)}
_option-group_::= {(}{:group} _label_ {{}↓_option_{\}}\*{)}
_option_::= {(}_value_ _label_ {[}{:selected}{]}{)}
*Arguments and Values:*
_name_, _label_, _value_—_strings_.
_multiple_—a _generalized boolean_. The default is _false_.
*Description:*
{html-widget-select} produces a {select} element _name_ preceded by _label_ containing {option} elements as declared in _options_. _Option-groups_ can be used to produce {optgroup} elements accordingly. If an _option_ declaration contains {:selected} as its third element, the resulting {option} element will be selected by default. If _multiple_ is true, the {select} element will allow for multiple selections.
*Arguments and Values:*
_head_—a _list_.
_body_—a _list_ of _lists_.
*Description:*
{html-widget-table} produces a {table} element with _head_ as its table head _body_ as its rows.
*Arguments and Values:*
_name_, _label_, _initial-text_—_strings_.
*Description:*
{html-widget-text-area} produces a {textarea} element with _name_ and _initial-text_ preceded by _label_.
Characters to escape in attributes.
Default document encoding.
Default document viewport.
Characters to escape in elements.
Default DOCTYPE.
List of HTML elements.
List of single HTML elements.
Define an element macro.
Defines *HTML-ELEMENTS* as elements and *HTML-SINGLE-ELEMENTS* as single elements.
Define a single-element macro.
Generate code to print element ATTRIBUTES.
Generate code to print element NAME-STRING with ATTRIBUTES opening.
Print closing tag for element NAME-STRING.
Escape *attribute-escapes* in STRING and return it.
Return the escape string of CHAR.
Escape *element-escapes* in STRING and return it.
Return escaped string of STRING.
Helper for HTML-WIDGET-SELECT.
Returns value, label and selected of option.
Returns nil unless LIST is an option group.
Parse attributes and children in arguments.
Reader macro function: [a b ...] -> (:attributes a b ...).
Converts OBJECT to string or returns nil.
Jump to: | A B C D E F H I K L M N O P Q R S T U V W |
---|
Jump to: | A B C D E F H I K L M N O P Q R S T U V W |
---|
Jump to: | *
S |
---|
Jump to: | *
S |
---|
Jump to: | F M P S W |
---|
Jump to: | F M P S W |
---|