目录
  1. WIKI教程
  2. 学习Grav
  3. 格拉夫 - 蓝图( Blueprints)

格拉夫 - 蓝图( Blueprints)

Blueprints是关于资源（信息源）的元数据信息。 它有两个目的 -

  • 首先是资源标识本身。
  • 其次是表格。

此完整信息保存在每个插件或主题中的blueprints.yaml文件中。

资源标识

在blueprints.yaml为每个主题和插件定义文件标识。 在蓝图未经过格式化和完美编译之前，不会在Grav存储库中添加资源。

蓝图示例 

name: plugin name
version: 0.6.0
description: Adds an advanced plugin to manage your site
icon: empire
author:
   name: Team Grav
   email: devs@getGrav.org
   url: http://getGrav.org
homepage: https://github.com/getGrav/Grav-plugin-assets
keywords: assets, plugin, manager, panel
bugs: https://github.com/getGrav/Grav-plugin-assets/issues
readme: https://github.com/getGrav/Grav-plugin-assets/blob/develop/README.md
license: MIT
dependencies:
   - form
   - email
   - login
form:
   validation: loose
   fields:
      Basics:
         type: section
         title: Basics
         underline: false
      enabled:
         type: hidden
         label: Plugin status
         highlight: 1
         default: 0
         options:
            1: Enabled
            0: Disabled
         validate:
            type: bool

以下几个属性是可选的，有些属性用于提供您的身份和资源。

Sr.No. 属性和描述
1

name*

提及资源的名称。

2

version*

指定资源的版本。

3

description*

提供有关资源的简要说明。 它不应超过200个字符。

4

icon*

指定用于开发新主题或插件的图标库。

5

author.name*

指定开发人员的名称。

6

author.email (optional)

指定开发人员的电子邮件地址。

7

author.url (optional)

指定开发人员的URL主页。

8

homepage (optional)

为您的资源指定分配的主页首页。

9

docs (optional)

指定您为资源编写的文档链接。

10

demo (optional)

指定演示资源的链接。

11

guide (optional)

指定如何指导资源的指南或教程的链接。

12

keywords (optional)

指定与资源相关的关键字列表。

13

bugs (optional)

指定可以报告问题或错误的Url。

14

license (optional)

指定您的资源许可证，即MIT，GPL等。

15

dependencies (optional)

指定插件或主题所需的依赖项的名称。

以下是登录插件蓝图的示例 - 

name: Login
version: 0.3.3
description: Enables user authentication and login screen.
icon: sign-in
author:
   name: Team Grav
   email: devs@getGrav.org
   url: http://getGrav.org
keywords: admin, plugin, login
homepage: https://github.com/getGrav/Grav-plugin-login
keywords: login, authentication, admin, security
bugs: https://github.com/Getgrav/Grav-plugin-login/issues
license: MIT

Forms

如果您希望主题或插件可以从管理界面直接配置选项，则可以使用表单填写blueprints.yaml文件。 可以通过Admin Plugin配置此资源的一部分， Admin Plugin由Forms元数据定义。

以下是Archives Plugin archives.yaml文件的示例。 

enabled: true
built_in_css: true
date_display_format: 'F Y'
show_count: true
limit: 12
order:
   by: date
   dir: desc
filter_combinator: and
filters:
   category: blog

这些是插件的默认设置。 要在不使用Admin插件的情况下配置它们，用户必须将此文件复制到/user/config/plugins/archives.yaml文件夹中并进行更改。 您可以正确提供archives.yaml文件; 您可以选择从用户更改管理界面中的设置。

保存更改后，它将自动写入《your_folder_name》/user/config/plugins/archives.yaml 。

Archives Plugin的blueprint.yaml文件包含如下所示的结构 - 

name: Archives
version: 1.3.0
description: The **Archives** plugin creates links for pages grouped by month/year
icon: university
author:
   name: Team Grav
   email: devs@getGrav.org
   url: http://getGrav.org
