UnicodeIt

https://github.com/svenkreiss/unicodeit
Admin
UnicodeIt converts LaTeX tags to unicode characters, enabling easy transformation of mathematical...
Tokens:5,748
Snippets:39
Trust Score:7.6
License:MIT
Update:6 months ago
Show doc for...
Tokens:
Raw
### Configure Mac Automator Integration

Source: https://context7.com/svenkreiss/unicodeit/llms.txt

Setup instructions for creating a system-wide keyboard shortcut to convert LaTeX text to Unicode.

```bash
# 1. First, install unicodeit for the system Python
/usr/local/bin/python3 -m pip install unicodeit

# 2. Create a new "Quick Action" in Automator with these settings:
#    - Service receives: selected text
#    - In: any application
#    - Check: "Output replaces selected text"
#    - Add action: "Run Shell Script"
#    - Shell: /bin/bash
#    - Pass input: as arguments

# 3. Use this command in the shell script:
/usr/local/bin/python3 -m unicodeit.cli "$1"

# 4. Save the workflow (e.g., as "UnicodeItAction")

# 5. Set up keyboard shortcut:
#    System Preferences → Keyboard → Shortcuts → Services → Text
#    Find "UnicodeItAction" and assign a shortcut like Cmd+Option+Shift+U

# Now select any LaTeX text in any app and press the shortcut to convert!
```

--------------------------------

### LaTeX to Unicode Mapping Examples

Source: https://github.com/svenkreiss/unicodeit/blob/main/README.md

Reference list showing common LaTeX tag conversions to Unicode characters.

```text
\alpha α, \beta β, \infty ∞       e^+ e⁺, \mu^- μ⁻               \exists ∃, \nexists ∄
\int ∫, \sum ∑, \partial ∂        \to →, p\bar{p} pp̅             \mathcal{H} ℋ, \mathbb{R} ℝ
\slash{\partial} ∂̸                \underline{x} x̲                \phone ☎, \checkmark ✓
\dot{x} ẋ, \ddot{x} ẍ             A^6 A⁶, m_0 m₀                 \Im ℑ, \Re ℜ, \hbar ℏ
\gamma γ, \Gamma Γ                \~{O} Õ                        \perp ⊥, \parallel ∥
\sfrac{3}{5} ⅗                    \therefore ∴, \because ∵       \subset ⊂, \supset ⊃
```

--------------------------------

### Update unicodeit.net

Source: https://github.com/svenkreiss/unicodeit/wiki/Home

Navigate to the src directory and run the conversion script. Then, copy the unicodeit.js file to the parent directory for the website.

```bash
cd src
python convert.py
```

```bash
cp unicodeit.js ../../UnicodeitGhPages/
```

--------------------------------

### Run UnicodeIt via CLI

Source: https://github.com/svenkreiss/unicodeit/blob/main/README.md

Execute the conversion directly from the command line.

```sh
python -m unicodeit.cli \alpha
```

--------------------------------

### Python Release Checks and Packaging

Source: https://github.com/svenkreiss/unicodeit/blob/main/docs/dev.md

Run pytest for testing and pylint for code analysis. Then, create a source distribution and upload it to PyPI using twine.

```sh
# python checks
pytest
pylint unicodeit

# create package and upload
python setup.py sdist
twine upload dist/unicodeit...
```

--------------------------------

### Create Automator Release

Source: https://github.com/svenkreiss/unicodeit/wiki/Home

Navigate to the src directory and run the conversion script. This is part of the process for creating Automator releases.

```bash
cd src
python convert.py
```

--------------------------------

### Convert LaTeX via Command Line Interface

Source: https://context7.com/svenkreiss/unicodeit/llms.txt

Execute conversions directly from the terminal using the unicodeit.cli module.

