README

定义要添加到仪表板中以供客户使用的有用链接。

要求

此插件需要Craft CMS 4.0.0或更高版本。

安装

要安装此插件，请按照以下说明操作。

打开您的终端并转到您的Craft项目
```
 cd /path/to/project
```
然后告诉Composer加载插件
```
 composer require adigital/help-links
```
在控制面板中，转到设置→插件，然后点击“安装”按钮安装帮助链接。

帮助链接概述

此小部件可用于在仪表板上显示对客户有用的链接。您可以在插件设置中创建所需数量的标题来清晰地分隔内容。每个链接都可以有标题、URL和附加注释。此插件受到了Katie Fritz在2018年柏林dot all上发表的关于优先考虑作者体验的讲话的启发。

配置帮助链接

在插件设置页面中创建您的部分标题。然后点击侧边栏中的帮助链接并配置您创建的每个标题的链接。

预先填充帮助链接

如果您像我们一样将为多个客户使用此插件，但大部分链接都将保持不变，则可以预先填充此插件的设置和链接。有2种方法可以实现这一点。

使用插件导入/导出

我们已在插件内创建了一个导入/导出页面，您可以使用该页面。一旦在某个网站上手动填充了链接，就可以将其导出为JSON格式的文件。然后可以将此文件导入干净的安装中，它将为您生成所有链接。从这里您可以根据需要编辑它们以使其特定于网站。这是我们推荐用于预先填充链接的方法。

使用迁移

您还可以创建内容迁移并在插件安装后在CMS中运行它。然后您可以像通常所需的那样编辑设置。

有关Craft 3中内容迁移的更多信息，请参阅此处：使用Craft 3中的内容迁移。

以下是一个代码示例，说明如何设置与该插件一起运行的迁移，只需确保在文件顶部添加use adigital\helplinks\HelpLinks;即可。

$plugin = Craft::$app->plugins->getPlugin("help-links");
$settings = [
	"widgetTitle" => "Help Links",
	"sections" => [
		["Documentation"],
		["Support"]
	]
];
Craft::$app->plugins->savePluginSettings($plugin, $settings);

$request = [];
$request["heading"] = "Documentation";
$request["position"] = "1";
$request["links"][] = [
	"Test",
	"http://www.test.com",
	"This is a test"
];
$request["links"][] = [
	"Another",
	"http://www.google.co.uk",
	"(Google)"
];
HelpLinks::$plugin->helpLinksService->generateSection($request);

$request = [];
$request["heading"] = "Support";
$request["position"] = "2";
$request["links"][] = [
	"Zendesk",
	"https://adigital.zendesk.com/agent/filters",
	"(tickets)"
];
HelpLinks::$plugin->helpLinksService->generateSection($request);