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

The hiccl Reference Manual

This is the hiccl Reference Manual, version 1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 06:22:51 2024 GMT+0.

Next: Systems, Previous: The hiccl Reference Manual, Up: The hiccl Reference Manual [Contents][Index]

1 Introduction

Next: Modules, Previous: Introduction, Up: The hiccl Reference Manual [Contents][Index]

2 Systems

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

hiccl

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

2.1 `hiccl`

HTML generator for Common Lisp

Author

garlic0x1

License

MIT

Version

1.0

Dependencies

serapeum (system).
trivia (system).
str (system).

Source

hiccl.asd.

Child Component

src (module).

Next: Files, Previous: Systems, Up: The hiccl Reference Manual [Contents][Index]

3 Modules

Modules are listed depth-first from the system components tree.

hiccl/src

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

3.1 `hiccl/src`

Source

hiccl.asd.

Parent Component

hiccl (system).

Child Components

utils.lisp (file).
expand.lisp (file).
sanitize.lisp (file).
render.lisp (file).

Next: Packages, Previous: Modules, Up: The hiccl Reference Manual [Contents][Index]

4 Files

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

Lisp

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

Next: hiccl/src/utils.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

4.1.1 `hiccl/hiccl.asd`

Source: hiccl.asd.
Parent Component: hiccl (system).
ASDF Systems: hiccl.

Next: hiccl/src/expand.lisp, Previous: hiccl/hiccl.asd, Up: Lisp [Contents][Index]

4.1.2 `hiccl/src/utils.lisp`

Source: hiccl.asd.
Parent Component: src (module).
Packages: hiccl/utils.
Public Interface: extract-attrs (function).

Next: hiccl/src/sanitize.lisp, Previous: hiccl/src/utils.lisp, Up: Lisp [Contents][Index]

4.1.3 `hiccl/src/expand.lisp`

Source

hiccl.asd.

Parent Component

src (module).

Packages

hiccl/expand.

Public Interface

expand (function).

Internals

ensure-has (function).
expand-tag (function).
prepare-attrs (function).

Next: hiccl/src/render.lisp, Previous: hiccl/src/expand.lisp, Up: Lisp [Contents][Index]

4.1.4 `hiccl/src/sanitize.lisp`

Source

hiccl.asd.

Parent Component

src (module).

Packages

hiccl/sanitize.

Public Interface

sanitize (generic function).

Internals

+storage-for-deflex-var-no-break-space+ (constant).
escape-table (function).
no-break-space (symbol macro).

Previous: hiccl/src/sanitize.lisp, Up: Lisp [Contents][Index]

4.1.5 `hiccl/src/render.lisp`

Source

hiccl.asd.

Parent Component

src (module).

Packages

hiccl/render.

Public Interface

render (macro).

Internals

apply-tag (generic function).
render-attr (function).
render-form (generic function).
render-forms (function).

Next: Definitions, Previous: Files, Up: The hiccl Reference Manual [Contents][Index]

5 Packages

Packages are listed by definition order.

hiccl/utils
hiccl/sanitize
hiccl/expand
hiccl/render

Next: hiccl/sanitize, Previous: Packages, Up: Packages [Contents][Index]

5.1 `hiccl/utils`

Source: utils.lisp.
Use List: common-lisp.
Public Interface: extract-attrs (function).

Next: hiccl/expand, Previous: hiccl/utils, Up: Packages [Contents][Index]

5.2 `hiccl/sanitize`

Source

sanitize.lisp.

Use List

common-lisp.

Public Interface

sanitize (generic function).

Internals

+storage-for-deflex-var-no-break-space+ (constant).
escape-table (function).
no-break-space (symbol macro).

Next: hiccl/render, Previous: hiccl/sanitize, Up: Packages [Contents][Index]

5.3 `hiccl/expand`

Source

expand.lisp.

Use List

common-lisp.

Public Interface

expand (function).

Internals

ensure-has (function).
expand-tag (function).
prepare-attrs (function).

Previous: hiccl/expand, Up: Packages [Contents][Index]

5.4 `hiccl/render`

Source

render.lisp.

Nickname

hiccl

Use List

common-lisp.

Public Interface

render (macro).

Internals

apply-tag (generic function).
render-attr (function).
render-form (generic function).
render-forms (function).

