01项目简介
Mas标书格式化是一款面向 WPS 文档的自动化排版加载项,用于把标书、技术文档等格式要求严格的稿件快速规范化,显著提升文档处理效率。
- 自动化处理 一键完成页面、标题、表格、图片等多种格式化操作,无需逐项手动设置。
- 智能识别 自动识别目录、价格列等特殊内容,并做针对性处理。
- 批量操作 支持对文档中的所有表格、图片进行批量格式化。
- 素材复用 连接公司素材库,按关键字与分类检索后一键插入到光标位置。
- 批量导入 Word、PDF 与图片按列表顺序批量插入,可拖拽调整顺序、中途停止。
- 详细日志 提供实时日志记录,方便追踪处理过程与排查问题。
02安装步骤
- 确认运行环境 已安装 WPS Office,且版本支持 WPS 加载项功能。
- 打开插件发布页 浏览器访问 插件发布页,安装过程中全部点击“允许”即可完成安装。
03核心功能
1页面格式化
自动把文档页面设置为标准 A4 规格,并配置规范的页眉、页脚与页码:
按 1 cm = 10 单位等比绘制
- 纸张规格
- A4(210 × 297 mm)
- 页边距
- 上下左右均为 2.5 厘米
- 页眉距离
- 1.5 厘米
- 页脚距离
- 1.75 厘米
- 页脚内容
- 右侧显示“重庆梅安森科技股份有限公司 编制”,底部居中显示页码
- 目录处理
- 智能识别目录,自动插入分节符,确保正文从第 1 页开始编号
2应用样式集
一键应用公司统一格式的样式集,无需手动导入:
- 自动获取:从插件站点下载样式集文件,不再需要通过微信传文件、手动导入。
- 直接应用: 把样式集中的标题、正文、表格等样式定义复制到当前文档,与手动应用样式集效果一致。
- 自动缓存: 首次下载后缓存到本地,版本更新时自动重新下载,日常执行不再重复下载。
- 可撤销:整个应用过程作为单条撤销记录,按 Ctrl+Z 可整体回退。
3标题格式化
规范化文档标题样式,确保层次结构清晰:
- 样式刷新:重新应用标题 1-9 的标准样式。
- 编号清理: 自动移除标题开头的数字编号和特殊字符(如“1. ”、“一、”等)。
- 格式统一:确保所有同级标题样式一致。
4表格格式化
统一表格格式,提升专业性与可读性:
- 字体设置:统一为宋体,字号 10.5 磅。
- 段落格式: 表格文字首行缩进清零,行距可在参数设置中选择单倍或 1.5 倍。
- 首行加粗:表头行自动加粗,增强层次感。
- 对齐方式:单元格内容水平与垂直均居中对齐。
- 自适应宽度:表格自动适应窗口宽度。
- 价格列处理: 智能识别包含“单价”“总价”“元”等关键词的价格列,统一保留 2 位小数。
- 数值校验: 校验“单价 × 数量 = 总价”与总价列合计,不符时自动修正并以修订方式记录,可在审阅中逐条接受或拒绝。
5图片格式化
规范化图片格式,确保文档整洁美观:
- 浮动图片转换: 自动将浮动图片转换为嵌入式图片(低于设定高度的小图视为签名图,默认 1.76 厘米,可在参数设置中调整)。
- 样式应用:应用“图片”样式(需文档中已定义该样式)。
- 尺寸限制: 按页面方向分别限制宽高——竖页 16 × 19.5 厘米、横页 19 × 13.5 厘米,超限时等比缩小,略小于上限时归位放大,可自定义。
- 比例锁定:保持图片原始宽高比,防止变形。
6正文格式化
把正文段落统一套用“正文”样式,并按需补充首行缩进,不破坏已有的标题、目录和表格格式:
- 样式驱动: 正文字体、字号、行距、段前段后全部由样式集里的“正文”样式决定,不再单独硬编码;样式集升级后重新执行即可同步。
- 先应用样式集: 文档中没有“正文”样式时会提示先执行“应用样式集”,不会静默改成其他格式。
- 首行缩进: 默认缩进 2 字符,仅在套用样式后补充;只作用于左对齐与两端对齐段落,居中/右对齐段落(落款、日期等)、图片段落和空段落自动跳过。
- 自动避让: 跳过标题样式、目录样式、题注样式和表格内文字,不会覆盖标题样式与表格格式化结果。
- 注意: 套用样式会清除正文段落的直接格式(如局部加粗、局部变色),这是样式规范化的预期行为。
- 风险提示: 目前对标题的识别尚不完善,个别标题可能被误判为正文而刷成“正文”样式。因此独立执行前会弹确认框,“全部执行”也默认不勾选正文格式化。
- 高效率: 关闭屏幕刷新并把连续正文段落合并成区间设置,避免逐段写入造成的卡顿。
- 可撤销:整篇格式统一作为单条撤销记录,按 Ctrl+Z 可整体回退。
7更新目录域
保持文档目录和域的实时更新:
- 目录更新:自动更新文档中的目录(如果存在)。
- 域更新:批量更新文档中所有域,确保数据准确性。
8全部执行
按顺序自动执行所有格式化功能,适合需要全面格式化的文档:
- 页面
- 样式集
- 标题
- 表格
- 图片
- 正文
- 目录域
9插入素材
点击“插入素材”打开素材库面板,检索公司素材并插入到光标位置:
- 索引来源: 面板打开时自动拉取素材索引;拉取失败时保留上次数据并提示,可点“刷新”重试,加载耗时记入日志。
- 检索: 关键字同时匹配标题、分类、摘要与标签,支持空格分词,多个关键词需同时命中。
- 筛选: 分类下拉按素材分类过滤,底部显示素材总数与当前已加载条数,滚动到底部自动加载更多。
- 图片素材: 按原图像素比例插入,超出可插入区域时等比缩小,不放大。
- Word 素材:整篇导入,保留原始排版。
- PDF 素材: 用 pdf.js 逐页渲染为图片插入,渲染分辨率由“导入设置”中的 DPI 决定。
- 标题: 按“导入设置”决定是否在素材前插入标题;开启 MAS 命名解析时按文件名规则截取标题。
- 可撤销:每次插入作为单条撤销记录,按 Ctrl+Z 可回退。
10批量导入
点击“批量导入”打开面板,把多个文件按列表顺序一次性插入到光标位置:
- 支持格式: Word(.doc/.docx)、PDF(.pdf)、图片(.png/.jpg/.jpeg/.bmp),可多选导入;分多次选择会继续追加到列表。GIF 动图会被跳过并提示,因为插入后只会显示为静态图片。
- 排序与清理: 列表内可上下移动、移除单项或清空全部,列表顺序即插入顺序。
- PDF:逐页渲染为图片插入,同时显示总页数与当前页码。
- Word:整篇导入,保留原文排版。
- 图片:原图等比插入,超出可插入区域时等比缩小,不放大。
- 过程控制: 显示整体进度、当前文件名与已完成份数,可随时停止;结束后汇总成功与失败数量。
- 日志: 每份文件记录开始、完成与失败原因,并附带单份耗时;整批结束输出总耗时,便于定位慢文件。
11参数设置
点击“参数设置”在任务窗格中打开设置面板,可在执行前调整各功能的默认参数:
- 页面: 页边距、页眉页脚距离、页脚公司名称、目录前是否插分节符、正文页码是否从 1 开始、首页页眉页脚是否不同。
- 批量执行范围: 勾选“全部执行”要包含的功能(页面、样式集、标题、表格、图片、正文、目录域);正文格式化仍在完善,默认不勾选。
- 标题: 是否刷新标题样式、是否清理编号、处理的标题级别范围。
- 表格: 字体、字号、首行是否加粗、行距是否 1.5 倍、价格列小数位数与识别关键词、数值校验开关与单价/数量/总价列关键词、金额校验容差。
- 正文: 是否跳过表格内文字、首行缩进开关与缩进字符数(正文字体、字号、行距由“正文”样式决定)。
- 图片: 图片样式名、签名图判定高度、各方向尺寸上限、放大/缩小容差、段落修复跳过宽度。
- 目录域:更新目录时是否顺带更新全文所有域(默认关闭)。
- 导入设置: 插入素材与批量导入时是否以文件名作标题、是否按 MAS 命名规则解析标题、标题使用哪种样式、PDF 渲染 DPI。
- 素材库:是否启用素材库,以及素材索引地址(由素材服务提供)。
- 通用: 执行前是否弹确认框(作用于标题与正文格式化,仅单独点击按钮时触发)、执行完成后是否弹窗提示。
常用参数直接展示,“高级参数”分组默认折叠,点击标题展开。修改后点击“保存”立即生效,无需重启加载项;“恢复默认”可还原全部默认值。参数保存在本机,不会写入文档。
12日志与排查
点击“打开日志”可实时查看每次执行的处理过程和结果:
日志级别
- STEP阶段开始
- INFO关键明细
- SUMMARY执行汇总
- SUCCESS动作完成
- WARNING可恢复异常
- ERROR功能失败
- 保留上限: 本机最多保留最近 1000 条,超出后自动丢弃最早记录,避免长期占用存储。
- 实时同步: 日志窗口通过 BroadcastChannel 实时接收;环境不支持时自动降级为轮询。
04二次开发步骤
前提条件
- 已安装 WPS Office(支持 WPS 加载项功能)。
- 已安装 Node.js(建议 18 及以上,推荐 20 LTS)。
- 已安装 npm(Node.js 包管理器)。
- 访问 GitHub 仓库(下载源码)。
安装依赖
打开命令行工具,进入项目目录,执行以下命令安装项目依赖:
npm install
该命令会自动安装项目所需的开发依赖,包括:
-
wps-jsapi-declare:WPS JSAPI 类型声明,提供代码智能提示。 vite:前端构建工具。wpsjs:WPS 加载项开发工具包。-
prettier:代码格式化工具,配合npm run format使用。
05使用指南
开发调试
有两种方式启动开发服务器:
方式一:使用 wpsjs 工具包(推荐)
wpsjs debug
该命令会自动启动 WPS 并加载插件,同时启动本地 HTTP 服务器,支持热更新。WPS 客户端通过 HTTP 服务请求加载项代码和资源。
方式二:使用 Vite 开发服务器
npm run dev
该命令会在
http://localhost:3889 启动开发服务器,支持实时热更新。
素材库服务(可选)
使用「插入素材」前,需要先在一台电脑上启动素材库静态服务,其他电脑通过局域网访问索引与素材文件。
服务脚本为 mock/serve.js,零依赖,只需安装 Node.js。
node mock\serve.js
无参数时服务 mock/.local 目录,默认监听
0.0.0.0:18081,局域网内其他电脑可直接访问。启动时会自动异步重建一次索引,完成后刷新素材面板即可看到新增素材;不需要自动重建时加
--no-rebuild。启动后会打印两份索引地址:
本机访问:http://127.0.0.1:18081/index.json
局域网访问:http://192.168.8.46:18081/index.json
把局域网地址填入「参数设置 → 素材库 → 素材索引地址」即可。指定素材目录与端口:
node mock\serve.js --root="D:\成套素材库" --port=18081 --assets="D:\成套素材库"
只在服务机本机调试时加 --host=127.0.0.1;Windows
防火墙需放行对应端口。索引生成与目录挂载方式见项目内
mock/素材库对接指南.md。
功能按钮说明
加载项成功加载后,WPS 功能区会出现“Mas标书格式化”选项卡,包含以下功能按钮:
| 按钮名称 | 功能说明 |
|---|---|
| 使用说明 | 打开本使用说明文档。 |
| 页面格式化 | 设置文档页面为 A4 规格,配置页边距、页眉页脚和页码。 |
| 应用样式集 | 下载公司样式集并应用到当前文档,无需手动导入。 |
| 标题格式化 | 刷新标题样式,清理标题中的多余编号和字符。 |
| 表格格式化 | 统一表格字体、首行无缩进与行距、对齐方式、自适应宽度,处理价格列并校验数值。 |
| 图片格式化 | 转换浮动图片为嵌入式,应用图片样式,限制图片尺寸。 |
| 正文格式化 | 套用“正文”样式并补充首行缩进,自动跳过标题、目录、题注与表格。 |
| 更新目录域 | 更新文档目录和所有域。 |
| 全部执行 | 按顺序执行所有格式化功能(正文格式化默认不参与,可在参数设置中勾选)。 |
| 插入素材 | 打开素材库面板,检索素材库并插入到光标位置。 |
| 批量导入 | 打开批量导入面板,把 Word、PDF 与图片按顺序批量插入。 |
| 参数设置 | 打开参数设置面板,自定义各功能的默认参数。 |
| 打开日志 | 打开日志窗口,查看详细的执行过程和结果。 |
使用流程
- 打开文档 在 WPS 中打开需要格式化的文档。
- 调整参数(可选) 点击“参数设置”,按需修改页边距、页脚公司名称、图片尺寸上限等参数并保存。
- 选择功能 根据需求点击相应的格式化按钮,或点击“全部执行”一键完成。
- 插入素材(可选) 点击“插入素材”检索素材库并插入;或点击“批量导入”把一批文件按顺序插入到光标处。
- 查看日志 点击“打开日志”按钮,查看详细的执行日志和结果。
- 检查文档 确认格式化效果,如有需要可撤销操作(Ctrl+Z)。
- 执行格式化前,建议先保存文档副本,以防意外情况。
- 标题格式化与正文格式化默认会弹出确认对话框(可在参数设置 → 通用中关闭),且仅在单独点击按钮时触发;“全部执行”不会逐项弹窗。
- 正文格式化仍在完善,可能把标题误判为正文而刷成“正文”样式,默认不参与“全部执行”,独立执行前会二次确认。
- 批量导入的 PDF 会逐页渲染为图片插入,文档体积会相应增大。
- 图片格式化需要文档中已定义“图片”样式。
- 某一功能执行期间,其他格式化按钮将被禁用,直到当前功能执行完成。
生产构建
构建生产版本:
npm run build
构建产物将生成在 dist 目录中,可直接部署到 Web 服务器供 WPS
加载。
npm run preview 可在本地预览构建产物;代码风格检查使用
npm run format(自动修复)与
npm run format:check(只校验不修改)。
EdgeOne 自动部署(静态托管)
本项目使用 EdgeOne 部署,可绑定自定义域名(如
masformat.limitlm.top)。这条链路只托管静态产物,不需要
KV,也不包含素材库热更新接口。
在 EdgeOne 控制台新建项目时,按照下表填写构建配置:
| 字段 | 填写值 |
|---|---|
| 框架预设 | Other |
| 根目录 | / |
| 输出目录 | out |
| 安装命令 | npm install |
| 编译命令 | npm run edgeone:deploy |
自动化原理:
EdgeOne 编译命令只接受
npm run ... 形式,因此将整套部署流水线封装在
scripts/edgeone-deploy.cjs 中。EdgeOne 只需执行
npm run edgeone:deploy 即可,后续
git push 自动触发构建上线。
安装页不再使用 wpsjs 包内硬编码的 publish.html 模板,改由项目内两个文件维护:
-
交互环节:
wpsjs build会弹出 inquirer 选择发布类型,通过echo online |管道喂入 stdin 跳过, 在线模式产物直接整理到out/。 -
发布清单:
.publishlist.json记录加载项的名称、说明、图标、类型与地址,可维护多个条目;每次部署会自动同步package.json中的版本号与发布地址,其余自定义字段保持不变。 -
页面模板:
scripts/publish-template.html独立维护安装页的界面与交互,可自由增加按钮和逻辑;与 WPS 客户端本地端口通信的协议部分保持不变。
后续只需执行 git push 即可触发 EdgeOne 重新构建上线。
Cloudflare Pages 部署(可选,支持热更新)
需要素材库主机在线热更新时,可改用 Cloudflare Pages 部署:Pages 自带
Functions 与 KV,接口和存储都随项目托管,不需要额外平台。自定义域名只需添加一条指向
xxx.pages.dev 的 CNAME,不需要把域名 NS 托管到
Cloudflare。两条链路的产物目录不同(EdgeOne 用 out,Pages 用
dist),可以并存。
在 Pages 控制台新建项目时,按照下表填写构建配置:
| 字段 | 填写值 |
|---|---|
| 框架预设 | None |
| 根目录 | / |
| 输出目录 | dist |
| 安装命令 | npm install |
| 构建命令 | npm run pages:build |
素材库热更新接口:
functions/api/update/
提供检查更新、版本总览与自检三个接口,由 Pages Functions 直接打包。首次上线后到 Pages
项目 → Settings → Functions → KV namespace bindings 绑定命名空间,变量名必须填
MAS_KV;访问
/api/update/ping 可确认绑定状态。未绑定时接口返回
503,静态页面访问不受影响。
06技术支持
项目信息
| 项目名称 | Mas标书格式化(MasFormat) |
|---|---|
| 版本 | v— |
| 类型 | WPS 加载项 |
| 开发框架 | WPS JSAPI + Vite |
| 开发者 | Limitlm |
技术架构
-
入口文件:
index.html— 加载项入口页面。 -
配置文件:
manifest.xml— 加载项清单文件。 -
功能区:
ribbon.xml— 定义 WPS 功能区按钮。 -
配置管理:
js/core/config.js— 默认参数、面板字段定义与读写校验。 -
核心逻辑:
js/format/— 格式化功能实现,每个功能一个文件。 -
素材模块:
js/material/— 素材索引拉取与校验、检索、图片/Word/PDF 素材插入。 -
导入模块:
js/pdf/— 批量导入编排、PDF 逐页渲染、Word 整篇导入、图片等比插入。 -
执行辅助:
js/core/formatCore.js— 撤销合并、屏幕刷新开关、日志缓冲。 -
交互逻辑:
js/ribbon.js— 功能区按钮响应。 -
参数设置:
js/settings.js+ui/settings.html— 参数设置任务窗格。 -
任务窗格:
ui/materialPanel.html、ui/pdfPanel.html— 素材库与批量导入面板。 -
日志系统:
js/core/log.js— 执行日志记录(6 级分类、1000 条上限、跨页面实时广播)。
目录结构
MasFormat/
├── images/ # 图标资源
│ ├── 1.svg
│ ├── 2.svg
│ ├── 3.svg
│ ├── newFromTemp.svg # 未登记按钮的默认回落图标
│ └── ribbon-*.svg # 功能区按钮图标(13 个,按功能命名)
├── js/ # JavaScript源码
│ ├── core/ # 通用基础层
│ │ ├── config.js # 配置模块(默认值、字段定义、读写校验)
│ │ ├── formatCore.js # 执行辅助(撤销合并、屏幕刷新、日志缓冲)
│ │ ├── log.js # 日志模块
│ │ ├── progress.js # 进度条组件(批量导入、素材插入复用)
│ │ └── util.js # 基础工具函数
│ ├── format/ # 功能执行层
│ │ ├── page.js # 页面格式化(含目录定位)
│ │ ├── title.js # 标题格式化
│ │ ├── table.js # 表格格式化与数值校验
│ │ ├── image.js # 图片格式化
│ │ ├── body.js # 正文格式化
│ │ ├── toc.js # 目录域更新
│ │ ├── styleSet.js # 应用样式集
│ │ └── executeAll.js # 全部执行编排
│ ├── material/ # 素材库
│ │ ├── api.js # 素材索引拉取与契约校验
│ │ ├── index.js # 素材面板交互(检索、分类、懒加载)
│ │ └── insert.js # 素材插入(图片/Word/PDF 与标题)
│ ├── pdf/ # 批量导入
│ │ ├── index.js # 面板交互(选择、排序、进度)
│ │ ├── batch.js # 批量编排与逐份执行
│ │ ├── word.js # Word 整篇导入
│ │ ├── render.js # PDF 逐页渲染
│ │ └── insert.js # 图片插入与版心等比缩放
│ ├── ribbon.js # 功能区按钮响应
│ └── settings.js # 参数设置面板逻辑
├── functions/ # Pages Functions(仅 Cloudflare 部署)
│ └── api/update/ # 素材库更新检查、版本总览、自检
├── public/ # 构建时原样复制到 dist
│ └── _routes.json # 仅 /api/* 进入 Functions
├── scripts/ # 构建与部署脚本
│ ├── edgeone-deploy.cjs # EdgeOne 静态部署流水线
│ ├── pack-mock.cjs # 素材库更新包打包
│ ├── pages-build.cjs # Cloudflare Pages 构建流水线
│ ├── publish.cjs # 安装页渲染
│ └── publish-template.html # 安装页模板
├── styles/ # 线上样式集文件
│ └── mas-style-v1.dotx
├── ui/ # 界面文件
│ ├── logViewer.html # 日志查看器
│ ├── materialPanel.html # 素材库面板
│ ├── pdfPanel.html # 批量导入面板
│ └── settings.html # 参数设置面板
├── index.html # 加载项入口
├── main.js # 主脚本加载器
├── manifest.xml # 加载项清单
├── .gitignore # Git 忽略规则
├── .prettierrc # 代码格式化配置
├── package.json # 项目配置
├── ribbon.xml # 功能区定义
└── vite.config.mjs # Vite配置