diff --git a/src/.vuepress/navbar/zh.ts b/src/.vuepress/navbar/zh.ts index 954e82e..f009457 100644 --- a/src/.vuepress/navbar/zh.ts +++ b/src/.vuepress/navbar/zh.ts @@ -3,7 +3,6 @@ import { navbar } from "vuepress-theme-hope"; export const zhNavbar = navbar([ "/", "/app/", - "/web/", "/management/", - "/community/", + "/about/", ]); diff --git a/src/.vuepress/sidebar/zh.ts b/src/.vuepress/sidebar/zh.ts index 3e5baa7..c3745c2 100644 --- a/src/.vuepress/sidebar/zh.ts +++ b/src/.vuepress/sidebar/zh.ts @@ -11,33 +11,32 @@ export const zhSidebar = sidebar({ "/app/": [ { icon: "fa-solid fa-lightbulb", - text: "应用帮助", - children: [ - "index.md", - "setup.md", - { - text: "档案设置", - collapsible: true, - expanded: true, - prefix: "profile/", - children: [ - "faq.md", - ], - icon: "fa-solid fa-file-lines" - }, - ], - }, - ], - "/web/": [ - { - text: "网页端", + text: "客户端", children: [ "README.md", + "setup.md", { - text: "部署教程", - link: "web-deploy.md", - icon: "fa-solid fa-file-lines" + text: "桌面端", + collapsible: true, + expanded: true, + prefix: "Desktop/", + children: [ + "README.md", + ], + icon: "desktop" }, + { + text: "网页端", + collapsible: true, + expanded: true, + prefix: "Web/", + children: [ + "README.md", + "web-deploy.md", + ], + icon: "globe" + }, + "config-edited.md", ], }, ], @@ -80,12 +79,14 @@ export const zhSidebar = sidebar({ ], }, ], - "/community/": [ + "/about/": [ { - text: "社区", + text: "关于", children: [ "README.md", - "rules.md" + "contributing.md", + "community.md", + "rules.md", ], }, ], diff --git a/src/.vuepress/theme.ts b/src/.vuepress/theme.ts index 128e039..3eaec62 100644 --- a/src/.vuepress/theme.ts +++ b/src/.vuepress/theme.ts @@ -14,7 +14,7 @@ export default hopeTheme({ logo: "https://avatars.githubusercontent.com/u/195304368?s=200&v=4", - repo: "ExamAware/ExamAware-docs-next", + repo: "ExamAware/ExamAware-docs", docsDir: "src", diff --git a/src/README.md b/src/README.md index 2094ee3..2f3e9b2 100644 --- a/src/README.md +++ b/src/README.md @@ -25,9 +25,9 @@ actions: --- -欢迎来到 ExamAware 的文档。 +欢迎来到 DSZ ExamAware 的文档。 -ExamAware 系列软件是显示当前时间与考试详细信息的工具，可以在各平台上运行。 +DSZ ExamAware 系列软件是显示当前时间与考试详细信息的工具，可以在各平台上运行。 ## 开始使用 @@ -47,23 +47,18 @@ ExamAware 系列软件是显示当前时间与考试详细信息的工具，可
-
diff --git a/src/about/README.md b/src/about/README.md new file mode 100644 index 0000000..e7959cc --- /dev/null +++ b/src/about/README.md @@ -0,0 +1,20 @@ +--- +title: 关于 +index: false +icon: users +category: + - 关于 +--- +# 关于我们 +ExamAware 是一个由一群热爱学习的学生开发者组成的团队。 + +我们的目标是为学生提供一个方便的考试工具，帮助他们更好地享受考试的过程(划掉)。 + +# 团队成员 + +- [Hello8693](https://github.com/hello8693) +- [MKStoler](https://github.com/MKStoler1024) +- [jiangyin](https://github.com/jiangyin14) +- [fhzit](https://github.com/fhzit) +- [unDefFtr](https://github.com/unDefFtr) +- [Jursin](https://github.com/Jursin) diff --git a/src/community/README.md b/src/about/community.md similarity index 97% rename from src/community/README.md rename to src/about/community.md index 33f2037..5331f8e 100644 --- a/src/community/README.md +++ b/src/about/community.md @@ -1,4 +1,5 @@ --- +title: 加入社区 icon: users index: true --- diff --git a/src/community/contributing.md b/src/about/contributing.md similarity index 70% rename from src/community/contributing.md rename to src/about/contributing.md index b2f9aa9..270711c 100644 --- a/src/community/contributing.md +++ b/src/about/contributing.md @@ -2,10 +2,10 @@ icon: code-commit --- -# 向 ClassIsland 文档做贡献 +# 向 ExamAware 文档做贡献 ::: warning 注意 -本文章是面向 _**ClassIsland 文档**_ 贡献者的贡献指南。如果您要为 **ClassIsland 本体** 做出贡献，请参阅 [ClassIsland 贡献指南](https://github.com/ClassIsland/ClassIsland/blob/master/CONTRIBUTING.md)。 +本文章是面向 _**ExamAware 文档**_ 贡献者的贡献指南。 ::: 在没有错误日志的情况下诊断任何问题无异于闭眼开车 > —— Apache 官方文档 Gettings Started 篇章 -3. 如果您要反馈软件的 Bug，或者要提出一个功能请求，建议[提交一个 Issue](https://github.com/ExamAware/ExamAware2-Desktop/issues/)。开发者可能会遗漏在聊天里提出的 Bug 反馈和功能请求。 +3. 如果您要反馈软件的 Bug，或者要提出一个功能请求，建议前往对应项目提交一个 Issue。开发者可能会遗漏在聊天里提出的 Bug 反馈和功能请求。 如果您不知道如何有效、精准地表述您的问题，我们建议您先阅读[《提问的智慧》](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way/blob/main/README-zh_CN.md)。 @@ -74,6 +74,6 @@ icon: scale-balanced 感谢您对本规范的支持与配合！希望大家能共同营造一个友好、和谐的交流社区。 ::: right -Hello8693 +ExamAware 团队 2025 年 1 月 4 日 ::: diff --git a/src/app/Desktop/README.md b/src/app/Desktop/README.md new file mode 100644 index 0000000..1f8b5a6 --- /dev/null +++ b/src/app/Desktop/README.md @@ -0,0 +1,18 @@ +--- +title: 桌面端 +index: false +category: + - 使用指南 +--- + +# 安装 ExamAware Dsektop 桌面端 + +请参阅[安装与开始](../setup.md) + +## 编写配置文件 + +请参阅[编写配置文件](../config-edited.md)。 + +## 问题反馈 + +如果您在使用的过程中遇到了 Bug，或者对本项目有任何的建议，可以在[这里](https://github.com/ExamAware/ExamAware2-Desktop/issues)提交 Issue。 \ No newline at end of file diff --git a/src/app/README.md b/src/app/README.md index 1a39bbc..576d128 100644 --- a/src/app/README.md +++ b/src/app/README.md @@ -1,5 +1,5 @@ --- -title: 桌面端 +title: 客户端介绍 index: false icon: lightbulb category: @@ -8,14 +8,23 @@ category: 这里是 ExamAware 帮助文档，关于应用本体的使用方法和常见问题，请参阅本文档。 +# 应用介绍 + +DSZ ExamAware 是该系列应用总称，也是本团队的团队名和 GitHub 组织名，具有众多子项目，辐射全平台。 + +ExamAware 系列旨在为考生展示当前时间与考试详细信息，其共用一套配置文件（存储在 json 文件里），可通过集控统一管理。 + +ExamAware 具有众多子项并适用于不同平台，在开始之前您需要根据情况选择合适应用。 + + ## 安装 ExamAware 请参阅[安装与开始](setup.md)。 -## 编写配置文件 +## 开始使用 -请参阅[编写配置文件](profile/faq.md)。 +您可以通过阅读本帮助文档来快速上手本应用。建议您按照以下顺序学习软件的基本功能： ## 问题反馈 -如果您在使用的过程中遇到了 Bug，或者对本项目有任何的建议，可以在[这里](https://github.com/ExamAware/ExamAware2-Desktop/issues)提交 Issue。 \ No newline at end of file +如果您在使用的过程中遇到了 Bug，或者对本项目有任何的建议，您可以前往[QQ 群](https://qm.qq.com/q/zDiEipHsaI)或者前往[Discussion](https://github.com/orgs/ExamAware/discussions)交流。 \ No newline at end of file diff --git a/src/web/README.md b/src/app/Web/README.md similarity index 86% rename from src/web/README.md rename to src/app/Web/README.md index 8909bcb..f7842ea 100644 --- a/src/web/README.md +++ b/src/app/Web/README.md @@ -1,7 +1,7 @@ --- title: 网页端 index: false -icon: server +icon: globe category: - 使用指南 - 部署教程 @@ -49,7 +49,13 @@ category: #### 电子钟表界面 ![time](../web/images/es-time.png) +#### 考试广播界面 +![notification](../web/images/es-notification.png) ## 开始使用/如何部署？ -请参阅[部署教程](/web/web-deploy.md)。 +请参阅[部署教程](../web/web-deploy.md)。 + +> [!WARNING] +> +> 注意，广播与看板的配置文件是**分开存储于不同的两个文件夹之下**。 diff --git a/src/web/images/bt01.png b/src/app/Web/images/bt01.png similarity index 100% rename from src/web/images/bt01.png rename to src/app/Web/images/bt01.png diff --git a/src/web/images/bt02.png b/src/app/Web/images/bt02.png similarity index 100% rename from src/web/images/bt02.png rename to src/app/Web/images/bt02.png diff --git a/src/app/Web/images/es-exam.png b/src/app/Web/images/es-exam.png new file mode 100644 index 0000000..0fbcf8e Binary files /dev/null and b/src/app/Web/images/es-exam.png differ diff --git a/src/app/Web/images/es-notification.png b/src/app/Web/images/es-notification.png new file mode 100644 index 0000000..630fb1c Binary files /dev/null and b/src/app/Web/images/es-notification.png differ diff --git a/src/app/Web/images/es-time.png b/src/app/Web/images/es-time.png new file mode 100644 index 0000000..3e966cc Binary files /dev/null and b/src/app/Web/images/es-time.png differ diff --git a/src/app/Web/images/es.png b/src/app/Web/images/es.png new file mode 100644 index 0000000..3c20856 Binary files /dev/null and b/src/app/Web/images/es.png differ diff --git a/src/web/images/gh01.png b/src/app/Web/images/gh01.png similarity index 100% rename from src/web/images/gh01.png rename to src/app/Web/images/gh01.png diff --git a/src/web/images/iis01.png b/src/app/Web/images/iis01.png similarity index 100% rename from src/web/images/iis01.png rename to src/app/Web/images/iis01.png diff --git a/src/web/images/iis02.png b/src/app/Web/images/iis02.png similarity index 100% rename from src/web/images/iis02.png rename to src/app/Web/images/iis02.png diff --git a/src/web/images/iis03.png b/src/app/Web/images/iis03.png similarity index 100% rename from src/web/images/iis03.png rename to src/app/Web/images/iis03.png diff --git a/src/web/images/iis04.png b/src/app/Web/images/iis04.png similarity index 100% rename from src/web/images/iis04.png rename to src/app/Web/images/iis04.png diff --git a/src/web/images/iis05.png b/src/app/Web/images/iis05.png similarity index 100% rename from src/web/images/iis05.png rename to src/app/Web/images/iis05.png diff --git a/src/web/images/iis06.jpg b/src/app/Web/images/iis06.jpg similarity index 100% rename from src/web/images/iis06.jpg rename to src/app/Web/images/iis06.jpg diff --git a/src/web/images/iis07.png b/src/app/Web/images/iis07.png similarity index 100% rename from src/web/images/iis07.png rename to src/app/Web/images/iis07.png diff --git a/src/web/images/iis08.png b/src/app/Web/images/iis08.png similarity index 100% rename from src/web/images/iis08.png rename to src/app/Web/images/iis08.png diff --git a/src/web/images/iis09.png b/src/app/Web/images/iis09.png similarity index 100% rename from src/web/images/iis09.png rename to src/app/Web/images/iis09.png diff --git a/src/web/web-deploy.md b/src/app/Web/web-deploy.md similarity index 98% rename from src/web/web-deploy.md rename to src/app/Web/web-deploy.md index 1d83a6b..a400bbb 100644 --- a/src/web/web-deploy.md +++ b/src/app/Web/web-deploy.md @@ -4,7 +4,7 @@ 填写或者用使用`ExamAware2` 或 `ExamCloud`集成的编辑器生成 `exam_config.json` 配置文件 -请参阅[配置文件](/app/profile/faq.md)。 +请参阅[配置文件编写](../config-edited.md)。 ## 使用Python部署 - 确保安装[Python](https://www.python.org/downloads/)。 diff --git a/src/app/profile/faq.md b/src/app/config-edited.md similarity index 85% rename from src/app/profile/faq.md rename to src/app/config-edited.md index d7b491f..3dfb803 100644 --- a/src/app/profile/faq.md +++ b/src/app/config-edited.md @@ -43,12 +43,10 @@ > > 如果有两个以"/"分隔的科目可以自动转化为双行显示 -## 配置文件编辑器(legacy) -> [!caution] -> **配置文件编辑器(legacy)不再维护** 如果您汇报使用此编辑器遇到的相关问题， **开发者可能不会受理。** +## 配置文件编辑器 - 您可以前往[ExamShowBoardEditor](https://github.com/ProjectCampus-CH/DSZExamShowBoardEditor/releases/latest)获取GUI的配置文件生成软件 - 1.双击运行从[仓库](https://github.com/ProjectCampus-CH/DSZExamShowBoardEditor/releases/latest)下载的软件 + 您可以前往[ExamScheduleEditor](https://github.com/ExamAware/ExamScheduleEditor/releases/latest)获取GUI的配置文件生成软件 + 1.双击运行从[仓库](https://github.com/ExamAware/ExamScheduleEditor/releases/latest)下载的软件 2.点击 `添加考试信息` 按钮添加考试信息 - 输入考试科目名称 - 输入考试日期，考试日期的格式如下 diff --git a/src/app/setup.md b/src/app/setup.md index 7ecfcd9..6b4629b 100644 --- a/src/app/setup.md +++ b/src/app/setup.md @@ -1,7 +1,9 @@ --- -icon: fa-solid fa-download +title: 安装与开始 +index: false +icon: list-check category: - - 使用指南 + - 应用使用指南 tag: - 应用 - 安装 @@ -9,68 +11,65 @@ tag: # 安装与开始 -本文将介绍如何安装与开始使用考试看板。 +本文将介绍如何安装与开始使用 DSZ ExamAware 考试看板系列软件。 -## 检查系统需求 - -首先，确保您的设备满足以下需求： - - Windows 10 及以上版本的系统，x86_64 架构 - - Linux 系统 - - macOS 系统 - - macOS 13 及以上版本 - - 移动设备 - - 安卓系统 - - 安卓 7 及以上版本 - - iOS 系统 - - iOS 13 及以上版本 - -# 下载应用本体 - -对于普通用户，可以在以下渠道下载到本软件，请根据自身网络环境选择合适的渠道。 -| Github下载 | [Releases](https://github.com/ExamAware/dsz-exam-showboard/releases) | [Actions](https://github.com/ExamAware/dsz-exam-showboard/actions) | -| ---- | -------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | - -# 安装软件 - -下载完成后，双击运行对应版本的安装包，等待进度条走完后双击运行系统桌面的 `ExamShowboard`快捷方式即可开始使用 +## 检查系统版本 > [!tip] -> 本软件的默认安装路径为 `AppData\Local\Programs\exam-showboard` -> +> 在使用桌面端或移动端时，请确保您的设备系统满足以下要求! + +- 桌面端 + - Windows 系统 + - Windows 10 及以上版本，x86_64 架构 + - Linux 系统 + - 待定 + - macOS 系统 + - macOS 13 及以上版本 +- 移动端 + - 安卓系统 + - 安卓 7 及以上版本 + - iOS 系统 + - iOS 13 及以上版本 +- 网页端 + - 谷歌浏览器 + - 微软 Edge + - 火狐浏览器 + - 苹果 Safari + - 360 浏览器 + - 其他浏览器 + - 请自行测试兼容性 + +## 安装应用 + +对于普通用户，可以在以下渠道下载到本软件，请根据自身网络环境选择合适的渠道。 + +| 名称 | 简述 | 🚀 发行版 | 🚧 当前构建 | +| - | - | - | - | +| [ExamShowboard-Legacy](https://github.com/ExamAware/ExamShowboard-Legacy) | 旧版桌面端考试看板 | [Releases](https://github.com/ExamAware/ExamShowboard-Legacy/releases) | [Actions](https://github.com/ExamAware/ExamShowboard-Legacy/actions) | +| [ExamAware2-Desktop](https://github.com/ExamAware/ExamAware2-Desktop) | 全新重构的桌面端考试看板 ***（开发中）*** | *暂无* | *暂无* | +| [ExamSchedule](https://github.com/ExamAware/ExamSchedule) | 静态网页版考试看板 | [ExamSchedule-main](https://github.com/ExamAware/ExamSchedule) | [ExamSchedule-dev](https://github.com/ExamAware/ExamSchedule/tree/dev) | +| [ExamCloudSchedule](https://github.com/ExamAware/ExamCloudSchedule) | 考试云看板 | [Releases](https://github.com/ExamAware/ExamCloudSchedule/releases) | | +| [ExamShowboard-Mobile](https://github.com/ExamAware/dsz-examaware-mobile) | 基于旧版移动端，暂停开发 | 请前往[QQ 群](https://qm.qq.com/q/zDiEipHsaI) `群文件` 获取 | | + +> [!tip] +>移动端目前缓慢更新，待`ExamAware2-Desktop`成熟后继续维护 +>如需下载，请前往[交流群](https://qm.qq.com/q/zDiEipHsaI)下载 + +::: details 在 Windows 10 以下的系统中安装 ExamAware + +> [!caution] +> **在 Windows 7 系统中使用 ExamAware Desktop 桌面端是不现实的。** 受限制于框架问题，在 Windows 7 中，您无法打开 ExamAware Desktop 桌面端 。 + +此外，**微软对 Windows 7 的支持已经在 2020/1/14 终止** [^1]。如果您汇报在 Windows 7 中遇到系统相关问题， **开发者可能不会受理。** + +如您有需要，请使用[考试看板网页版](./web/README.md) +::: # 遇到问题？ -如果安装时遇到问题，**首先请自行[百度](https://www.baidu.com/)一下**。如果问题无法解决，您可以[在 QQ 群求助](https://qm.qq.com/q/zDiEipHsaI)或者[前往 Discussion](https://github.com/orgs/ExamAware/discussions)。 +如果安装时遇到问题，**首先请自行[百度](https://www.baidu.com/)一下**。如果问题无法解决，您可以[在 QQ 群求助](https://qm.qq.com/q/zDiEipHsaI)或者前往[Discussion](https://github.com/orgs/ExamAware/discussions)交流。 # 开始使用 如果您要进一步了解本软件，您可以继续阅读本文档。 -::: details 在 Windows 7 中安装 ExamAware - -> [!caution] -> **在 Windows 7 中使用 ExamAware 是不现实的。** 受限制于框架问题，在 Windows 7 中，您无法打开 ExamAware 。 - -此外，**微软对 Windows 7 的支持已经在 2020/1/14 终止** [^1]。如果您汇报在 Windows 7 中遇到系统相关问题， **开发者可能不会受理。** - -::: - -## 下载应用本体 - -对于普通用户，可以在以下渠道下载到本软件，请根据自身网络环境选择合适的渠道。 - -::: warning -当前构建包含最新的功能，但也可能包含未完善和不稳定的功能，请谨慎使用。 - -| 平台 | **🚀 正式版**
[![GitHub Release](https://img.shields.io/github/v/release/ExamAware/dsz-exam-showboard?include_prereleases&style=flat-square&logo=GitHub&label=最新版本)](https://github.com/ExamAware/dsz-exam-showboard/releases/) | 🚧 当前构建 | -| - | - | - | -| 桌面端 | [dsz-exam-showboard/releases](https://github.com/ExamAware/dsz-exam-showboard/releases) | [dsz-exam-showboard/actions](https://github.com/ExamAware/dsz-exam-showboard/actions) | -| 移动端 | [dsz-examaware-mobile/releases](https://github.com/ExamAware/dsz-examaware-mobile/releases) | [dsz-examaware-mobile/actions](https://github.com/ExamAware/dsz-examaware-mobile/actions) | - -::: -> [!tip] ->移动端目前缓慢更新，待`ExamAware2-Desktop`成熟后继续维护 ->移动端请前往[交流群](https://qm.qq.com/q/zDiEipHsaI)下载 - - -[^1]: Windows 7 生命周期策略：。Windows 7 ESU 结束支持于 2023/1/10。 diff --git a/src/web/images/es-exam.png b/src/web/images/es-exam.png deleted file mode 100644 index 70c5d1d..0000000 Binary files a/src/web/images/es-exam.png and /dev/null differ diff --git a/src/web/images/es-time.png b/src/web/images/es-time.png deleted file mode 100644 index aa69e5f..0000000 Binary files a/src/web/images/es-time.png and /dev/null differ diff --git a/src/web/images/es.png b/src/web/images/es.png deleted file mode 100644 index 6a41327..0000000 Binary files a/src/web/images/es.png and /dev/null differ