The thorn Reference Manual

Table of Contents

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

The thorn Reference Manual

This is the thorn Reference Manual, version 0.1, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 04:39:11 2018 GMT+0.


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

1 Introduction

Thorn

Build Status

A CommonDoc extension for inserting special characters.

Overview

Most input methods allow the user to insert characters in different alphabets and accented or modified versions of the same, but these are different for everyone and often the user will end up looking up a character by name.

Thorn is a tool for inserting Unicode characters by an ASCII name, the way TeX allows users to insert the letters α and þ with the commands \alpha and \th, respectively.

Simply put, it defines a macro that maps a string to a Unicode character.

Usage

To insert a character by name, use the l macro (For 'letter'). The content of that macro should be a single text node.

For example, in VerTeX, the following:

The fine-structure constant, \l{alpha}, is approximately 7.29e\sup{-3}.

Produces this:

The fine-structure constant, α, is approximately 7.29e-3.

List of Characters

Diacritical Marks

Acute Accent

| Name | Character | | ---- | --------- | | 'a | á | | 'A | Á | | 'c | ć | | 'C | Ć | | 'e | é | | 'E | É | | 'g | ǵ | | 'G | Ǵ | | 'i | í | | 'I | Í | | 'k | ḱ | | 'K | Ḱ | | 'l | ĺ | | 'L | Ĺ | | 'm | ḿ | | 'M | Ḿ | | 'n | ń | | 'N | Ń | | 'o | ó | | 'O | Ó | | 'p | ṕ | | 'P | Ṕ | | 'r | ŕ | | 'R | Ŕ | | 's | ś | | 'S | Ś | | 'u | ú | | 'U | Ú | | 'w | ẃ | | 'W | Ẃ | | 'y | ý | | 'Y | Ý | | 'z | ź | | 'Z | Ź |

Double Acute Accent

| Name | Character | | ---- | --------- | | ''a | a̋ | | ''A | A̋ | | ''e | e̋ | | ''E | E̋ | | ''i | i̋ | | ''I | I̋ | | ''o | ő | | ''O | Ő | | ''u | ű | | ''U | Ű |

Scripts

Greek

| Name | Character | | ---- | --------- | | alpha | α | | Alpha | Α | | beta | β | | Beta | Β | | gamma | γ | | Gamma | Γ | | delta | δ | | Delta | Δ | | epsilon | ε | | Epsilon | Ε | | zeta | ζ | | Zeta | Ζ | | eta | η | | Eta | Η | | theta | θ | | Theta | Θ | | iota | ι | | Iota | Ι | | kappa | κ | | Kappa | Κ | | lambda | λ | | Lambda | Λ | | mu | μ | | Mu | Μ | | nu | ν | | Nu | Ν | | xi | ξ | | Xi | Ξ | | omicron | ο | | Omicron | Ο | | pi | π | | Pi | Π | | rho | ρ | | Rho | Ρ | | sigma | σ | | fsigma | ς | | Sigma | Σ | | tau | τ | | Tau | Τ | | upsilon | υ | | Upsilon | Υ | | phi | φ | | Phi | Φ | | chi | χ | | Chi | Χ | | psi | ψ | | Psi | Ψ | | omega | ω | | Omega | Ω |

Punctuation

| Name | Character | | ---- | --------- | | ndash | – | | mdash | — | | sdash | ⁓ |

Sources

The following were consulted in the elaboration of this list:


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

2 Systems

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


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

2.1 thorn

Maintainer

Fernando Borretti <eudoxiahp@gmail.com>

Author

Fernando Borretti <eudoxiahp@gmail.com>

Home Page

https://github.com/CommonDoc/thorn

Source Control

(:git "git@github.com:commondoc/thorn.git")

Bug Tracker

https://github.com/CommonDoc/thorn/issues

License

MIT

Description

A CommonDoc extension for entering special characters.

Long Description

# Thorn

