CTAN Comprehensive TeX Archive Network

Directory macros/latex/contrib/simplesystemtex

README.md

SimpleSystem

An automated file & block management system for large-scale typesetting.

SimpleSystem is a package built on 3, specifically designed for large-scale, integrated typesetting tasks. Its core design philosophy is to maximize the separation of content and structure.

By freeing creators from constantly managing global document structure, anchors, and stylistic details, this package significantly reduces the maintenance burden of large documents. This approach is particularly beneficial for boosting efficiency when utilizing AI tools for text polishing or assisting.

Key Features

  • Automated File Management: Treat "Sections" as independent subfiles. Import them sequentially to automatically build your document body.
  • Auto-Generated TOC: Easily generate a Table of Contents (\TableofContents) that dynamically adapts to the sequence of your imported section files.
  • Block & Cross-Reference Integration: Declare regular and anonymous block types (e.g., Theorems, Definitions, Proofs). Creating a block automatically generates anchors, allowing you to link them effortlessly without manually managing \label and \ref.
  • Automated Indexing: Quickly generate indices for specific block types within any specific group/directory scope (\MakeBlockIndex).
  • Highly Flexible Styling Engine: A powerful \SetStyle command that supports standard commands, special display arguments (e.g., @sectionname), and conditionals (e.g., #ifempty) to customize the appearance of TOCs, headings, blocks, and links.

Building from Source

This project utilizes the standard 3 build system. If you are cloning this repository or downloading the raw source code, you can open your terminal in the project's root directory and run

l3build unpack

to generate the simplesystemtex.sty package file from the source files.

This command will use the included build.lua script to automatically process the source files and extract the ready-to-use simplesystemtex.sty file.

Typical Directory Structure

The system relies on a clean directory structure. By default, it looks for section files in the ./sec/ directory:

Project/
├── main.tex                 % Your main LaTeX file
├── simplesystemtex.sty      % The package file (if not installed globally)
└── sec/
    └── Group/               % Top-level group
        ├── Subgroup/        % Second-level group
        │   ├── Section1.tex % Section file
        │   └── Section2.tex

Quick Start

  1. Main File (main.tex)
\documentclass{article}
\usepackage{simplesystemtex}

% Declare block types in the preamble
\NewBlockType{Theorem}
\NewBlockType*{Proof}

\begin{document}

% Generate the Table of Contents
\TableofContents

% Import sections (Paths are relative to the default './sec/' prefix)
\AddPart{Part A: Introduction}
\ImportSection{Group/Subgroup/Section1}(Custom Display Name)

\end{document}
  1. Section File (sec/Group/Subgroup/Section1.tex)

Write your content using the declared block commands.

\Theorem{thm-euler}{Euler's Identity}{
    $e^{i\pi} + 1 = 0$
}

\Proof(Proof of Identity){
    As we can see from \blclink{thm-euler}, the relationship between these fundamental constants is elegant...
}

% Insert a block index anywhere
\MakeBlockIndex{Group/Subgroup}[Theorem]

Documentation

For comprehensive details on all commands, advanced styling configurations, and predefined styles, please refer to the official manual: simplesystemtex.doc.pdf.

Repository & Bug Tracker

License

This material is subject to the Project Public License (LPPL), version 1.3c or later.

Download the contents of this package in one zip archive (171.2k).

SimpleSystem – An automated file & block management system for large-scale

This 3 package has been specifically designed for large-scale, integrated typesetting tasks such as books, theses, or extensive lecture notes.

The core design philosophy of this package is to maximize the separation of content and structure. It provides an automated file and block management system that frees content creators from constantly managing global document structure and stylistic details.

Key features include:

  • Automated subfile management: Section files are automatically added to the TOC upon import.
  • A flexible Block System for theorems, definitions, and proofs.
  • Dynamic cross-referencing that generates and manages anchors automatically.
  • Automated generation of block indexes (e.g., List of Theorems).
  • Highly customizable styling via dynamic display arguments and conditional statements.

PackageSimpleSystemTeX
Bug trackerhttps://github.com/JokerXin2025/SimpleSystemTeX/issues
Repositoryhttps://github.com/JokerXin2025/SimpleSystemTeX
Version1.0.0 2026-03-24
LicensesThe Project Public License 1.3c
MaintainerKeXin Zhou
Contained inTeX Live as simplesystemtex
TopicsBook publication
Optimise
...
Guest Book Sitemap Contact Contact Author