Commit 28e98023 authored by Marco Antoniotti's avatar Marco Antoniotti 💬
Browse files

Fixed documentation strings for documentation.

parent 3550abdc
......@@ -337,9 +337,25 @@ are kept empty and for future use."
;;; (tag attributes . body)
(deftype html-sexp-syntax ()
"The (enumerated) type of 'syntaxes' for the HTML Sexp-based representation."
'(member :compact
:standard))
"The (enumerated) type of 'syntaxes' for the HTML Sexp-based representation.
The actual type is defined to be (member :compact :standard).
Examples:
:COMPACT
tag
(tag . body)
((tag . attribute) . body)
:STANDARD
tag
(tag attributes . body)"
'(member :compact :standard))
;;;; *default-html-sexp-syntax* --
......@@ -347,7 +363,7 @@ are kept empty and for future use."
"The default HTML syntax used in the SEXP-based coding of HTML.
The variable can take on the values of the type HTML-SEXP-SYNTAX,
i.e., :COMPACT or :STANDARD.
i.e., :COMPACT or :STANDARD. The default is :COMPACT.
See Also:
......@@ -509,6 +525,12 @@ attribute list must always be specified, even if (). The default for
the SYNTAX switch, which is held in the variable
*DEFAULT-HTML-SEXP-SYNTAX* is :COMPACT.
Arguments and Values:
XHTML-FORM : a Sexp representing some (X)HTML code.
SYNTAX : a HTML-SEXP-SYNTAX designator; defaults to *DEFAULT-HTML-SEXP-SYNTAX*
FORM : a FORM
Examples:
cl-prompt> (htmlise (:syntax :compact) (<:p (<:b \"Compact syntax.\")))
......@@ -850,6 +872,35 @@ See Also:
(syntax *default-html-sexp-syntax*)
)
html)
"Writes out a (X)HTML form to a stream.
The writing is done using the XHTMLambda pretty-print dispatch table,
which is used if PRINT-PRETTY is non-NIL. The HTML form is
represented using the appropriate SYNTAX.
Arguments and Values:
STREAM : a STREAM
PRINT-PRETTY : a generalized boolean; defaults to *print-pretty*
SYNTAX : a HTML-SEXP-SYNTAX value; defaults to *default-html-sexp-syntax*
FORM : a FORM
Examples:
cl-prompt> (<:with-html-syntax-output (*standard-output* :syntax :standard
:print-pretty t)
(<:p () (<:code () \"for i in $ZZ do ...\")))
<p>
<code>
for i in $ZZ do ...
</code>
</p>
<p><code>for i in $ZZ do ...</code></p>
See Also:
*default-html-sexp-syntax* and html-sexp-syntax
"
`(write (htmlize ,html :syntax ,syntax)
:stream ,stream
:pprint-dispatch *xhtml-pd*
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment