From bec0e46b8fb6e47ae82bec5378a5db02992010de Mon Sep 17 00:00:00 2001 From: "weiye.wang" Date: Sun, 21 Apr 2024 15:47:11 +0800 Subject: [PATCH] =?UTF-8?q?=E4=BF=AE=E6=94=B9=E4=BD=BF=E7=94=A8=E6=8C=87?= =?UTF-8?q?=E5=8D=97?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- 文档/使用指南/使用指南2024.md | 34 ++++++++++++++++++++++------------ 1 file changed, 22 insertions(+), 12 deletions(-) diff --git a/文档/使用指南/使用指南2024.md b/文档/使用指南/使用指南2024.md index 3b8624b3..a72be5dd 100644 --- a/文档/使用指南/使用指南2024.md +++ b/文档/使用指南/使用指南2024.md @@ -1,22 +1,26 @@ ![控江数学组题库](http://wwylss.synology.me:48089/i/2024/02/08/65c4504d1fc58.png) -#
题库使用指南2024版
+#
题库使用指南2024年5月版
-**本教程中的默认文件夹是题库根目录/工具v2** +**本教程中的默认文件夹是题库根目录/工具v3** ## 注意事项 -**所有同志可以放心大胆地在自己的电脑上进行任何操作, 不用担心产生任何破坏性后果. 在远程服务器上的master分支只有管理员有权限修改. 退一步说, 即使远程服务器上的master分支不慎被改错了, 返回到某一个历史版本也只是一条命令的事情.** +**所有同志可以放心大胆地在自己的电脑上进行任何操作, 不用担心产生严重的破坏性后果.** + +**目前的题库数据是保存在搭建在NAS上的一个MySQL数据库中的, 每六个小时会作一次全量备份得到压缩文件, 每天会把这些压缩文件备份到其他地方, 所以即使误操作了, 损失也不会太大** + +**在远程服务器上的master分支只有管理员有权限修改. 退一步说, 即使远程服务器上的master分支不慎被改错了, 返回到某一个历史版本也只是一条命令的事情.** **原则上题库内容中不出现全角的句号(。)、逗号(，)、冒号(：)、问号(？)、感叹号(！)、小括号(（）)等** -**半角的标点符号后面一般应该有半角的空格或是直接换行** +**在文本中, 半角的标点符号后面一般应该有半角的空格或是直接换行** **如果运行程序报错, 在联系管理员之前, 可以先试试和master同步, 随后在进入面板, 再退出面板之后输入``cd ..``(回到题库根目录), ``pip install -r requirements.txt``, 或许安装一些python的package之后, 问题就解决了.** ## 使用题库必要的软件安装 -要使用题库, 最好在windows环境下, 以下四个软件是必须要安装的: +要使用题库, 比较典型的是在windows环境下, 以下四个软件是必须要安装的: - git (版本管理): [git下载界面](https://git-scm.com/download/win) 选择``64-bit Git for Windows Setup`` - vscode (代码编辑): [vscode下载界面](https://code.visualstudio.com/download) 选择``Windows`` @@ -25,18 +29,24 @@ **其中git的下载可能会不顺利**, 因为下载的地址在众所周知难以访问的``github.com``上, 也可以到 [我们自己网盘上的镜像](http://wwylss.synology.me:45212/s/l5i5)下载. 自己的网盘上虽然四个软件都有, 但是事实上texlive不建议大家在自己这里下, 因为太慢了 -下载完成之后按照任意排列安装这四个软件即可, 安装路径中必须没有中文, 也没有空格. 其他的都按照安装程序默认的方式即可. anaconda的安装大约需要十分钟左右, texlive可能要30至120分钟, 都是因为小文件非常多. +下载完成之后按照任意排列安装这四个软件即可, **安装路径中必须没有中文, 也没有空格**. 其他的都按照安装程序默认的方式即可. anaconda的安装大约需要10分钟左右, texlive可能要30至120分钟, 都是因为小文件非常多. + + ## 打开面板的方式 -在配置好python的math环境, 在题库根目录运行过``pip install -r requirements.txt``, 并且编写过``conda_initiate.bat``之后, 在``cmd终端``的题库根目录运行``conda_initiate.bat``, 会跳出一个``tkinter``做的GUI面板. +![conda_initiate批处理文件](http://wwylss.synology.me:48089/i/2024/04/21/6624c207db1e7.png) -如果面板还没有跳出来, 随后在终端依次输入``cd 工具v2``回车, ``python 工具面板.py``回车, 就会跳出一个``tkinter``做的GUI面板. +在配置好python的math环境, 在题库根目录运行过``pip install -r requirements.txt``, 并且编写过``conda_initiate.bat``之后(编写``conda_initiate.bat``的工作请联系管理员), 在``cmd终端``的题库根目录运行``conda_initiate.bat``, 会跳出一个``PySide6``做的GUI面板. -![1707404577237.png](http://wwylss.synology.me:48089/i/2024/02/08/65c4ed2046c2a.png) +如果面板还没有跳出来, 随后在终端依次输入``cd 工具v3``回车, ``python 工具面板.py``回车, 就会跳出一个``tkinter``做的GUI面板. + +![题库工具面板v3(20240417版)](http://wwylss.synology.me:48089/i/2024/04/21/6624c25c5cb44.png) ## 在overleaf上协作编辑 +![overleaf登录界面](http://wwylss.synology.me:48089/i/2024/04/21/6624c2d989ab8.png) + 我们**自己部署的本地overleaf服务器**的地址是[overleaf kongjiang](http://kjwangweiye.top:40388)(``kjwangweiye.top:40388``)或[overleaf kongjiang mirror](http://wwylss.synology.me:40388)(``wwylss.synology.me:40388``) 如果还未注册过, 请联系管理员, 提供一个邮箱(可以是真实的邮箱, 也可以不是)以新建账号(之后首次登录会要求设置密码, 请**不要忘记邮箱和密码**) @@ -66,16 +76,16 @@ 1. 用简略的文字描述issue 2. 详细描述issue的内容(可以使用markdown语法, 如果会markdown的话) 3. 按这个按钮可以添加附件(在提供一些文件例如metadata.txt等的时候十分有用) -4. **指派哪些人来跟进这个议题**, 一般有同备课组的负责人和管理员等 +4. **指派哪个人来跟进这个议题**, 一般有同备课组的负责人和管理员等 5. 前四项全填完之后, 点击``Create议题``以生成这个新的issue 之后就可以在这个issue中进行对话沟通, 完成后(或者完不成但是也不想留置)有权限的成员(提出者, 指派人, 管理员等)可以关闭议题. ## 收录新题 -***对于需要合并到主题库的题目, 在收录之前请务必和管理员协商确定起始题号, 避免不同使用者的题号出现冲突*** +***对于需要合并到主题库的题目, 在收录之前请尽量和管理员协商确定起始题号, 避免不同使用者的题号出现冲突*** -***测试的时候请先拉取远程的tutorial分支, 在此基础上新建分支, 之后进行收录新题操作*** +***测试的时候请先切换到远程的``测试用``分支, 在这个分支上进行各种操作*** 收录新题前, 需要准备一个能够编译通过的LaTeX文件, 正文部分是一个``enumerate``环境, 其中每一个``\item``表示一道题目. 例如: