向导制作组件使用说明

向导制作组件使用说明

Ø  向导的查看

         向导库HG地址：http://192.168.1.172:8000/reportmis-guide。

         将向导库中的mis2文件夹中的内容拷贝到产品应用中：

         启动平台后访问：http://localhost:8800/reportmis/mis2/helpGuide/guide.jsp即可查看已有向导的效果。

Ø  向导的制作

         制作一个向导需要新建/设置的文件(图中带“+”的为新建文件，其余为修改的文件)包括以下5种：

Ø  向导中需要用到的图片

Ø  存储向导内容的XML

Ø  向导中的按钮和目录的配置文件（2个JSon）

Ø  向导总配置文件helpGuideConfig.json

Ø  在查看向导效果的JSP中添加相应的按钮

         目录结构和说明见下图：

 

         制作一个新向导时，在guideFiles文件夹中新建一个文件夹。文件夹中新建一个image目录用于存放图片。Xml目录用于存放XML文件。文件夹命名规则：demo向导命名为“demo_xxxx”；模块功能向导命名为：“module_xxxx”。

图片

注意：

1．  文件名称不能包含中文和“-”、空格等特殊符号，下划线可以，不能重名。

2．  目前文件支持jpg和png两种格式。

XML

         一个向导页面的内容对应一个XML文件，文件中可以存放文字和图片。XML定义的格式如下（可以在已有XML的基础上来修改）：

         <?xml version="1.0"encoding="utf-8"?>

                   <Module >

                            <Labeltext="  向导中的说明文字" />

                            <Image source="KC10002.jpg"/>

                   </Module>

        

         XML定义时可以使用以下几种标签：

²  <Labeltext="xxxx" />：文字标签，能进行自动换行，一般用于正文内容。

²  <Label id="B00001_Label"text="XXX" />: 文字标签，一般用于标题，加粗，不能自动换行。

²  <Label  id="A00001_Label" text="·xxx" mousedown="A010101"  />：用于列表或目录显示，行间距较前两种属性大一些。

         在label标签中均可定义“链接属性”，mousedown="A010101"点击后打开A010101.xml。

² <Image source="/A010201.jpg"/>：指定图位置

 

按钮、目录的json文件配置

         每个向导都需要定义两个配置一个是由于翻页的按钮，一个是目录。可以参照已有向导中JSON定义规则进行定义即可。下图为向导库中现有配置文件的存放位置：

 

向导总配置文件

         \mis2\helpGuide\guideConfig\helpGuideConfig.json为所有向导的总配置文件。每一个向导都需要在这个文件中增加两行具体的配置。

JSP按钮定义

         上面的配置完成后需要在mis2/helpGuide/guide.jsp中添加一个按钮用于查看向导效果。

按钮定义格式如下：

<buttonοnclick="showHelpGuide('<%=path%>','D20001','styleManagerGuide','styleManagerMenu','module_styleManger.swf')">样式管理</button>

         其中：

         D2001为本向导第一页XML 文件的名称。

         styleManagerGuide为helpGuideConfig.json中配置的按钮配置名称。

         styleManagerMenu为helpGuideConfig.json中配置的目录配置的名称。

         module_styleManger.swf为编译后的swf的文件。

         样式管理为按钮的名称

         经过以上操作后就完成了向导的制作。

Ø  向导的编译

         制作好的向导XML和图片需要使用编译工具编译成SWF后提交到产品中使用   。

         编译时直接在guide库中进行即可。拉取最新的guide 库后，需要下载一下SDK，下载后解压到guide库根目录的4.5.1文件夹中。

下载地址：http://www.kuaipan.cn/file/id_42334951470794234.htm

         运行HelpGuide.bat即可，执行完成后将会在\mis2\helpGuide文件中生成对应的swf文件。

 

注意：编译时guide库存放的目录不能包含括号、横杠、点等特殊符号。否则可能导致编译工具无法正常执行生成swf。