lisp/org-entities.el

   1 ;;; org-entities.el --- Support for special entities in Org-mode
   2
   3 ;; Copyright (C) 2010-2015 Free Software Foundation, Inc.
   4
   5 ;; Author: Carsten Dominik <carsten at orgmode dot org>,
   6 ;;         Ulf Stegemann <ulf at zeitform dot de>
   7 ;; Keywords: outlines, calendar, wp
   8 ;; Homepage: http://orgmode.org
   9 ;;
  10 ;; This file is part of GNU Emacs.
  11 ;;
  12 ;; GNU Emacs is free software: you can redistribute it and/or modify
  13 ;; it under the terms of the GNU General Public License as published by
  14 ;; the Free Software Foundation, either version 3 of the License, or
  15 ;; (at your option) any later version.
  16
  17 ;; GNU Emacs is distributed in the hope that it will be useful,
  18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 ;; GNU General Public License for more details.
  21
  22 ;; You should have received a copy of the GNU General Public License
  23 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  24 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  25 ;;
  26 ;;; Commentary:
  27
  28 ;;; Code:
  29
  30 (declare-function org-toggle-pretty-entities "org"       ())
  31 (declare-function org-table-align            "org-table" ())
  32
  33 (eval-when-compile
  34   (require 'cl))
  35
  36 (defgroup org-entities nil
  37   "Options concerning entities in Org-mode."
  38   :tag "Org Entities"
  39   :group 'org)
  40
  41 (defun org-entities--user-safe-p (v)
  42   "Non-nil if V is a safe value for `org-entities-user'."
  43   (or (null v)
  44       (and (listp v)
  45            (= (length v) 7)
  46            (stringp (nth 0 v))
  47            (stringp (nth 1 v))
  48            (booleanp (nth 2 v))
  49            (stringp (nth 3 v))
  50            (stringp (nth 4 v))
  51            (stringp (nth 5 v))
  52            (stringp (nth 6 v)))))
  53
  54 (defcustom org-entities-user nil
  55   "User-defined entities used in Org-mode to produce special characters.
  56 Each entry in this list is a list of strings.  It associates the name
  57 of the entity that can be inserted into an Org file as \\name with the
  58 appropriate replacements for the different export backends.  The order
  59 of the fields is the following
  60
  61 name                 As a string, without the leading backslash.
  62 LaTeX replacement    In ready LaTeX, no further processing will take place.
  63 LaTeX mathp          Either t or nil.  When t this entity needs to be in
  64                      math mode.
  65 HTML replacement     In ready HTML, no further processing will take place.
  66                      Usually this will be an &...; entity.
  67 ASCII replacement    Plain ASCII, no extensions.
  68 Latin1 replacement   Use the special characters available in latin1.
  69 utf-8 replacement    Use the special characters available in utf-8.
  70
  71 If you define new entities here that require specific LaTeX
  72 packages to be loaded, add these packages to `org-latex-packages-alist'."
  73   :group 'org-entities
  74   :version "24.1"
  75   :type '(repeat
  76           (list
  77            (string :tag "name  ")
  78            (string :tag "LaTeX ")
  79            (boolean :tag "Require LaTeX math?")
  80            (string :tag "HTML  ")
  81            (string :tag "ASCII ")
  82            (string :tag "Latin1")
  83            (string :tag "utf-8 ")))
  84   :safe #'org-entities--user-safe-p)
  85
  86 (defconst org-entities
  87   (append
  88    '("* Letters"
  89      "** Latin"
  90      ("Agrave" "\\`{A}" nil "&Agrave;" "A" "À" "À")
  91      ("agrave" "\\`{a}" nil "&agrave;" "a" "à" "à")
  92      ("Aacute" "\\'{A}" nil "&Aacute;" "A" "Á" "Á")
  93      ("aacute" "\\'{a}" nil "&aacute;" "a" "á" "á")
  94      ("Acirc" "\\^{A}" nil "&Acirc;" "A" "Â" "Â")
  95      ("acirc" "\\^{a}" nil "&acirc;" "a" "â" "â")
  96      ("Atilde" "\\~{A}" nil "&Atilde;" "A" "Ã" "Ã")
  97      ("atilde" "\\~{a}" nil "&atilde;" "a" "ã" "ã")
  98      ("Auml" "\\\"{A}" nil "&Auml;" "Ae" "Ä" "Ä")
  99      ("auml" "\\\"{a}" nil "&auml;" "ae" "ä" "ä")
 100      ("Aring" "\\AA{}" nil "&Aring;" "A" "Å" "Å")
 101      ("AA" "\\AA{}" nil "&Aring;" "A" "Å" "Å")
 102      ("aring" "\\aa{}" nil "&aring;" "a" "å" "å")
 103      ("AElig" "\\AE{}" nil "&AElig;" "AE" "Æ" "Æ")
 104      ("aelig" "\\ae{}" nil "&aelig;" "ae" "æ" "æ")
 105      ("Ccedil" "\\c{C}" nil "&Ccedil;" "C" "Ç" "Ç")
 106      ("ccedil" "\\c{c}" nil "&ccedil;" "c" "ç" "ç")
 107      ("Egrave" "\\`{E}" nil "&Egrave;" "E" "È" "È")
 108      ("egrave" "\\`{e}" nil "&egrave;" "e" "è" "è")
 109      ("Eacute" "\\'{E}" nil "&Eacute;" "E" "É" "É")
 110      ("eacute" "\\'{e}" nil "&eacute;" "e" "é" "é")
 111      ("Ecirc" "\\^{E}" nil "&Ecirc;" "E" "Ê" "Ê")
 112      ("ecirc" "\\^{e}" nil "&ecirc;" "e" "ê" "ê")
 113      ("Euml" "\\\"{E}" nil "&Euml;" "E" "Ë" "Ë")
 114      ("euml" "\\\"{e}" nil "&euml;" "e" "ë" "ë")
 115      ("Igrave" "\\`{I}" nil "&Igrave;" "I" "Ì" "Ì")
 116      ("igrave" "\\`{i}" nil "&igrave;" "i" "ì" "ì")
 117      ("Iacute" "\\'{I}" nil "&Iacute;" "I" "Í" "Í")
 118      ("iacute" "\\'{i}" nil "&iacute;" "i" "í" "í")
 119      ("Icirc" "\\^{I}" nil "&Icirc;" "I" "Î" "Î")
 120      ("icirc" "\\^{i}" nil "&icirc;" "i" "î" "î")
 121      ("Iuml" "\\\"{I}" nil "&Iuml;" "I" "Ï" "Ï")
 122      ("iuml" "\\\"{i}" nil "&iuml;" "i" "ï" "ï")
 123      ("Ntilde" "\\~{N}" nil "&Ntilde;" "N" "Ñ" "Ñ")
 124      ("ntilde" "\\~{n}" nil "&ntilde;" "n" "ñ" "ñ")
 125      ("Ograve" "\\`{O}" nil "&Ograve;" "O" "Ò" "Ò")
 126      ("ograve" "\\`{o}" nil "&ograve;" "o" "ò" "ò")
 127      ("Oacute" "\\'{O}" nil "&Oacute;" "O" "Ó" "Ó")
 128      ("oacute" "\\'{o}" nil "&oacute;" "o" "ó" "ó")
 129      ("Ocirc" "\\^{O}" nil "&Ocirc;" "O" "Ô" "Ô")
 130      ("ocirc" "\\^{o}" nil "&ocirc;" "o" "ô" "ô")
 131      ("Otilde" "\\~{O}" nil "&Otilde;" "O" "Õ" "Õ")
 132      ("otilde" "\\~{o}" nil "&otilde;" "o" "õ" "õ")
 133      ("Ouml" "\\\"{O}" nil "&Ouml;" "Oe" "Ö" "Ö")
 134      ("ouml" "\\\"{o}" nil "&ouml;" "oe" "ö" "ö")
 135      ("Oslash" "\\O" nil "&Oslash;" "O" "Ø" "Ø")
 136      ("oslash" "\\o{}" nil "&oslash;" "o" "ø" "ø")
 137      ("OElig" "\\OE{}" nil "&OElig;" "OE" "OE" "Œ")
 138      ("oelig" "\\oe{}" nil "&oelig;" "oe" "oe" "œ")
 139      ("Scaron" "\\v{S}" nil "&Scaron;" "S" "S" "Š")
 140      ("scaron" "\\v{s}" nil "&scaron;" "s" "s" "š")
 141      ("szlig" "\\ss{}" nil "&szlig;" "ss" "ß" "ß")
 142      ("Ugrave" "\\`{U}" nil "&Ugrave;" "U" "Ù" "Ù")
 143      ("ugrave" "\\`{u}" nil "&ugrave;" "u" "ù" "ù")
 144      ("Uacute" "\\'{U}" nil "&Uacute;" "U" "Ú" "Ú")
 145      ("uacute" "\\'{u}" nil "&uacute;" "u" "ú" "ú")
 146      ("Ucirc" "\\^{U}" nil "&Ucirc;" "U" "Û" "Û")
 147      ("ucirc" "\\^{u}" nil "&ucirc;" "u" "û" "û")
 148      ("Uuml" "\\\"{U}" nil "&Uuml;" "Ue" "Ü" "Ü")
 149      ("uuml" "\\\"{u}" nil "&uuml;" "ue" "ü" "ü")
 150      ("Yacute" "\\'{Y}" nil "&Yacute;" "Y" "Ý" "Ý")
 151      ("yacute" "\\'{y}" nil "&yacute;" "y" "ý" "ý")
 152      ("Yuml" "\\\"{Y}" nil "&Yuml;" "Y" "Y" "Ÿ")
 153      ("yuml" "\\\"{y}" nil "&yuml;" "y" "ÿ" "ÿ")
 154
 155      "** Latin (special face)"
 156      ("fnof" "\\textit{f}" nil "&fnof;" "f" "f" "ƒ")
 157      ("real" "\\Re" t "&real;" "R" "R" "ℜ")
 158      ("image" "\\Im" t "&image;" "I" "I" "ℑ")
 159      ("weierp" "\\wp" t "&weierp;" "P" "P" "℘")
 160      ("ell" "\\ell" t "&ell;" "ell" "ell" "ℓ")
 161      ("imath" "\\imath" t "&imath;" "[dotless i]" "dotless i" "ı")
 162      ("jmath" "\\jmath" t "&jmath;" "[dotless j]" "dotless j" "ȷ")
 163
 164      "** Greek"
 165      ("Alpha" "A" nil "&Alpha;" "Alpha" "Alpha" "Α")
 166      ("alpha" "\\alpha" t "&alpha;" "alpha" "alpha" "α")
 167      ("Beta" "B" nil "&Beta;" "Beta" "Beta" "Β")
 168      ("beta" "\\beta" t "&beta;" "beta" "beta" "β")
 169      ("Gamma" "\\Gamma" t "&Gamma;" "Gamma" "Gamma" "Γ")
 170      ("gamma" "\\gamma" t "&gamma;" "gamma" "gamma" "γ")
 171      ("Delta" "\\Delta" t "&Delta;" "Delta" "Gamma" "Δ")
 172      ("delta" "\\delta" t "&delta;" "delta" "delta" "δ")
 173      ("Epsilon" "E" nil "&Epsilon;" "Epsilon" "Epsilon" "Ε")
 174      ("epsilon" "\\epsilon" t "&epsilon;" "epsilon" "epsilon" "ε")
 175      ("varepsilon" "\\varepsilon" t "&epsilon;" "varepsilon" "varepsilon" "ε")
 176      ("Zeta" "Z" nil "&Zeta;" "Zeta" "Zeta" "Ζ")
 177      ("zeta" "\\zeta" t "&zeta;" "zeta" "zeta" "ζ")
 178      ("Eta" "H" nil "&Eta;" "Eta" "Eta" "Η")
 179      ("eta" "\\eta" t "&eta;" "eta" "eta" "η")
 180      ("Theta" "\\Theta" t "&Theta;" "Theta" "Theta" "Θ")
 181      ("theta" "\\theta" t "&theta;" "theta" "theta" "θ")
 182      ("thetasym" "\\vartheta" t "&thetasym;" "theta" "theta" "ϑ")
 183      ("vartheta" "\\vartheta" t "&thetasym;" "theta" "theta" "ϑ")
 184      ("Iota" "I" nil "&Iota;" "Iota" "Iota" "Ι")
 185      ("iota" "\\iota" t "&iota;" "iota" "iota" "ι")
 186      ("Kappa" "K" nil "&Kappa;" "Kappa" "Kappa" "Κ")
 187      ("kappa" "\\kappa" t "&kappa;" "kappa" "kappa" "κ")
 188      ("Lambda" "\\Lambda" t "&Lambda;" "Lambda" "Lambda" "Λ")
 189      ("lambda" "\\lambda" t "&lambda;" "lambda" "lambda" "λ")
 190      ("Mu" "M" nil "&Mu;" "Mu" "Mu" "Μ")
 191      ("mu" "\\mu" t "&mu;" "mu" "mu" "μ")
 192      ("nu" "\\nu" t "&nu;" "nu" "nu" "ν")
 193      ("Nu" "N" nil "&Nu;" "Nu" "Nu" "Ν")
 194      ("Xi" "\\Xi" t "&Xi;" "Xi" "Xi" "Ξ")
 195      ("xi" "\\xi" t "&xi;" "xi" "xi" "ξ")
 196      ("Omicron" "O" nil "&Omicron;" "Omicron" "Omicron" "Ο")
 197      ("omicron" "\\textit{o}" nil "&omicron;" "omicron" "omicron" "ο")
 198      ("Pi" "\\Pi" t "&Pi;" "Pi" "Pi" "Π")
 199      ("pi" "\\pi" t "&pi;" "pi" "pi" "π")
 200      ("Rho" "P" nil "&Rho;" "Rho" "Rho" "Ρ")
 201      ("rho" "\\rho" t "&rho;" "rho" "rho" "ρ")
 202      ("Sigma" "\\Sigma" t "&Sigma;" "Sigma" "Sigma" "Σ")
 203      ("sigma" "\\sigma" t "&sigma;" "sigma" "sigma" "σ")
 204      ("sigmaf" "\\varsigma" t "&sigmaf;" "sigmaf" "sigmaf" "ς")
 205      ("varsigma" "\\varsigma" t "&sigmaf;" "varsigma" "varsigma" "ς")
 206      ("Tau" "T" nil "&Tau;" "Tau" "Tau" "Τ")
 207      ("Upsilon" "\\Upsilon" t "&Upsilon;" "Upsilon" "Upsilon" "Υ")
 208      ("upsih" "\\Upsilon" t "&upsih;" "upsilon" "upsilon" "ϒ")
 209      ("upsilon" "\\upsilon" t "&upsilon;" "upsilon" "upsilon" "υ")
 210      ("Phi" "\\Phi" t "&Phi;" "Phi" "Phi" "Φ")
 211      ("phi" "\\phi" t "&phi;" "phi" "phi" "φ")
 212      ("varphi" "\\varphi" t "&varphi;" "varphi" "varphi" "ɸ")
 213      ("Chi" "X" nil "&Chi;" "Chi" "Chi" "Χ")
 214      ("chi" "\\chi" t "&chi;" "chi" "chi" "χ")
 215      ("acutex" "\\acute x" t "&acute;x" "'x" "'x" "𝑥́")
 216      ("Psi" "\\Psi" t "&Psi;" "Psi" "Psi" "Ψ")
 217      ("psi" "\\psi" t "&psi;" "psi" "psi" "ψ")
 218      ("tau" "\\tau" t "&tau;" "tau" "tau" "τ")
 219      ("Omega" "\\Omega" t "&Omega;" "Omega" "Omega" "Ω")
 220      ("omega" "\\omega" t "&omega;" "omega" "omega" "ω")
 221      ("piv" "\\varpi" t "&piv;" "omega-pi" "omega-pi" "ϖ")
 222      ("varpi" "\\varpi" t "&piv;" "omega-pi" "omega-pi" "ϖ")
 223      ("partial" "\\partial" t "&part;" "[partial differential]" "[partial differential]" "∂")
 224
 225      "** Hebrew"
 226      ("alefsym" "\\aleph" t "&alefsym;" "aleph" "aleph" "ℵ")
 227      ("aleph" "\\aleph" t "&aleph;" "aleph" "aleph" "ℵ")
 228      ("gimel" "\\gimel" t "&gimel;" "gimel" "gimel" "ℷ")
 229      ("beth" "\\beth" t "&beth;" "beth" "beth" "ב")
 230      ("dalet" "\\daleth" t "&daleth;" "dalet" "dalet" "ד")
 231
 232      "** Dead languages"
 233      ("ETH" "\\DH{}" nil "&ETH;" "D" "Ð" "Ð")
 234      ("eth" "\\dh{}" nil "&eth;" "dh" "ð" "ð")
 235      ("THORN" "\\TH{}" nil "&THORN;" "TH" "Þ" "Þ")
 236      ("thorn" "\\th{}" nil "&thorn;" "th" "þ" "þ")
 237
 238      "* Punctuation"
 239      "** Dots and Marks"
 240      ("dots" "\\dots{}" nil "&hellip;" "..." "..." "…")
 241      ("cdots" "\\cdots{}" t "&ctdot;" "..." "..." "⋯")
 242      ("hellip" "\\dots{}" nil "&hellip;" "..." "..." "…")
 243      ("middot" "\\textperiodcentered{}" nil "&middot;" "." "·" "·")
 244      ("iexcl" "!`" nil "&iexcl;" "!" "¡" "¡")
 245      ("iquest" "?`" nil "&iquest;" "?" "¿" "¿")
 246
 247      "** Dash-like"
 248      ("shy" "\\-" nil "&shy;" "" "" "")
 249      ("ndash" "--" nil "&ndash;" "-" "-" "–")
 250      ("mdash" "---" nil "&mdash;" "--" "--" "—")
 251
 252      "** Quotations"
 253      ("quot" "\\textquotedbl{}" nil "&quot;" "\"" "\"" "\"")
 254      ("acute" "\\textasciiacute{}" nil "&acute;" "'" "´" "´")
 255      ("ldquo" "\\textquotedblleft{}" nil "&ldquo;" "\"" "\"" "“")
 256      ("rdquo" "\\textquotedblright{}" nil "&rdquo;" "\"" "\"" "”")
 257      ("bdquo" "\\quotedblbase{}" nil "&bdquo;" "\"" "\"" "„")
 258      ("lsquo" "\\textquoteleft{}" nil "&lsquo;" "`" "`" "‘")
 259      ("rsquo" "\\textquoteright{}" nil "&rsquo;" "'" "'" "’")
 260      ("sbquo" "\\quotesinglbase{}" nil "&sbquo;" "," "," "‚")
 261      ("laquo" "\\guillemotleft{}" nil "&laquo;" "<<" "«" "«")
 262      ("raquo" "\\guillemotright{}" nil "&raquo;" ">>" "»" "»")
 263      ("lsaquo" "\\guilsinglleft{}" nil "&lsaquo;" "<" "<" "‹")
 264      ("rsaquo" "\\guilsinglright{}" nil "&rsaquo;" ">" ">" "›")
 265
 266      "* Other"
 267      "** Misc. (often used)"
 268      ("circ" "\\^{}" nil "&circ;" "^" "^" "ˆ")
 269      ("vert" "\\vert{}" t "&vert;" "|" "|" "|")
 270      ("brvbar" "\\textbrokenbar{}" nil "&brvbar;" "|" "¦" "¦")
 271      ("S" "\\S" nil "&sect;" "paragraph" "§" "§")
 272      ("sect" "\\S" nil "&sect;" "paragraph" "§" "§")
 273      ("amp" "\\&" nil "&amp;" "&" "&" "&")
 274      ("lt" "\\textless{}" nil "&lt;" "<" "<" "<")
 275      ("gt" "\\textgreater{}" nil "&gt;" ">" ">" ">")
 276      ("tilde" "\\textasciitilde{}" nil "~" "~" "~" "~")
 277      ("slash" "/" nil "/" "/" "/" "/")
 278      ("plus" "+" nil "+" "+" "+" "+")
 279      ("under" "\\_" nil "_" "_" "_" "_")
 280      ("equal" "=" nil "=" "=" "=" "=")
 281      ("asciicirc" "\\textasciicircum{}" nil "^" "^" "^" "^")
 282      ("dagger" "\\textdagger{}" nil "&dagger;" "[dagger]" "[dagger]" "†")
 283      ("dag" "\\dag{}" nil "&dagger;" "[dagger]" "[dagger]" "†")
 284      ("Dagger" "\\textdaggerdbl{}" nil "&Dagger;" "[doubledagger]" "[doubledagger]" "‡")
 285      ("ddag" "\\ddag{}" nil "&Dagger;" "[doubledagger]" "[doubledagger]" "‡")
 286
 287      "** Whitespace"
 288      ("nbsp" "~" nil "&nbsp;" " " " " " ")
 289      ("ensp" "\\hspace*{.5em}" nil "&ensp;" " " " " " ")
 290      ("emsp" "\\hspace*{1em}" nil "&emsp;" " " " " " ")
 291      ("thinsp" "\\hspace*{.2em}" nil "&thinsp;" " " " " " ")
 292
 293      "** Currency"
 294      ("curren" "\\textcurrency{}" nil "&curren;" "curr." "¤" "¤")
 295      ("cent" "\\textcent{}" nil "&cent;" "cent" "¢" "¢")
 296      ("pound" "\\pounds{}" nil "&pound;" "pound" "£" "£")
 297      ("yen" "\\textyen{}" nil "&yen;" "yen" "¥" "¥")
 298      ("euro" "\\texteuro{}" nil "&euro;" "EUR" "EUR" "€")
 299      ("EUR" "\\texteuro{}" nil "&euro;" "EUR" "EUR" "€")
 300
 301      "** Property Marks"
 302      ("copy" "\\textcopyright{}" nil "&copy;" "(c)" "©" "©")
 303      ("reg" "\\textregistered{}" nil "&reg;" "(r)" "®" "®")
 304      ("trade" "\\texttrademark{}" nil "&trade;" "TM" "TM" "™")
 305
 306      "** Science et al."
 307      ("minus" "\\minus" t "&minus;" "-" "-" "−")
 308      ("pm" "\\textpm{}" nil "&plusmn;" "+-" "±" "±")
 309      ("plusmn" "\\textpm{}" nil "&plusmn;" "+-" "±" "±")
 310      ("times" "\\texttimes{}" nil "&times;" "*" "×" "×")
 311      ("frasl" "/" nil "&frasl;" "/" "/" "⁄")
 312      ("colon" "\\colon" t ":" ":" ":" ":")
 313      ("div" "\\textdiv{}" nil "&divide;" "/" "÷" "÷")
 314      ("frac12" "\\textonehalf{}" nil "&frac12;" "1/2" "½" "½")
 315      ("frac14" "\\textonequarter{}" nil "&frac14;" "1/4" "¼" "¼")
 316      ("frac34" "\\textthreequarters{}" nil "&frac34;" "3/4" "¾" "¾")
 317      ("permil" "\\textperthousand{}" nil "&permil;" "per thousand" "per thousand" "‰")
 318      ("sup1" "\\textonesuperior{}" nil "&sup1;" "^1" "¹" "¹")
 319      ("sup2" "\\texttwosuperior{}" nil "&sup2;" "^2" "²" "²")
 320      ("sup3" "\\textthreesuperior{}" nil "&sup3;" "^3" "³" "³")
 321      ("radic" "\\sqrt{\\,}" t "&radic;" "[square root]" "[square root]" "√")
 322      ("sum" "\\sum" t "&sum;" "[sum]" "[sum]" "∑")
 323      ("prod" "\\prod" t "&prod;" "[product]" "[n-ary product]" "∏")
 324      ("micro" "\\textmu{}" nil "&micro;" "micro" "µ" "µ")
 325      ("macr" "\\textasciimacron{}" nil "&macr;" "[macron]" "¯" "¯")
 326      ("deg" "\\textdegree{}" nil "&deg;" "degree" "°" "°")
 327      ("prime" "\\prime" t "&prime;" "'" "'" "′")
 328      ("Prime" "\\prime{}\\prime" t "&Prime;" "''" "''" "″")
 329      ("infin" "\\propto" t "&infin;" "[infinity]" "[infinity]" "∞")
 330      ("infty" "\\infty" t "&infin;" "[infinity]" "[infinity]" "∞")
 331      ("prop" "\\propto" t "&prop;" "[proportional to]" "[proportional to]" "∝")
 332      ("propto" "\\propto" t "&prop;" "[proportional to]" "[proportional to]" "∝")
 333      ("not" "\\textlnot{}" nil "&not;" "[angled dash]" "¬" "¬")
 334      ("neg" "\\neg{}" t "&not;" "[angled dash]" "¬" "¬")
 335      ("land" "\\land" t "&and;" "[logical and]" "[logical and]" "∧")
 336      ("wedge" "\\wedge" t "&and;" "[logical and]" "[logical and]" "∧")
 337      ("lor" "\\lor" t "&or;" "[logical or]" "[logical or]" "∨")
 338      ("vee" "\\vee" t "&or;" "[logical or]" "[logical or]" "∨")
 339      ("cap" "\\cap" t "&cap;" "[intersection]" "[intersection]" "∩")
 340      ("cup" "\\cup" t "&cup;" "[union]" "[union]" "∪")
 341      ("int" "\\int" t "&int;" "[integral]" "[integral]" "∫")
 342      ("therefore" "\\therefore" t "&there4;" "[therefore]" "[therefore]" "∴")
 343      ("there4" "\\therefore" t "&there4;" "[therefore]" "[therefore]" "∴")
 344      ("because" "\\because" t "&because;" "[because]" "[because]" "∵")
 345      ("sim" "\\sim" t "&sim;" "~" "~" "∼")
 346      ("cong" "\\cong" t "&cong;" "[approx. equal to]" "[approx. equal to]" "≅")
 347      ("simeq" "\\simeq" t "&cong;"  "[approx. equal to]" "[approx. equal to]" "≅")
 348      ("asymp" "\\asymp" t "&asymp;" "[almost equal to]" "[almost equal to]" "≈")
 349      ("approx" "\\approx" t "&asymp;" "[almost equal to]" "[almost equal to]" "≈")
 350      ("ne" "\\ne" t "&ne;" "[not equal to]" "[not equal to]" "≠")
 351      ("neq" "\\neq" t "&ne;" "[not equal to]" "[not equal to]" "≠")
 352      ("equiv" "\\equiv" t "&equiv;" "[identical to]" "[identical to]" "≡")
 353
 354      ("triangleq" "\\triangleq" t "&triangleq;" "[defined to]" "[defined to]" "≜")
 355      ("le" "\\le" t "&le;" "<=" "<=" "≤")
 356      ("leq" "\\le" t "&le;" "<=" "<=" "≤")
 357      ("ge" "\\ge" t "&ge;" ">=" ">=" "≥")
 358      ("geq" "\\ge" t "&ge;" ">=" ">=" "≥")
 359      ("lessgtr" "\\lessgtr" t "&lessgtr;" "[less than or greater than]" "[less than or greater than]" "≶")
 360      ("lesseqgtr" "\\lesseqgtr" t "&lesseqgtr;" "[less than or equal or greater than or equal]" "[less than or equal or greater than or equal]" "⋚")
 361      ("ll" "\\ll" t  "&Lt;" "<<" "<<" "≪")
 362      ("Ll" "\lll" t "&Ll;" "<<<" "<<<" "⋘")
 363      ("lll" "\lll" t "&Ll;" "<<<" "<<<" "⋘")
 364      ("gg" "\\gg" t  "&Gt;" ">>" ">>" "≫")
 365      ("Gg" "\\ggg" t "&Gg;" ">>>" ">>>" "⋙")
 366      ("ggg" "\\ggg" t "&Gg;" ">>>" ">>>" "⋙")
 367      ("prec" "\\prec" t "&pr;" "[precedes]" "[precedes]" "≺")
 368      ("preceq" "\\preceq" t "&prcue;" "[precedes or equal]" "[precedes or equal]" "≼")
 369      ("preccurlyeq" "\\preccurlyeq" t "&prcue;" "[precedes or equal]" "[precedes or equal]" "≼")
 370      ("succ" "\\succ" t "&sc;" "[succeeds]" "[succeeds]" "≻")
 371      ("succeq" "\\succeq" t "&sccue;" "[succeeds or equal]" "[succeeds or equal]" "≽")
 372      ("succcurlyeq" "\\succcurlyeq" t "&sccue;" "[succeeds or equal]" "[succeeds or equal]" "≽")
 373      ("sub" "\\subset" t "&sub;" "[subset of]" "[subset of]" "⊂")
 374      ("subset" "\\subset" t "&sub;" "[subset of]" "[subset of]" "⊂")
 375      ("sup" "\\supset" t "&sup;" "[superset of]" "[superset of]" "⊃")
 376      ("supset" "\\supset" t "&sup;" "[superset of]" "[superset of]" "⊃")
 377      ("nsub" "\\not\\subset" t "&nsub;" "[not a subset of]" "[not a subset of" "⊄")
 378      ("sube" "\\subseteq" t "&sube;" "[subset of or equal to]" "[subset of or equal to]" "⊆")
 379      ("nsup" "\\not\\supset" t "&nsup;" "[not a superset of]" "[not a superset of]" "⊅")
 380      ("supe" "\\supseteq" t "&supe;" "[superset of or equal to]" "[superset of or equal to]" "⊇")
 381      ("setminus" "\\setminus" t "&setminus;" "\" "\" "⧵")
 382      ("forall" "\\forall" t "&forall;" "[for all]" "[for all]" "∀")
 383      ("exist" "\\exists" t "&exist;" "[there exists]" "[there exists]" "∃")
 384      ("exists" "\\exists" t "&exist;" "[there exists]" "[there exists]" "∃")
 385      ("nexist" "\\nexists" t "&exist;" "[there does not exists]" "[there does not  exists]" "∄")
 386      ("nexists" "\\nexists" t "&exist;" "[there does not exists]" "[there does not  exists]" "∄")
 387      ("empty" "\\empty" t "&empty;" "[empty set]" "[empty set]" "∅")
 388      ("emptyset" "\\emptyset" t "&empty;" "[empty set]" "[empty set]" "∅")
 389      ("isin" "\\in" t "&isin;" "[element of]" "[element of]" "∈")
 390      ("in" "\\in" t "&isin;" "[element of]" "[element of]" "∈")
 391      ("notin" "\\notin" t "&notin;" "[not an element of]" "[not an element of]" "∉")
 392      ("ni" "\\ni" t "&ni;" "[contains as member]" "[contains as member]" "∋")
 393      ("nabla" "\\nabla" t "&nabla;" "[nabla]" "[nabla]" "∇")
 394      ("ang" "\\angle" t "&ang;" "[angle]" "[angle]" "∠")
 395      ("angle" "\\angle" t "&ang;" "[angle]" "[angle]" "∠")
 396      ("perp" "\\perp" t "&perp;" "[up tack]" "[up tack]" "⊥")
 397      ("parallel" "\\parallel" t "&parallel;" "||" "||" "∥")
 398      ("sdot" "\\cdot" t "&sdot;" "[dot]" "[dot]" "⋅")
 399      ("cdot" "\\cdot" t "&sdot;" "[dot]" "[dot]" "⋅")
 400      ("lceil" "\\lceil" t "&lceil;" "[left ceiling]" "[left ceiling]" "⌈")
 401      ("rceil" "\\rceil" t "&rceil;" "[right ceiling]" "[right ceiling]" "⌉")
 402      ("lfloor" "\\lfloor" t "&lfloor;" "[left floor]" "[left floor]" "⌊")
 403      ("rfloor" "\\rfloor" t "&rfloor;" "[right floor]" "[right floor]" "⌋")
 404      ("lang" "\\langle" t "&lang;" "<" "<" "⟨")
 405      ("rang" "\\rangle" t "&rang;" ">" ">" "⟩")
 406      ("langle" "\\langle" t "&lang;" "<" "<" "⟨")
 407      ("rangle" "\\rangle" t "&rang;" ">" ">" "⟩")
 408      ("hbar" "\\hbar" t "&hbar;" "hbar" "hbar" "ℏ")
 409      ("mho" "\\mho" t "&mho;" "mho" "mho" "℧")
 410
 411      "** Arrows"
 412      ("larr" "\\leftarrow" t "&larr;" "<-" "<-" "←")
 413      ("leftarrow" "\\leftarrow" t "&larr;"  "<-" "<-" "←")
 414      ("gets" "\\gets" t "&larr;"  "<-" "<-" "←")
 415      ("lArr" "\\Leftarrow" t "&lArr;" "<=" "<=" "⇐")
 416      ("Leftarrow" "\\Leftarrow" t "&lArr;" "<=" "<=" "⇐")
 417      ("uarr" "\\uparrow" t "&uarr;" "[uparrow]" "[uparrow]" "↑")
 418      ("uparrow" "\\uparrow" t "&uarr;" "[uparrow]" "[uparrow]" "↑")
 419      ("uArr" "\\Uparrow" t "&uArr;" "[dbluparrow]" "[dbluparrow]" "⇑")
 420      ("Uparrow" "\\Uparrow" t "&uArr;" "[dbluparrow]" "[dbluparrow]" "⇑")
 421      ("rarr" "\\rightarrow" t "&rarr;" "->" "->" "→")
 422      ("to" "\\to" t "&rarr;" "->" "->" "→")
 423      ("rightarrow" "\\rightarrow" t "&rarr;"  "->" "->" "→")
 424      ("rArr" "\\Rightarrow" t "&rArr;" "=>" "=>" "⇒")
 425      ("Rightarrow" "\\Rightarrow" t "&rArr;" "=>" "=>" "⇒")
 426      ("darr" "\\downarrow" t "&darr;" "[downarrow]" "[downarrow]" "↓")
 427      ("downarrow" "\\downarrow" t "&darr;" "[downarrow]" "[downarrow]" "↓")
 428      ("dArr" "\\Downarrow" t "&dArr;" "[dbldownarrow]" "[dbldownarrow]" "⇓")
 429      ("Downarrow" "\\Downarrow" t "&dArr;" "[dbldownarrow]" "[dbldownarrow]" "⇓")
 430      ("harr" "\\leftrightarrow" t "&harr;" "<->" "<->" "↔")
 431      ("leftrightarrow" "\\leftrightarrow" t "&harr;"  "<->" "<->" "↔")
 432      ("hArr" "\\Leftrightarrow" t "&hArr;" "<=>" "<=>" "⇔")
 433      ("Leftrightarrow" "\\Leftrightarrow" t "&hArr;" "<=>" "<=>" "⇔")
 434      ("crarr" "\\hookleftarrow" t "&crarr;" "<-'" "<-'" "↵")
 435      ("hookleftarrow" "\\hookleftarrow" t "&crarr;"  "<-'" "<-'" "↵")
 436
 437      "** Function names"
 438      ("arccos" "\\arccos" t "arccos" "arccos" "arccos" "arccos")
 439      ("arcsin" "\\arcsin" t "arcsin" "arcsin" "arcsin" "arcsin")
 440      ("arctan" "\\arctan" t "arctan" "arctan" "arctan" "arctan")
 441      ("arg" "\\arg" t "arg" "arg" "arg" "arg")
 442      ("cos" "\\cos" t "cos" "cos" "cos" "cos")
 443      ("cosh" "\\cosh" t "cosh" "cosh" "cosh" "cosh")
 444      ("cot" "\\cot" t "cot" "cot" "cot" "cot")
 445      ("coth" "\\coth" t "coth" "coth" "coth" "coth")
 446      ("csc" "\\csc" t "csc" "csc" "csc" "csc")
 447      ("deg" "\\deg" t "&deg;" "deg" "deg" "deg")
 448      ("det" "\\det" t "det" "det" "det" "det")
 449      ("dim" "\\dim" t "dim" "dim" "dim" "dim")
 450      ("exp" "\\exp" t "exp" "exp" "exp" "exp")
 451      ("gcd" "\\gcd" t "gcd" "gcd" "gcd" "gcd")
 452      ("hom" "\\hom" t "hom" "hom" "hom" "hom")
 453      ("inf" "\\inf" t "inf" "inf" "inf" "inf")
 454      ("ker" "\\ker" t "ker" "ker" "ker" "ker")
 455      ("lg" "\\lg" t "lg" "lg" "lg" "lg")
 456      ("lim" "\\lim" t "lim" "lim" "lim" "lim")
 457      ("liminf" "\\liminf" t "liminf" "liminf" "liminf" "liminf")
 458      ("limsup" "\\limsup" t "limsup" "limsup" "limsup" "limsup")
 459      ("ln" "\\ln" t "ln" "ln" "ln" "ln")
 460      ("log" "\\log" t "log" "log" "log" "log")
 461      ("max" "\\max" t "max" "max" "max" "max")
 462      ("min" "\\min" t "min" "min" "min" "min")
 463      ("Pr" "\\Pr" t "Pr" "Pr" "Pr" "Pr")
 464      ("sec" "\\sec" t "sec" "sec" "sec" "sec")
 465      ("sin" "\\sin" t "sin" "sin" "sin" "sin")
 466      ("sinh" "\\sinh" t "sinh" "sinh" "sinh" "sinh")
 467      ("sup" "\\sup" t "&sup;" "sup" "sup" "sup")
 468      ("tan" "\\tan" t "tan" "tan" "tan" "tan")
 469      ("tanh" "\\tanh" t "tanh" "tanh" "tanh" "tanh")
 470
 471      "** Signs & Symbols"
 472      ("bull" "\\textbullet{}" nil "&bull;" "*" "*" "•")
 473      ("bullet" "\\textbullet{}" nil "&bull;" "*" "*" "•")
 474      ("star" "\\star" t "*" "*" "*" "⋆")
 475      ("lowast" "\\ast" t "&lowast;" "*" "*" "∗")
 476      ("ast" "\\ast" t "&lowast;" "*" "*" "*")
 477      ("odot" "\\odot" t "o" "[circled dot]" "[circled dot]" "ʘ")
 478      ("oplus" "\\oplus" t "&oplus;" "[circled plus]" "[circled plus]" "⊕")
 479      ("otimes" "\\otimes" t "&otimes;" "[circled times]" "[circled times]" "⊗")
 480      ("check" "\\checkmark" t "&checkmark;" "[checkmark]" "[checkmark]" "✓")
 481      ("checkmark" "\\checkmark" t "&check;" "[checkmark]" "[checkmark]" "✓")
 482
 483      "** Miscellaneous (seldom used)"
 484      ("para" "\\P{}" nil "&para;" "[pilcrow]" "¶" "¶")
 485      ("ordf" "\\textordfeminine{}" nil "&ordf;" "_a_" "ª" "ª")
 486      ("ordm" "\\textordmasculine{}" nil "&ordm;" "_o_" "º" "º")
 487      ("cedil" "\\c{}" nil "&cedil;" "[cedilla]" "¸" "¸")
 488      ("oline" "\\overline{~}" t "&oline;" "[overline]" "¯" "‾")
 489      ("uml" "\\textasciidieresis{}" nil "&uml;" "[diaeresis]" "¨" "¨")
 490      ("zwnj" "\\/{}" nil "&zwnj;" "" "" "‌")
 491      ("zwj" "" nil "&zwj;" "" "" "‍")
 492      ("lrm" "" nil "&lrm;" "" "" "‎")
 493      ("rlm" "" nil "&rlm;" "" "" "‏")
 494
 495      "** Smilies"
 496      ("smile" "\\smile" t "&smile;" ":-)" ":-)" "⌣")
 497      ("frown" "\\frown" t "&frown;" ":-(" ":-(" "⌢")
 498      ("smiley" "\\ddot\\smile" t "&#9786;" ":-)" ":-)" "☺")
 499      ("blacksmile" "\\ddot\\smile" t "&#9787;" ":-)" ":-)" "☻")
 500      ("sad" "\\ddot\\frown" t "&#9785;" ":-(" ":-(" "☹")
 501
 502      "** Suits"
 503      ("clubs" "\\clubsuit" t "&clubs;" "[clubs]" "[clubs]" "♣")
 504      ("clubsuit" "\\clubsuit" t "&clubs;" "[clubs]" "[clubs]" "♣")
 505      ("spades" "\\spadesuit" t "&spades;" "[spades]" "[spades]" "♠")
 506      ("spadesuit" "\\spadesuit" t "&spades;" "[spades]" "[spades]" "♠")
 507      ("hearts" "\\heartsuit" t "&hearts;" "[hearts]" "[hearts]" "♥")
 508      ("heartsuit" "\\heartsuit" t "&heartsuit;" "[hearts]" "[hearts]" "♥")
 509      ("diams" "\\diamondsuit" t "&diams;" "[diamonds]" "[diamonds]" "◆")
 510      ("diamondsuit" "\\diamondsuit" t "&diams;" "[diamonds]" "[diamonds]" "◆")
 511      ("diamond" "\\diamondsuit" t "&diamond;" "[diamond]" "[diamond]" "◆")
 512      ("Diamond" "\\diamondsuit" t "&diamond;" "[diamond]" "[diamond]" "◆")
 513      ("loz" "\\lozenge" t "&loz;" "[lozenge]" "[lozenge]" "⧫"))
 514    ;; Add "\_ "-entity family for spaces.
 515    (let (space-entities html-spaces (entity "_"))
 516      (dotimes (n 20 (nreverse space-entities))
 517        (let ((n (+ 1 n))
 518              (spaces (make-string n ?\s)))
 519          (push (list (setq entity (concat entity " "))
 520                      (format "\\hspace*{%sem}" (* n .5))
 521                      nil
 522                      (setq html-spaces (concat "&ensp;" html-spaces))
 523                      spaces
 524                      spaces
 525                      (make-string n ?\x2002))
 526                space-entities)))))
 527   "Default entities used in Org mode to produce special characters.
 528 For details see `org-entities-user'.")
 529
 530 (defsubst org-entity-get (name)
 531   "Get the proper association for NAME from the entity lists.
 532 This first checks the user list, then the built-in list."
 533   (or (assoc name org-entities-user)
 534       (assoc name org-entities)))
 535
 536 ;; Helpfunctions to create a table for orgmode.org/worg/org-symbols.org
 537
 538 (defun org-entities-create-table ()
 539   "Create an Org mode table with all entities."
 540   (interactive)
 541   (let ((pos (point)) e latex mathp html latin utf8 name ascii)
 542     (insert "|Name|LaTeX code|LaTeX|HTML code |HTML|ASCII|Latin1|UTF-8\n|-\n")
 543     (mapc (lambda (e) (when (listp e)
 544                         (setq name (car e)
 545                               latex (nth 1 e)
 546                               mathp (nth 2 e)
 547                               html (nth 3 e)
 548                               ascii (nth 4 e)
 549                               latin (nth 5 e)
 550                               utf8 (nth 6 e))
 551                         (if (equal ascii "|") (setq ascii "\\vert"))
 552                         (if (equal latin "|") (setq latin "\\vert"))
 553                         (if (equal utf8  "|") (setq utf8  "\\vert"))
 554                         (if (equal ascii "=>") (setq ascii "= >"))
 555                         (if (equal latin "=>") (setq latin "= >"))
 556                         (insert "|" name
 557                                 "|" (format "=%s=" latex)
 558                                 "|" (format (if mathp "$%s$" "$\\mbox{%s}$")
 559                                             latex)
 560                                 "|" (format "=%s=" html) "|" html
 561                                 "|" ascii "|" latin "|" utf8
 562                                 "|\n")))
 563           org-entities)
 564     (goto-char pos)
 565     (org-table-align)))
 566
 567 (defvar org-pretty-entities) ;; declare defcustom from org
 568 (defun org-entities-help ()
 569   "Create a Help buffer with all available entities."
 570   (interactive)
 571   (with-output-to-temp-buffer "*Org Entity Help*"
 572     (princ "Org-mode entities\n=================\n\n")
 573     (let ((ll (append '("* User-defined additions (variable org-entities-user)")
 574                       org-entities-user
 575                       org-entities))
 576           e latex mathp html latin utf8 name ascii
 577           (lastwasstring t)
 578           (head (concat
 579                  "\n"
 580                  "   Symbol   Org entity        LaTeX code             HTML code\n"
 581                  "   -----------------------------------------------------------\n")))
 582       (while ll
 583         (setq e (pop ll))
 584         (if (stringp e)
 585             (progn
 586               (princ e)
 587               (princ "\n")
 588               (setq lastwasstring t))
 589           (if lastwasstring (princ head))
 590           (setq lastwasstring nil)
 591           (setq name (car e)
 592                 latex (nth 1 e)
 593                 html (nth 3 e)
 594                 utf8 (nth 6 e))
 595           (princ (format "   %-8s \\%-16s %-22s %-13s\n"
 596                          utf8 name latex html))))))
 597   (with-current-buffer "*Org Entity Help*"
 598     (org-mode)
 599     (when org-pretty-entities
 600       (org-toggle-pretty-entities)))
 601   (select-window (get-buffer-window "*Org Entity Help*")))
 602
 603
 604 (provide 'org-entities)
 605
 606 ;; Local variables:
 607 ;; coding: utf-8
 608 ;; End:
 609
 610 ;;; org-entities.el ends here