lanyuanxiaoyao
2fd8bc1b4a
添加可选的description字段用于文档目的，不影响渲染输出。 主要更改： - core/presentation.py: 添加metadata.description属性 - core/template.py: 添加template.description属性 - tests: 添加16个新测试用例验证description功能 - docs: 更新README.md和README_DEV.md文档 - specs: 新增page-description规范文件
47 lines
2.2 KiB
Markdown
47 lines
2.2 KiB
Markdown
# Tasks: Add Description Field to Metadata, Templates, and Slides
|
||
|
||
## 1. 数据模型更新
|
||
|
||
- [x] 1.1 在Metadata/Document类中添加description属性（可选，默认为None）
|
||
- [x] 1.2 在Template类中添加description属性（可选，默认为None）
|
||
- [x] 1.3 在Slide类中添加description属性（可选，默认为None）
|
||
- [x] 1.4 更新Metadata/Document类的__init__方法接受description参数
|
||
- [x] 1.5 更新Template类的__init__方法接受description参数
|
||
- [x] 1.6 更新Slide类的__init__方法接受description参数
|
||
|
||
## 2. YAML解析器更新
|
||
|
||
- [x] 2.1 更新metadata解析逻辑，读取YAML中的description字段
|
||
- [x] 2.2 更新模板解析逻辑，读取模板YAML中的description字段
|
||
- [x] 2.3 更新幻灯片解析逻辑，读取slides列表中的description字段
|
||
- [x] 2.4 确保description字段缺失时使用默认值None
|
||
- [x] 2.5 支持多行YAML格式的description文本
|
||
|
||
## 3. 测试用例
|
||
|
||
- [x] 3.1 添加测试：metadata包含description字段时正确加载
|
||
- [x] 3.2 添加测试：metadata不包含description字段时正常工作
|
||
- [x] 3.3 添加测试：模板包含description字段时正确加载
|
||
- [x] 3.4 添加测试：模板不包含description字段时正常工作
|
||
- [x] 3.5 添加测试：幻灯片包含description字段时正确加载
|
||
- [x] 3.6 添加测试：幻灯片不包含description字段时正常工作
|
||
- [x] 3.7 添加测试：description包含中文字符时正确处理
|
||
- [x] 3.8 添加测试：description为空字符串时正常工作
|
||
- [x] 3.9 添加测试：description不影响渲染输出
|
||
|
||
## 4. 文档更新
|
||
|
||
- [x] 4.1 更新README.md，说明metadata支持description字段
|
||
- [x] 4.2 更新README.md，说明模板支持description字段
|
||
- [x] 4.3 更新README.md，说明幻灯片支持description字段
|
||
- [x] 4.4 在README.md中添加description字段的使用示例
|
||
- [x] 4.5 更新README_DEV.md，记录description字段的设计说明
|
||
- [x] 4.6 确保文档中说明description仅用于文档目的，不影响输出
|
||
|
||
## 5. 验证和集成
|
||
|
||
- [x] 5.1 运行所有现有测试，确保向后兼容性
|
||
- [x] 5.2 运行新添加的测试用例，确保全部通过
|
||
- [x] 5.3 使用包含description的示例YAML进行端到端测试
|
||
- [x] 5.4 验证生成的PPTX文件不受description字段影响
|