13.2 Skribilo User Manual — HTML Engine
Contents↑ Engines

The HTML engine produces---guess what!---HTML output. It can be customized in various ways, as shown below.

13.2.1 HTML Customization

customdefaultdescription
favicon#fThe name of an image file of the URL image. The favicon custom can be either bound to a string which is the name of the image, or to a procedure of two arguments, a node and an engine that returns the file name of the icon. This can be used to use different icons per chapter or section.
charset"ISO-8859-1"The character set used for the document.
javascript#fEnable/disable Javascript support.
head#fA string included in the HTML header.
css()The URL or a list of URLs of CSS used by the document.
inline-css()The file or a list of files inlined inside the header's style section. The custom inline-css should be used in replacement of the css custom in order to produce stand alone HTML documents.
js()A URL or a list of URLs of JavaScript programs used by the document.
emit-sui#fEmit a SUI file for this document (see Section 4.4 for details).
background#fThe background color of the document.
foreground#fThe foreground color of the document.
margin-padding3Margins padding.
left-margin#fA procedure of two arguments producing the left margin of the document.
chapter-left-margin#fA procedure of two arguments producing the left margin of the document.
section-left-margin#fA procedure of two arguments producing the left margin of the document.
left-margin-font#fThe font of the left margin.
left-margin-size17.0The width of the left margin.
left-margin-background#fThe background color of the left margin.
left-margin-foreground#fThe foreground color of the left margin.
right-margin#fA procedure of two arguments producing the right margin of the document.
chapter-right-margin#fA procedure of two arguments producing the right margin of the document.
section-right-margin#fA procedure of two arguments producing the right margin of the document.
right-margin-font#fThe font of the right margin.
right-margin-size17.0The width of the right margin.
right-margin-background#fThe background color of the right margin.
right-margin-foreground#fThe foreground color of the right margin.
author-font#fThe author font.
title-font#fThe title font.
title-background#fThe title background color.
title-foreground#fThe title foreground color.
file-title-separator(unquote (! " — "))A text to be inserted in between the document title and the chapter or section title when the chapter or section is rendered in a separate file.
file-name-proc(unquote html-file-default)A two-argument procedure that should return a string. This procedure is to be passed a node and an engine and should return a file name for the HTML page corresponding to this node.
index-header-font-size#fThe index header font size.
chapter-number->stringnumber->stringA procedure of one argument for rendering chapter numbers.
chapter-file#fA boolean specifying if chapters are rendered in separate HTML file (see chapter markup).
section-title-start"<h3>"The HTML sequence for starting section title.
section-title-stop"</h3>"The HTML sequence for stopping section title.
section-title-background#fThe background color of section title.
section-title-foreground#fThe foreground color of section title.
section-title-number-separator" "The section title number separator.
section-number->stringnumber->stringA procedure of one argument for rendering section numbers.
section-file#fA boolean specifying if sections are rendered in separate HTML file (see section markup).
subsection-title-start"<h3>"The HTML sequence for starting subsection title.
subsection-title-stop"</h3>"The HTML sequence for stopping subsection title.
subsection-title-background#fThe background color of subsection title.
subsection-title-foreground#fThe foreground color of subsection title.
subsection-title-number-separator" "The subsection title number separator.
subsection-number->stringnumber->stringA procedure of one argument for rendering subsection numbers.
subsection-file#fA boolean specifying if subsections are rendered in separate HTML file (see subsection markup).
subsubsection-title-start"<h4>"The HTML sequence for starting subsubsection title.
subsubsection-title-stop"</h4>"The HTML sequence for stopping subsubsection title.
subsubsection-title-background#fThe background color of subsubsection title.
subsubsection-title-foreground#fThe foreground color of subsubsection title.
subsubsection-title-number-separator" "The subsubsection title number separator.
subsubsection-number->stringnumber->stringA procedure of one argument for rendering subsubsection numbers.
subsubsection-file#fA boolean specifying if subsubsections are rendered in separate HTML file (see subsubsection markup).
source-color#tA boolean enabling/disabling color of source code (see source markup).
source-comment-color"#ffa600"The source comment color.
source-error-color"red"The source error color.
source-define-color"#6959cf"The source define color.
source-module-color"#1919af"The source module color.
source-markup-color"#1919af"The source markup color.
source-thread-color"#ad4386"The source thread color.
source-string-color"red"The source string color.
source-bracket-color"red"The source bracket color.
source-type-color"#00cf00"The source type color.
image-format("png" "gif" "jpg" "jpeg")The image formats for this engine.
(made with skribilo)