Next: Indexes, Previous: Packages, Up: The hiccl Reference Manual [Contents][Index]

6 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]

6.1 Public Interface

Macros
Ordinary functions
Generic functions

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

6.1.1 Macros

Macro: render (output &body forms) ¶

Package: hiccl/render.
Source: render.lisp.

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

6.1.2 Ordinary functions

Function: expand (tag attrs) ¶

Package: hiccl/expand.
Source: expand.lisp.

Function: extract-attrs (body) ¶

Package: hiccl/utils.
Source: utils.lisp.

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

6.1.3 Generic functions

Generic Function: sanitize (obj) ¶

Package

hiccl/sanitize.

Source

sanitize.lisp.

Methods

Method: sanitize ((obj string)) ¶

Method: sanitize ((obj symbol)) ¶

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

6.2 Internals

Constants
Symbol macros
Ordinary functions
Generic functions

Next: Symbol macros, Previous: Internals, Up: Internals [Contents][Index]

6.2.1 Constants

Constant: +storage-for-deflex-var-no-break-space+ ¶

Package: hiccl/sanitize.
Source: sanitize.lisp.

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

6.2.2 Symbol macros

Symbol Macro: no-break-space ¶

Package: hiccl/sanitize.
Source: sanitize.lisp.

Next: Generic functions, Previous: Symbol macros, Up: Internals [Contents][Index]

6.2.3 Ordinary functions

Function: ensure-has (alist key) ¶

Package: hiccl/expand.
Source: expand.lisp.

Function: escape-table (c) ¶

Package: hiccl/sanitize.
Source: sanitize.lisp.

Function: expand-tag (input &key tag class id state) ¶

Package: hiccl/expand.
Source: expand.lisp.

Function: prepare-attrs (attrs class id) ¶

Package: hiccl/expand.
Source: expand.lisp.

Function: render-attr (out attr) ¶

Package: hiccl/render.
Source: render.lisp.

Function: render-forms (output forms) ¶

Package: hiccl/render.
Source: render.lisp.

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

6.2.4 Generic functions

Generic Function: apply-tag (out tag body) ¶

Package

hiccl/render.

Source

render.lisp.

Methods

Method: apply-tag (out (tag (eql :comment)) body) ¶

Method: apply-tag (out (tag (eql :!--)) body) ¶

Method: apply-tag (out (tag (eql :doctype)) body) ¶

Method: apply-tag (out (tag (eql :<>)) body) ¶

Method: apply-tag (out (tag (eql :raw)) body) ¶

Method: apply-tag (out tag body) ¶

Generic Function: render-form (out sxml) ¶

Package

hiccl/render.

Source

render.lisp.

Methods

Method: render-form (out (sxml null)) ¶

Method: render-form (out (sxml symbol)) ¶

Method: render-form (out (sxml number)) ¶

Method: render-form (out (sxml string)) ¶

Method: render-form (out (sxml list)) ¶

Previous: Definitions, Up: The hiccl 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:	A E F G M P R S

	Index Entry	Section

A
	`apply-tag`:	Private generic functions
	`apply-tag`:	Private generic functions
	`apply-tag`:	Private generic functions
	`apply-tag`:	Private generic functions
	`apply-tag`:	Private generic functions
	`apply-tag`:	Private generic functions
	`apply-tag`:	Private generic functions

E
	`ensure-has`:	Private ordinary functions
	`escape-table`:	Private ordinary functions
	`expand`:	Public ordinary functions
	`expand-tag`:	Private ordinary functions
	`extract-attrs`:	Public ordinary functions

F
	`Function, ensure-has`:	Private ordinary functions
	`Function, escape-table`:	Private ordinary functions
	`Function, expand`:	Public ordinary functions
	`Function, expand-tag`:	Private ordinary functions
	`Function, extract-attrs`:	Public ordinary functions
	`Function, prepare-attrs`:	Private ordinary functions
	`Function, render-attr`:	Private ordinary functions
	`Function, render-forms`:	Private ordinary functions

G
	`Generic Function, apply-tag`:	Private generic functions
	`Generic Function, render-form`:	Private generic functions
	`Generic Function, sanitize`:	Public generic functions

