Grav - 藍圖

---

---

藍圖是關於資源（資訊來源）的元資料資訊。它有兩個用途：

• 首先是資源本身的身份。
• 其次是關於表單的。

所有這些完整的資訊都儲存在每個外掛或主題中存在的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

以下一些屬性是可選的，有些用於提供您的身份和資源。

以下是登入外掛藍圖的示例：

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

表單

如果您希望主題或外掛具有可直接從管理介面配置的選項，則可以使用表單填充blueprints.yaml檔案。此資源的一部分可以透過管理外掛配置，該外掛由表單元資料定義。

以下是 Archives 外掛的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

這些是外掛的預設設定。要無需使用管理外掛即可配置它們，使用者必須將此檔案複製到/user/config/plugins/archives.yaml資料夾中並進行更改。您可以正確提供archives.yaml檔案；您可以選擇從使用者更改管理介面中的設定。

儲存更改後，它將自動寫入<your_folder_name>/user/config/plugins/archives.yaml。

Archives 外掛的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中存在的表單元素。

切換

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

根元素Enabled、date_display_format和limit是選項。此根元素中存在的欄位確定型別、大小、標籤、預設值和選項。根據欄位型別，其他欄位可能會發生變化；例如，選擇欄位需要選項列表。

順序方向

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檔案中看到的那樣，表單驗證設定為嚴格。當驗證設定為嚴格時，對於所有選項，您都必須新增藍圖表單，否則在儲存時會彈出錯誤。當您只想將兩個欄位自定義到管理介面時，可以將form.validation設定為寬鬆。

下表對與上述表單元素相關的欄位進行了簡要說明。

管理中可用的表單欄位

有許多內建表單欄位可供外掛和主題使用，或者可以建立自己的表單欄位。下表列出了可用的表單欄位：

常用表單欄位

特殊表單欄位