apluslms/compile-presentation

apluslms/compile-presentation镜像说明

镜像概述

本镜像为A+ LMS课程体系提供演示文稿生成工具，可从课程reStructuredText（RST）文件中的兴趣点（POI）指令提取内容，生成兼容hovercraft的RST文件，进而创建HTML演示文稿，并支持通过deck2pdf或rst2pdf生成PDF文件。请注意，该项目已归档，不再维护。

核心功能

• 内容提取：从课程RST文件中收集POI内容，自动生成演示文稿专用RST文件；
• 格式支持：生成HTML演示文稿（基于hovercraft），并提供两种PDF生成方式（deck2pdf/ rst2pdf）；
• 自定义配置：通过配置文件或参数设置演示文稿标题、作者、语言、页眉/页脚等；
• 功能扩展：支持隐藏特定POI、添加背景图片、多列布局、嵌入视频/音频及数学公式等。

使用场景

• 教育工作者将课程重点内容转化为课堂演示文稿；
• 学生从课程材料中提取POI生成复习用演示文稿；
• 课程开发者测试和生成课程配套演示内容。

配置说明

1. 配置文件（presentation_config.yaml）

在课程根目录创建配置文件，可设置以下内容：

• 基础信息：标题、副标题、作者、描述；
• 页眉页脚：内容及可见性（如header_visible: True）；
• PDF设置：开启PDF生成（make_pdf: True）并选择生成方法（rst2pdf: False启用deck2pdf）；
• 语言设置：指定演示文稿语言（如language: en）。

2. 课程参数（course.yml）

在课程根目录的course.yml中配置镜像使用步骤：

yaml
version: 2
steps:
  - img: apluslms/compile-presentation:latest
    cmd: -y "presentation_config.yaml" -l en -p -m
    mnt: /compile

• cmd参数说明：
  • -y：指定配置文件路径；
  • -l en：设置语言为英语；
  • -p：开启PDF生成；
  • -m：使用deck2pdf生成PDF。

Docker部署示例

该镜像需配合Roman工具（A+课程构建工具）使用：

1. 安装Roman（需Python 3.5+）：

   bash
   python3 -m venv venv
   source venv/bin/activate
   pip install apluslms-roman==0.2.1rc4
   

2. 在课程根目录运行Roman：

   bash
   roman
   

生成的演示文稿将位于_build/presentation（HTML）和_build/pdf（PDF）文件夹中。