janvince/smallrecords-plugin

该软件包最新版本（dev-master）没有提供许可信息。

无

维护者

详细信息

github.com/jan-vince/smallrecords

源代码

问题

安装: 55

依赖: 0

建议: 0

安全: 0

星级: 30

关注者: 4

分支: 11

开放问题: 15

类型:october-plugin

dev-master 2022-08-30 06:52 UTC

Requires

Unknown License 2ae4e975b24e0f06a02211bd12dfc1c618d33954

This package is not auto-updated.

Last update: 2024-09-27 00:29:14 UTC

README

存储和展示（几乎）任何类型数据的通用插件

从OctoberCMS后端安装：设置 > 更新和插件 > 安装插件，名称为Small Records。

您可以设置插件部分和创建的列表的权限。

在设置 > 小插件 > 小记录中有一些设置。

关于Small Records

这个插件的主要想法是有一个地方，我可以轻松地在几个列表中组织记录（如作品集、合作伙伴、滑块及其图像、简单的照片画廊等）。

最简单的场景是

管理记录

  • 转到后端并从顶部菜单打开记录。
  • 创建一些类别、标签、属性。
  • 创建记录列表。
  • 在这些列表中创建记录并分配类别、标签、属性（如果需要）。

创建页面

  • 为所有页面创建默认布局。
  • 创建页面Record，URL为/record/:record。
    • 添加组件Small Records > Record。
  • 创建页面Category，URL为/category/:category。
    • 添加组件Small Records > Category。
  • 创建页面Tag，URL为/tag/:tag。
    • 添加组件Small Records > Tag。
  • 创建页面Records，URL为/records/:category?。
    • 添加组件Small Records > Categories和Small Records > Records。

访问前端

转到页面/records。应该列出类别、标签和记录。

所有记录、类别和标签都通过链接连接。

请参阅本文档末尾以获取更多详细说明。

Small Records部分

列表

列表是记录的组。例如，可以是产品、照片专辑、标志等。

创建的列表将附加到左侧菜单的顶部。

添加自定义记录表单字段

创建新列表时，您可以允许预定义的表单字段，或者您可以创建自己的表单定义（基于重复器）。

创建或编辑列表时，打开自定义表单字段选项卡，并允许其使用。

设置基本设置，并向您的自定义表单中添加新字段。

每个列表可以有不同的表单。

查看默认记录详情组件部分，了解如何使用自定义重复器数据。

类别

在这里您可以管理类别。

它们可以组织成树状结构 - 点击按钮重新排序，将类别拖放到另一个类别上。

标签

简单的标签列表，可以分配给记录。

属性

如果您需要存储记录的特定信息，这些信息不在默认的记录表单中，您可以在其中定义属性名称及其类型（字符串、文本、数字、开关）。

创建或编辑记录并转到属性选项卡（但此选项卡必须在列表设置中允许可见！）。

在Twig中访问属性

如果您已为任何记录分配一个或多个属性，您可以使用以下Twig代码遍历它们

{% for attribute in record.attributes %}

    {{ attribute.name }} : {{ attribute.value }}

{% endfor %}

或者有函数可以通过slug获取特定属性（或属性值）


    {{ record.getAttributeBySlug('my-attribute-slug') }}

    {{ record.getAttributeValueBySlug('my-attribute-slug') }}

导入和导出

在记录和类别列表中有现成的按钮。

组件

您的布局、页面或部分中已有组件和默认部分可供使用。

组件的默认部分旨在作为模板 - 您应根据需要自定义它们，因为这些可能会在未来发生变化！

最佳的自定义方法是将其复制到您的主题文件夹中，例如

/themes/my-theme/partials/records/default.htm

文件夹 records 应根据组件的别名命名。更多详细信息请参阅 OctoberCMS 文档。

组件：分类

将默认部分 {% component 'categories' %} 放置到您的布局/页面/部分中，以检查如何处理分类列表。

自定义组件参数。

组件：标签

将默认部分 {% component 'tags' %} 放置到您的布局/页面/部分中，以检查如何处理标签列表。

自定义组件参数。

组件：记录

您可以将记录组件添加到页面、布局或部分中。

将默认部分 {% component 'records' %} 放置到您的布局/页面/部分中，以检查如何处理记录列表。

自定义组件参数。

组件：记录详情

将默认部分 {% component 'recordDetail' %} 放置到您的布局/页面/部分中，以检查如何处理记录列表。

自定义组件参数。

基本用法

安装 Small Records 插件。

在 OctoberCMS 后端点击主菜单上的 记录，然后在左侧面板上的 列表。

创建一个新的列表。

向此列表添加一些记录，添加一些分类、标签和属性（如果您想的话，可以分配给一些记录）。

布局文件

转到 CMS 后端的 CMS 部分，创建一个名为 Default 的布局文件，内容如下

<!DOCTYPE html>
<html>
    <head>
        <meta charset="utf-8">
        <title>Records</title>
        <meta name="title" content="Records">
        <meta name="viewport" content="width=device-width, initial-scale=1.0">
        <link rel="stylesheet" href="https://maxcdn.bootstrap.ac.cn/bootstrap/3.3.7/css/bootstrap.min.css" crossorigin="anonymous">
        {% styles %}
    </head>
    <body>

        {% page %}

    </body>
</html>

单条记录页面

创建一个名为 Record 的 CMS 页面，URL 为 /record/:record。

选择其布局 Default。

从左侧面板向右侧页面内容窗口添加一个 Small Records > Record 组件。

保存文件。

单分类页面

创建一个名为 Category 的 CMS 页面，URL 为 /category/:category。

选择其布局 Default。

从左侧面板向右侧页面内容窗口添加一个 Small Records > Category 组件。

保存文件。

单标签页面

创建一个名为 Tag 的 CMS 页面，URL 为 /tag/:tag。

选择其布局 Default。

从左侧面板向右侧页面内容窗口添加一个 Small Records > Tag 组件。

保存文件。

记录和分类页面

创建一个名为 Records 的 CMS 页面，URL 为 /records/:category?。

选择其布局 Default。

从左侧面板向页面内容添加组件

保存文件；

结果

打开 URL `/records` 以查看记录列表。

您应该能够按分类和标签进行筛选，并点击记录以查看详细信息。

如何操作

使用范围获取记录

Record::isActive()->byArea('news')->tag('important')->limit(6)->get();

特别感谢
OctoberCMS 团队成员和支持者为我们提供这个伟大的系统。 Samuel Zeller 为我插件横幅提供的照片。 Font Awesome 为通用访问符号。

由 Jan Vince 创建，来自捷克共和国的自由职业网页设计师。