Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]

The print-html Reference Manual

This is the print-html Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 17:36:50 2024 GMT+0.

Next: Systems, Previous: The print-html Reference Manual, Up: The print-html Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The print-html Reference Manual [Contents][Index]

2 Systems

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

print-html

Previous: Systems, Up: Systems [Contents][Index]

2.1 `print-html`

Simple html generator.

Author: Olaf Ritter von Ruppert <oruppert@googlemail.com>
License: MIT License
Version: 1.0.0
Source: print-html.asd.
Child Component: print-html.lisp (file).

Next: Packages, Previous: Systems, Up: The print-html Reference Manual [Contents][Index]

3 Files

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

Lisp

Previous: Files, Up: Files [Contents][Index]

Next: print-html/print-html.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `print-html/print-html.asd`

Source: print-html.asd.
Parent Component: print-html (system).
ASDF Systems: print-html.

Previous: print-html/print-html.asd, Up: Lisp [Contents][Index]

3.1.2 `print-html/print-html.lisp`

Source

print-html.asd.

Parent Component

print-html (system).

Packages

print-html.

Public Interface

html (macro).
print-html (generic function).
print-html-to-string (function).
render (generic function).
unsafe (function).
unsafe (structure).

Internals

*self-closing-tags* (special variable).
copy-tag (function).
copy-unsafe (function).
make-tag (function).
tag (structure).
tag-attrs (reader).
(setf tag-attrs) (writer).
tag-children (reader).
(setf tag-children) (writer).
tag-name (reader).
(setf tag-name) (writer).
tag-p (function).
unsafe-p (function).
unsafe-string (reader).
(setf unsafe-string) (writer).

Next: Definitions, Previous: Files, Up: The print-html Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

print-html

Previous: Packages, Up: Packages [Contents][Index]

4.1 `print-html`

Source

print-html.lisp.

Use List

common-lisp.

Public Interface

html (macro).
print-html (generic function).
print-html-to-string (function).
render (generic function).
unsafe (function).
unsafe (structure).

Internals

*self-closing-tags* (special variable).
copy-tag (function).
copy-unsafe (function).
make-tag (function).
tag (structure).
tag-attrs (reader).
(setf tag-attrs) (writer).
tag-children (reader).
(setf tag-children) (writer).
tag-name (reader).
(setf tag-name) (writer).
tag-p (function).
unsafe-p (function).
unsafe-string (reader).
(setf unsafe-string) (writer).

Next: Indexes, Previous: Packages, Up: The print-html Reference Manual [Contents][Index]

5 Definitions

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

Public Interface
Internals

Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]

5.1 Public Interface

Macros
Ordinary functions
Generic functions
Structures

Next: Ordinary functions, Previous: Public Interface, Up: Public Interface [Contents][Index]

5.1.1 Macros

Macro: html (&body body) ¶

Package: print-html.
Source: print-html.lisp.

Next: Generic functions, Previous: Macros, Up: Public Interface [Contents][Index]

5.1.2 Ordinary functions

Function: print-html-to-string (object) ¶

Package: print-html.
Source: print-html.lisp.

Function: unsafe (string) ¶

Package: print-html.
Source: print-html.lisp.

Next: Structures, Previous: Ordinary functions, Up: Public Interface [Contents][Index]

5.1.3 Generic functions

Generic Function: print-html (object stream) ¶

Package

print-html.

Source

print-html.lisp.

Methods

Method: print-html ((unsafe unsafe) stream) ¶

Method: print-html ((self (eql :doctype-html)) stream) ¶

Method: print-html :after ((self tag) stream) ¶

Method: print-html :before ((self tag) stream) ¶

Method: print-html ((self tag) stream) ¶

Method: print-html (object stream) ¶

Method: print-html ((char character) stream) ¶

Method: print-html ((string string) stream) ¶

Method: print-html ((list list) stream) ¶

Generic Function: render (object) ¶

Package

print-html.

Source

print-html.lisp.

Methods

Method: render (object) ¶

Previous: Generic functions, Up: Public Interface [Contents][Index]

5.1.4 Structures

Structure: unsafe ¶

Package

print-html.

Source

print-html.lisp.

Direct superclasses

structure-object.

Direct methods

print-html.

Direct slots

Slot: string ¶

Package: common-lisp.
Readers: unsafe-string.
Writers: (setf unsafe-string).

Previous: Public Interface, Up: Definitions [Contents][Index]

5.2 Internals

Special variables
Ordinary functions
Structures

Next: Ordinary functions, Previous: Internals, Up: Internals [Contents][Index]

5.2.1 Special variables

Special Variable: *self-closing-tags* ¶

List of self closing tags.

Package: print-html.
Source: print-html.lisp.

Next: Structures, Previous: Special variables, Up: Internals [Contents][Index]

5.2.2 Ordinary functions

Function: copy-tag (instance) ¶

Package: print-html.
Source: print-html.lisp.

Function: copy-unsafe (instance) ¶

Package: print-html.
Source: print-html.lisp.

Function: make-tag (&key name attrs children) ¶

Package: print-html.
Source: print-html.lisp.

Reader: tag-attrs (instance) ¶

Writer: (setf tag-attrs) (instance) ¶

Package: print-html.
Source: print-html.lisp.
Target Slot: attrs.

Reader: tag-children (instance) ¶

Writer: (setf tag-children) (instance) ¶

Package: print-html.
Source: print-html.lisp.
Target Slot: children.

Reader: tag-name (instance) ¶

Writer: (setf tag-name) (instance) ¶

Package: print-html.
Source: print-html.lisp.
Target Slot: name.

Function: tag-p (object) ¶

