一图看懂如何使用文档编辑器
1. 如何创建文档
如果想创建一篇新文档,那么在帮助文档首页,点击「创建文档」即可,如下图所示:
然后输入「文档标题」,点击「选择分类」,选择一个合适的分类,再点击「创建文档」,如下图所示:
选取模板自动生成文档大纲
从模板创建文档,分为四个选项,根据实际情况,选择对应的模板,点击「确定」即可,如下图所示:
这样就创建了一篇帮助文档,如何撰写技术文档请参见 技术文档写作流程规范。
2. 如何编辑文档
如果想修改某一篇文档,那么在文档页面,点击「编辑」即可,如下图所示:
3. 如何保存文档
手动保存:点击右上角的「保存」按钮即可
自动保存:每分钟自动保存一次。
已保存的文档在「我的草稿箱」,在没有发布的状态下,内容仅自己可见。如果想对外公布进行发布即可。
4. 如何发布文档
点击右上角的「发布」即可,发布后,内容仅自己和管理员可见,当管理员审核通过后,所有用户可见。
已发布的文档在「我创建的文档」、「我编辑的文档」。
5. 文档编辑器
图标 | 含义 | 详细说明 |
---|---|---|
一级目录 | 在当前行,点击一级目录即可 | |
二级目录 | 在当前行,点击二级目录即可 | |
三级目录 | 在当前行,点击三级目录即可 | |
撤销/重做 | 「撤销」是把最近一次更改取消掉,恢复回到未更改的状态 「重做」是把更改操作再做一次 | |
清除格式 | 选中内容之后,点击「清除格式」,即可清除格式 | |
加粗 | 选中内容之后,点击「加粗」,为特定字符设置加粗效果,以突出显示这些字符。 | |
有序列表 | 什么时候使用项目步骤(Item Step)
| |
无序列表 | 什么时候使用项目列表(Item list)
| |
多图上传 | 编辑器支持 N 种插入图片的方式,总有一种满足你的编写习惯。
上传完毕后,图片就会自动显示在文档中。点击选中图片,会显示图片工具栏。这时可以图片进行各种操作。鼠标拖动图片右下角,还可以调节图片的长宽进行图片缩放。 图示规范参考文档 图示标注规范。 | |
附件 | 点击「附件」,「点击选择文件」,选择需要上传的附件即可。 | |
插入表格 | 点击「插入表格」,此时可以看到下拉的菜单,直接向下移动鼠标,移动经过的行与列代表插入表格的行数与列数,确定行数与列数后直接单击就可以插入一个表格。 表格插入后,右键查看表格的工具栏,比如插入标题行,删除当前行,插入行等等。 | |
超链接 | 点击「超链接」插入文本和链接 | |
代码复制 | 代码写好之后,选中需要被复制的内容,点击「插入代码」按钮 | |
高亮:路径 | 例如%FR_HOME%\webroot\WEB-INF\reportlets\AxisCustom2.cpt | |
高亮:公式 | 例如CNMONEY(1200)等于壹仟贰佰圆整。 | |
高亮:警告 | 例如注:注意事项xxx。 | |
高亮:按钮 | 例如插入>单元格元素>插入图表 | |
高亮:SQL | 例如SELECT * FROM [销量] where 地区 =${地区} |
正文导航模块,可快速定位正文各部分;
根据目录(一级目录、二级目录)自动生成正文导航;
点击快速跳转至正文各个目录或模块;
随正文浏览进度实时定位;
6. 文档审核流程
假设文档 A 目前最新版本是 3,简称为 A3,所有人都可以浏览 A3,所有非违规用户都可以编辑 A3;
一旦有用户编辑了 A3 发布了 A4 版本,比如这人是甲。那么甲和管理员看到的是 A4,而其他人看到的依旧只是A3版本。且甲可以继续编辑发布,其他人都不能进行编辑,编辑发布后依旧是 A4 版本。
等到管理员审核批准 A4 后,其他普通用户和游客才能看到 A4,以及编辑文档 A4。