```bash
# Basic symbol conversion
python -m unicodeit.cli '\\Sigma'
# Output: Σ

# Complex expression with subscripts
python -m unicodeit.cli '\\Sigma_{01234}abc\\alpha_{567}'
# Output: Σ₀₁₂₃₄abcα₅₆₇

# Superscripts with letters
python -m unicodeit.cli 'def^{01234}abc\\alpha^{567abc}'
# Output: def⁰¹²³⁴abcα⁵⁶⁷ᵃᵇᶜ

# Greek subscripts
python -m unicodeit.cli 'a_{\\beta\\gamma\\varphi\\rho\\chi}'
# Output: aᵦᵧᵩᵨᵪ

# Mixed superscripts with Greek letters
python -m unicodeit.cli 'm^{ABDEGabcdef\\beta\\gamma}'
# Output: mᴬᴮᴰᴱᴳᵃᵇᶜᵈᵉᶠᵝᵞ

# Particle physics notation
python -m unicodeit.cli 'e^+ e^- \\mu^- \\pi^0'
# Output: e⁺ e⁻ μ⁻ π⁰

# Multiple arguments
python -m unicodeit.cli '\\alpha' '\\beta' '\\gamma'
# Output: α β γ
```

--------------------------------

### NPM Release: Data Export, Checks, Build, and Publish

Source: https://github.com/svenkreiss/unicodeit/blob/main/docs/dev.md

First, export data using the Python module. Then, perform TypeScript checks with npm lint and tests with npm test. Rebuild bundles with npm run build before publishing with npm publish.

```sh
# update typescript data
python -m unicodeit.export_data

# typescript checks
npm run lint
npm run test

# rebuild typescript bundles
npm run build

# publish
npm publish
```

--------------------------------

### Website Deployment to GitHub Pages

Source: https://github.com/svenkreiss/unicodeit/blob/main/docs/dev.md

After completing the NPM release steps, push the web folder to the gh-pages branch using ghp-import for deployment.

```sh
# follow steps of NPM release first

# push web folder to gh-pages branch
ghp-import --no-jekyll --push web
```

--------------------------------

### Command Line Interface (CLI)

Source: https://context7.com/svenkreiss/unicodeit/llms.txt

Use the command line interface for quick LaTeX to Unicode conversions directly from your terminal.

```APIDOC
## Command Line Interface

### Description
UnicodeIt provides a CLI for quick conversions from the terminal. Run it as a Python module with the LaTeX string as an argument. Multiple arguments are joined with spaces in the output.

### Method
`python -m unicodeit.cli <latex_string>`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
# Basic symbol conversion
python -m unicodeit.cli '\Sigma'
# Output: Σ

# Complex expression with subscripts
python -m unicodeit.cli '\Sigma_{01234}abc\alpha_{567}'
# Output: Σ₀₁₂₃₄abcα₅₆₇

# Superscripts with letters
python -m unicodeit.cli 'def^{01234}abc\alpha^{567abc}'
# Output: def⁰¹²³⁴abcα⁵⁶⁷ᵃᵇᶜ

# Greek subscripts
python -m unicodeit.cli 'a_{\beta\gamma\varphi\rho\chi}'
# Output: aᵦᵧᵩᵨᵪ

# Mixed superscripts with Greek letters
python -m unicodeit.cli 'm^{ABDEGabcdef\beta\gamma}'
# Output: mᴬᴮᴰᴱᴳᵃᵇᶜᵈᵉᶠᵝᵞ

# Particle physics notation
python -m unicodeit.cli 'e^+ e^- \mu^- \pi^0'
# Output: e⁺ e⁻ μ⁻ π⁰

# Multiple arguments
python -m unicodeit.cli '\alpha' '\beta' '\gamma'
# Output: α β γ
```

### Response
#### Success Response (200)
- **unicode_string** (string) - The Unicode representation of the input LaTeX string.
```

--------------------------------

### Access Supported Symbol Categories

Source: https://context7.com/svenkreiss/unicodeit/llms.txt

Demonstrates usage for various categories of mathematical and Greek symbols.

```python
import unicodeit

# Greek letters (uppercase and lowercase)
greek = unicodeit.replace('\\Alpha \\Beta ... \\Omega \\alpha \\beta ... \\omega')
# Α Β ... Ω α β ... ω

# Mathematical operators
operators = unicodeit.replace('\\sum \\prod \\int \\oint \\partial \\nabla')
# ∑ ∏ ∫ ∮ ∂ ∇

