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

The cl-markup Reference Manual

This is the cl-markup Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:26:19 2024 GMT+0.

Next: Systems, Previous: The cl-markup Reference Manual, Up: The cl-markup Reference Manual [Contents][Index]

1 Introduction

Next: Modules, Previous: Introduction, Up: The cl-markup Reference Manual [Contents][Index]

2 Systems

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

cl-markup

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

2.1 `cl-markup`

Author: Eitarow Fukamachi
License: LLGPL
Version: 0.1
Source: cl-markup.asd.
Child Component: src (module).

Next: Files, Previous: Systems, Up: The cl-markup Reference Manual [Contents][Index]

3 Modules

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

cl-markup/src

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

3.1 `cl-markup/src`

Source

cl-markup.asd.

Parent Component

cl-markup (system).

Child Components

package.lisp (file).
util.lisp (file).
special.lisp (file).
markup.lisp (file).
helper.lisp (file).
readmacro.lisp (file).

Next: Packages, Previous: Modules, Up: The cl-markup 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: cl-markup/src/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

4.1.1 `cl-markup/cl-markup.asd`

Source: cl-markup.asd.
Parent Component: cl-markup (system).
ASDF Systems: cl-markup.
Packages: cl-markup-asd.

Next: cl-markup/src/util.lisp, Previous: cl-markup/cl-markup.asd, Up: Lisp [Contents][Index]

4.1.2 `cl-markup/src/package.lisp`

Source: cl-markup.asd.
Parent Component: src (module).
Packages: cl-markup.

Next: cl-markup/src/special.lisp, Previous: cl-markup/src/package.lisp, Up: Lisp [Contents][Index]

4.1.3 `cl-markup/src/util.lisp`

Dependency

package.lisp (file).

Source

cl-markup.asd.

Parent Component

src (module).

Public Interface

*auto-escape* (special variable).
escape-string (function).

Internals

ensure-string (function).
map-group-if (function).
should-escape-p (function).
substitute-string-by (function).

Next: cl-markup/src/markup.lisp, Previous: cl-markup/src/util.lisp, Up: Lisp [Contents][Index]

4.1.4 `cl-markup/src/special.lisp`

Dependency

util.lisp (file).

Source

cl-markup.asd.

Parent Component

src (module).

Public Interface

*markup-language* (special variable).
*output-stream* (special variable).

Next: cl-markup/src/helper.lisp, Previous: cl-markup/src/special.lisp, Up: Lisp [Contents][Index]

4.1.5 `cl-markup/src/markup.lisp`

Dependency

special.lisp (file).

Source

cl-markup.asd.

Parent Component

src (module).

Public Interface

doctype (function).
html (macro).
html5 (macro).
markup (macro).
markup* (function).
xhtml (macro).
xml (macro).

Internals

%dirty-string-form (function).
%escape-string-form (macro).
%write-strings (macro).
attributes->string (function).
parse-tag (function).
tag->string (function).
tagp (function).
with-doctype (macro).

Next: cl-markup/src/readmacro.lisp, Previous: cl-markup/src/markup.lisp, Up: Lisp [Contents][Index]

4.1.6 `cl-markup/src/helper.lisp`

Dependency

markup.lisp (file).

Source

cl-markup.asd.

Parent Component

src (module).

Public Interface

esc (macro).
raw (macro).

Previous: cl-markup/src/helper.lisp, Up: Lisp [Contents][Index]

4.1.7 `cl-markup/src/readmacro.lisp`

Dependency

helper.lisp (file).

Source

cl-markup.asd.

Parent Component

src (module).

Public Interface

enable-markup-syntax (macro).

Internals

%enable-markup-syntax (function).
markup-reader (function).

Next: Definitions, Previous: Files, Up: The cl-markup Reference Manual [Contents][Index]

5 Packages

Packages are listed by definition order.

cl-markup
cl-markup-asd

Next: cl-markup-asd, Previous: Packages, Up: Packages [Contents][Index]

5.1 `cl-markup`

Source

package.lisp.

Nickname

markup

Use List

common-lisp.

Public Interface

*auto-escape* (special variable).
*markup-language* (special variable).
*output-stream* (special variable).
doctype (function).
enable-markup-syntax (macro).
esc (macro).
escape-string (function).
html (macro).
html5 (macro).
markup (macro).
markup* (function).
raw (macro).
xhtml (macro).
xml (macro).

Internals

%dirty-string-form (function).
%enable-markup-syntax (function).
%escape-string-form (macro).
%write-strings (macro).
attributes->string (function).
ensure-string (function).
map-group-if (function).
markup-reader (function).
parse-tag (function).
should-escape-p (function).
substitute-string-by (function).
tag->string (function).
tagp (function).
with-doctype (macro).

