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

The whofields Reference Manual

This is the whofields Reference Manual, version 1.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 08:05:54 2024 GMT+0.

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

1 Introduction

Next: Files, Previous: Introduction, Up: The whofields Reference Manual [Contents][Index]

2 Systems

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

whofields
whofields/core/all
whofields/core/fieldspec
whofields/core/render
whofields/core/validate

Next: whofields/core/all, Previous: Systems, Up: Systems [Contents][Index]

2.1 `whofields`

HTML field rendering and input validation utilities written in Common Lisp

Author: Michael J. Forster <mike@forsterfamily.ca>
License: MIT
Version: 1.0.1
Defsystem Dependency: asdf-package-system (system).
Dependency: whofields/core/all (system).
Source: whofields.asd.

Next: whofields/core/fieldspec, Previous: whofields, Up: Systems [Contents][Index]

2.2 `whofields/core/all`

Author

Michael J. Forster <mike@forsterfamily.ca>

License

MIT

Dependencies

whofields/core/fieldspec (system).
whofields/core/render (system).
whofields/core/validate (system).

Source

whofields.asd.

Next: whofields/core/render, Previous: whofields/core/all, Up: Systems [Contents][Index]

2.3 `whofields/core/fieldspec`

Author: Michael J. Forster <mike@forsterfamily.ca>
License: MIT
Source: whofields.asd.

Next: whofields/core/validate, Previous: whofields/core/fieldspec, Up: Systems [Contents][Index]

2.4 `whofields/core/render`

Author: Michael J. Forster <mike@forsterfamily.ca>
License: MIT
Dependency: cl-who (system).
Source: whofields.asd.

Previous: whofields/core/render, Up: Systems [Contents][Index]

2.5 `whofields/core/validate`

Author: Michael J. Forster <mike@forsterfamily.ca>
License: MIT
Dependency: whofields/core/fieldspec (system).
Source: whofields.asd.

Next: Packages, Previous: Systems, Up: The whofields 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]

3.1 Lisp

whofields/whofields.asd
whofields/core/all/file-type.lisp
whofields/core/fieldspec/file-type.lisp
whofields/core/render/file-type.lisp
whofields/core/validate/file-type.lisp

Next: whofields/core/all/file-type.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `whofields/whofields.asd`

Source

whofields.asd.

Parent Component

whofields (system).

ASDF Systems

whofields.
whofields/core/all.
whofields/core/fieldspec.
whofields/core/render.
whofields/core/validate.

Next: whofields/core/fieldspec/file-type.lisp, Previous: whofields/whofields.asd, Up: Lisp [Contents][Index]

3.1.2 `whofields/core/all/file-type.lisp`

Source: whofields.asd.
Parent Component: whofields/core/all (system).
Packages: whofields/core/all.

Next: whofields/core/render/file-type.lisp, Previous: whofields/core/all/file-type.lisp, Up: Lisp [Contents][Index]

3.1.3 `whofields/core/fieldspec/file-type.lisp`

Source

whofields.asd.

Parent Component

whofields/core/fieldspec (system).

Packages

whofields/core/fieldspec.

Public Interface

fieldspec-label (function).
fieldspec-name (function).
fieldspec-plist (function).

Next: whofields/core/validate/file-type.lisp, Previous: whofields/core/fieldspec/file-type.lisp, Up: Lisp [Contents][Index]

3.1.4 `whofields/core/render/file-type.lisp`

Source

whofields.asd.

Parent Component

whofields/core/render (system).

Packages

whofields/core/render.

Public Interface

render-field (function).

Internals

escape-value (function).
render-checkbox (function).
render-password-input (function).
render-select (function).
render-static (function).
render-text-input (function).

Previous: whofields/core/render/file-type.lisp, Up: Lisp [Contents][Index]

3.1.5 `whofields/core/validate/file-type.lisp`

Source

whofields.asd.

Parent Component

whofields/core/validate (system).

Packages

whofields/core/validate.

Public Interface

validate-field (function).
validate-fields (function).

Internals

validate-boolean (function).
validate-option (function).
validate-string (function).

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

4 Packages

Packages are listed by definition order.

whofields/core/validate
whofields/core/fieldspec
whofields/core/render
whofields/core/all