# Relations
relations = unicodeit.replace('\\leq \\geq \\neq \\approx \\equiv \\sim')
# ≤ ≥ ≠ ≈ ≡ ∼
```

--------------------------------

### Use UnicodeIt in Python

Source: https://github.com/svenkreiss/unicodeit/blob/main/README.md

Import the library and use the replace function to convert LaTeX strings.

```py
import unicodeit
print(unicodeit.replace('\alpha'))
```

--------------------------------

### Use UnicodeIt in JavaScript

Source: https://github.com/svenkreiss/unicodeit/blob/main/README.md

Require the module and use the replace function in Node.js environments.

```js
var unicodeit = require('unicodeit');
console.log(unicodeit.replace('\alpha'));
```

--------------------------------

### Format Subscripts and Superscripts

Source: https://context7.com/svenkreiss/unicodeit/llms.txt

Apply subscript and superscript formatting using _ and ^ notation, including support for grouped characters.

```python
import unicodeit

# Individual subscripts (0-9)
print(unicodeit.replace('x_0 x_1 x_2'))
# Output: x₀ x₁ x₂

# Individual superscripts (0-9)
print(unicodeit.replace('x^0 x^1 x^2 x^3'))
# Output: x⁰ x¹ x² x³

# Grouped subscripts
print(unicodeit.replace('a_{0123456789}'))
# Output: a₀₁₂₃₄₅₆₇₈₉

# Grouped superscripts
print(unicodeit.replace('b^{0123456789}'))
# Output: b⁰¹²³⁴⁵⁶⁷⁸⁹

# Letter subscripts (limited set: a, e, h, i, j, k, l, m, n, o, p, r, s, t, u, v, x)
print(unicodeit.replace('x_a x_e x_n'))
# Output: xₐ xₑ xₙ

# Letter superscripts (larger set of letters available)
print(unicodeit.replace('x^a x^b x^c x^n'))
# Output: xᵃ xᵇ xᶜ xⁿ

# Signs in super/subscripts
print(unicodeit.replace('x^+ x^- x^= y_+ y_-'))
# Output: x⁺ x⁻ x⁼ y₊ y₋

# Greek letter subscripts
print(unicodeit.replace('a_{\\beta\\gamma\\rho\\chi}'))
# Output: aᵦᵧᵨᵪ

# Greek letter superscripts
print(unicodeit.replace('a^{\\beta\\gamma\\delta\\phi\\chi}'))
# Output: aᵝᵞᵟᵠᵡ

# Parentheses in super/subscripts
print(unicodeit.replace('a^{(1)} b_{(2)}'))
# Output: a⁽¹⁾ b₍₂₎

# Physics notation
print(unicodeit.replace('e^+ e^- \\mu^- \\pi^+ K^0'))
# Output: e⁺ e⁻ μ⁻ π⁺ K⁰
```

--------------------------------

### Convert LaTeX Symbols to Unicode

Source: https://context7.com/svenkreiss/unicodeit/llms.txt

Basic usage of unicodeit.replace to convert various mathematical and symbolic LaTeX commands into Unicode.

```python
arrows = unicodeit.replace('\\leftarrow \\rightarrow \\uparrow \\downarrow \\leftrightarrow')
# ← → ↑ ↓ ↔

# Set theory
sets = unicodeit.replace('\\emptyset \\in \\notin \\subset \\supset \\cup \\cap')
# ∅ ∈ ∉ ⊂ ⊃ ∪ ∩

# Logic
logic = unicodeit.replace('\\forall \\exists \\nexists \\land \\lor \\lnot')
# ∀ ∃ ∄ ∧ ∨ ¬

# Fractions
fractions = unicodeit.replace('\\sfrac{1}{2} \\sfrac{1}{4} \\sfrac{3}{4}')
# ½ ¼ ¾

# Card suits and misc symbols
misc = unicodeit.replace('\\spadesuit \\heartsuit \\diamondsuit \\clubsuit \\checkmark')
# ♠ ♥ ♦ ♣ ✓

# Box drawing characters
boxes = unicodeit.replace('\\boxdr \\boxdl \\boxur \\boxul \\boxvh')
# ┌ ┐ └ ┘ ┼

# Blackboard bold (number sets)
bbold = unicodeit.replace('\\mathbb{N} \\mathbb{Z} \\mathbb{Q} \\mathbb{R} \\mathbb{C}')
# ℕ ℤ ℚ ℝ ℂ

# Calligraphic/script letters
callig = unicodeit.replace('\\mathcal{A} \\mathcal{B} \\mathcal{L} \\mathcal{H}')
# 𝒜 ℬ ℒ ℋ

