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 Wed May 15 04:13:29 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-markup

Author

Eitarow Fukamachi

License

LLGPL

Version

0.1

Source

cl-markup.asd.

Child Component

src (module).


3 Modules

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


3.1 cl-markup/src

Source

cl-markup.asd.

Parent Component

cl-markup (system).

Child Components

4 Files

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


4.1 Lisp


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.


4.1.2 cl-markup/src/package.lisp

Source

cl-markup.asd.

Parent Component

src (module).

Packages

cl-markup.


4.1.3 cl-markup/src/util.lisp

Dependency

package.lisp (file).

Source

cl-markup.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.4 cl-markup/src/special.lisp

Dependency

util.lisp (file).

Source

cl-markup.asd.

Parent Component

src (module).

Public Interface

4.1.5 cl-markup/src/markup.lisp

Dependency

special.lisp (file).

Source

cl-markup.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.6 cl-markup/src/helper.lisp

Dependency

markup.lisp (file).

Source

cl-markup.asd.

Parent Component

src (module).

Public Interface

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

5 Packages

Packages are listed by definition order.


5.1 cl-markup

Source

package.lisp.

Nickname

markup

Use List

common-lisp.

Public Interface
Internals

5.2 cl-markup-asd

Source

cl-markup.asd.

Use List
  • asdf/interface.
  • common-lisp.

6 Definitions

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


6.1 Public Interface


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.


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.


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.


6.2 Internals


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.


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.


Appendix A Indexes


A.1 Concepts


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