Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the thorn Reference Manual, version 0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 15:15:06 2020 GMT+0.
• Introduction | What thorn is all about | |
• Systems | The systems documentation | |
• Modules | The modules documentation | |
• Files | The files documentation | |
• Packages | The packages documentation | |
• Definitions | The symbols documentation | |
• Indexes | Concepts, functions, variables and data types |
A CommonDoc extension for inserting special characters.
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.
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.
| 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
| Ź |
| Name | Character |
| ---- | --------- |
| ''a
| a̋ |
| ''A
| A̋ |
| ''e
| e̋ |
| ''E
| E̋ |
| ''i
| i̋ |
| ''I
| I̋ |
| ''o
| ő |
| ''O
| Ő |
| ''u
| ű |
| ''U
| Ű |
| 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
| Ω |
| Name | Character |
| ---- | --------- |
| ndash
| – |
| mdash
| — |
| sdash
| ⁓ |
The following were consulted in the elaboration of this list:
Next: Modules, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
• The thorn system |
Fernando Borretti <eudoxiahp@gmail.com>
Fernando Borretti <eudoxiahp@gmail.com>
(:git "git@github.com:commondoc/thorn.git")
MIT
A CommonDoc extension for entering special characters.
# Thorn
[](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.
0.1
common-doc
thorn.asd (file)
src (module)
Modules are listed depth-first from the system components tree.
• The thorn/src module |
thorn (system)
src/
thorn.lisp (file)
Files are sorted by type and then listed depth-first from the systems components trees.
• Lisp files |
• The thorn.asd file | ||
• The thorn/src/thorn.lisp file |
Next: The thorn/src/thorn․lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
thorn.asd
thorn (system)
Previous: The thorn․asd file, Up: Lisp files [Contents][Index]
src (module)
src/thorn.lisp
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
• The thorn package |
The main package of Thorn.
thorn.lisp (file)
common-lisp
Definitions are sorted by export status, category, package, and then by lexicographic order.
• Exported definitions | ||
• Internal definitions |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
• Exported special variables | ||
• Exported classes |
Next: Exported classes, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
A hash table that maps the name of a character to its resulting string.
thorn.lisp (file)
Previous: Exported special variables, Up: Exported definitions [Contents][Index]
Letter macro.
thorn.lisp (file)
macro-node (class)
expand-macro (method)
Previous: Exported definitions, Up: Definitions [Contents][Index]
• Internal special variables | ||
• Internal functions |
Next: Internal functions, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
thorn.lisp (file)
Previous: Internal special variables, Up: Internal definitions [Contents][Index]
Recur through *characters*, building a hash table of characters.
thorn.lisp (file)
Previous: Definitions, Up: Top [Contents][Index]
• Concept index | ||
• Function index | ||
• Variable index | ||
• Data type index |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
Jump to: | F L M T |
---|
Jump to: | F L M T |
---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
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: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
Jump to: | *
S |
---|
Jump to: | *
S |
---|
Previous: Variable index, Up: Indexes [Contents][Index]
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 |
---|