操作手册(GB8567——88)
1引言
1.1编写目的
为了帮助用户更好的上手本系统,加快用户对forture-sheet在线表格的快速入门,本操作手册详细介绍使用forture-sheet的部分基础操作以及注意细节。
1.2前景
- 待开发系统的名称:基于协同的在线表格forture-sheet
- 本项目的任务提出者:老师引导下小组成员共同讨论的结果;
- 开发者:*********
- 用户:使用Excel表用户
- 安装软件:WebStorm、MongoDB
1.3定义
forture-sheet:即本系统开发的在线表格。
1.4参考资料
列出有用的参考资料,如:
- 腾讯文档(苍穹-TencentDoc)集成操作手册;
- 百度文档操作使用手册;;
- [1]左紫欢. 软件测试过程可视化的研究与应用[D].西南科技大学,2022.DOI:10.27415/d.cnki.gxngc.2022.000960.
- [1]王秀艳.软件测试过程管理系统的设计与实现[J].电子技术与软件工程,2020(24):46-47.。
- 可行性研究报告、项目开发计划、软件需求分析、概要设计说明书
- 《软件工程事务》刘学俊 李继芳 刘汉中 编著 浙江大学出版社
2软件征述
2.1软件的结构
软件的系统结构如下图所示:
forture-sheet采用常见的上下型界面,上半部分为菜单工具栏,文档所有参数都可以在此部分进行控制调整,下半部分为可视化编辑区,实时显示文档的内容。
2.2程序表
本系统内采用大量的程序的标识符、编号和助记名。以下展示部分:
名称 | 标识 | 数据类型 | 值示例 | 属性值 | 安全保密 | |
单元格值格式 | celltype | String | {"fa":"General", "t": "g" } | ct | 中 | |
背景颜色 | background | String | #fff000 | bg | 中 | |
字体 | fontfamily | String | 微软雅黑 | ff | 中 | |
字体颜色 | fontcolor | String | #fff000 | fc | 中 | |
粗体 | bold | String |
| bl | 中 | |
斜体 | italic | String | 0 常规1斜体 | it | 中 | |
字体大小 | fontsize | String | 14 | fs | 中 | |
删除线 | cancelline | String | 0 常规 、 1 删除线 | cl | 中 | |
下划线 | underline | String | 0 无 、 1 有 | un | 中 | |
垂直对齐 | verticaltype | String | 0 中间、1 上、2下 | vt | 中 | |
水平对齐 | horizontaltype | String | 0 居中、1 左、2右 | ht | 中 | |
合并单元格 | mergecell | String | 主单元格{ r:0, c:0, rs: 2, cs:2 },辅单元格{ r:0, c:0 } | mc | 中 | |
竖排文字 | textrotate | String | 3 | tr | 中 | |
文字旋转角度 | rotatetext | String | 介于0~180之间的整数,包含0和180 | rt | 中 | |
文本换行 | textbeak | String | 0 截断、1溢出、2 自动换行 | tb | 中 | |
原始值 | value | String | v | 中 | ||
显示值 | monitor | String | m | 中 | ||
公式 | function | String | f | 中 | ||
批注 | comment | String | height: 140,//批注框高度 | ps | 中 |
2.3文卷表
本系统未使用永久性文卷。
3安装与初始化
本项目为基于协同的在线表格,无需专门安装软件。直接通过URL连接访问即可。
4运行说明
任何一台可以访问网络的PC机或者手机均可。
4.1运行表
列出每种可能的运行,摘要说明每个运行的目的,指出每个运行各自所执行的程序。
4.2运行步骤
每当用户在表格上做操作,一个Op列表会通过onOp回调发出。Op描述了如何从当前数据修改为用户操作后的新数据的步骤。例如,当用户在A2单元格上设置了加粗,生成的op如下:
[ { "op": "replace", "id": "0", "path": ["data", 1, 0, "bl"], "value": 1 } ] |
Op对后端数据修改和同步在线协同数据非常有用。
我们在 backend-demo 目录中展示了一个例子,使用 Express (后端) and MongoDB (数据库) 实现。
通过 node index.js 运行后端服务器,然后访问 Collabration example 即可体验。
4.3后端存储和在线协同说明
每当用户在表格上做操作,一个Op列表会通过onOp回调发出。op描述了如何从当前数据修改为用户操作后的新数据的步骤。例如,当用户在A2单元格上设置了加粗,生成的op如下:
[
{
"op": "replace",
"index": "0",
"path": ["data", 1, 0, "bl"],
"value": 1
}
]
op对后端数据修改和同步在线协同数据非常有用。
我们在 backend-demo 目录中展示了一个例子,使用 Express (后端) and MongoDB (数据库) 实现。
通过 node index.js 运行后端服务器,然后访问 Collabration example 即可体验。(可通过 http://localhost:8081/init 初始化数据)
详细的 Op 文档, 请参考 fortune-sheet-doc
4.3.1运行控制
本系统的运行步骤极其简单,具体的背后逻辑,用户无需查看到,仅需完成简单的点击窗口,完成交互即可,在各个终端展示同一个表格。
4.3.2操作信息
- 运行目的:通过表格的形式帮助用户完成在线的数据共享,直观的展示有用的信息。
- 操作要求:能够访问互联网。
- 启动方法:获取到表格对应的Url。
- 预计的运行时间和解题时间:基于网络情况考虑。
- 操作命令:可视化操作,鼠标悬停即可查看各个图标对应作用。
4.3.3输入一输出文卷
本系统数据存放在MongoDB,采用在线的形式直接远程访问数据库。
4.3.4输出文段
本软件输出的用于提示、说明、或应答的文段(包括“菜单”)的有关信息:
(1)菜单栏
几乎所有功能都集合在菜单栏中,包括文件的操作、格式的设置、查看视图等。
(2)权限及分享
点击“权限”按钮,可设置文档的权限(私密、可查看、可编辑),还可指定文档的协作者及其权限。另外底部高级设置可设置文档的有效期(永久、7天、1天)以及文档水印等。(详细用法见第五章)
(3)工具栏
工具栏汇集了常用的格式调整功能。包括文字格式、单元格格式等。
(4)编辑区
您可直接在编辑区中选定单元格进行内容的输入,数据的处理。单元格的位置由行和列构成,行数以数字表示,列数以字母表示。如第一行第一个单元格,表示为A1。
由于功能较为丰富,用户可以打开在线表格,通过悬停鼠标的方式自行查看详细作用。
- 文字容量:文字暂时没有上限,需要结合用户对界面的展示需求。
- 分发对象:使用同一个Url进入同一个表格的用户。
- 保密要求;暂无。
4.3.5输出文段的复制
本系统无需输出文段的复制。
4.3.6恢复过程
由于本系统是都是采用在线的方式,用户的每一步操作都会实时生效,如果用户的某一步操作出现了BUG卡顿,即可刷新url,重新访问即可。
5非常规过程
用户在使用的过程中断网,断电等异常操作可能会导致当前事件失效,那么就需要对当前的操作重新编辑,建议用户每进行一步操作就立即对当前表格进行保存提交。
6远程操作
本软件在某种程度上即可理解为远程操作,如需远程通过分享Url的方式即可重新访问同一个表格,进行编辑修改。