The lml Reference Manual

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

The lml Reference Manual

This is the lml Reference Manual, version 2.4, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed Jun 15 05:12:24 2022 GMT+0.

Table of Contents


1 Systems

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


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

1.1 lml

Lisp Markup Language

Maintainer

Kevin M. Rosenberg <kmr@debian.org>

Author

Kevin M. Rosenberg <kevin@rosenberg.net>

License

GNU General Public License

Long Description

LML provides creation of XHTML for Lisp programs.

Version

2.4

Source

lml.asd.

Child Components

2 Files

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


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

2.1 Lisp


Next: , Previous: , Up: Lisp   [Contents][Index]

2.1.1 lml/lml.asd

Source

lml.asd.

Parent Component

lml (system).

ASDF Systems

lml.

Packages

lml-system.


Next: , Previous: , Up: Lisp   [Contents][Index]

2.1.2 lml/package.lisp

Source

lml.asd.

Parent Component

lml (system).

Packages

lisp-markup-language.


Next: , Previous: , Up: Lisp   [Contents][Index]

2.1.3 lml/utils.lisp

Dependency

package.lisp (file).

Source

lml.asd.

Parent Component

lml (system).

Public Interface
Internals

Next: , Previous: , Up: Lisp   [Contents][Index]

2.1.4 lml/files.lisp

Dependency

utils.lisp (file).

Source

lml.asd.

Parent Component

lml (system).

Public Interface
Internals

Next: , Previous: , Up: Lisp   [Contents][Index]

2.1.5 lml/base.lisp

Dependency

files.lisp (file).

Source

lml.asd.

Parent Component

lml (system).

Public Interface
Internals

Next: , Previous: , Up: Lisp   [Contents][Index]

2.1.6 lml/read-macro.lisp

Dependency

base.lisp (file).

Source

lml.asd.

Parent Component

lml (system).


2.1.7 lml/stdsite.lisp

Dependency

base.lisp (file).

Source

lml.asd.

Parent Component

lml (system).

Public Interface
Internals

std-footer (function).


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

2.1.8 lml/downloads.lisp

Dependency

base.lisp (file).

Source

lml.asd.

Parent Component

lml (system).

Public Interface
Internals

3 Packages

Packages are listed by definition order.


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

3.1 lml-system

Source

lml.asd.

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

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

3.2 lisp-markup-language

Source

package.lisp.

Nickname

lml

Use List

common-lisp.

Public Interface
Internals

4 Definitions

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


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

4.1 Public Interface


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

4.1.1 Special variables

Special Variable: *html-output*
Package

lisp-markup-language.

Source

files.lisp.

Special Variable: *print-spaces*
Package

lisp-markup-language.

Source

base.lisp.


4.1.2 Macros

Package

lisp-markup-language.

Source

base.lisp.

Package

lisp-markup-language.

Source

base.lisp.

Macro: br (&rest args)
Package

lisp-markup-language.

Source

base.lisp.

Macro: hr (&rest args)
Package

lisp-markup-language.

Source

base.lisp.

Macro: img (dest &rest args)
Package

lisp-markup-language.

Source

base.lisp.

Macro: input (&rest args)
Package

lisp-markup-language.

Source

base.lisp.

Macro: jscript (&body body)
Package

lisp-markup-language.

Source

base.lisp.

Package

lisp-markup-language.

Source

base.lisp.

Macro: meta (&rest args)
Package

lisp-markup-language.

Source

base.lisp.

Macro: page (out-file &body body)
Package

lisp-markup-language.

Source

base.lisp.

Macro: print-page (title &body body)
Package

lisp-markup-language.

Source

base.lisp.

Macro: print-std-page (file title &body body)
Package

lisp-markup-language.

Source

stdsite.lisp.

Macro: std-body (file &body body)
Package

lisp-markup-language.

Source

stdsite.lisp.

Macro: std-head (title &body body)
Package

lisp-markup-language.

Source

stdsite.lisp.

Macro: std-page (out-file title &body body)
Package

lisp-markup-language.

Source

stdsite.lisp.

Macro: titled-pre-section (title &body body)
Package

lisp-markup-language.

Source

stdsite.lisp.

Macro: with (tag &rest args)

Return a list of keyargs and also the body of LML form

Package

lisp-markup-language.

Source

base.lisp.

Macro: with-dir ((output &key sources) &body body)
Package

lisp-markup-language.

Source

files.lisp.


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

4.1.3 Ordinary functions

Function: full-dl-page (pkg-name pkg-base dl-base dl-url &optional giturl gitweb)
Package

lisp-markup-language.

Source

downloads.lisp.

Function: include-file (file)
Package

lisp-markup-language.

Source

files.lisp.

Function: lml-cwd ()

Returns the current working directory. Based on CLOCC’s DEFAULT-DIRECTORY function.

Package

lisp-markup-language.

Source

utils.lisp.

Function: lml-format (str &rest args)
Package

lisp-markup-language.

Source

base.lisp.

Function: lml-load (file)
Package

lisp-markup-language.

Source

files.lisp.

Function: lml-princ (s)
Package

lisp-markup-language.

Source

base.lisp.

Function: lml-print (s)
Package

lisp-markup-language.

Source

base.lisp.

Function: lml-print-date (date)
Package

lisp-markup-language.

Source

base.lisp.

Function: lml-quit (&optional code)

Function to exit the Lisp implementation.

Package

lisp-markup-language.

Source

utils.lisp.

Function: lml-write-char (char)
Package

lisp-markup-language.

Source

base.lisp.

Function: lml-write-string (str)
Package

lisp-markup-language.

Source

base.lisp.

Function: process-dir (dir &key sources)
Package

lisp-markup-language.

Source

files.lisp.

Function: reset-indent ()
Package

lisp-markup-language.

Source

base.lisp.

Function: std-dl-page (pkg-name pkg-base dl-base dl-url &optional giturl gitweb)
Package

lisp-markup-language.

Source

downloads.lisp.


4.2 Internals


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

4.2.1 Special variables

Special Variable: *base-name*
Package

lisp-markup-language.

Source

downloads.lisp.

Special Variable: *dl-base*
Package

lisp-markup-language.

Source

downloads.lisp.

Special Variable: *dl-url*
Package

lisp-markup-language.

Source

downloads.lisp.

Special Variable: *indent*
Package

lisp-markup-language.

Source

base.lisp.

Special Variable: *macro-list*
Package

lisp-markup-language.

Source

base.lisp.

Special Variable: *output-dir*
Package

lisp-markup-language.

Source

files.lisp.

Special Variable: *section-indent*
Package

lisp-markup-language.

Source

downloads.lisp.

Special Variable: *signed*
Package

lisp-markup-language.

Source

downloads.lisp.

Special Variable: *sources-dir*
Package

lisp-markup-language.

Source

files.lisp.


4.2.2 Macros

Macro: aif (test then &optional else)
Package

lisp-markup-language.

Source

utils.lisp.

Macro: awhen (test-form &body body)
Package

lisp-markup-language.

Source

utils.lisp.

Macro: bind-all-keyargs (keyargs)

Convert a list of keyarg pairs and convert eval/bind arguments

Package

lisp-markup-language.

Source

base.lisp.

Macro: bind-one-keyarg (keyarg)
Package

lisp-markup-language.

Source

base.lisp.

Macro: lml-exec-body (&body forms)
Package

lisp-markup-language.

Source

base.lisp.

Macro: lml-tag-class-macro (tag)
Package

lisp-markup-language.

Source

base.lisp.

Macro: lml-tag-macro (tag)
Package

lisp-markup-language.

Source

base.lisp.

Macro: with-attr-string (tag attr-string &body body)
Package

lisp-markup-language.

Source

base.lisp.

Macro: with-keyargs (tag keyargs &body body)
Package

lisp-markup-language.

Source

base.lisp.

Macro: with-no-endtag (tag &rest args)

Return a list of keyargs body of LML form

Package

lisp-markup-language.

Source

base.lisp.

Macro: with-no-endtag-attr-string (tag attr-string)
Package

lisp-markup-language.

Source

base.lisp.

Macro: with-no-endtag-keyargs (tag keyargs)
Package

lisp-markup-language.

Source

base.lisp.

Macro: xhtml-prologue ()
Package

lisp-markup-language.

Source

base.lisp.


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

4.2.3 Ordinary functions

Function: date-string (ut)
Package

lisp-markup-language.

Source

utils.lisp.

Function: display-footer ()
Package

lisp-markup-language.

Source

downloads.lisp.

Function: display-header (name url)
Package

lisp-markup-language.

Source

downloads.lisp.

Function: display-one-section (title pat)
Package

lisp-markup-language.

Source

downloads.lisp.

Function: display-page (pkg-name pkg-base dl-base dl-url giturl gitweb sects)
Package

lisp-markup-language.

Source

downloads.lisp.

Function: display-sections (sects)
Package

lisp-markup-language.

Source

downloads.lisp.

Function: filter-against-base (files)
Package

lisp-markup-language.

Source

downloads.lisp.

Function: filter-latest (files)
Package

lisp-markup-language.

Source

downloads.lisp.

Function: html4-prologue-string ()
Package

lisp-markup-language.

Source

base.lisp.

Function: indent-spaces (n &optional stream)

Indent n*2 spaces to output stream

Package

lisp-markup-language.

Source

utils.lisp.

Function: keyword-symbol? (x)

Returns T if object is a symbol in the keyword package

Package

lisp-markup-language.

Source

utils.lisp.

Function: list-files (files)

List files in a directory for downloading

Package

lisp-markup-language.

Source

downloads.lisp.

Function: list-to-spaced-string (list)
Package

lisp-markup-language.

Source

utils.lisp.

Function: lml-file-name (f &optional type)
Package

lisp-markup-language.

Source

files.lisp.

Function: lml-load-path (file)
Package

lisp-markup-language.

Source

files.lisp.

Function: match-base-name-latest? (name)
Package

lisp-markup-language.

Source

downloads.lisp.

Function: match-base-name? (name)
Package

lisp-markup-language.

Source

downloads.lisp.

Function: new-string ()
Package

lisp-markup-language.

Source

base.lisp.

Function: one-keyarg-string (key value)

Return attribute string for keys

Package

lisp-markup-language.

Source

base.lisp.

Function: print-file (file)
Package

lisp-markup-language.

Source

downloads.lisp.

Function: print-file-contents (file &optional strm)

Opens a reads a file. Returns the contents as a single string

Package

lisp-markup-language.

Source

utils.lisp.

Function: print-n-chars (char n stream)
Package

lisp-markup-language.

Source

utils.lisp.

Function: print-sect-title (title)
Package

lisp-markup-language.

Source

downloads.lisp.

Function: sort-pathnames (list)
Package

lisp-markup-language.

Source

downloads.lisp.

Function: std-footer (file)
Package

lisp-markup-language.

Source

stdsite.lisp.

Function: strip-dl-base (file)
Package

lisp-markup-language.

Source

downloads.lisp.

Function: xhtml-prologue-string ()
Package

lisp-markup-language.

Source

base.lisp.

Function: xml-prologue-string ()
Package

lisp-markup-language.

Source

base.lisp.


Appendix A Indexes


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

A.1 Concepts


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

A.2 Functions

Jump to:   A   B   D   F   H   I   J   K   L   M   N   O   P   R   S   T   W   X  
Index Entry  Section

A
aif: Private macros
alink: Public macros
alink-c: Public macros
awhen: Private macros

B
bind-all-keyargs: Private macros
bind-one-keyarg: Private macros
br: Public macros

D
date-string: Private ordinary functions
display-footer: Private ordinary functions
display-header: Private ordinary functions
display-one-section: Private ordinary functions
display-page: Private ordinary functions
display-sections: Private ordinary functions

F
filter-against-base: Private ordinary functions
filter-latest: Private ordinary functions
full-dl-page: Public ordinary functions
Function, date-string: Private ordinary functions
Function, display-footer: Private ordinary functions
Function, display-header: Private ordinary functions
Function, display-one-section: Private ordinary functions
Function, display-page: Private ordinary functions
Function, display-sections: Private ordinary functions
Function, filter-against-base: Private ordinary functions
Function, filter-latest: Private ordinary functions
Function, full-dl-page: Public ordinary functions
Function, html4-prologue-string: Private ordinary functions
Function, include-file: Public ordinary functions
Function, indent-spaces: Private ordinary functions
Function, keyword-symbol?: Private ordinary functions
Function, list-files: Private ordinary functions
Function, list-to-spaced-string: Private ordinary functions
Function, lml-cwd: Public ordinary functions
Function, lml-file-name: Private ordinary functions
Function, lml-format: Public ordinary functions
Function, lml-load: Public ordinary functions
Function, lml-load-path: Private ordinary functions
Function, lml-princ: Public ordinary functions
Function, lml-print: Public ordinary functions
Function, lml-print-date: Public ordinary functions
Function, lml-quit: Public ordinary functions
Function, lml-write-char: Public ordinary functions
Function, lml-write-string: Public ordinary functions
Function, match-base-name-latest?: Private ordinary functions
Function, match-base-name?: Private ordinary functions
Function, new-string: Private ordinary functions
Function, one-keyarg-string: Private ordinary functions
Function, print-file: Private ordinary functions
Function, print-file-contents: Private ordinary functions
Function, print-n-chars: Private ordinary functions
Function, print-sect-title: Private ordinary functions
Function, process-dir: Public ordinary functions
Function, reset-indent: Public ordinary functions
Function, sort-pathnames: Private ordinary functions
Function, std-dl-page: Public ordinary functions
Function, std-footer: Private ordinary functions
Function, strip-dl-base: Private ordinary functions
Function, xhtml-prologue-string: Private ordinary functions
Function, xml-prologue-string: Private ordinary functions

H
hr: Public macros
html4-prologue-string: Private ordinary functions

I
img: Public macros
include-file: Public ordinary functions
indent-spaces: Private ordinary functions
input: Public macros

J
jscript: Public macros

K
keyword-symbol?: Private ordinary functions

L
link: Public macros
list-files: Private ordinary functions
list-to-spaced-string: Private ordinary functions
lml-cwd: Public ordinary functions
lml-exec-body: Private macros
lml-file-name: Private ordinary functions
lml-format: Public ordinary functions
lml-load: Public ordinary functions
lml-load-path: Private ordinary functions
lml-princ: Public ordinary functions
lml-print: Public ordinary functions
lml-print-date: Public ordinary functions
lml-quit: Public ordinary functions
lml-tag-class-macro: Private macros
lml-tag-macro: Private macros
lml-write-char: Public ordinary functions
lml-write-string: Public ordinary functions

M
Macro, aif: Private macros
Macro, alink: Public macros
Macro, alink-c: Public macros
Macro, awhen: Private macros
Macro, bind-all-keyargs: Private macros
Macro, bind-one-keyarg: Private macros
Macro, br: Public macros
Macro, hr: Public macros
Macro, img: Public macros
Macro, input: Public macros
Macro, jscript: Public macros
Macro, link: Public macros
Macro, lml-exec-body: Private macros
Macro, lml-tag-class-macro: Private macros
Macro, lml-tag-macro: Private macros
Macro, meta: Public macros
Macro, page: Public macros
Macro, print-page: Public macros
Macro, print-std-page: Public macros
Macro, std-body: Public macros
Macro, std-head: Public macros
Macro, std-page: Public macros
Macro, titled-pre-section: Public macros
Macro, with: Public macros
Macro, with-attr-string: Private macros
Macro, with-dir: Public macros
Macro, with-keyargs: Private macros
Macro, with-no-endtag: Private macros
Macro, with-no-endtag-attr-string: Private macros
Macro, with-no-endtag-keyargs: Private macros
Macro, xhtml-prologue: Private macros
match-base-name-latest?: Private ordinary functions
match-base-name?: Private ordinary functions
meta: Public macros

N
new-string: Private ordinary functions

O
one-keyarg-string: Private ordinary functions

P
page: Public macros
print-file: Private ordinary functions
print-file-contents: Private ordinary functions
print-n-chars: Private ordinary functions
print-page: Public macros
print-sect-title: Private ordinary functions
print-std-page: Public macros
process-dir: Public ordinary functions

R
reset-indent: Public ordinary functions

S
sort-pathnames: Private ordinary functions
std-body: Public macros
std-dl-page: Public ordinary functions
std-footer: Private ordinary functions
std-head: Public macros
std-page: Public macros
strip-dl-base: Private ordinary functions

T
titled-pre-section: Public macros

W
with: Public macros
with-attr-string: Private macros
with-dir: Public macros
with-keyargs: Private macros
with-no-endtag: Private macros
with-no-endtag-attr-string: Private macros
with-no-endtag-keyargs: Private macros

X
xhtml-prologue: Private macros
xhtml-prologue-string: Private ordinary functions
xml-prologue-string: Private ordinary functions

Jump to:   A   B   D   F   H   I   J   K   L   M   N   O   P   R   S   T   W   X