WordeX 写法说明

WordeX 写法说明

这里介绍 WordeX 的写法和命令。你(或 AI)只要按这套写法描述内容,模板就会决定它如何输出成规范的 Word 文档。

概览

WordeX 是做什么的

WordeX 不试图复刻完整 Word 界面,而是把正式文档拆成两层:内容源文件描述写什么,模板描述怎么排版和有哪些字段约束。这样,技术报告、期刊论文、通知和企业交付文档就能被反复生成、审阅和修订。

核心思路

内容源文件 + 模板 → 统一结构 → Word .docx

生成流程

从写作到 Word 文档

WordeX 的生成过程很直接:源文件先被解析并载入模板与配置,再整理成统一结构,最后输出为 Word 文档。

1

写源文件

作者或大模型编写源文件,描述文档标题、元数据、章节、图表、公式和引用。

2

载入模板

WordeX 载入引入的模板,执行配置、样式、字段别名等设置。

3

整理结构

把内容整理成统一的中间结构,保留章节、段落、题注、编号和引用关系。

4

生成 Word

将整理好的结构和最终样式渲染为 Microsoft Word 可打开的 .docx 文件。

文档项目

在浏览器里管理文档项目

WordeX 用项目来组织源文件、模板和素材。项目页可以创建、进入或删除项目;编辑页展示文件树和编辑器,并支持上传文件或目录。

文件树

管理 .wex、.txt、.md、.json、.csv、.tex 和图片素材。

编辑器

为 .wex 提供语法高亮、提示标记、行号、搜索和括号匹配。

项目素材

相对资源从项目根目录解析,图表可引用 assets/ 下的文件。

生成结果

生成当前打开的 .wex 文件,并下载得到的 .docx。

写法基础

写内容本身,而不是调 Word 样式

WEX 使用类 LaTeX 的命令写法。普通正文直接写自然段;标题、元数据、图片、公式、表格和引用用反斜杠命令表达。

官网文档使用静态高亮展示写法,不加载完整在线编辑器。

\include{@builtin/tech.report.basic}

\title{技术报告模板使用说明}
\issuer{硅途数智}
\date{2026-06-10}

\section{套用模板}

在文首引入内置模板,填好标题、单位与日期,正文按章节书写即可,版式由模板统一接管。

\figure{assets/structure.png}[caption=模板章节结构示意,label=fig:structure,width=420]

模板结构见\ref{fig:structure}

表格

表格支持简单的竖线写法,也支持结构化单元格。图片、公式和表格可以加标签,并在正文中引用。

\table{测试设备清单}[label=tab:equipment,style=grid]{
| 设备名称 | 型号 | 编号 |
| 接收机 | ESR 7 | A001 |
}

命令参考

支持的内置命令

以下命令来自 WordeX 默认命令表。表格内部的 row、th、td 由表格解析器处理;公式语法由解析器直接支持。

模板与配置

控制模板引入、页面配置、编号、渲染和样式,主要由模板使用。

\include{path}

载入模板或其他 WEX 文件。支持 @builtin、@project、@current、@user 和相对路径。

\config{name}{value}

写入规则配置,例如 requiredMeta、allowedBlocks、maxSectionDepth。

\page{...}

等价于 \config{page}{...},描述纸张、页边距、分栏、页眉页脚等页面规则。

\numbering{...}

等价于 \config{numbering}{...},描述章节、图表、公式等编号规则。

\render{...}

等价于 \config{render}{...},描述渲染阶段选项。

\style{role}{patch}

修改最终样式 role,支持 key=value 和结构化块。

\alias{name}{meta:key}

为模板字段注册友好的元数据命令,例如 \journalyear{2026}。

常用元数据

描述标题、日期、签发单位和通用元数据。

\title{...}

文档标题。

\issuer{...}

签发单位、出具单位或署名单位。

\date{YYYY-MM-DD}

文档日期。

\recipients{...}

主送对象;支持顿号、中文逗号或英文逗号分隔。

\meta{key}{value}

