联机帮助规范

联机帮助 1 文档结构 联机帮助的每一个文档分为两个部分。 1. 文档开头用一段话概括所有的操作或功能。 2. 然后逐一分别介绍每一个操作或功能。 。。。操作有创建、编辑、查看、删除、重命名、更改用户对象的所有者、删除用户拥有的对象。具体介绍如下。 此处是具体介绍的内容。 … 在文档的第二部分（主要部分），即逐一描述各功能的部分，一定要层次结构清楚，类似树形结构。 在第二部分，等级编号最多有三级目录，每个等级前面的编号为： （1）       第一级：● （2）       第二级： （3）       第三级： 形如： 范例如附件：webtools-kem-security.sgml中的id为webtools-kem-SearchUser的sgml页面。 2 特殊符号的使用 特殊符号，包括『』、【】、〖〗、中英文引号及中英文圆括号。 2.1 界面元素的引用 界面元素 符号 示例 页面（父页面、弹出对话框或标签页） 『』 如搜索数据库页面，文档中应描述为『搜索数据库』页面 按钮和超链接 【】 如确认按钮，文档中描述为【确认】按钮 其它组件 〖〗 如数据库名文本框，文档中描述为：〖数据库名〗文本框。如单选按钮 2.2 引号和括弧 （1）       文字中使用英文引号和中文括弧； （2）       代码中使用英文引号和英文括弧。 说明： 1. 不要使用中文的引号。 2. 使用半角的英文引号，不要使用全角的英文引号。 3. 不要使用sgml语法里的引号（"）。 3 sgml语法 具体语法请参阅联机帮助语法.pdf。 3.1 插入图片 3.1.1 有标题的图片 图片的格式一律采用“.png”格式。截图的时候一定保存为“.png”格式。

效果： 统一使用有标题的图片。 3.1.2 无标题的图片 效果： （无类似的字样。） 3.2 注意 范例： 注意的内容。 效果： 注意：注意的内容。 4 图片 不需要对弹出窗口截图。 注意：1、每个联机帮助页面对应一张截图，所有弹出窗口都不需要截图； 2、截图时，窗口的背景颜色一定不要使用护眼色（一律使用白色）。 4.1 图片的格式 图片的格式一律采用“.png”格式。截图的时候一定保存为“.png”格式。 png格式的图片失真最小，效果最好。 4.2 图片的标题 要求每个图片都要有标题。例如： 上图中的标题即：。 图片的标题居左。 4.3 图片的大小 图片不要太大，可以进行适当的编辑。 注意：截图最大不能大于联机帮助（chm）页面宽度。 4.4 图片命名 范例： 说明： 1) 图片的后缀名是.png。 2) 图片名称的前部分是模块名称，如：webtools_kem，后部分

表

关于同志近三年现实表现材料材料类招标技术评分表图表与交易pdf视力表打印pdf用图表说话 pdf

示相应的功能。 3) 图片名称中使用下划线，如下名称是不合要求的： webtools-kem-CreateUserWindow.png(不合要求，应该使用下划线。) 4) 在图片的名称中不要使用空格。 下面的名称是不合要求的： webtools_ kem_CreateUserWindow.png 图片名称的前部分是模块名称，如：webtools_kem，后部分是图片对应的页面名称，如CreateUserWindow.zul。那么图片的名称就可以定为：webtools_kem_CreateUserWindow.png。 截图名称=模块名称+页面名称+[可选] 模块名称 页面名称 可选 webtools_kem webtools_kam webtools_ksm webtools_kisql … CreateDatabaseLinkWindow CreateIndexGeneralWindow CreateIndexWindow CreateSchemaWindow … create edit view 如果不同模块的截图使用了相同的页面（zul文件），如『创建用户』和『编辑用户』使用了相同的zul页面（例如：CreateUserWindow.zul），那么这两个模块的截图的名称可以分别定为： webtools_kem_CreateUserWindow_create.png webtools_kem_CreateUserWindow_edit.png 5 超链接 5.1 目标是整个页面 范例： 注意：一律使用“请参阅xxx”的字样。 5.2 目标不是整个页面 超链接的目标是一个表或一个图片等。 范例： 请参阅表 4-1 5.3 首页超链接 效果如下： 所有帮助文档页面的最下方应该提供回到首页的超链接。 范例： 注意：超链接的位置位于文档页面的最下方，居左显示。 6 表格 表格格式 （1） 标题：居左显示。 （2）       表头：居中显示； （3）       内容：居左显示。 范例： 在上面的范例中，标题即：。 表头指： 规定：使用表格时，一定要有标题，并且标题是加粗的。标题在表格的上方。 7 列表 一律使用标签，不要使用< orderedlist>标签。 范例如下： 代码： 效果如下： 8 段落 段首一定要有缩进，sgml形如：&space;具体内容 范例： 代码： &space;连接成功之后就进入『信息与对象管理』页。『信息与对象管理』页分为三个标签页：『连接信息』、『一般信息』和『服务器管理』。 效果如下： 注意：段首一定要有缩进。 9 描述 组件的描述 （1）       提示框：确认提示框、警告提示框、错误提示框、消息框；如：弹出『删除用户』确认提示框，如下图所示。 图 14-19 删除用户 （2）       弹出窗口：对话框，例如：创建数据库窗口在文档中应描述为『创建数据库』对话框。不要使用“窗口”或“弹出窗口”，统一使用“页面”或“对话框”。 （3）  标签页 （4）  页面 父窗口称为页面，如，『搜索数据库』页面。 注意：统一使用“页面”这一名称，不要使用“界面”。 （5）  文本框（不要使用“输入框”，统一使用“文本框”这一名称） （6）  标签页 （7）  复选框 （8）   单选按钮 ，使用〖〗括起来 （9） 文本域（不要使用“多行文本框”，统一使用“文本域”这一名称） （10） 下拉框（不要使用“下拉列表”，统一使用“下拉框”这一名称） （11） 单选按钮组 操作的描述 不要使用“单击”，统一使用“点击”或“双击”。 10 引用名称 10.1 文件名称 使用中划线： 注意：最后一个中划线后面的字符串一定对应页面名称。 10.2 id 使用中划线： 10.3 图片名称 图片名称使用下划线： 文档开头