The monkeylib-markup-html Reference Manual

This is the monkeylib-markup-html Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 17:22:42 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 monkeylib-markup-html

Library for generating HTML from Markup formatted text.

Dependencies
  • com.gigamonkeys.macro-utilities (system).
  • alexandria (system).
  • com.gigamonkeys.markup (system).
  • com.gigamonkeys.utilities (system).
  • monkeylib-html (system).
Source

monkeylib-markup-html.asd.

Child Components

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


3.1 Lisp


3.1.1 monkeylib-markup-html/monkeylib-markup-html.asd

Source

monkeylib-markup-html.asd.

Parent Component

monkeylib-markup-html (system).

ASDF Systems

monkeylib-markup-html.


3.1.3 monkeylib-markup-html/html.lisp

Dependency

packages.lisp (file).

Source

monkeylib-markup-html.asd.

Parent Component

monkeylib-markup-html (system).

Public Interface
Internals

3.1.4 monkeylib-markup-html/footnotes.lisp

Dependency

packages.lisp (file).

Source

monkeylib-markup-html.asd.

Parent Component

monkeylib-markup-html (system).

Public Interface

footnotes (function).

Internals

wrap-with-noterefs (function).


3.1.5 monkeylib-markup-html/handy-tags.lisp

Dependency

packages.lisp (file).

Source

monkeylib-markup-html.asd.

Parent Component

monkeylib-markup-html (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 com.gigamonkeys.markup.html

Source

packages.lisp.

Use List
  • com.gigamonkeys.markup.
  • com.gigamonkeys.utilities.
  • common-lisp.
Used By List

com.gigamonkeys.markup.html.handy-tags.

Public Interface
Internals

4.2 com.gigamonkeys.markup.html.handy-tags

Source

packages.lisp.

Use List
Public Interface
Internals

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


5.1 Public Interface


5.1.1 Ordinary functions

Function: add-amazon-image-bugs (sexp)
Package

com.gigamonkeys.markup.html.handy-tags.

Source

handy-tags.lisp.

Function: footnotes (tag sexp &key number-format)
Package

com.gigamonkeys.markup.html.

Source

footnotes.lisp.

Package

com.gigamonkeys.markup.html.

Source

html.lisp.

Function: just-text (sexp)
Package

com.gigamonkeys.markup.html.

Source

html.lisp.

Package

com.gigamonkeys.markup.html.handy-tags.

Source

handy-tags.lisp.

Function: make-retagger (mappings)
Package

com.gigamonkeys.markup.html.

Source

html.lisp.

Function: render (file &key title stylesheets scripts links subdocument-tags rewriter)

Render ‘file’ to an html file with a header made from ‘title’, ‘stylesheets’, and ‘scripts’. If ‘title’ is not supplied, we try to guess from the first H1 in sexps. Tags specified with ‘subdocument-tags’ are parsed as subdocuments.

Package

com.gigamonkeys.markup.html.

Source

html.lisp.

Function: render-sexps-to-stream (sexps out &key title stylesheets scripts rewriter)

Render ‘sexps’ to ‘out’ with a header made from ‘title’, ‘stylesheets’, and ‘scripts’. If ‘title’ is not supplied, we try to guess from the first H1 in sexps.

Package

com.gigamonkeys.markup.html.

Source

html.lisp.

Function: render-to-stream (file out &key title stylesheets scripts links subdocument-tags rewriter)

Render ‘file’ to the stream ‘out’ with a header made from ‘title’, ‘stylesheets’, and ‘scripts’. If ‘title’ is not supplied, we try to guess from the first H1 in sexps. Tags specified with ‘subdocument-tags’ are parsed as subdocuments.

Package

com.gigamonkeys.markup.html.

Source

html.lisp.

Package

com.gigamonkeys.markup.html.handy-tags.

Source

handy-tags.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *amazon-image-bug*
Package

com.gigamonkeys.markup.html.handy-tags.

Source

handy-tags.lisp.

Package

com.gigamonkeys.markup.html.handy-tags.

Source

handy-tags.lisp.

Special Variable: *asins*
Package

com.gigamonkeys.markup.html.handy-tags.

Source

handy-tags.lisp.

Special Variable: *default-subdocument-tags*
Package

com.gigamonkeys.markup.html.

Source

html.lisp.


5.2.2 Ordinary functions

Function: amazon-image-bug (sexp)
Package

com.gigamonkeys.markup.html.handy-tags.

Source

handy-tags.lisp.

Package

com.gigamonkeys.markup.html.handy-tags.

Source

handy-tags.lisp.

Package

com.gigamonkeys.markup.html.

Source

html.lisp.

Function: guess-title (sexps)
Package

com.gigamonkeys.markup.html.

Source

html.lisp.

Package

com.gigamonkeys.markup.html.

Source

html.lisp.

Package

com.gigamonkeys.markup.html.

Source

html.lisp.

Function: remap-one-tag (sexp mappings walker-fn)
Package

com.gigamonkeys.markup.html.

Source

html.lisp.

Function: remap-tags (sexp mappings)
Package

com.gigamonkeys.markup.html.

Source

html.lisp.

Function: remove-key (link)
Package

com.gigamonkeys.markup.html.

Source

html.lisp.

Package

com.gigamonkeys.markup.html.

Source

html.lisp.

Function: wrap-with-noterefs (body start current noteref-name-fmt)
Package

com.gigamonkeys.markup.html.

Source

footnotes.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   A   E   F   G   H   J   L   M   R   U   W  
Index Entry  Section

A
add-amazon-image-bugs: Public ordinary functions
amazon-image-bug: Private ordinary functions
amazon-link: Private ordinary functions

E
extract-link-defs: Private ordinary functions

F
footnotes: Public ordinary functions
Function, add-amazon-image-bugs: Public ordinary functions
Function, amazon-image-bug: Private ordinary functions
Function, amazon-link: Private ordinary functions
Function, extract-link-defs: Private ordinary functions
Function, footnotes: Public ordinary functions
Function, guess-title: Private ordinary functions
Function, htmlize-links: Public ordinary functions
Function, just-text: Public ordinary functions
Function, link-key: Private ordinary functions
Function, link-url: Private ordinary functions
Function, mailto-link: Public ordinary functions
Function, make-retagger: Public ordinary functions
Function, remap-one-tag: Private ordinary functions
Function, remap-tags: Private ordinary functions
Function, remove-key: Private ordinary functions
Function, render: Public ordinary functions
Function, render-sexps-to-stream: Public ordinary functions
Function, render-to-stream: Public ordinary functions
Function, rewrite-links: Private ordinary functions
Function, url-link: Public ordinary functions
Function, wrap-with-noterefs: Private ordinary functions

G
guess-title: Private ordinary functions

H
htmlize-links: Public ordinary functions

J
just-text: Public ordinary functions

L
link-key: Private ordinary functions
link-url: Private ordinary functions

M
mailto-link: Public ordinary functions
make-retagger: Public ordinary functions

R
remap-one-tag: Private ordinary functions
remap-tags: Private ordinary functions
remove-key: Private ordinary functions
render: Public ordinary functions
render-sexps-to-stream: Public ordinary functions
render-to-stream: Public ordinary functions
rewrite-links: Private ordinary functions

U
url-link: Public ordinary functions

W
wrap-with-noterefs: Private ordinary functions