HelpStack为您提供为iOS应用用户添加出色App内支持的简单方式。您可以轻松整合您喜欢的任何帮助台解决方案。

HelpStack目前支持以下帮助台解决方案

• HappyFox
• Zendesk
• Desk.com
• 电子邮件 - 如果您没有帮助台解决方案，您仍然可以配置HelpStack，以便用户可以通过电子邮件提出请求。

用户界面也可以自定义，以便与您的应用主题相匹配。

如何继续使用HelpStack

如果您想了解如何继续使用HelpStack有清晰的想法，请查看以下维基页面：[Wiki - 如何继续使用HelpStack](https://github.com/happyfoxinc/helpstack/wiki/How-to-Progress-with-HelpStack)

应用展示

您是否使用HelpStack完成了令人惊叹的工作？在这里添加您自己：[App展示](https://github.com/happyfoxinc/helpstack/wiki/App-Showcase)

如何使用HelpStack

将HelpStack集成到您的应用中是一个简单的3步过程

1. 安装HelpStack及其依赖项
2. 配置您的所需的帮助台解决方案
3. 使用简单的plist文件自定义HelpStack的用户界面

安装

使用CocoaPods安装HelpStack及其依赖项。HelpStack的依赖包括AFNetworking 2.0。

pod 'HelpStack'

HelpStack需要Xcode 5.0，目标为iOS 7及以上版本。

配置HelpStack齿轮

齿轮的一般结构如下

    <GearType> *<gearObject> = [[<GearType> alloc] 
            parameter1  : value1
            parameter2  : value2

            parameterN  : valueN ];

    HSHelpStack *helpStack = [HSHelpStack instance];
    helpStack.gear = <gearObject>;

HelpStack目前提供4种不同的齿轮。按照以下说明配置您选择的齿轮

• HappyFox齿轮
• Zendesk齿轮
• Desk齿轮
• 电子邮件齿轮

与本地文章一起分发

请注意，由于FAQ/KB文章是从服务器获取的，因此需要网络连接，如果没有网络连接，您的应用可能无法显示FAQ。使用HelpStack，您可以配置您的齿轮从服务器获取KB文章，或者您可以通过pList文件本地提供它们。在配置帮助台解决方案时，您必须指定pList文件名，如下所示

yourGear.localArticlePath = @"<FAQs file name>";

下载示例文章

显示您的 HelpStack

整合您的 helpStack 后，使用 'showHelp' API 调用来打开 HelpStack，显示常见问题解答或报告问题。

@implementation MyViewController

    - (IBAction) onHelpPressed: (id)sender {
        [[HSHelpStack instance] showHelp:self];
    }

使用 Swift，使用以下调用显示 HelpStack

let helpStack = HSHelpStack.instance() as HSHelpStack
    helpStack.showHelp(self)

自定义 HelpStack UI

HelpStack 随附内置屏幕，具有默认主题。它还包含一系列预配置的主题，您可以从以下链接下载

下载主题

您可以从这些主题之一开始。下载任何这些 pList 文件，将其包含到项目中并根据需要重命名。要应用 HelpStack 屏幕的主题，配置 HelpStack 时请包含以下代码行。

[[HSHelpStack instance] setThemeFrompList:@"MyCustomThemeForHelpStack"];

如何自定义主题 plist

基础知识

必须以以下列出的预定义格式提供某些 pList 属性

• 颜色 - 通过以逗号分隔的 R、G、B、alpha 值指定颜色。例如：255,255,255,1.0 是白色。

• 字体 - 字体名称和字体大小应在 pList 文件中作为两个单独的属性提供。字体应通过其字体家族名称和字体样式指定。例如：Helvetica-Bold 指定的字体大小将默认视为 'pts'。有关 iOS 支持的字体，请参考 iosfonts.com。

• 图片 - 包含在您项目中的图片必须指定其文件名。例如：example.png

自定义

以下是您可以自定义的 UI 项目列表，以及 wiki 中的说明

• 导航栏
• 背景
• 表格视图
• 聊天屏幕

导航栏

表格视图

聊天屏幕

关于

有关 HelpStack 的更多信息，请访问 helpstack.io。

HelpStack 由 HappyFox 公司维护。作为一个开源项目，它还包含来自 HelpStack 社区的作品。

视频

联系

在 Twitter 上与我们联系 @HelpStackSDK。

许可协议

HelpStack 在 MIT 许可协议下可用。有关更多信息，请参阅 LICENSE 文件。