Package: print-html.
Source: print-html.lisp.

Function: unsafe-p (object) ¶

Package: print-html.
Source: print-html.lisp.

Reader: unsafe-string (instance) ¶

Writer: (setf unsafe-string) (instance) ¶

Package: print-html.
Source: print-html.lisp.
Target Slot: string.

Previous: Ordinary functions, Up: Internals [Contents][Index]

5.2.3 Structures

Structure: tag ¶

Package

print-html.

Source

print-html.lisp.

Direct superclasses

structure-object.

Direct methods

print-html.
print-html.
print-html.

Direct slots

Slot: name ¶

Readers: tag-name.
Writers: (setf tag-name).

Slot: attrs ¶

Readers: tag-attrs.
Writers: (setf tag-attrs).

Slot: children ¶

Readers: tag-children.
Writers: (setf tag-children).

Previous: Definitions, Up: The print-html Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

Next: Functions, Previous: Indexes, Up: Indexes [Contents][Index]

A.1 Concepts

Next: Variables, Previous: Concepts, Up: Indexes [Contents][Index]

A.2 Functions

Jump to:	( C F G H M P R T U

	Index Entry	Section

(
	`(setf tag-attrs)`:	Private ordinary functions
	`(setf tag-children)`:	Private ordinary functions
	`(setf tag-name)`:	Private ordinary functions
	`(setf unsafe-string)`:	Private ordinary functions

C
	`copy-tag`:	Private ordinary functions
	`copy-unsafe`:	Private ordinary functions

F
	`Function, (setf tag-attrs)`:	Private ordinary functions
	`Function, (setf tag-children)`:	Private ordinary functions
	`Function, (setf tag-name)`:	Private ordinary functions
	`Function, (setf unsafe-string)`:	Private ordinary functions
	`Function, copy-tag`:	Private ordinary functions
	`Function, copy-unsafe`:	Private ordinary functions
	`Function, make-tag`:	Private ordinary functions
	`Function, print-html-to-string`:	Public ordinary functions
	`Function, tag-attrs`:	Private ordinary functions
	`Function, tag-children`:	Private ordinary functions
	`Function, tag-name`:	Private ordinary functions
	`Function, tag-p`:	Private ordinary functions
	`Function, unsafe`:	Public ordinary functions
	`Function, unsafe-p`:	Private ordinary functions
	`Function, unsafe-string`:	Private ordinary functions

G
	`Generic Function, print-html`:	Public generic functions
	`Generic Function, render`:	Public generic functions

H
	`html`:	Public macros

M
	`Macro, html`:	Public macros
	`make-tag`:	Private ordinary functions
	`Method, print-html`:	Public generic functions
	`Method, print-html`:	Public generic functions
	`Method, print-html`:	Public generic functions
	`Method, print-html`:	Public generic functions
	`Method, print-html`:	Public generic functions
	`Method, print-html`:	Public generic functions
	`Method, print-html`:	Public generic functions
	`Method, print-html`:	Public generic functions
	`Method, print-html`:	Public generic functions
	`Method, render`:	Public generic functions

P
	`print-html`:	Public generic functions
	`print-html`:	Public generic functions
	`print-html`:	Public generic functions
	`print-html`:	Public generic functions
	`print-html`:	Public generic functions
	`print-html`:	Public generic functions
	`print-html`:	Public generic functions
	`print-html`:	Public generic functions
	`print-html`:	Public generic functions
	`print-html`:	Public generic functions
	`print-html-to-string`:	Public ordinary functions

R
	`render`:	Public generic functions
	`render`:	Public generic functions

T
	`tag-attrs`:	Private ordinary functions
	`tag-children`:	Private ordinary functions
	`tag-name`:	Private ordinary functions
	`tag-p`:	Private ordinary functions

U
	`unsafe`:	Public ordinary functions
	`unsafe-p`:	Private ordinary functions
	`unsafe-string`:	Private ordinary functions

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	* A C N S

	Index Entry	Section

*
	`self-closing-tags`:	Private special variables

A
	`attrs`:	Private structures

C
	`children`:	Private structures

N
	`name`:	Private structures

S
	`Slot, attrs`:	Private structures
	`Slot, children`:	Private structures
	`Slot, name`:	Private structures
	`Slot, string`:	Public structures
	`Special Variable, self-closing-tags`:	Private special variables
	`string`:	Public structures

Previous: Variables, Up: Indexes [Contents][Index]

A.4 Data types

Jump to:	F P S T U

	Index Entry	Section

F
	`File, print-html.asd`:	The print-html/print-html․asd file
	`File, print-html.lisp`:	The print-html/print-html․lisp file

P
	`Package, print-html`:	The print-html package
	`print-html`:	The print-html system
	`print-html`:	The print-html package
	`print-html.asd`:	The print-html/print-html․asd file
	`print-html.lisp`:	The print-html/print-html․lisp file

S
	`Structure, tag`:	Private structures
	`Structure, unsafe`:	Public structures
	`System, print-html`:	The print-html system

T
	`tag`:	Private structures

U
	`unsafe`:	Public structures

The print-html Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 print-html

3 Files

3.1 Lisp

3.1.1 print-html/print-html.asd

3.1.2 print-html/print-html.lisp

4 Packages

4.1 print-html

5 Definitions

5.1 Public Interface

5.1.1 Macros

5.1.2 Ordinary functions

5.1.3 Generic functions

5.1.4 Structures

5.2 Internals

5.2.1 Special variables

5.2.2 Ordinary functions

5.2.3 Structures

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `print-html`

3.1.1 `print-html/print-html.asd`

3.1.2 `print-html/print-html.lisp`

4.1 `print-html`