LoveChengke
19c2aa07b2
文档站（`docs/` 就是 docfx 项目，发布在 https://lovechengke.github.io/ClassHelper/）： - 四章 + 常见问题 + 完整参考，共 44 页：快速上手（8 页）/ 应用帮助（10 页）/ 管理运维（6 页）/ 开发文档（11 页）。信息架构照 ClassIsland 文档站来： 顶栏分章、左侧章节导航、右侧本页目录、上一页 / 下一页、站内搜索、深色主题跟随系统； - 自定义模板覆盖（`templates/classhelper/`）：把 docfx modern 模板那套英文 UI 文案 （In this article / Improve this doc / Next…）换成中文，补 GitHub 入口与版本徽标， 并加一层只调排版与配色的 `public/main.css`（不动 DOM 结构）； - 站点顶栏的版本徽标取自根 `package.json`（`docs/build.mjs` 用 `--metadata` 注入）， 不在文档里写第二份 —— 否则一定漂； - 404 页单独生成：GitHub Pages 的项目页挂在 `/<仓库名>/` 子路径下，而浏览器是按**被请求的路径** 解析页面里的相对链接的，所以 `<base>` 必须钉到站点根，由 `build.mjs`（本地 `./`）与 workflow（CI 传 `/<仓库名>/`）分别注入； - 构建前清空 `_site`：docfx 只覆盖不清理，删掉或改名的页面会以旧文件留在目录里， 而 Pages 上传的是整个目录。 版本迭代（**每一次 releases，不是每一次提交**）： - 新增 `scripts/version.mjs`。这个仓库里同一个版本号散在 **10 个文件**里（5 份 `package.json`、 `deploy/package.runtime.json`、两个 compose 的镜像 tag、插件 `manifest.yml`、以及插件 C# 里的 `PluginVersion` 常量），手工改必然漏一处，而漏掉的那处**不会报错**，只在某个不常走的分支上 表现为"版本号对不上"。现在收口成两条命令：`pnpm version:check`（逐处比对，不一致 exit 1） 与 `pnpm version:bump patch|minor|major`（一次改写全部 10 处，任何一处匹配不到或匹配到多处 就直接失败退出，不做尽力而为的部分改写）； - `AGENTS.md` 新增 §4.4「版本迭代（每一次 releases，不是每一次提交）」：写清版本号落在哪 10 处、 完整发布命令序列（体检 → 验收 → `dist:all` → 哈希清单 → 推 master → `gh release create` → Linux 包由 CI 合并哈希行），以及"已发布的版本号不要复用"的理由。 其它： - `.github/workflows/docs.yml`：推 master（`docs/**` / `package.json` / workflow 自身有变）即构建并 部署到 Pages；构建带 `--check`，把 docfx 的警告当错误 —— 最常见的警告是"某个 `.md` 没被任何 `toc.yml` 引用"，那种页面有内容但没有侧边栏，属于必须修掉的疏漏； - docs 目录重组后的引用同步：`production` / `mysql` / `linux-deploy` / `winisland-design-tokens` 移到新位置后，AGENTS.md、`deploy/`、`scripts/`、客户端源码注释里的路径引用一并更新； - 文档站只发布 `docs/` 这一棵树，页面里指向树外的相对链接（`../AGENTS.md` 等）改成 GitHub 绝对 URL， 否则上线全是 404； - 图标派生清单补上文档站模板里的 `logo.png` 与 `favicon.png`（`pnpm icons` 一并生成， 仍然只有一个图形源 `build/classhelper.{png,ico}`）； - `docs/_site` 进 `.gitignore` / `.prettierignore` 与 ESLint ignores； - 根脚本补 `version:check` / `version:bump` / `docs:build` / `docs:serve` / `docs:check`。
83 lines
4.6 KiB
Markdown
83 lines
4.6 KiB
Markdown
---
|
||
title: 课表
|
||
description: 周课表与「今天」时间轴、单双周、学期周数、课表来源，以及上课时段是怎么判定的。
|
||
---
|
||
|
||
# 课表
|
||
|
||
课表不只是"给学生们看看"的表格 —— **「上课时段」的判定完全基于它**。
|
||
课表排错，提醒就会在该弹的时候不弹。所以这一页值得读完。
|
||
|
||
## 两个视图
|
||
|
||
| 视图 | 在哪 | 内容 |
|
||
| -------------- | ----------------------------------------- | -------------------------------------------------------- |
|
||
| **周视图** | Web 端「课表管理」、客户端「课表 → 本周」 | 节次 × 星期 的 7 列表格 |
|
||
| **今天时间轴** | 客户端「课表 → 今天」 | 大时钟 + 当前状态卡 + 时间轴（已结束 / 正在上 / 下一节） |
|
||
|
||
「今天」时间轴是客户端默认打开的那一屏：
|
||
|
||
- **大时钟**：时:分（大字）+ 秒（小字），下面一行是日期 / 星期 / 第 N 教学周。
|
||
- **当前状态卡**：「正在上 XXX」+ 时段地点 + **距下课 X 分钟**；没课时显示"今天的课都上完了"或"今天没有课程安排"。
|
||
- **时间轴**：左侧时间栏（开始 / 结束）+ 竖向轨道与节点 + 右侧课卡。已结束的置灰、
|
||
正在上的用强调色实底 + 进度条 + 距下课倒计时、下一节用橙色标记 + "还有多久开始"。
|
||
|
||
## 单双周
|
||
|
||
一门课可以设成**每周**（默认）、**单周**或**双周**。判定口径是 **第 1 周 = 单周**。
|
||
|
||
从 ClassIsland 导入时，`WeekCountDiv`（`0=每周 / 1=单周 / 2=双周`）会换算成这套 `ALL / ODD / EVEN`。
|
||
**3 周及以上的轮换没法用单双周表达**，导入时会给出 warning 并按"每周"处理 ——
|
||
如果学校里真的是三周轮换，目前只能用两份课表 + 手工切换的方式绕过。
|
||
|
||
## 学期周数
|
||
|
||
每个班有自己的**学期周数**（`Class.termWeeks`，默认 20，**上限 30**），只有管理员能改。
|
||
|
||
它决定三件事：课表的周次下拉能选到第几周、`weekEnd` 的默认值、以及"现在是第几教学周"。
|
||
周次换算的起点是服务端 `.env` 里的 `TERM_START_DATE`（当学期第 1 教学周的周一）。
|
||
|
||
> **`TERM_START_DATE` 设错，整套周次都错。** 它不在界面上改，要改 `.env` 后重启服务端。
|
||
> 上限三处必须一致（`MAX_TERM_WEEK`、周次校验、班级设置），曾经出现过"班级能设到 40 周、
|
||
> 而课表只到 30 周"的错位。
|
||
|
||
## 上课时段是怎么判定的
|
||
|
||
服务端有一个接口专门回答"这个班现在是不是在上课"：
|
||
|
||
```
|
||
GET /api/schedules/current?classId=<班级 id>[&at=<ISO 时间>]
|
||
```
|
||
|
||
返回 `{ inClass, current, next, week, serverTime }`。`at` 参数可以覆盖判定时刻，用来联调与测试。
|
||
|
||
判定结果被用在四处，规则完全一致：
|
||
|
||
1. 客户端灵动岛：上课时段普通通知**不显示**（窗口直接隐藏）并进队列，下课自动补弹；
|
||
2. ClassIsland 插件：同样暂存，下课后补弹；
|
||
3. 服务端发布接口：上课时段发紧急通知会被拦（`409 URGENT_DURING_CLASS`），确认后放行；
|
||
4. Web 端：提交紧急通知前先查一次状态，命中就弹全屏二次确认。
|
||
|
||
## 课表的"来源"字段
|
||
|
||
每一行课表都记着它是从哪来的：
|
||
|
||
| 来源 | 什么时候产生 | 会被自动清理吗 |
|
||
| ------------- | ---------------------------------------------- | ---------------------------- |
|
||
| `manual` | Web 端手工录入、从 ClassIsland JSON 一次性导入 | **不会**，永远保留 |
|
||
| `classisland` | 教室插件上报同步过来的 | 会——本次没再上报的行会被删掉 |
|
||
|
||
这条规则解决了"老师在 ClassIsland 里删掉一节，小助手这边却永远留着"的幽灵课问题，
|
||
同时保证老师在小助手这边手排的课不会被插件覆盖掉。
|
||
|
||
> 去重键是「星期 + 开始时间 + 单双周」。如果老师手排的某一节恰好和上报的同一时间槽重合，
|
||
> 那一行会被上报"收养"（保留原本的 `manual` 来源），下一次清理不会删它。
|
||
|
||
## 排课 / 改课 / 导入
|
||
|
||
- 手工排课在 **课表管理**（管理员 / 本班班主任）。科目下拉是全校统一的 18 科目录，
|
||
选中一个该班还没有的科目会自动建课。
|
||
- 从 ClassIsland 档案导入最省事，课表、节次时间、单双周会一起进来，
|
||
见[表格与课表导入](imports.md)。
|
||
- 课表变更后会广播 `schedule:updated`，客户端与灵动岛立刻刷新。
|