homepage: https://github.com/getGrav/Grav-plugin-archives
demo: http://demo.getGrav.org/blog-skeleton
keywords: archives, plugin, blog, month, year, date, navigation, history
bugs: https://github.com/getGrav/Grav-plugin-archives/issues
license: MIT
form:
   validation: strict
   fields:
      enabled:
         type: toggle
         label: Plugin status
         highlight: 1
         default: 1
         options:
            1: Enabled
            0: Disabled
         validate:
            type: bool
      date_display_format:
         type: select
         size: medium
         classes: fancy
         label: Date Format
         default: 'jS M Y'
         options:
            'F jS Y': "January 1st 2014"
            'l jS of F': "Monday 1st of January"
            'D, m M Y': "Mon, 01 Jan 2014"
            'd-m-y': "01-01-14"
            'jS M Y': "10th Feb 2014"
      limit:
         type: text
         size: x-small
         label: Count Limit
         validate:
            type: number
            min: 1
      order.dir:
         type: toggle
         label: Order Direction
         highlight: asc
         default: desc
         options:
            asc: Ascending
            desc: Descending

以下是archive.yaml中的表单元素。

Toggle 

enabled:
   type: toggle
   label: Plugin status
   highlight: 1
   default: 1
   options:
      1: Enabled
      0: Disabled
   validate:
      type: bool

Select 

date_display_format:
   type: select
   size: medium
   classes: fancy
   label: Date Format
   default: 'jS M Y'
   options:
      'F jS Y': "January 1st 2014"
      'l jS of F': "Monday 1st of January"
      'D, m M Y': "Mon, 01 Jan 2014"
      'd-m-y': "01-01-14"
      'jS M Y': "10th Feb 2014"

Text 

limit:
   type: text
   size: x-small
   label: Count Limit
   validate:
      type: number
      min: 1

根元素Enabled, date_display_format和limit是选项。 此根元素中存在的字段确定类型，大小，标签，默认值和选项。 根据字段类型，其他字段可以更改; 例如，选择字段需要选项列表。

Order direction 

order.dir:
   type: toggle
   label: Order Direction
   highlight: asc
   default: desc
   options:
      asc: Ascending
      desc: Descending

该字段由嵌套选项组成。 有许多字段类型可用于plugins/admin/themes/Grav/templates/forms/fields 。 正如我们在archive.yaml文件中看到的那样，表单验证设置为strict。 当验证设置为严格时，则对于所有选项，您必须添加蓝图表单，否则在保存时会弹出错误。 当您只想将两个字段自定义为管理界面时，可以将form.validation设置为松散。

下表给出了与上述表格元素相关的字段的简要说明。

Sr.No. 领域和描述
1

Type

表示字段类型。

2

Size

指定字段的大小。

3

Label

指定字段的标签。

4

Validate

它验证字段的类型和字段中输入的最小长度。

5

Default

设置默认字段。

6

Options

指定选项列表。

7

Classes

指定字段的类。

管理员中可用的表单字段

有许多可用的内置表单字段，可供插件和主题使用，也可以创建自己的表单字段。 下表列出了可用的表单字段 -

常见的表单字段

Sr.No. 领域和描述
1

Checkbox

显示单个复选框。

2

Checkboxes

显示复选框列表。

3

Date

包含日期字段。

4

Datetime

包含日期和时间字段。

5

Email

包含带验证的电子邮件地址字段。

6

Password

包含以点格式显示的密码字段。

7

Hidden

包含隐藏的输入字段。

8

Radio

允许从列表中仅选择一个选项。

9

Select

该字段包含几个选项。

10

Spacer

向表单添加标题，文本或水平线。

11

Text

包含普通文本字段。

12

Textarea

包含多行文本输入。

特殊表格领域

Sr.No. 领域和描述
1

Array

添加多个键值行。

2

Ignore

未使用的字段将被删除。

3

Columns

将表单分成多列。

4

Column

显示单个列。

5

Dateformat

设置日期和时间格式。

6

Display

显示没有任何输入值的文本值。

7

Frontmatter

页面以原始格式显示。

8

List

显示没有键的项目列表。

9

Markdown

显示降价编辑器。

10

Pages

显示页面列表。

11

Section

设置页面分为几个部分，每个部分都有一个标题。

12

Selectize

它用于选择框。

13

Tabs

设置分为选项卡列表。

14

Tab

标签字段用于提供标签。

15

Taxonomy

这是一个预先配置的选择，用于选择分类。

16

Toggle

它表示指定打开或关闭输入类型的切换效果。

<上一篇.Grav - 页面编辑器高级( Page Editor Advanced)
Grav - 性能和缓存( Performance & Caching).下一篇>
↑回到顶部↑
WIKI教程 @2018