历史版本44 :帮助文档编辑器 返回文档
编辑时间: 内容长度:图片数:目录数: 修改原因:

目录:

1. 如何创建文档编辑

如果想创建一篇新文档，那么在帮助文档首页，点击「创建文档」即可，如下图所示：

image.png

然后输入「文档标题」，点击「选择分类」，选择一个合适的分类，再点击「创建文档」，这样就创建了一篇空白的帮助文档，如何撰写技术文档请参见 技术文档写作流程规范 。

image.png


2. 如何编辑文档编辑

如果想修改某一篇文档，那么在文档页面，点击「编辑」即可，如下图所示：

image.png


3. 如何保存文档编辑

  • 手动保存：点击右上角的「保存」按钮即可

  • 自动保存：每分钟自动保存一次。

已保存的文档在「我的草稿箱」，在没有发布的状态下，内容仅自己可见。如果想对外公布进行发布即可。

4. 如何发布文档编辑

点击右上角的「发布」即可，发布后，内容仅自己和管理员可见，当管理员审核通过后，所有用户可见。

已发布的文档在「我创建的文档」、「我编辑的文档」。

5. 如何编辑文档编辑

图标含义详细说明

image.png

一级目录在当前行，点击一级目录即可

image.png

二级目录在当前行，点击二级目录即可

image.png

三级目录在当前行，点击三级目录即可

image.png

撤销／重做

「撤销」是把最近一次更改取消掉，恢复回到未更改的状态

「重做」是把更改操作再做一次

image.png

清除格式选中内容之后，点击「清除格式」，即可清除格式
image.png加粗选中内容之后，点击「加粗」，为特定字符设置加粗效果，以突出显示这些字符。
image.png有序列表

什么时候使用项目步骤（Item Step）

  1. 必须按顺序操作的步骤（最常用）

  2. 对多项内容进行的排名


image.png无序列表

什么时候使用项目列表（Item list）

  • 当列表项之间的顺序不重要时

  • 并列关系的分句

  • 项目列表下面不可以嵌套子标题

  • 单独一项内容不要使用项目列表

image.png多图上传

编辑器支持 N 种插入图片的方式，总有一种满足你的编写习惯。

  • 菜单栏按钮：点击「多图上传」，然后选择图片（支持上传多张图片）即可。

  • 粘贴图片：复制一张图片，图片就已经保存在张贴板里面，然后只需要右键「粘贴」，或者 Ctrl + v 快捷粘贴即可。

  • 拖拽图片文件：从文件夹将图片文件直接拖拽进编辑器即可。

上传完毕后，图片就会自动显示在文档中。点击选中图片，会显示图片工具栏。这时可以图片进行各种操作。鼠标拖动图片右下角，还可以调节图片的长宽进行图片缩放。

图示规范参考文档 图示标注规范。

image.png
附件点击「附件」，「点击选择文件」，选择需要上传的附件即可。
image.png插入表格

点击「插入表格」，此时可以看到下拉的菜单，直接向下移动鼠标，移动经过的行与列代表插入表格的行数与列数，确定行数与列数后直接单击就可以插入一个表格。

表格插入后，右键查看表格的工具栏，比如插入标题行，删除当前行，插入行等等。

image.png
超链接

点击「超链接」插入文本和链接

image.png代码复制代码写好之后，选中需要被复制的内容，点击「插入代码」按钮
image.png
高亮：路径例如 %FR_HOME%\webroot\WEB-INF\reportlets\AxisCustom2.cpt
image.png高亮：公式例如CNMONEY(1200)等于壹仟贰佰圆整。
image.png高亮：警告例如 注：注意事项xxx。
image.png高亮：按钮例如插入>单元格元素>插入图表
image.png高亮：SQL例如 SELECT * FROM [销量] where 地区 ='${地区}'

6. 文档审核流程编辑

假设文档A目前最新版本是3，简称为A3，所有人都可以浏览A3，所有非违规用户都可以编辑A3；

一旦有用户编辑了A3发布了A4版本，比如这人是甲。那么甲和管理员看到的是A4，而其他人看到的依旧只是A3版本。且甲可以继续编辑发布，其他人都不能进行编辑，编辑发布后依旧是A4版本。

等到管理员审核批准A4后，其他普通用户和游客才能看到A4，以及编辑文档A4。 


编辑