CTAN Comprehensive TeX Archive Network

Directory macros/xetex/latex/impe-framework

README.md

IMPE System

繁體中文

IMPE is a modular framework for reusable layouts, font routing, multilingual typesetting, and optional document features.

Current release: v1.0.1 (2026-09-29). See CHANGELOG.md.

Quick Start

Use an IMPE wrapper class when its defaults match the document:

\documentclass{impeart}

\title{Sample Document}
\author{Author Name}

\UseTemplateSet{
  fonts = {libertinus},
  features = {math,hyperlinks,headers}
}

\begin{document}
\maketitle
\section{Introduction}
Hello, IMPE.
\end{document}

The canonical entry points are impe.sty, impeart, impeart_zh, impebook, impebook_zh, impereport, impereport_zh, impebeamer, and impebeamer_zh. The older next* names remain compatibility wrappers for existing documents and are shipped only in the full and core releases.

Support Matrix

Area Support
Primary document engine
Supported and used by manuals, showcase, and general regressions
Lua Not a supported or tested general document route; only explicit backend hooks may use it
Unicode-range global routing only
Special/externalized backends Explicit engine resolved from PATH; shell escape required; helper regression uses
Live 2026 tested
Windows CI tested
Linux CI tested
macOS Best effort; not currently CI tested

The API and compatibility policy defines the 1.x public contract. The extension guide describes the catalog-first rule for new fonts, scripts, layouts, and features.

Installation

For a GitHub full or core release, extract the archive and run:

install.bat

The installer writes to the user TEXMF tree under tex/latex/impe/. The full archive includes redistributable local fonts; the core archive contains the runtime only. Configure another font library with impe.local.tex or \SetCatalogFontRoot{...}.

Checkout-local documents may load package/impe-system.tex directly:

\usepackage{import}
\subimport{../../package/}{impe-system.tex}
\UseTemplateSet{...}

Font Resources

The CTAN distribution does not include the optional local font library. Some multilingual manual and showcase sources require locally configured fonts for full source reproduction; the prebuilt documentation PDFs are included. The third-party records under font_licenses/ belong to the source repository and, where applicable, the full release—not to the CTAN archive, which contains no font binaries or font-license tree.

Documentation

Build every manual with:

scripts\build_manual.ps1

Use -Language en, -Language de, or -Language zh-tw for one edition. Direct builds from manual/en/ and manual/zh-tw/ use their .latexmkrc files and .

Repository Layout

package/          public package and class entries
core/             stable subsystem logic
catalog/          public font, layout, and feature registrations
modules/          concrete layout, font, and feature modules
assets/           local runtime resources; font binaries are untracked
manual/           manual sources, tracked PDFs, and showcase
docs/             subsystem reference documentation
scripts/          build and install tooling
tests/            regression suite

Release Packages

scripts\build_release.bat generates:

  • IMPE-LaTeX-System-vX.Y.Z-full.zip: runtime, compatibility wrappers, and the permitted local font library
  • IMPE-LaTeX-System-vX.Y.Z-core.zip: runtime and compatibility wrappers, without fonts
  • impe-framework.zip: CTAN distribution with one impe-framework/ root, canonical impe* entries, manuals, showcase source/PDF, and no next* entries or font binaries

Versioned standalone manual and showcase PDFs retain the impe- project prefix. The CTAN id impe-framework does not change the project name, package name, class names, or TEXMF namespace.

Development and Tests

Run the regression suite with locally configured fonts:

tests\run_regressions.ps1

For CI-safe public font fixtures:

tests\run_regressions.ps1 -PublicFonts

The suite covers canonical and legacy entry points, font routing, manual builds, deterministic CTAN packaging, archive contents, and installer migration. The repository does not track assets/fonts/; the distribution policy is in assets/README.md.

Maintainer

Sikai Yang. Use GitHub Issues for public contact and support.

License

MIT License. See LICENSE.

Download the contents of this package in one zip archive (5.2M).

Impe-framework – A framework for building documents from reusable components

IMPE is a modular framework designed to keep document setup simple even when the underlying typesetting is not. Layouts, fonts, and optional features can be selected through a small set of common interfaces, so ordinary documents do not need to expose the framework’s internal structure.

It provides ready-to-use classes for several document types while keeping layouts, font configurations, and features reusable and extensible. More specialized facilities, including multilingual and script-specific typesetting, can be added when needed without making the basic workflow more complicated.

PackageImpe-framework
Home page
Bug tracker
Repository
Version1.0.1
LicensesMIT License
Copyright2026 Sikai Yang
MaintainerSikai Yang
TopicsDissertation
Article-like
Report like
Class
Book publication
Chinese
Presentation
...
Guest Book Sitemap Contact Contact Author