软件教学引导功能说明书

一、功能概述

软件教学引导功能主要用于为用户提供软件操作的引导，通过一系列步骤逐步引导用户完成软件的重要操作。该功能会创建遮罩层、高亮框和提示框，引导用户点击特定元素或填写输入框内容，帮助用户更好地理解和使用软件。

二、核心函数与调用格式

1. setGuide

$cq.系统_教学_引导().setGuide(steps);

该函数用于设置引导步骤列表。`steps` 是一个包含多个步骤对象的数组，每个步骤对象包含选择器、提示文本、点击检查和输入检查等信息。

2. start

$cq.系统_教学_引导().start();

该函数用于从第一个步骤开始启动引导。调用该函数后，会创建引导所需的 DOM 元素，并渲染第一个步骤的引导信息。

3. startRange

$cq.系统_教学_引导().startRange(startNum, endNum);

该函数用于从指定的起始步骤开始，到指定的结束步骤结束进行引导。`startNum` 表示起始步骤的编号，`endNum` 表示结束步骤的编号。

4. close

$cq.系统_教学_引导().close();

该函数用于关闭引导。调用该函数后，会移除所有创建的 DOM 元素，并重置相关变量。

三、参数说明

1. setGuide 参数

2. startRange 参数

四、返回值

- `setGuide`：无明确返回值，主要是设置引导步骤列表。 - `start`：无明确返回值，主要是启动引导。 - `startRange`：无明确返回值，主要是从指定范围启动引导。 - `close`：无明确返回值，主要是关闭引导。

五、使用示例

1. 使用 setGuide 示例

var guideSteps = [
    { selector: '[data-step="1"]', text: '请点击此按钮', checkClick: true },
    { selector: '[data-step="2"]', text: '点击第二个功能按钮', checkClick: true },
    { selector: '[data-step="3"]', text: '请在输入框填写内容', checkFill: true },
    { selector: '[data-step="4"]', text: '点击区域切换标签', checkClick: true },
    { selector: '[data-step="5"]', text: '点击完成按钮', checkClick: true }
];
$cq.系统_教学_引导().setGuide(guideSteps);
                

2. 使用 start 示例

$cq.系统_教学_引导().start();
                

3. 使用 startRange 示例

$cq.系统_教学_引导().startRange(2, 4);
                

4. 使用 close 示例

$cq.系统_教学_引导().close();
                

六、注意事项

• 在使用引导功能时，确保目标元素的选择器能够准确匹配到相应的元素。
• 若引导过程中需要进行点击或输入检查，用户需要按照提示完成相应操作才能继续下一步。
• 若需要停止引导，可以调用 `$cq.Fams_techer_Guider.close()` 方法。