Next: whofields/core/fieldspec, Previous: Packages, Up: Packages [Contents][Index]

4.1 `whofields/core/validate`

Source

file-type.lisp.

Use List

common-lisp.

Used By List

whofields/core/all.

Public Interface

validate-field (function).
validate-fields (function).

Internals

validate-boolean (function).
validate-option (function).
validate-string (function).

Next: whofields/core/render, Previous: whofields/core/validate, Up: Packages [Contents][Index]

4.2 `whofields/core/fieldspec`

Source

file-type.lisp.

Use List

common-lisp.

Used By List

whofields/core/all.

Public Interface

fieldspec-label (function).
fieldspec-name (function).
fieldspec-plist (function).

Next: whofields/core/all, Previous: whofields/core/fieldspec, Up: Packages [Contents][Index]

4.3 `whofields/core/render`

Source

file-type.lisp.

Use List

common-lisp.

Used By List

whofields/core/all.

Public Interface

render-field (function).

Internals

escape-value (function).
render-checkbox (function).
render-password-input (function).
render-select (function).
render-static (function).
render-text-input (function).

Previous: whofields/core/render, Up: Packages [Contents][Index]

4.4 `whofields/core/all`

Source

file-type.lisp.

Nickname

whofields

Use List

whofields/core/fieldspec.
whofields/core/render.
whofields/core/validate.

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

Ordinary functions

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

5.1.1 Ordinary functions

Function: fieldspec-label (fieldspec) ¶

Package: whofields/core/fieldspec.
Source: file-type.lisp.

Function: fieldspec-name (fieldspec) ¶

Package: whofields/core/fieldspec.
Source: file-type.lisp.

Function: fieldspec-plist (fieldspec) ¶

Package: whofields/core/fieldspec.
Source: file-type.lisp.

Function: render-field (stream fieldspec value) ¶

Package: whofields/core/render.
Source: file-type.lisp.

Function: validate-field (fieldspec value) ¶

Package: whofields/core/validate.
Source: file-type.lisp.

Function: validate-fields (fieldspecs fieldvals) ¶

Package: whofields/core/validate.
Source: file-type.lisp.

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

5.2 Internals

Ordinary functions

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

5.2.1 Ordinary functions

Function: escape-value (value) ¶

Package: whofields/core/render.
Source: file-type.lisp.

Function: render-checkbox (stream name value &key &allow-other-keys) ¶

Package: whofields/core/render.
Source: file-type.lisp.

Function: render-password-input (stream name value &key placeholder &allow-other-keys) ¶

Package: whofields/core/render.
Source: file-type.lisp.

Function: render-select (stream name value &key options test key label-function &allow-other-keys) ¶

Package: whofields/core/render.
Source: file-type.lisp.

Function: render-static (stream name value &key &allow-other-keys) ¶

Package: whofields/core/render.
Source: file-type.lisp.

Function: render-text-input (stream name value &key placeholder &allow-other-keys) ¶

Package: whofields/core/render.
Source: file-type.lisp.

Function: validate-boolean (value &key truep &allow-other-keys) ¶

Package: whofields/core/validate.
Source: file-type.lisp.

Function: validate-option (value &key options test key &allow-other-keys) ¶

Package: whofields/core/validate.
Source: file-type.lisp.

Function: validate-string (value &key validation-function &allow-other-keys) ¶

Package: whofields/core/validate.
Source: file-type.lisp.

Previous: Definitions, Up: The whofields Reference Manual [Contents][Index]

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

A.1 Concepts

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

A.2 Functions

Jump to:	E F R V

	Index Entry	Section

E
	`escape-value`:	Private ordinary functions

F
	`fieldspec-label`:	Public ordinary functions
	`fieldspec-name`:	Public ordinary functions
	`fieldspec-plist`:	Public ordinary functions
	`Function, escape-value`:	Private ordinary functions
	`Function, fieldspec-label`:	Public ordinary functions
	`Function, fieldspec-name`:	Public ordinary functions
	`Function, fieldspec-plist`:	Public ordinary functions
	`Function, render-checkbox`:	Private ordinary functions
	`Function, render-field`:	Public ordinary functions
	`Function, render-password-input`:	Private ordinary functions
	`Function, render-select`:	Private ordinary functions
	`Function, render-static`:	Private ordinary functions
	`Function, render-text-input`:	Private ordinary functions
	`Function, validate-boolean`:	Private ordinary functions
	`Function, validate-field`:	Public ordinary functions
	`Function, validate-fields`:	Public ordinary functions
	`Function, validate-option`:	Private ordinary functions
	`Function, validate-string`:	Private ordinary functions