# Fraktur letters
fraktur = unicodeit.replace('\\mathfrak{A} \\mathfrak{B} \\mathfrak{R}')
# 𝔄 𝔅 𝔜
```

--------------------------------

### Apply Combining Marks

Source: https://context7.com/svenkreiss/unicodeit/llms.txt

Use the \mark{character} syntax to add diacritical marks to characters.

```python
import unicodeit

# Dot above
print(unicodeit.replace('\\dot{x}'))      # Output: ẋ
print(unicodeit.replace('\\dot{\\alpha}')) # Output: α̇

# Double dot (umlaut/diaeresis)
print(unicodeit.replace('\\ddot{x}'))     # Output: ẍ

# Bar/overline
print(unicodeit.replace('\\bar{x}'))      # Output: x̅
print(unicodeit.replace('\\overline{p}')) # Output: p̅

# Hat/circumflex
print(unicodeit.replace('\\hat{x}'))      # Output: x̂

# Vector arrow
print(unicodeit.replace('\\vec{v}'))      # Output: v⃗

# Tilde
print(unicodeit.replace('\\tilde{n}'))    # Output: ñ

# Underline
print(unicodeit.replace('\\underline{x}')) # Output: x̲

# Strikethrough
print(unicodeit.replace('\\strikethrough{a}')) # Output: a̵

# Combining slash (for negation)
print(unicodeit.replace('\\slash{\\partial}')) # Output: ∂̸

# Breve
print(unicodeit.replace('\\breve{a}'))    # Output: ă
```

--------------------------------

### Python API: replace()

Source: https://context7.com/svenkreiss/unicodeit/llms.txt

The primary API for converting LaTeX strings to Unicode in Python. It handles standard symbols, combining marks, and grouped subscripts/superscripts.

```APIDOC
## Python API: replace()

### Description
The `replace()` function is the primary API for converting LaTeX strings to Unicode. It takes a string containing LaTeX tags and returns the equivalent Unicode representation. The function handles standard symbols, combining marks (like `\dot{a}`), and grouped subscripts/superscripts (`_{123}` and `^{abc}`).

### Method
`unicodeit.replace(latex_string)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```python
import unicodeit

# Basic Greek letters
result = unicodeit.replace('\\alpha \\beta \\gamma')
print(result) # Output: α β γ

# Mathematical symbols
result = unicodeit.replace('\\sum \\int \\partial \\infty')
print(result) # Output: ∑ ∫ ∂ ∞

# Subscripts and superscripts
result = unicodeit.replace('e^+ e^- m_0 x_{12}')
print(result) # Output: e⁺ e⁻ m₀ x₁₂

# Grouped subscripts/superscripts
result = unicodeit.replace('a_{01234} b^{567}')
print(result) # Output: a₀₁₂₃₄ b⁵⁶⁷

# Combining marks (accents on characters)
result = unicodeit.replace('\\dot{x} \\bar{y} \\hat{z} \\vec{a}')
print(result) # Output: ẋ y̅ ẑ a⃗

# Negation with combining slash
result = unicodeit.replace('\\not\\subset \\not\\in')
print(result) # Output: ⊄ ∉

# Calligraphic and blackboard bold letters
result = unicodeit.replace('\\mathcal{H} \\mathbb{R} \\mathbb{C}')
print(result) # Output: ℋ ℝ ℂ

# Complex expressions
result = unicodeit.replace('\\Sigma_{i=0}^{n} x_i')
print(result) # Output: Σᵢ₌₀ⁿ xᵢ

# Special characters
result = unicodeit.replace('\\therefore \\because \\forall \\exists')
print(result) # Output: ∴ ∵ ∀ ∃
```

### Response
#### Success Response (200)
- **unicode_string** (string) - The Unicode representation of the input LaTeX string.
```

--------------------------------

### JavaScript/TypeScript API

Source: https://context7.com/svenkreiss/unicodeit/llms.txt

The JavaScript/TypeScript version of the `replace()` function provides identical behavior for web applications and Node.js backends.

```APIDOC
## JavaScript/TypeScript API

### Description
The JavaScript/TypeScript version provides the same `replace()` function with identical behavior. It's suitable for web applications, Node.js backends, or browser-based editors that need LaTeX to Unicode conversion.

### Method
`unicodeit.replace(latex_string)` or `replace(latex_string)` (ES6 import)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```javascript
// CommonJS
var unicodeit = require('unicodeit');

// ES6 import (TypeScript)
import { replace } from 'unicodeit';

