联机帮助规范

1、联机帮助规范1文档结构联机帮助的每一个文档分为两个部分。1. 文档开头用一段话概括所有的操作或功能。2. 然后逐一分别介绍每一个操作或功能。操作有创建、编辑、查看、删除、重命名、更改用户对象的所有者、删除用户拥有的对 象。具体介绍如下。此处是具体介绍的内容。在文档的第二部分（主要部分），即逐一描述各功能的部分，一定要层次结构清楚，类似树 形结构。在第二部分，等级编号最多有二级目录，每个等级前面的编号为：(1)第一级：(2)第二级：:(3)第三级：形如：段落1C段落良落2 2段落戈.乳1 段落，乳2段落厶勺3段IS2.3.4c段落Z4段叡5*段落3段落4范例如附件： webtools-kem-s

2、ecurity.sgml 中的 id 为 webtools-kem-SearchUser 的 sgml 页面。2特殊符号的使用特殊符号，包括、【】、中英文引号及中英文圆括号。2.1界面元素的引用界面兀素符号示例页面（父页面、弹出对话框或标签页）如搜索数据库页面，文档中应描述为搜 索数据库页面按钮和超链接【】如确认按钮，文档中描述为【确认】按钮其它组件如数据库名文本框，文档中描述为：数据库名文本框。如单选按钮2.2引号和括弧（1）文字中使用英文引号和中文括弧；（2）代码中使用英文引号和英文括弧。说明：1. 不要使用中文的引号。2. 使用半角的英文引号，不要使用全角的英文引号3. 不要使用sgml

3、语法里的引号（"）。3 sgml语法具体语法请参阅联机帮助语法.pdf。3.1插入图片3.1.1有标题的图片图片的格式 一律采用“ .png ” 格式。截图的时候一定保存为.png”格式。vfigure id=更改用户对象的所有者 vgraphic fileref=images/webtools_kem_ ReUserOw nerWi ndow.p ng效果：统一使用有标题的图片3.1.2无标题的图片vgraphic fileref=images/webtools_kem_ ReUserOw nerWi ndow.p ng 效果：（无类似图许更改用户对象的所有者的字样。3.2注意范例

4、： 注意的内容。 效果：注意：注意的内容。4图片不需要对弹出窗口截图。注意:：1、每个联机帮助页面对应一张截图，所有弹出窗口都不需要截图;2、截图时，窗口的背景颜色一定不要使用护眼色（一律使用白色），4.1图片的格式图片的格式 一律采用“ .png ” 格式。截图的时候一定保存为.png”格式。png格式的图片失真最小，效果最好。4.2图片的标题要求每个图片都要有标题。例如:点击【执行】按钮，弹出如下对话框，如下图所示. 更取用户对更閑所有普-每Z请选搖所有者：w确认取消图14-21更改用户对象的所有看上图中的标题即：图14-21更渎用户对象的所有若图片的标题居左4.3图片的大小图片不要太大，

5、可以进行适当的编辑。注意:截图最大不能大于联机帮助（chm）页面宽度。4.4图片命名范例：F web to al s_ke m_Cr e at eD at ab as eLi iikW i ndw. png F webtocil E_keait sb as i mdow png：wet to*l s_kemCr e at el ndejsGener altti ndow. pag w e b t o 1 s_ke m_Cr e at el adew HT i ndwy . png ftols_kn_CrsatSchmWindow png F web ts*l s_km!_Cre iteS eq

6、uiieeViudow. png F11 q s_ke m_Cr e sTpiugf wtbtool s_km_Cr at t ITs sr W i nd oir. png说明:1）图片的后缀名是.png。2）图片名称的前部分是模块名称，如：webtools_kem，后部分表示相应的功能。3）图片名称中使用下划线，如下名称是不合要求的：webtools-kem-CreateUserWindow.png（不合要求，应该使用下戈卩线。）4）在图片的名称中不要使用空格下面的名称是不合要求的：webtools_ kem_CreateUserWi ndow.p ng图片名称的前部分是模块名称，如：web

7、tools_kem，后部分是图片对应的页面名称，如CreateUserWindow.zul。那么图片的名称就可以定为：webtools_kem_CreateUserWindow.png。截图名称=模块名称+页面名称+可选模块名称页面名称可选webtools_kemCreateDatabaseL inkWindowcreatewebtools_kamCreateI ndexGe neraIWi ndoweditwebtools_ksmCreate In dexWi ndowviewwebtools_kisqlCreateSchemaWi ndow如果不同模块的截图使用了相同的页面（zul文件），

8、如创建用户和编辑用户使用了相同的zul页面（例如：CreateUserWindow.zul），那么这两个模块的截图的名称可以分别定 为：webtools_kem_CreateUserWindow_ create .png webtools_kem_CreateUserWindow_ edit .png5超链接5.1目标是整个页面范例:14. 8. 3. 2实例级语句谣壽阅箝14詔节系统权限注意:一律使用“请参阅xxx ”的字样。5.2目标不是整个页面超链接的目标是一个表或一个图片等。 范例：请参阅表一4-15.3首页超链接效果如下:as所有帮助文档页面的最下方应该提供回到首页的超链接。 范例：

9、起始页注意:超链接的位置位于文档页面的 最下方，居左显示6表格表格格式（1）标题：居左显示。（2）表头：居中显示;（3）内容：居左显示。范例:表4-32参数说明参数名称输入爲出参数说明pass厂输入管理员口令，以结東在上面的范例中，标题即:表4-32莠数说明。表头指：參数名称输入张出卷数说明规定：使用表格时，一定要有标题，并且标题是加粗的。标题在表格的上方。7列表一律使用itemizedlist 标签，不要使用 orderedlist标签。范例如下：代码效果如下:8段落段首一定要有缩进， sgml形如：&space;具体内容范例：代码：&space;连接成功之后就进入信息与对象管理页。信息与对

10、象管理页分为三个标签页：连接信息、一般信息器管理。效果如下：洗搀成功之信躺拄扎信息写对象管理瓦 信息写对象管理贡分为三个标签贡：逹接信息、一般信息f 理口注意:段首一定要有缩进。9描述组件的描述(1) 提示框：确认提示框、警告提示框、错误提示框、消息框；女口：弹出删 除用户确认提示框，如下图所示。珊曉用尸确走要删除选中的用户吗3igii 取消图14-19删除用户(2) 弹出窗口：对话框，例如：创建数据库窗口在文档中应描述为创建数 据库对话框。不要使用“窗口”或“弹出窗口”，统一使用“页面”或 “对话框”。(3) 标签页4) 页面 父窗口称为页面，如，搜索数据库页面。 注意：统一使用“页面”这一

11、名称，不要使用“界面(5) 文本框(不要使用“输入框”，统一使用“文本框”这一名称)(6) 标签页(7) 复选框(8) 单选按钮，使用括起来(9) 文本域(不要使用“多行文本框”，统一使用“文本域”这一名称)(10) 下拉框(不要使用“下拉列表”，统一使用“下拉框”这一名称)(11) 单选按钮组(12)操作的描述用“单击”，统一使用“点击”或“双击10引用名称10.1文件名称使用中划线：申i nt vir Fat W t s-j b aclcup-. s 詳 1 int*rfatr8totlt_jcontrol.iLt*rfaceto ols-j dts. sgjnlCESS.申LiLt*2rfols-j ds-pr(j_ int*rfacatc&lE-jduinj. Mgjnl注意：最后一个中划线后面的字符串一定对应页面名称。10.2 id使用中划线:sect2 id=webtoc(webtools-teni-dbot ject isKen-(ibo