janvince / smallgdpr-plugin
无
Requires
- composer/installers: ~1.0
README
简单的插件,用于处理GDPR
安装
GitHub 克隆到 /plugins
目录
git clone https://github.com/jan-vince/smallgdpr
OctoberCMS 后端
只需在
设置 > 更新 & 插件 > 安装插件
权限
设置 > 管理员
您可以设置权限以限制对 设置 > 小插件 > 小GDPR 以及消息列表的访问。
快速入门指南
cookies
-
安装插件。
-
转到 October 的设置页面,点击 GDPR > Cookies。
- 转到“导入”选项卡,点击按钮
导入默认设置
。 - 转到“Cookies”选项卡,添加您的 JS 代码到所需的 cookies 组。
- 转到“导入”选项卡,点击按钮
-
转到 October 的 CMS 部分。
- 添加新的布局(或使用您现有的)
- 添加组件 Small GDPR > Cookies bar(在您的
body
标签内)。
-
转到 October 的 CMS 部分。
- 添加新的页面,URL 为
/gdpr
- 添加组件 Small GDPR > 管理 cookies(在您的任何标签内)
- 添加新的页面,URL 为
别忘了在布局页面上添加
{% scripts %}
标签,就在关闭body
标签之前!更多信息请参阅October 文档。
- 打开您的网站 - cookies 栏应该可见 :)
设置
选项卡:Cookies 组
主要思想是创建包含您要在网站上运行的 JS 脚本的 cookies 组。
必需的
当开启时,用户不能在小 cookies 组件中禁用这些组,并且脚本将始终执行。
默认启用
这些组中的脚本将不经过用户的明确同意而执行,但用户可以在小 cookies 组件中禁用它们。
请注意,不要违反当地法律!
默认选中
这些组中的脚本不会执行,但在模态窗口中它们将被预选中。
脚本
您可以为选定的组添加一个或多个脚本
自定义 JS 代码或文件
您可以将自己的 JS 代码和/或文件添加到在允许(或必需)cookies 组时执行的脚本中。
您可以选择将脚本执行限制在生产模式下。
仅在生产模式下运行
脚本仅在 production
环境中执行。
禁用
这些脚本将永远不会执行
在特定页面上运行
您可以将脚本执行限制到特定的页面 URL。
选项卡:Cookies 栏
您可以编辑 cookies 栏的标题和内容。
如果您愿意,您可以从预定义的 CSS 样式中选择。
按钮
您可以在 cookies 栏中添加一个或多个按钮。
允许所有 cookies
当开启时,点击此按钮将设置所有 cookies 组启用。
对于 Cookies 栏上的“允许所有”按钮很有用。
注意:如果创建了类似 /gdpr 的页面,用户可以在 CMS 页面上通过管理 cookies 组件(如)稍后更改 cookies 设置。
打开模态窗口
当开启时,点击此按钮将打开包含 cookies 组列表的模态窗口。
目前仅支持 Bootstrap 3 UI 样式(可以在设置选项卡上设置)。
选项卡:管理 cookies
只需添加标题和内容,这些内容将显示在“管理Cookies”组件中的Cookies组列表上方。
选项卡:设置
需要设置一些常规设置。
Cookies过期时间
Cookies在浏览器中存在的天数。
UI样式
更改输出HTML代码的格式。
为每种语言设置Cookies
默认为开启。
如果您使用Rainlab Translate插件,并且为每种语言设置了不同Cookies组代码的Cookies组,则此选项为必需。
另一方面,如果您有单独的语言但相同的Cookies组代码,并且希望访客不需要为每种语言分别同意,则可以关闭此选项。
选项卡:导入
您可以从自己的路径或默认插件预设(如果您全部留空)中导入设置预设。
您必须使用YAML格式。
注意:先尝试导出,以了解导入文件的结构。
选项卡:导出
您可以将当前设置数据导出到配置文件中,用作备份或其他网站的模板。
组件
Cookies栏
应在您的布局或页面中使用。
隐藏Cookies栏
如果您需要在特定页面或布局中隐藏Cookies栏,可以使用以下方式在您的页面中使用View Bag
[viewBag]
hideCookiesBar = 1
管理Cookies
将此组件放置到您的页面中,其中包含有关隐私的详细信息(如/gdpr或/cookies)。
管理Cookies组件也可以添加到静态页面中作为代码片段
用户将能够更改Cookies设置。
如何使用
使用组件Cookies栏
或管理Cookies
,您可以在Twig代码中像这样访问Cookies设置
{% if sgCookies.necessary %}
...
{% endif %}
我要感谢
OctoberCMS团队成员和支持者,因为他们有一个伟大的系统。
Brooke Cagle的照片。
Font Awesome提供漂亮的图标。OFFLINE从他的GDPR插件中汲取灵感
由来自捷克共和国的自由职业网页设计师Jan Vince创建。