EN:Home

English | 中文版

LuaTeX-CN Wiki

Welcome to the LuaTeX-CN Wiki. This site provides comprehensive documentation for users and developers to help you create high-quality Chinese typesetting with LuaTeX-CN — classical vertical books, modern vertical books, and clreq-conformant horizontal documents.

Current Version: v0.4.1 | CTAN: v0.4.1

Quick Access

• 🚀 Quick Start - Get started with your first project in 5 minutes
• 📦 Installation - Install LuaTeX-CN on your system
• 📚 Examples - Explore "Records of the Grand Historian" (Shiji) and "Dream of the Red Chamber"

Documentation

1. Fundamentals

• Templates & Format - Understand the "Banxin" (Page Center) concept
• Font Setup - Config Chinese fonts and fallback chains
• Layout Control - Chapters, TOC entries, and fine-grained layout control

2. Writing Modes

Vertical — four document classes

• guji (Ancient Books) - Traditional vertical typesetting (default class)
• guji-digital - Digitization mode: one source line = one vertical column, for reproducing a source edition's page layout exactly
• cn-vbook / tw-vbook (Modern Books) - Modern vertical books with punct squeeze and footnotes

Horizontal — one package

• \usepackage{luatex-cn} (horizontal) - Modern horizontal Chinese per W3C clreq: CJK–Western spacing, four kinsoku levels, per-line compression/stretch, interlinear marks and ruby, paragraph and widow control. Loads on top of article and friends — it is a package, not a class
• clreq conformance matrix - per-clause status for both directions, with evidence and documented deviations

3. Punctuation & Judou

• Punctuation System - Modern punct styles (mainland/Taiwan), squeeze, kinsoku
• Judou - Classical Chinese punctuation (judou/plain/normal modes)

4. Specialized Commands

• Interlinear & Side Notes - Detailed usage of jiazhu and side notes
• Annotations & Marginal Notes - Floating annotations and marginal notes (MeiPi)
• Decorations - Underlines, book titles, and correction marks
• Elevation - Honorific elevation formatting

5. Advanced Features

• Text Boxes - Absolute positioning and adaptive containers
• Seals - Adding and positioning electronic seals
• Debugging - Grid visualization and layout debugging

---

Developers

For information on contributing or understanding the internal architecture:

• Development Guide
• Release Process

---

Contact

• Contact: Sheldon Li (sheldonli.dev@gmail.com), Frank Lin (ctan@linshuang.info)