chenguanzhou123
776190628d
添加完整的cveoreport文档类模板，包含： - 符合国内政府文档规范的文档类定义 - 示例主文档、章节文件和编译脚本 - 多种中文字体文件支持 - 详细的README使用说明 - 特殊环境（重点框、警告框等）和表格样式
170 lines
4.1 KiB
Markdown
170 lines
4.1 KiB
Markdown
# cveoreport - 通用技术报告 LaTeX 模板
|
||
|
||
## 简介
|
||
|
||
cveoreport 是一个基于 LaTeX 的通用技术报告/方案文档模板，遵循国内政府文档规范，支持中英文混排，适用于技术方案、项目申报书、研究报告等各类文档。
|
||
|
||
## 文件结构
|
||
|
||
```
|
||
cveoreport/
|
||
├── cveoreport.cls # 文档类文件（模板核心）
|
||
├── cveoreport.tex # 主入口文件（示例）
|
||
├── README.md # 使用说明
|
||
├── fonts/ # 字体文件目录
|
||
│ ├── simkai.ttf # 楷体
|
||
│ ├── simsun.ttc # 宋体
|
||
│ ├── HYKaiTiJ.ttf # 汉仪楷体
|
||
│ ├── TimesNewRoman.ttf # 英文衬线字体
|
||
│ └── Wingdings.ttf # 符号字体
|
||
├── sections/ # 章节内容目录
|
||
│ └── 示例章节.tex # 示例章节文件
|
||
└── figures/ # 图片资源目录
|
||
└── (请放置您的图片文件)
|
||
```
|
||
|
||
## 快速开始
|
||
|
||
### 1. 准备环境
|
||
|
||
确保系统已安装以下软件：
|
||
- TeX Live 或 MiKTeX
|
||
- lualatex 编译器
|
||
- 建议使用 VSCode + LaTeX Workshop 扩展
|
||
|
||
### 2. 创建项目
|
||
|
||
```bash
|
||
# 复制模板目录
|
||
cp -r cveoreport your_project_name
|
||
cd your_project_name
|
||
```
|
||
|
||
### 3. 配置项目信息
|
||
|
||
编辑 `your_project_name.tex` 文件，修改项目配置：
|
||
|
||
```latex
|
||
% 封面信息定义
|
||
\renewcommand{\ptitle}{您的项目标题}
|
||
\renewcommand{\psubtitle}{项目副标题}
|
||
\renewcommand{\pauthor}{编制单位名称}
|
||
\renewcommand{\pdate}{2026年1月}
|
||
|
||
% PDF 元数据
|
||
\hypersetup{
|
||
pdftitle={项目标题},
|
||
pdfsubject={文档类型},
|
||
pdfkeywords={关键词1, 关键词2}
|
||
}
|
||
```
|
||
|
||
### 4. 添加章节内容
|
||
|
||
在 `sections/` 目录下创建章节文件，然后在主文件中引用：
|
||
|
||
```latex
|
||
\input{sections/概述}
|
||
\input{sections/技术方案}
|
||
\input{sections/实施计划}
|
||
```
|
||
|
||
### 5. 编译文档
|
||
|
||
```bash
|
||
# 方法1：使用 lualatex（推荐）
|
||
lualatex -interaction=nonstopmode your_project_name.tex
|
||
lualatex -interaction=nonstopmode your_project_name.tex # 运行两次更新目录
|
||
|
||
# 方法2：使用 Make（如果有 Makefile）
|
||
make
|
||
|
||
# 方法3：使用 VSCode
|
||
# 选择编译配方 "lualatex ×2"
|
||
```
|
||
|
||
## 模板特性
|
||
|
||
### 封面定制
|
||
模板提供了 `\makecover` 命令，自动生成标准格式封面，包含：
|
||
- 主标题
|
||
- 副标题说明
|
||
- 编制单位
|
||
- 编制日期
|
||
|
||
### 图表支持
|
||
- 支持 `.png`, `.jpg`, `.pdf` 等格式图片
|
||
- 提供 `\figwidth[比例]{文件名}` 命令插入图片
|
||
- 支持子图（subfigure）
|
||
- 支持长表格（longtable）
|
||
|
||
### 特殊环境
|
||
| 环境 | 用途 | 样式 |
|
||
|------|------|------|
|
||
| `keypoint` | 关键要点 | 蓝色边框 |
|
||
| `warningbox` | 注意事项 | 红色边框 |
|
||
| `tipbox` | 提示信息 | 绿色边框 |
|
||
| `references` | 引用文件 | 无编号列表 |
|
||
|
||
### 表格样式
|
||
提供三线表命令：
|
||
- `\topline` - 表格顶线
|
||
- `\midline` - 表格中线
|
||
- `\bottomline` - 表格底线
|
||
|
||
## 自定义修改
|
||
|
||
### 修改页面边距
|
||
|
||
在主文件导言区添加：
|
||
```latex
|
||
\RequirePackage[top=2.5cm,bottom=2.5cm,left=3.0cm,right=3.0cm]{geometry}
|
||
```
|
||
|
||
### 修改章节样式
|
||
|
||
在主文件导言区添加：
|
||
```latex
|
||
\ctexset{section={format=\zihao{-2}\bfseries\centering}}
|
||
```
|
||
|
||
### 添加自定义命令
|
||
|
||
```latex
|
||
\newcommand{\yourcommand}[1]{%
|
||
% 您的命令定义
|
||
}
|
||
```
|
||
|
||
## 常见问题
|
||
|
||
### Q: 编译报错 "File not found"
|
||
A: 请确保所有图片路径正确，使用相对路径，如 `figures/image.png`
|
||
|
||
### Q: 中文字体显示为方块
|
||
A: 确认系统已安装中文字体，或在 fonts/ 目录放置字体文件
|
||
|
||
### Q: 如何调整行距
|
||
A: 在导言区添加 `\setstretch{1.5}`（1.5倍行距）
|
||
|
||
### Q: 如何添加页眉页脚
|
||
A: 模板已预设页眉为项目标题，如需自定义请修改 cls 文件
|
||
|
||
## 参考资料
|
||
|
||
- [LaTeX 官方文档](https://www.latex-project.org/)
|
||
- [ctex 宏包文档](https://ctan.org/pkg/ctex)
|
||
- [hyperref 宏包文档](https://ctan.org/pkg/hyperref)
|
||
|
||
## 许可证
|
||
|
||
本模板基于 MIT 许可证开源，欢迎自由使用和修改。
|
||
|
||
## 作者
|
||
|
||
模板由 cveoreport 开发维护。
|
||
|
||
---
|
||
|
||
如有问题或建议，欢迎提交 Issue 或 Pull Request。
|