The html-entities Reference Manual

This is the html-entities Reference Manual, version 0.2, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 05:31:36 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 html-entities

A module for encoding and decoding HTML/XML/SGML entities.

Author

Aaron Sokoloski <>

License

MIT License

Version

0.2

Dependency

cl-ppcre (system).

Source

html-entities.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 html-entities/html-entities.asd

Source

html-entities.asd.

Parent Component

html-entities (system).

ASDF Systems

html-entities.

Packages

html-entities-asd.


3.1.2 html-entities/packages.lisp

Source

html-entities.asd.

Parent Component

html-entities (system).

Packages

html-entities.


3.1.3 html-entities/entity-tables.lisp

Dependency

packages.lisp (file).

Source

html-entities.asd.

Parent Component

html-entities (system).

Internals

3.1.4 html-entities/html-entities.lisp

Dependencies
Source

html-entities.asd.

Parent Component

html-entities (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 html-entities-asd

Source

html-entities.asd.

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

4.2 html-entities

Main package for html-entities.

Source

packages.lisp.

Use List
  • cl-ppcre.
  • common-lisp.
Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Special variables

Special Variable: *enable-sgml*

Encode and decode using SGML entity names, of which HTML entity names are almost a subset (&apos; is different).

Package

html-entities.

Source

html-entities.lisp.

Special Variable: *encode-in-hexadecimal*

When a symbolic name is not available, use hexadecimal-based integers: &#xE1; instead of &#225; .

Package

html-entities.

Source

html-entities.lisp.

Special Variable: *encode-using-named-entities*

Use symbolic names, such as &aacute; , rather than &#225; or &#xE1; .

Package

html-entities.

Source

html-entities.lisp.


5.1.2 Ordinary functions

Function: char-of-name (name)
Package

html-entities.

Source

html-entities.lisp.

Function: char-to-entity (char-or-string)
Package

html-entities.

Source

html-entities.lisp.

Function: decode-entities (html)

Decodes all entites in HTML.

Package

html-entities.

Source

html-entities.lisp.

Function: encode-entities (html &key regex)

Encodes entites in HTML. Defaults to pretty much everything you can, but you can pass a regex like "[<>&\"]" to only encode the basics.

Package

html-entities.

Source

html-entities.lisp.

Function: entity-to-char (string)
Package

html-entities.

Source

html-entities.lisp.

Function: name-of-char (char)
Package

html-entities.

Source

html-entities.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *char-to-name*
Package

html-entities.

Source

html-entities.lisp.

Special Variable: *entity-definitions*
Package

html-entities.

Source

entity-tables.lisp.

Special Variable: *escape-all*
Package

html-entities.

Source

html-entities.lisp.

Special Variable: *name-to-char*
Package

html-entities.

Source

html-entities.lisp.

Special Variable: *sgml-char-to-name*
Package

html-entities.

Source

html-entities.lisp.

Special Variable: *sgml-entity-definitions*
Package

html-entities.

Source

entity-tables.lisp.

Special Variable: *sgml-name-to-char*
Package

html-entities.

Source

html-entities.lisp.


5.2.2 Ordinary functions

Function: init-hashes ()
Package

html-entities.

Source

html-entities.lisp.


Appendix A Indexes


A.1 Concepts