Previous: cl-markup, Up: Packages [Contents][Index]

5.2 `cl-markup-asd`

Source

cl-markup.asd.

Use List

asdf/interface.
common-lisp.

Next: Indexes, Previous: Packages, Up: The cl-markup 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

Special variables
Macros
Ordinary functions

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

6.1.1 Special variables

Special Variable: *auto-escape* ¶

Package: cl-markup.
Source: util.lisp.

Special Variable: *markup-language* ¶

Valid markup languages are :html, :xhtml and :xml

Package: cl-markup.
Source: special.lisp.

Special Variable: *output-stream* ¶

Stream to output the generated string. If this is nil, then just return as a string the result. T means *standard-output*.

Package: cl-markup.
Source: special.lisp.

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

6.1.2 Macros

Macro: enable-markup-syntax () ¶

Package: cl-markup.
Source: readmacro.lisp.

Macro: esc (&rest forms) ¶

Package: cl-markup.
Source: helper.lisp.

Macro: html (&rest tags) ¶

Package: cl-markup.
Source: markup.lisp.

Macro: html5 (&rest tags) ¶

Package: cl-markup.
Source: markup.lisp.

Macro: markup (&rest tags) ¶

Package: cl-markup.
Source: markup.lisp.

Macro: raw (&rest forms) ¶

Package: cl-markup.
Source: helper.lisp.

Macro: xhtml (&rest tags) ¶

Package: cl-markup.
Source: markup.lisp.

Macro: xml (&rest tags) ¶

Package: cl-markup.
Source: markup.lisp.

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

6.1.3 Ordinary functions

Function: doctype (lang) ¶

Package: cl-markup.
Source: markup.lisp.

Function: escape-string (string) ¶

Package: cl-markup.
Source: util.lisp.

Function: markup* (&rest tags) ¶

Package: cl-markup.
Source: markup.lisp.

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

6.2 Internals

Macros
Ordinary functions

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

6.2.1 Macros

Macro: %escape-string-form (val) ¶

Package: cl-markup.
Source: markup.lisp.

Macro: %write-strings (&rest strings) ¶

Package: cl-markup.
Source: markup.lisp.

Macro: with-doctype (lang &body body) ¶

Package: cl-markup.
Source: markup.lisp.

Previous: Macros, Up: Internals [Contents][Index]

6.2.2 Ordinary functions

Function: %dirty-string-form (form) ¶

Package: cl-markup.
Source: markup.lisp.

Function: %enable-markup-syntax () ¶

Package: cl-markup.
Source: readmacro.lisp.

Function: attributes->string (attr-plist) ¶

Package: cl-markup.
Source: markup.lisp.

Function: ensure-string (val) ¶

Package: cl-markup.
Source: util.lisp.

Function: map-group-if (pred list fn) ¶

Package: cl-markup.
Source: util.lisp.

Function: markup-reader (stream char arg) ¶

Package: cl-markup.
Source: readmacro.lisp.

Function: parse-tag (tag) ¶

Package: cl-markup.
Source: markup.lisp.

Function: should-escape-p (val) ¶

Package: cl-markup.
Source: util.lisp.

Function: substitute-string-by (fn string) ¶

Package: cl-markup.
Source: util.lisp.

Function: tag->string (tag) ¶

Package: cl-markup.
Source: markup.lisp.

Function: tagp (form) ¶

Package: cl-markup.
Source: markup.lisp.

Previous: Definitions, Up: The cl-markup 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 D E F H M P R S T W X

	Index Entry	Section

%
	`%dirty-string-form`:	Private ordinary functions
	`%enable-markup-syntax`:	Private ordinary functions
	`%escape-string-form`:	Private macros
	`%write-strings`:	Private macros

A
	`attributes->string`:	Private ordinary functions

D
	`doctype`:	Public ordinary functions

E
	`enable-markup-syntax`:	Public macros
	`ensure-string`:	Private ordinary functions
	`esc`:	Public macros
	`escape-string`:	Public ordinary functions

F
	`Function, %dirty-string-form`:	Private ordinary functions
	`Function, %enable-markup-syntax`:	Private ordinary functions
	`Function, attributes->string`:	Private ordinary functions
	`Function, doctype`:	Public ordinary functions
	`Function, ensure-string`:	Private ordinary functions
	`Function, escape-string`:	Public ordinary functions
	`Function, map-group-if`:	Private ordinary functions
	`Function, markup*`:	Public ordinary functions
	`Function, markup-reader`:	Private ordinary functions
	`Function, parse-tag`:	Private ordinary functions
	`Function, should-escape-p`:	Private ordinary functions
	`Function, substitute-string-by`:	Private ordinary functions
	`Function, tag->string`:	Private ordinary functions
	`Function, tagp`:	Private ordinary functions