[![Build Status](https://travis-ci.org/CommonDoc/thorn.svg?branch=master)](https://travis-ci.org/CommonDoc/thorn)

A CommonDoc extension for inserting special characters.

# Overview

Most input methods allow the user to insert characters in different alphabets
and accented or modified versions of the same, but these are different for
everyone and often the user will end up looking up a character by name.

Thorn is a tool for inserting Unicode characters by an ASCII name, the way TeX
allows users to insert the letters α and þ with the commands ‘\alpha‘ and ‘\th‘,
respectively.

Simply put, it defines a macro that maps a string to a Unicode character.

# Usage

To insert a character by name, use the ‘l‘ macro (For ’letter’). The content of
that macro should be a single text node.

For example, in VerTeX, the following:

“‘tex
The fine-structure constant, \l{alpha}, is approximately 7.29e\sup{-3}.
“‘

Produces this:

>The fine-structure constant, α, is approximately 7.29e<sup>-3</sup>.

# List of Characters

## Diacritical Marks

### Acute Accent

| Name | Character |
| —- | ——— |
| “‘ ’a “‘ | á |
| “‘ ’A “‘ | Á |
| “‘ ’c “‘ | ć |
| “‘ ’C “‘ | Ć |
| “‘ ’e “‘ | é |
| “‘ ’E “‘ | É |
| “‘ ’g “‘ | ǵ |
| “‘ ’G “‘ | Ǵ |
| “‘ ’i “‘ | í |
| “‘ ’I “‘ | Í |
| “‘ ’k “‘ | ḱ |
| “‘ ’K “‘ | Ḱ |
| “‘ ’l “‘ | ĺ |
| “‘ ’L “‘ | Ĺ |
| “‘ ’m “‘ | ḿ |
| “‘ ’M “‘ | Ḿ |
| “‘ ’n “‘ | ń |
| “‘ ’N “‘ | Ń |
| “‘ ’o “‘ | ó |
| “‘ ’O “‘ | Ó |
| “‘ ’p “‘ | ṕ |
| “‘ ’P “‘ | Ṕ |
| “‘ ’r “‘ | ŕ |
| “‘ ’R “‘ | Ŕ |
| “‘ ’s “‘ | ś |
| “‘ ’S “‘ | Ś |
| “‘ ’u “‘ | ú |
| “‘ ’U “‘ | Ú |
| “‘ ’w “‘ | ẃ |
| “‘ ’W “‘ | Ẃ |
| “‘ ’y “‘ | ý |
| “‘ ’Y “‘ | Ý |
| “‘ ’z “‘ | ź |
| “‘ ’Z “‘ | Ź |

### Double Acute Accent

| Name | Character |
| —- | ——— |
| “‘ ”a “‘ | a̋ |
| “‘ ”A “‘ | A̋ |
| “‘ ”e “‘ | e̋ |
| “‘ ”E “‘ | E̋ |
| “‘ ”i “‘ | i̋ |
| “‘ ”I “‘ | I̋ |
| “‘ ”o “‘ | ő |
| “‘ ”O “‘ | Ő |
| “‘ ”u “‘ | ű |
| “‘ ”U “‘ | Ű |

## Scripts

### Greek

| Name | Character |
| —- | ——— |
| “‘ alpha “‘ | α |
| “‘ Alpha “‘ | Α |
| “‘ beta “‘ | β |
| “‘ Beta “‘ | Β |
| “‘ gamma “‘ | γ |
| “‘ Gamma “‘ | Γ |
| “‘ delta “‘ | δ |
| “‘ Delta “‘ | Δ |
| “‘ epsilon “‘ | ε |
| “‘ Epsilon “‘ | Ε |
| “‘ zeta “‘ | ζ |
| “‘ Zeta “‘ | Ζ |
| “‘ eta “‘ | η |
| “‘ Eta “‘ | Η |
| “‘ theta “‘ | θ |
| “‘ Theta “‘ | Θ |
| “‘ iota “‘ | ι |
| “‘ Iota “‘ | Ι |
| “‘ kappa “‘ | κ |
| “‘ Kappa “‘ | Κ |
| “‘ lambda “‘ | λ |
| “‘ Lambda “‘ | Λ |
| “‘ mu “‘ | μ |
| “‘ Mu “‘ | Μ |
| “‘ nu “‘ | ν |
| “‘ Nu “‘ | Ν |
| “‘ xi “‘ | ξ |
| “‘ Xi “‘ | Ξ |
| “‘ omicron “‘ | ο |
| “‘ Omicron “‘ | Ο |
| “‘ pi “‘ | π |
| “‘ Pi “‘ | Π |
| “‘ rho “‘ | ρ |
| “‘ Rho “‘ | Ρ |
| “‘ sigma “‘ | σ |
| “‘ fsigma “‘ | ς |
| “‘ Sigma “‘ | Σ |
| “‘ tau “‘ | τ |
| “‘ Tau “‘ | Τ |
| “‘ upsilon “‘ | υ |
| “‘ Upsilon “‘ | Υ |
| “‘ phi “‘ | φ |
| “‘ Phi “‘ | Φ |
| “‘ chi “‘ | χ |
| “‘ Chi “‘ | Χ |
| “‘ psi “‘ | ψ |
| “‘ Psi “‘ | Ψ |
| “‘ omega “‘ | ω |
| “‘ Omega “‘ | Ω |

## Punctuation

| Name | Character |
| —- | ——— |
| “‘ ndash “‘ | – |
| “‘ mdash “‘ | — |
| “‘ sdash “‘ | ⁓ |

# Sources

The following were consulted in the elaboration of this list:

* [Special Characters][latex-special] chapter in the LaTeX wikibook.
* The [list of XML/HTML entities][entities].
* The [Comprehensive LaTeX Symbol List][symbols].

[latex-special]: https://en.wikibooks.org/wiki/LaTeX/Special_Characters
[entities]: https://en.wikipedia.org/wiki/List_of_XML_and_HTML_character_entity_references
[symbols]: http://ctan.mirror.rafal.ca/info/symbols/comprehensive/symbols-a4.pdf

# License

Copyright (c) 2015 Fernando Borretti

Licensed under the MIT License.

Version

0.1

Dependency

common-doc

Source

thorn.asd (file)

Component

src (module)


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

3 Modules

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


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

3.1 thorn/src

Parent

thorn (system)

Location

src/

Component

thorn.lisp (file)


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

4 Files

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


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

4.1 Lisp


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

4.1.1 thorn.asd

Location

thorn.asd

Systems

thorn (system)


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

4.1.2 thorn/src/thorn.lisp

Parent

src (module)

Location

src/thorn.lisp

Packages

thorn

Exported Definitions
Internal Definitions

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

5 Packages

Packages are listed by definition order.


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

5.1 thorn

The main package of Thorn.

Source

thorn.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

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

6 Definitions

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


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

6.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.1 Special variables

Special Variable: *character-table*

A hash table that maps the name of a character to its resulting string.

Package

thorn

Source

thorn.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

6.1.2 Classes

Class: letter ()

Letter macro.

Package

thorn

Source

thorn.lisp (file)

Direct superclasses

macro-node (class)

Direct methods

expand-macro (method)


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

6.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.1 Special variables

Special Variable: *characters*
Package

thorn

Source

thorn.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

6.2.2 Functions

Function: build-character-table ()

Recur through *characters*, building a hash table of characters.

Package

thorn

Source

thorn.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   M   T  
Index Entry  Section

F
File, Lisp, thorn.asd: The thorn<dot>asd file
File, Lisp, thorn/src/thorn.lisp: The thorn/src/thorn<dot>lisp file

L
Lisp File, thorn.asd: The thorn<dot>asd file
Lisp File, thorn/src/thorn.lisp: The thorn/src/thorn<dot>lisp file

M
Module, thorn/src: The thorn/src module

T
thorn.asd: The thorn<dot>asd file
thorn/src: The thorn/src module
thorn/src/thorn.lisp: The thorn/src/thorn<dot>lisp file

Jump to:   F   L   M   T  

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

A.2 Functions

Jump to:   B   F  
Index Entry  Section

B
build-character-table: Internal functions

F
Function, build-character-table: Internal functions

Jump to:   B   F  

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

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*character-table*: Exported special variables
*characters*: Internal special variables

S
Special Variable, *character-table*: Exported special variables
Special Variable, *characters*: Internal special variables

Jump to:   *  
S  

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

A.4 Data types

Jump to:   C   L   P   S   T  
Index Entry  Section

C
Class, letter: Exported classes

L
letter: Exported classes

P
Package, thorn: The thorn package

S
System, thorn: The thorn system

T
thorn: The thorn system
thorn: The thorn package

Jump to:   C   L   P   S   T