M
	`Macro, render`:	Public macros
	`Method, apply-tag`:	Private generic functions
	`Method, apply-tag`:	Private generic functions
	`Method, apply-tag`:	Private generic functions
	`Method, apply-tag`:	Private generic functions
	`Method, apply-tag`:	Private generic functions
	`Method, apply-tag`:	Private generic functions
	`Method, render-form`:	Private generic functions
	`Method, render-form`:	Private generic functions
	`Method, render-form`:	Private generic functions
	`Method, render-form`:	Private generic functions
	`Method, render-form`:	Private generic functions
	`Method, sanitize`:	Public generic functions
	`Method, sanitize`:	Public generic functions

P
	`prepare-attrs`:	Private ordinary functions

R
	`render`:	Public macros
	`render-attr`:	Private ordinary functions
	`render-form`:	Private generic functions
	`render-form`:	Private generic functions
	`render-form`:	Private generic functions
	`render-form`:	Private generic functions
	`render-form`:	Private generic functions
	`render-form`:	Private generic functions
	`render-forms`:	Private ordinary functions

S
	`sanitize`:	Public generic functions
	`sanitize`:	Public generic functions
	`sanitize`:	Public generic functions

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

A.3 Variables

Jump to:	+ C N S

	Index Entry	Section

+
	`+storage-for-deflex-var-no-break-space+`:	Private constants

C
	`Constant, +storage-for-deflex-var-no-break-space+`:	Private constants

N
	`no-break-space`:	Private symbol macros

S
	`Symbol Macro, no-break-space`:	Private symbol macros

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

A.4 Data types

Jump to:	E F H M P R S U

	Index Entry	Section

E
	`expand.lisp`:	The hiccl/src/expand․lisp file

F
	`File, expand.lisp`:	The hiccl/src/expand․lisp file
	`File, hiccl.asd`:	The hiccl/hiccl․asd file
	`File, render.lisp`:	The hiccl/src/render․lisp file
	`File, sanitize.lisp`:	The hiccl/src/sanitize․lisp file
	`File, utils.lisp`:	The hiccl/src/utils․lisp file

H
	`hiccl`:	The hiccl system
	`hiccl.asd`:	The hiccl/hiccl․asd file
	`hiccl/expand`:	The hiccl/expand package
	`hiccl/render`:	The hiccl/render package
	`hiccl/sanitize`:	The hiccl/sanitize package
	`hiccl/utils`:	The hiccl/utils package

M
	`Module, src`:	The hiccl/src module

P
	`Package, hiccl/expand`:	The hiccl/expand package
	`Package, hiccl/render`:	The hiccl/render package
	`Package, hiccl/sanitize`:	The hiccl/sanitize package
	`Package, hiccl/utils`:	The hiccl/utils package

R
	`render.lisp`:	The hiccl/src/render․lisp file

S
	`sanitize.lisp`:	The hiccl/src/sanitize․lisp file
	`src`:	The hiccl/src module
	`System, hiccl`:	The hiccl system

U
	`utils.lisp`:	The hiccl/src/utils․lisp file

The hiccl Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 hiccl

3 Modules

3.1 hiccl/src

4 Files

4.1 Lisp

4.1.1 hiccl/hiccl.asd

4.1.2 hiccl/src/utils.lisp

4.1.3 hiccl/src/expand.lisp

4.1.4 hiccl/src/sanitize.lisp

4.1.5 hiccl/src/render.lisp

5 Packages

5.1 hiccl/utils

5.2 hiccl/sanitize

5.3 hiccl/expand

5.4 hiccl/render

6 Definitions

6.1 Public Interface

6.1.1 Macros

6.1.2 Ordinary functions

6.1.3 Generic functions

6.2 Internals

6.2.1 Constants

6.2.2 Symbol macros

6.2.3 Ordinary functions

6.2.4 Generic functions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `hiccl`

3.1 `hiccl/src`

4.1.1 `hiccl/hiccl.asd`

4.1.2 `hiccl/src/utils.lisp`

4.1.3 `hiccl/src/expand.lisp`

4.1.4 `hiccl/src/sanitize.lisp`

4.1.5 `hiccl/src/render.lisp`

5.1 `hiccl/utils`

5.2 `hiccl/sanitize`

5.3 `hiccl/expand`

5.4 `hiccl/render`