// Basic usage
console.log(unicodeit.replace('\\alpha'));  // Output: α

// Greek alphabet
console.log(unicodeit.replace('\\Gamma \\Delta \\Theta \\Lambda'));
// Output: Γ Δ Θ Λ

// Subscripts and superscripts
console.log(unicodeit.replace('H_2O'));     // Output: H₂O
console.log(unicodeit.replace('x^2 + y^2'));  // Output: x² + y²

// Combining marks
console.log(unicodeit.replace('\\dot{a}'));       // Output: ȧ
console.log(unicodeit.replace('\\dot{\\alpha}')); // Output: α̇
console.log(unicodeit.replace('\\breve{}'));      // Output: ˘ (standalone breve)

// Arrows and relations
console.log(unicodeit.replace('\\rightarrow \\Leftrightarrow \\mapsto'));
// Output: → ⇔ ↦

// Set notation
console.log(unicodeit.replace('\\subset \\supset \\cup \\cap'));
// Output: ⊂ ⊃ ∪ ∩
```

### Response
#### Success Response (200)
- **unicode_string** (string) - The Unicode representation of the input LaTeX string.
```

--------------------------------

### Convert LaTeX to Unicode in JavaScript/TypeScript

Source: https://context7.com/svenkreiss/unicodeit/llms.txt

The replace function is available for Node.js and browser environments using CommonJS or ES6 imports.

```javascript
// CommonJS
var unicodeit = require('unicodeit');

// ES6 import (TypeScript)
import { replace } from 'unicodeit';

// Basic usage
console.log(unicodeit.replace('\\alpha'));  // Output: α

// Greek alphabet
console.log(unicodeit.replace('\\Gamma \\Delta \\Theta \\Lambda'));
// Output: Γ Δ Θ Λ

// Subscripts and superscripts
console.log(unicodeit.replace('H_2O'));     // Output: H₂O
console.log(unicodeit.replace('x^2 + y^2'));  // Output: x² + y²

// Combining marks
console.log(unicodeit.replace('\\dot{a}'));       // Output: ȧ
console.log(unicodeit.replace('\\dot{\\alpha}')); // Output: α̇
console.log(unicodeit.replace('\\breve{}'));      // Output: ˘ (standalone breve)

// Arrows and relations
console.log(unicodeit.replace('\\rightarrow \\Leftrightarrow \\mapsto'));
// Output: → ⇔ ↦

// Set notation
console.log(unicodeit.replace('\\subset \\supset \\cup \\cap'));
// Output: ⊂ ⊃ ∪ ∩
```

--------------------------------

### Convert LaTeX to Unicode in Python

Source: https://context7.com/svenkreiss/unicodeit/llms.txt

Use the replace function to transform various LaTeX symbols, subscripts, superscripts, and combining marks into Unicode.

```python
import unicodeit

# Basic Greek letters
result = unicodeit.replace('\\alpha \\beta \\gamma')
print(result)  # Output: α β γ

# Mathematical symbols
result = unicodeit.replace('\\sum \\int \\partial \\infty')
print(result)  # Output: ∑ ∫ ∂ ∞

# Subscripts and superscripts
result = unicodeit.replace('e^+ e^- m_0 x_{12}')
print(result)  # Output: e⁺ e⁻ m₀ x₁₂

# Grouped subscripts/superscripts
result = unicodeit.replace('a_{01234} b^{567}')
print(result)  # Output: a₀₁₂₃₄ b⁵⁶⁷

# Combining marks (accents on characters)
result = unicodeit.replace('\\dot{x} \\bar{y} \\hat{z} \\vec{a}')
print(result)  # Output: ẋ y̅ ẑ a⃗

# Negation with combining slash
result = unicodeit.replace('\\not\\subset \\not\\in')
print(result)  # Output: ⊄ ∉

# Calligraphic and blackboard bold letters
result = unicodeit.replace('\\mathcal{H} \\mathbb{R} \\mathbb{C}')
print(result)  # Output: ℋ ℝ ℂ

# Complex expressions
result = unicodeit.replace('\\Sigma_{i=0}^{n} x_i')
print(result)  # Output: Σᵢ₌₀ⁿ xᵢ

# Special characters
result = unicodeit.replace('\\therefore \\because \\forall \\exists')
print(result)  # Output: ∴ ∵ ∀ ∃
```
Tokens:
Raw