写入任意结构化元数据路径,例如 journal.name.zh。

期刊元数据

期刊、论文和报告模板常用的内置元数据命令。

\doi{...}

DOI。

\editornote{...}

编辑说明。

\author{...}

作者;可重复使用形成作者列表。

\affiliation{...}

作者单位;可重复使用。

\classification{...}

分类号。

\abstract{...}

中文摘要。

\keywords{...}

中文关键词;按分号、逗号、顿号分隔。

\correspondence{...}

通信作者或联系信息;可重复使用。

\englishtitle{...}

英文标题。

\englishauthor{...}

英文作者;可重复使用。

\englishaffiliation{...}

英文单位;可重复使用。

\englishabstract{...}

英文摘要。

\englishkeywords{...}

英文关键词;按分隔符拆分。

\fund{...}

基金项目。

\received{...}

收稿日期。

\revised{...}

修回日期。

\authorbio{...}

作者简介;可重复使用。

结构与正文

构建正文结构、段落、列表、附件、题注和标签。

\section{...}

一级标题,可带 [role=...] 覆盖样式 role。

\subsection{...}

二级标题,可带 [role=...]。

\subsubsection{...}

三级标题,可带 [role=...]。

\paragraph{...}

显式段落;可带 [role=docx.someStyle]。

\item{...}

列表项。

\attachment{...}[from=...]

附件块,from 指向项目内文件。

\caption{...}

显式题注块。

\label{id}

把标签附加到前一个可编号结构,例如公式。

图片、表格与引用

插入图片、表格、交叉引用和参考文献。

\figure{path}[caption=...,label=...,width=...]

图片;支持 captionEn、role、captionRole。

\table{caption}[label=...,style=grid]{...}

表格;支持 pipe 表格和结构化单元格。

\row[header]{...}

结构化表格内部命令,定义一行。

\th[colspan=...,rowspan=...]{...}

结构化表格内部命令,定义表头单元格。

\td[colspan=...,rowspan=...]{...}

结构化表格内部命令,定义普通单元格。

\bibitem{id}{text}

声明参考文献条目。

\cite{id}

正文内引用参考文献,渲染为编号交叉引用。

\ref{id}

正文内引用图片、表格或公式标签。

公式语法

公式不是普通命令注册项,但由解析器支持,并在生成阶段编号和渲染。

$...$

行内公式。

\(...\)

行内公式。

\[...\]

不带 equation 环境的展示公式。

\begin{equation}...\end{equation}

编号展示公式,可紧跟 \label{eq:id}。

\begin{equation*}...\end{equation*}

不带编号的展示公式。

模板

模板决定排版规则

模板通过 include 载入。内置模板使用 @builtin 前缀,自定义模板可以放在项目路径、当前文件路径或用户全局目录里。模板可以定义页面、编号、样式 role 和字段别名。

\include{@builtin/tech.report.basic}

\style{section.1}{
  size: 18
  color: "#1F4E79"
}

\alias{journalyear}{meta:journalYear}
\journalyear{2026}

page.wex

模板里可维护的 WEX 文件。

styles.wex

模板里可维护的 WEX 文件。

aliases.wex

模板里可维护的 WEX 文件。

从 Word 提取模板

用现有 Word 文档生成模板初稿

WordeX 可以把一份参考 Word 文档提取成可编辑的模板初稿。这个流程用于生成后续可维护的模板,不承诺对任意 Word 文档做一次性无损复刻。

npm run wordex -- extract-template ./reference.docx -o ./templates/my.template --name my.template
npm run wordex -- verify-template ./templates/my.template
npm run wordex -- build ./main.wex -o ./dist/my-template-check.docx

边界说明

参考 Word 文档只在提取阶段读取。正式生成仍走 WEX 到 DOCX 的标准链路,不会在生成阶段回读原始 Word 内容做修补。

测试状态

在线编辑器入口

WordeX 在线编辑器目前处于内部测试阶段。通过测试后,这里会承载在线文档项目。