R
	`render-checkbox`:	Private ordinary functions
	`render-field`:	Public ordinary functions
	`render-password-input`:	Private ordinary functions
	`render-select`:	Private ordinary functions
	`render-static`:	Private ordinary functions
	`render-text-input`:	Private ordinary functions

V
	`validate-boolean`:	Private ordinary functions
	`validate-field`:	Public ordinary functions
	`validate-fields`:	Public ordinary functions
	`validate-option`:	Private ordinary functions
	`validate-string`:	Private ordinary functions

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

A.3 Variables

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

A.4 Data types

Jump to:	F P S W

	Index Entry	Section

F
	`File, file-type.lisp`:	The whofields/core/all/file-type․lisp file
	`File, file-type.lisp`:	The whofields/core/fieldspec/file-type․lisp file
	`File, file-type.lisp`:	The whofields/core/render/file-type․lisp file
	`File, file-type.lisp`:	The whofields/core/validate/file-type․lisp file
	`File, whofields.asd`:	The whofields/whofields․asd file
	`file-type.lisp`:	The whofields/core/all/file-type․lisp file
	`file-type.lisp`:	The whofields/core/fieldspec/file-type․lisp file
	`file-type.lisp`:	The whofields/core/render/file-type․lisp file
	`file-type.lisp`:	The whofields/core/validate/file-type․lisp file

P
	`Package, whofields/core/all`:	The whofields/core/all package
	`Package, whofields/core/fieldspec`:	The whofields/core/fieldspec package
	`Package, whofields/core/render`:	The whofields/core/render package
	`Package, whofields/core/validate`:	The whofields/core/validate package

S
	`System, whofields`:	The whofields system
	`System, whofields/core/all`:	The whofields/core/all system
	`System, whofields/core/fieldspec`:	The whofields/core/fieldspec system
	`System, whofields/core/render`:	The whofields/core/render system
	`System, whofields/core/validate`:	The whofields/core/validate system

W
	`whofields`:	The whofields system
	`whofields.asd`:	The whofields/whofields․asd file
	`whofields/core/all`:	The whofields/core/all system
	`whofields/core/all`:	The whofields/core/all package
	`whofields/core/fieldspec`:	The whofields/core/fieldspec system
	`whofields/core/fieldspec`:	The whofields/core/fieldspec package
	`whofields/core/render`:	The whofields/core/render system
	`whofields/core/render`:	The whofields/core/render package
	`whofields/core/validate`:	The whofields/core/validate system
	`whofields/core/validate`:	The whofields/core/validate package

The whofields Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 whofields

2.2 whofields/core/all

2.3 whofields/core/fieldspec

2.4 whofields/core/render

2.5 whofields/core/validate

3 Files

3.1 Lisp

3.1.1 whofields/whofields.asd

3.1.2 whofields/core/all/file-type.lisp

3.1.3 whofields/core/fieldspec/file-type.lisp

3.1.4 whofields/core/render/file-type.lisp

3.1.5 whofields/core/validate/file-type.lisp

4 Packages

4.1 whofields/core/validate

4.2 whofields/core/fieldspec

4.3 whofields/core/render

4.4 whofields/core/all

5 Definitions

5.1 Public Interface

5.1.1 Ordinary functions

5.2 Internals

5.2.1 Ordinary functions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `whofields`

2.2 `whofields/core/all`

2.3 `whofields/core/fieldspec`

2.4 `whofields/core/render`

2.5 `whofields/core/validate`

3.1.1 `whofields/whofields.asd`

3.1.2 `whofields/core/all/file-type.lisp`

3.1.3 `whofields/core/fieldspec/file-type.lisp`

3.1.4 `whofields/core/render/file-type.lisp`

3.1.5 `whofields/core/validate/file-type.lisp`

4.1 `whofields/core/validate`

4.2 `whofields/core/fieldspec`

4.3 `whofields/core/render`

4.4 `whofields/core/all`