Outdated egg!

This is an egg for CHICKEN 4, the unsupported old release. You're almost certainly looking for the CHICKEN 5 version of this egg, if it exists.

If it does not exist, there may be equivalent functionality provided by another egg; have a look at the egg index. Otherwise, please consider porting this egg to the current version of CHICKEN.

html-tags

Introduction

html-tags is an extension which provides procedures to generate [X]HTML tags. html-tags can generate plain strings or SXML representation (version 0.10 or more recent) of [X]HTML tags.

Quick start

html-tags provides procedures named after [X]HTML tags. Here are some examples:

(<h1> "hello")
    => "<h1>hello</h1>"

Attributes are represented by keyword parameters:

(<img> src: "pic.png" alt: "A pic")
    => "<img src='pic.png' alt='A pic'>"

All the html-tags procedures provide a keyword parameter to specify an one argument procedure to be used as a quoting procedure. By default, html-tags procedures quote attributes' arguments using '. For example, for quoting attributes' arguments using ", you can do, for example:

(<img> src: "pic.png" quote-procedure: (cut string-append "\"" <> "\""))
    => "<img src=\"pic.png\">"

All the html-tags procedures also provide a keyword parameter (convert-to-entities?, default is #f) to specify that special HTML characters should be converted to their equivalent entities (see Spiffy's htmlize).

Important: convert-to-entities? and quote-procedure are only effective when generating the string representation of [X]HTML tags (i.e., when generate-sxml? is #f). When generate-sxml? is #t, the SXML to [X]HTML conversion automatically handles the conversion to entities and quoting of attribute's values.

Parameters

xhtml-style?

[parameter] (xhtml-style? [boolean])

The parameter xhtml-style? (default = #f) can be used to generate XHTML-style tags. Example:

(xhtml-style? #t)
(<img> src: "pic.png" alt: "A pic")
    => "<img src='pic.png' alt='A pic' />"

Important: this parameter is only effective when generating the string representation of [X]HTML tags (i.e., when generate-sxml? is #f).

generate-sxml?

[parameter] (generate-sxml? [boolean])

Unless #f, generates SXML representation of [X]HTML tags.

Procedures

Bellow is the full set of procedures provided by html-tags:

[procedure] (<!-- . comments)

Generate HTML comments from comments.

[procedure] (<a> ...)

Keyword parameters: name, href, hreflang, type, rel, rev, charset, coords, shape, accesskey, tabindex, target, quote-procedure, id, class, lang, title, style, dir, lang, xml:lang, tabindex, accesskey, onclick, onabort, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onload, onmousedown, onmousemove, onmouseover, onmouseout, onmouseup, onreset, onselect, onsubmit, onunload

[procedure] (<abbr> ...)

Keyword parameters: quote-procedure, id, class, lang, title, style, dir, lang, xml:lang, tabindex, accesskey, onclick, onabort, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onload, onmousedown, onmousemove, onmouseover, onmouseout, onmouseup, onreset, onselect, onsubmit, onunload

[procedure] (<acronym> ...)

[procedure] (<address> ...)

[procedure] (<applet> ...)

[procedure] (<area> ...)

Keyword parameters: accesskey, alt, coords, hash, host, hostname, href, noHref, pathname, port, protocol, search, shape, tabindex, target, quote-procedure, id, class, lang, title, style, dir, lang, xml:lang, tabindex, accesskey, onclick, onabort, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onload, onmousedown, onmousemove, onmouseover, onmouseout, onmouseup, onreset, onselect, onsubmit, onunload

[procedure] (<article> ...)

[procedure] (<aside> ...)

[procedure] (<audio> ...)

[procedure] (<b> ...)

[procedure] (<base> ...)

Keyword parameters: href, target, quote-procedure, id, class, lang, title, style, dir, lang, xml:lang, tabindex, accesskey, onclick, onabort, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onload, onmousedown, onmousemove, onmouseover, onmouseout, onmouseup, onreset, onselect, onsubmit, onunload

[procedure] (<basefont> ...)

[procedure] (<bdo> ...)

[procedure] (<big> ...)

[procedure] (<blink> ...)

[procedure] (<blockquote> ...)

[procedure] (<body> ...)

Keyword parameters: background, bgcolor, text, link, vlink, alink, accesskey, aLink, scrollleft, scrolltop, quote-procedure, id, class, lang, title, style, dir, lang, xml:lang, tabindex, accesskey, onclick, onabort, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onload, onmousedown, onmousemove, onmouseover, onmouseout, onmouseup, onreset, onselect, onsubmit, onunload

[procedure] (<bold> ...)

[procedure] (<br> ...)

Keyword parameters: clear, quote-procedure, id, class, lang, title, style, dir, lang, xml:lang, tabindex, accesskey, onclick, onabort, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onload, onmousedown, onmousemove, onmouseover, onmouseout, onmouseup, onreset, onselect, onsubmit, onunload

[procedure] (<button> ...)

Keyword parameters: accesskey, disabled, form, name, tabindex, type, value, quote-procedure, id, class, lang, title, style, dir, lang, xml:lang, tabindex, accesskey, onclick, onabort, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onload, onmousedown, onmousemove, onmouseover, onmouseout, onmouseup, onreset, onselect, onsubmit, onunload

[procedure] (<caption> ...)

[procedure] (<canvas> ...)

[procedure] (<center> ...)

[procedure] (<cite> ...)

[procedure] (<code> ...)

[procedure] (<command> ...)

[procedure] (<colgroup> ...)

[procedure] (<datagrid> ...)

[procedure] (<datalist> ...)

[procedure] (<datatemplate> ...)

[procedure] (<details> ...)

[procedure] (<dd> ...)

[procedure] (<del> ...)

[procedure] (<dialog> ...)

[procedure] (<dir> ...)

[procedure] (<div> ...)

[procedure] (<dfn> ...)

[procedure] (<dl> ...)

[procedure] (<dt> ...)

[procedure] (<em> ...)

[procedure] (<embed> ...)

Keyword parameters: src, width, height, align, name, pluginspage, pluginurl, hidden, href, target, units, autostart, loop, playcount, volume, controls, controller, mastersound, starttime, endtime, quote-procedure, id, class, lang, title, style, dir, lang, xml:lang, tabindex, accesskey, onclick, onabort, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onload, onmousedown, onmousemove, onmouseover, onmouseout, onmouseup, onreset, onselect, onsubmit, onunload

[procedure] (<eventsource> ...)

[procedure] (<fieldset> ...)

[procedure] (<figcaption> ...)

[procedure] (<figure> ...)

[procedure] (<font> ...)

Keyword parameters: color, face, size, quote-procedure, id, class, lang, title, style, dir, lang, xml:lang, tabindex, accesskey, onclick, onabort, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onload, onmousedown, onmousemove, onmouseover, onmouseout, onmouseup, onreset, onselect, onsubmit, onunload

[procedure] (<footer> ...)

[procedure] (<form> ...)

Keyword parameters: action, method, acceptcharset, encoding, enctype, length, name, tabindex, target, quote-procedure, id, class, lang, title, style, dir, lang, xml:lang, tabindex, accesskey, onclick, onabort, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onload, onmousedown, onmousemove, onmouseover, onmouseout, onmouseup, onreset, onselect, onsubmit, onunload

[procedure] (<frame> ...)

Keyword parameters: src, contentdocument, frameborder, longdesc, marginheight, marginwidth, name, noresize, scrolling, quote-procedure, id, class, lang, title, style, dir, lang, xml:lang, tabindex, accesskey, onclick, onabort, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onload, onmousedown, onmousemove, onmouseover, onmouseout, onmouseup, onreset, onselect, onsubmit, onunload

[procedure] (<frameset> ...)

Keyword parameters: rows, cols, quote-procedure, id, class, lang, title, style, dir, lang, xml:lang, tabindex, accesskey, onclick, onabort, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onload, onmousedown, onmousemove, onmouseover, onmouseout, onmouseup, onreset, onselect, onsubmit, onunload

[procedure] (<h1> ...)

Keyword parameters: align, quote-procedure, id, class, lang, title, style, dir, lang, xml:lang, tabindex, accesskey, onclick, onabort, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onload, onmousedown, onmousemove, onmouseover, onmouseout, onmouseup, onreset, onselect, onsubmit, onunload

[procedure] (<h2> ...)

[procedure] (<h3> ...)

[procedure] (<h4> ...)

[procedure] (<h5> ...)

[procedure] (<h6> ...)

[procedure] (<head> ...)

[procedure] (<header> ...)

[procedure] (<hgroup> ...)

[procedure] (<html> ...)

[procedure] (<hr> ...)

[procedure] (<i> ...)

[procedure] (<iframe> ...)

Keyword parameters: src, width, align, height, contentdocument, frameborder, longdesc, marginheight, marginwidth, name, noresize, scrolling, quote-procedure, id, class, lang, title, style, dir, lang, xml:lang, tabindex, accesskey, onclick, onabort, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onload, onmousedown, onmousemove, onmouseover, onmouseout, onmouseup, onreset, onselect, onsubmit, onunload

[procedure] (<img> ...)

Keyword parameters: src, alt, align, height, width, border, hspace, vspace, usemap, ismap, longdesc, lowsrc, quote-procedure, id, class, lang, title, style, dir, lang, xml:lang, tabindex, accesskey, onclick, onabort, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onload, onmousedown, onmousemove, onmouseover, onmouseout, onmouseup, onreset, onselect, onsubmit, onunload

[procedure] (<input> ...)

Keyword parameters: type, name, value, size, maxlength, checked, src, accept, accesskey, align, alt, defaultchecked, disabled, form, tabindex, quote-procedure, id, class, lang, title, style, dir, lang, xml:lang, tabindex, accesskey, onclick, onabort, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onload, onmousedown, onmousemove, onmouseover, onmouseout, onmouseup, onreset, onselect, onsubmit, onunload

[procedure] (<ins> ...)

[procedure] (<keygen> ...)

[procedure] (<kbd> ...)

[procedure] (<label> ...)

Keyword parameters: for, accesskey, onfocus, onblur, quote-procedure, id, class, lang, title, style, dir, lang, xml:lang, tabindex, accesskey, onclick, onabort, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onload, onmousedown, onmousemove, onmouseover, onmouseout, onmouseup, onreset, onselect, onsubmit, onunload

[procedure] (<legend> ...)

[procedure] (<li> ...)

Keyword parameters: type, value, quote-procedure, id, class, lang, title, style, dir, lang, xml:lang, tabindex, accesskey, onclick, onabort, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onload, onmousedown, onmousemove, onmouseover, onmouseout, onmouseup, onreset, onselect, onsubmit, onunload

[procedure] (<link> ...)

Keyword parameters: charset, disabled, href, hreflang, media, name, rev, rel, target, type, quote-procedure, id, class, lang, title, style, dir, lang, xml:lang, tabindex, accesskey, onclick, onabort, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onload, onmousedown, onmousemove, onmouseover, onmouseout, onmouseup, onreset, onselect, onsubmit, onunload

[procedure] (<map> ...)

[procedure] (<mark> ...)

[procedure] (<menu> ...)

[procedure] (<meta> ...)

Keyword parameters: name, content, charset, disabled, http-equiv, scheme, quote-procedure, id, class, lang, title, style, dir, lang, xml:lang, tabindex, accesskey, onclick, onabort, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onload, onmousedown, onmousemove, onmouseover, onmouseout, onmouseup, onreset, onselect, onsubmit, onunload

[procedure] (<metter> ...)

[procedure] (<nav> ...)

[procedure] (<nest> ...)

[procedure] (<noembed> ...)

[procedure] (<noframes> ...)

[procedure] (<noscript> ...)

[procedure] (<object> ...)

[procedure] (<option> ...)

Keyword parameters: value, defaultselected, disabled, form, index, label, selected, text, quote-procedure, id, class, lang, title, style, dir, lang, xml:lang, tabindex, accesskey, onclick, onabort, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onload, onmousedown, onmousemove, onmouseover, onmouseout, onmouseup, onreset, onselect, onsubmit, onunload

[procedure] (<optgroup> ...)

Keyword parameters: disabled, label, quote-procedure, id, class, lang, title, style, dir, lang, xml:lang, tabindex, accesskey, onclick, onabort, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onload, onmousedown, onmousemove, onmouseover, onmouseout, onmouseup, onreset, onselect, onsubmit, onunload

[procedure] (<ol> ...)

[procedure] (<output> ...)

[procedure] (<p> ...)

[procedure] (<param> ...)

[procedure] (<pre> ...)

Keyword parameters: width, quote-procedure, id, class, lang, title, style, dir, lang, xml:lang, tabindex, accesskey, onclick, onabort, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onload, onmousedown, onmousemove, onmouseover, onmouseout, onmouseup, onreset, onselect, onsubmit, onunload

[procedure] (<progress> ...)

[procedure] (<q> ...)

[procedure] (<rp> ...)

[procedure] (<rt> ...)

[procedure] (<ruby> ...)

[procedure] (<rule> ...)

[procedure] (<script> ...)

Keyword parameters: src, type, language, quote-procedure, id, class, lang, title, style, dir, lang, xml:lang, tabindex, accesskey, onclick, onabort, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onload, onmousedown, onmousemove, onmouseover, onmouseout, onmouseup, onreset, onselect, onsubmit, onunload

[procedure] (<s> ...)

[procedure] (<samp> ...)

[procedure] (<section> ...)

[procedure] (<select> ...)

Keyword parameters: name, accesskey, align, disabled, form, length, multiple, selectedindex, size, tabindex, type, value, quote-procedure, id, class, lang, title, style, dir, lang, xml:lang, tabindex, accesskey, onclick, onabort, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onload, onmousedown, onmousemove, onmouseover, onmouseout, onmouseup, onreset, onselect, onsubmit, onunload

[procedure] (<small> ...)

[procedure] (<source> ...)

[procedure] (<span> ...)

[procedure] (<strong> ...)

[procedure] (<sub> ...)

[procedure] (<summary> ...)

[procedure] (<sup> ...)

[procedure] (<strike> ...)

[procedure] (<style> ...)

Keyword parameters: media, type, quote-procedure, id, class, lang, title, style, dir, lang, xml:lang, tabindex, accesskey, onclick, onabort, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onload, onmousedown, onmousemove, onmouseover, onmouseout, onmouseup, onreset, onselect, onsubmit, onunload

[procedure] (<table> ...)

Keyword parameters: align, border, cellspacing, cellpadding, color, frame, rules, summary, valign, width, bgcolor, quote-procedure, id, class, lang, title, style, dir, lang, xml:lang, tabindex, accesskey, onclick, onabort, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onload, onmousedown, onmousemove, onmouseover, onmouseout, onmouseup, onreset, onselect, onsubmit, onunload

[procedure] (<td> ...)

Keyword parameters: rowspan, colspan, nowrap, align, valign, width, height, abbr, accesskey, axis, background, bgcolor, bordercolor, cellindex, ch, choff, disabled, headers, innerhtml, innertext, rowspan, scope, tabindex, quote-procedure, id, class, lang, title, style, dir, lang, xml:lang, tabindex, accesskey, onclick, onabort, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onload, onmousedown, onmousemove, onmouseover, onmouseout, onmouseup, onreset, onselect, onsubmit, onunload

[procedure] (<textarea> ...)

Keyword parameters: name, rows, cols, wrap, accesskey, defaultvalue, disabled, readonly, form, quote-procedure, id, class, lang, title, style, dir, lang, xml:lang, tabindex, accesskey, onclick, onabort, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onload, onmousedown, onmousemove, onmouseover, onmouseout, onmouseup, onreset, onselect, onsubmit, onunload

[procedure] (<thead> ...)

[procedure] (<tbody> ...)

[procedure] (<tfoot> ...)

[procedure] (<th> ...)

Keyword parameters: rowspan, colspan, nowrap, align, valign, width, height, abbr, accesskey, axis, background, bgcolor, bordercolor, cellindex, ch, choff, disabled, headers, innerhtml, innertext, rowSpan, scope, tabindex, quote-procedure, id, class, lang, title, style, dir, lang, xml:lang, tabindex, accesskey, onclick, onabort, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onload, onmousedown, onmousemove, onmouseover, onmouseout, onmouseup, onreset, onselect, onsubmit, onunload

[procedure] (<time> ...)

[procedure] (<title> ...)

[procedure] (<tr> ...)

Keyword parameters: align, valign, bgcolor, rowspan, colspan, nowrap, align, valign, width, height, abbr, accesskey, axis, background, bgcolor, bordercolor, rowindex, ch, choff, disabled, headers, innerhtml, innertext, scope, tabindex, sectionrowindex, outerhtml, outertext, quote-procedure, id, class, lang, title, style, dir, lang, xml:lang, tabindex, accesskey, onclick, onabort, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onload, onmousedown, onmousemove, onmouseover, onmouseout, onmouseup, onreset, onselect, onsubmit, onunload

[procedure] (<tt> ...)

[procedure] (<u> ...)

Keyword parameters: bgcolor, quote-procedure, id, class, lang, title, style, dir, lang, xml:lang, tabindex, accesskey, onclick, onabort, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onload, onmousedown, onmousemove, onmouseover, onmouseout, onmouseup, onreset, onselect, onsubmit, onunload

[procedure] (<ul> ...)

Keyword parameters: type, compact, quote-procedure, id, class, lang, title, style, dir, lang, xml:lang, tabindex, accesskey, onclick, onabort, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onload, onmousedown, onmousemove, onmouseover, onmouseout, onmouseup, onreset, onselect, onsubmit, onunload

[procedure] (<var> ...)

[procedure] (<video> ...)

[procedure] (<wbr> ...)

License

Copyright (c) 2008-2011, Mario Domenech Goulart
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.

Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.

Neither the name of the author nor the names of its contributors may
be used to endorse or promote products derived from this software
without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
OF THE POSSIBILITY OF SUCH DAMAGE.

Added HTML5 support. The following procedures have been added: <article>, <aside>, <audio>, <canvas>, <command>, <datagrid>, <datalist>, <datatemplate>, <details>, <dialog>, <embed>, <eventsource>, <figcaption>, <figure>, <footer>, <header>, <hgroup>, <keygen>, <mark>, <meter>, <nav>, <nest>, <output>, <progress>, <rp>, <rt>, <ruby>, <rule>, <section>, <source>, <summary>, <time>, <video> and <wbr>

Version 0.10

Added SXML support, which can be triggered by setting the generate-sxml? parameter to #t.

Version 0.9

Added label and disabled keyword parameters to <optgroup>

Version 0.8

Properly export all the available parameters and procedures. check-html-syntax renamed to check-html-syntax? (Warning: this change may break your code).