H
	`html`:	Public macros
	`html5`:	Public macros

M
	`Macro, %escape-string-form`:	Private macros
	`Macro, %write-strings`:	Private macros
	`Macro, enable-markup-syntax`:	Public macros
	`Macro, esc`:	Public macros
	`Macro, html`:	Public macros
	`Macro, html5`:	Public macros
	`Macro, markup`:	Public macros
	`Macro, raw`:	Public macros
	`Macro, with-doctype`:	Private macros
	`Macro, xhtml`:	Public macros
	`Macro, xml`:	Public macros
	`map-group-if`:	Private ordinary functions
	`markup`:	Public macros
	`markup*`:	Public ordinary functions
	`markup-reader`:	Private ordinary functions

P
	`parse-tag`:	Private ordinary functions

R
	`raw`:	Public macros

S
	`should-escape-p`:	Private ordinary functions
	`substitute-string-by`:	Private ordinary functions

T
	`tag->string`:	Private ordinary functions
	`tagp`:	Private ordinary functions

W
	`with-doctype`:	Private macros

X
	`xhtml`:	Public macros
	`xml`:	Public macros

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

A.3 Variables

Jump to:	* S

	Index Entry	Section

*
	`auto-escape`:	Public special variables
	`markup-language`:	Public special variables
	`output-stream`:	Public special variables

S
	`Special Variable, auto-escape`:	Public special variables
	`Special Variable, markup-language`:	Public special variables
	`Special Variable, output-stream`:	Public special variables

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

A.4 Data types

Jump to:	C F H M P R S U

	Index Entry	Section

C
	`cl-markup`:	The cl-markup system
	`cl-markup`:	The cl-markup package
	`cl-markup-asd`:	The cl-markup-asd package
	`cl-markup.asd`:	The cl-markup/cl-markup․asd file

F
	`File, cl-markup.asd`:	The cl-markup/cl-markup․asd file
	`File, helper.lisp`:	The cl-markup/src/helper․lisp file
	`File, markup.lisp`:	The cl-markup/src/markup․lisp file
	`File, package.lisp`:	The cl-markup/src/package․lisp file
	`File, readmacro.lisp`:	The cl-markup/src/readmacro․lisp file
	`File, special.lisp`:	The cl-markup/src/special․lisp file
	`File, util.lisp`:	The cl-markup/src/util․lisp file

H
	`helper.lisp`:	The cl-markup/src/helper․lisp file

M
	`markup.lisp`:	The cl-markup/src/markup․lisp file
	`Module, src`:	The cl-markup/src module

P
	`Package, cl-markup`:	The cl-markup package
	`Package, cl-markup-asd`:	The cl-markup-asd package
	`package.lisp`:	The cl-markup/src/package․lisp file

R
	`readmacro.lisp`:	The cl-markup/src/readmacro․lisp file

S
	`special.lisp`:	The cl-markup/src/special․lisp file
	`src`:	The cl-markup/src module
	`System, cl-markup`:	The cl-markup system

U
	`util.lisp`:	The cl-markup/src/util․lisp file

The cl-markup Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 cl-markup

3 Modules

3.1 cl-markup/src

4 Files

4.1 Lisp

4.1.1 cl-markup/cl-markup.asd

4.1.2 cl-markup/src/package.lisp

4.1.3 cl-markup/src/util.lisp

4.1.4 cl-markup/src/special.lisp

4.1.5 cl-markup/src/markup.lisp

4.1.6 cl-markup/src/helper.lisp

4.1.7 cl-markup/src/readmacro.lisp

5 Packages

5.1 cl-markup

5.2 cl-markup-asd

6 Definitions

6.1 Public Interface

6.1.1 Special variables

6.1.2 Macros

6.1.3 Ordinary functions

6.2 Internals

6.2.1 Macros

6.2.2 Ordinary functions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `cl-markup`

3.1 `cl-markup/src`

4.1.1 `cl-markup/cl-markup.asd`

4.1.2 `cl-markup/src/package.lisp`

4.1.3 `cl-markup/src/util.lisp`

4.1.4 `cl-markup/src/special.lisp`

4.1.5 `cl-markup/src/markup.lisp`

4.1.6 `cl-markup/src/helper.lisp`

4.1.7 `cl-markup/src/readmacro.lisp`

5.1 `cl-markup`

5.2 `cl-markup-asd`