Grav - Bản thiết kế

Blueprintslà thông tin siêu dữ liệu về tài nguyên (nguồn thông tin). Nó phục vụ hai mục đích -

• Đầu tiên là bản thân danh tính tài nguyên.
• Thứ hai là về các hình thức.

Thông tin đầy đủ này được lưu trong tệp blueprints.yaml có trong mỗi plugin hoặc chủ đề.

Nhận dạng tài nguyên

Trong blueprints.yaml, nhận dạng tệp được xác định cho từng chủ đề và plugin. Tài nguyên sẽ không được thêm vào kho lưu trữ Grav cho đến khi các bản thiết kế không được định dạng và biên dịch hoàn hảo.

Ví dụ về bản thiết kế

name: plugin name
version: 0.6.0
description: Adds an advanced plugin to manage your site
icon: empire
author:
   name: Team Grav
   email: [email protected]
   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

Một số thuộc tính sau là tùy chọn và một số được sử dụng để cung cấp danh tính và tài nguyên của bạn.

Sr.No.	Thuộc tính & Mô tả
1	name* Đề cập đến tên của tài nguyên.
2	version* Chỉ định phiên bản của tài nguyên.
3	description* Cung cấp mô tả ngắn gọn về tài nguyên. Nó không được vượt quá 200 ký tự.
4	icon* Chỉ định thư viện biểu tượng để phát triển chủ đề hoặc plugin mới.
5	author.name* Chỉ định tên của nhà phát triển.
6	author.email (optional) Chỉ định địa chỉ email của nhà phát triển.
7	author.url (optional) Chỉ định trang chủ URL của nhà phát triển.
số 8	homepage (optional) Chỉ định Url được phân bổ cho trang chủ cho tài nguyên của bạn.
9	docs (optional) Chỉ định liên kết tài liệu mà bạn đã viết cho tài nguyên của mình.
10	demo (optional) Chỉ định liên kết của tài nguyên demo.
11	guide (optional) Chỉ định liên kết về cách hướng dẫn hoặc hướng dẫn cho tài nguyên của bạn.
12	keywords (optional) Chỉ định danh sách các từ khóa có liên quan đến tài nguyên của bạn.
13	bugs (optional) Chỉ định Url nơi các vấn đề hoặc lỗi có thể được báo cáo.
14	license (optional) Chỉ định giấy phép tài nguyên của bạn, tức là MIT, GPL, v.v.
15	dependencies (optional) Chỉ định tên của các phần phụ thuộc được yêu cầu cho các plugin hoặc chủ đề.

Sau đây là một ví dụ về bản thiết kế plugin đăng nhập:

name: Login
version: 0.3.3
description: Enables user authentication and login screen.
icon: sign-in
author:
   name: Team Grav
   email: [email protected]
   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

Các hình thức

Bạn có thể điền vào tệp blueprints.yaml với các biểu mẫu nếu bạn muốn các chủ đề hoặc plugin có các tùy chọn có thể định cấu hình trực tiếp từ giao diện quản trị. Một phần của tài nguyên này có thể được định cấu hình thông quaAdmin Plugin, được định nghĩa bởi Forms metadata.

Sau đây là một ví dụ về tệp archives.yaml của Plugin lưu trữ .

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

Đây là các cài đặt mặc định của plugin. Để định cấu hình chúng mà không cần sử dụng plugin Quản trị, người dùng phải sao chép tệp này trong/user/config/plugins/archives.yamlthư mục và thực hiện các thay đổi. Bạn có thể cung cấp chính xác tệp archives.yaml ; bạn có thể chọn thay đổi cài đặt trong giao diện quản trị từ người dùng.

Sau khi lưu các thay đổi, nó sẽ tự động được ghi vào <your_folder_name>/user/config/plugins/archives.yaml.

Tệp blueprint.yaml của Plugin Archives chứa cấu trúc như hình dưới đây:

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: [email protected]
   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

Sau đây là các phần tử biểu mẫu có trong 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

Phần tử gốc Enabled, date_display_format và limit là các tùy chọn. Trường hiện diện trong phần tử gốc này xác định kiểu, kích thước, nhãn, mặc định và các tùy chọn. Tùy thuộc vào loại trường, các trường khác có thể thay đổi; ví dụ, trường chọn yêu cầu danh sách tùy chọn.

Order direction

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

Trường này bao gồm các tùy chọn lồng nhau. Có nhiều loại trường có thể được sử dụng trong plugin / quản trị / chủ đề / Grav / mẫu / biểu mẫu / trường . Như chúng ta có thể thấy trong tệp archive.yaml , xác thực biểu mẫu được đặt thành nghiêm ngặt. Khi xác thực được đặt là nghiêm ngặt, thì đối với tất cả các tùy chọn, bạn phải thêm biểu mẫu bản thiết kế, nếu không, nó sẽ xuất hiện lỗi trong khi lưu. Các form.validation có thể được thiết lập như là lỏng lẻo khi bạn muốn tùy chỉnh chỉ hai lĩnh vực để giao diện quản trị.

Bảng sau đây giải thích ngắn gọn về các trường liên quan đến các phần tử biểu mẫu ở trên.

Sr.No.	Trường & Mô tả
1	Type Cho biết loại trường.
2	Size Chỉ định kích thước của trường.
3	Label Chỉ định nhãn cho trường.
4	Validate Nó xác nhận loại trường và độ dài tối thiểu được nhập vào trường.
5	Default Đặt các trường mặc định.
6	Options Chỉ định danh sách các tùy chọn.
7	Classes Chỉ định lớp cho trường.

Các trường biểu mẫu có sẵn trong quản trị viên

Có nhiều trường biểu mẫu dựng sẵn có sẵn được sử dụng bởi các plugin và chủ đề hoặc có thể tạo trường biểu mẫu của riêng chúng. Bảng sau đây liệt kê các trường biểu mẫu có sẵn:

Các trường biểu mẫu chung

Sr.No.	Trường & Mô tả
1	Checkbox Hiển thị một hộp kiểm.
2	Checkboxes Hiển thị danh sách các hộp kiểm.
3	Date Chứa trường ngày tháng.
4	Datetime Chứa trường ngày và giờ.
5	Email Chứa một trường địa chỉ email có xác thực.
6	Password Chứa trường mật khẩu hiển thị ở định dạng dấu chấm.
7	Hidden Chứa trường đầu vào ẩn.
số 8	Radio Chỉ cho phép chọn một tùy chọn từ danh sách.
9	Select Trường này chứa ít tùy chọn.
10	Spacer Thêm tiêu đề, văn bản hoặc dòng ngang vào biểu mẫu.
11	Text Chứa trường văn bản bình thường.
12	Textarea Chứa đầu vào văn bản nhiều dòng.

Các trường biểu mẫu đặc biệt

Sr.No.	Trường & Mô tả
1	Array Thêm nhiều hàng giá trị khóa.
2	Ignore Các trường không sử dụng sẽ bị xóa.
3	Columns Chia biểu mẫu thành nhiều cột.
4	Column Hiển thị một cột duy nhất.
5	Dateformat Đặt định dạng ngày và giờ.
6	Display Hiển thị giá trị văn bản mà không có bất kỳ giá trị đầu vào nào.
7	Frontmatter Trang được hiển thị ở định dạng thô.
số 8	List Hiển thị danh sách các mục không có chìa khóa.
9	Markdown Hiển thị trình chỉnh sửa đánh dấu.
10	Pages Hiển thị danh sách các trang.
11	Section Trang cài đặt được chia thành các phần và mỗi phần có một tiêu đề.
12	Selectize Nó được sử dụng để chọn các hộp.
13	Tabs Cài đặt được chia thành danh sách các tab.
14	Tab Trường tab sử dụng để cung cấp một tab.
15	Taxonomy Nó là một lựa chọn được cấu hình sẵn để chọn phân loại.
16	Toggle Nó đại diện cho hiệu ứng bật tắt chỉ định loại đầu vào bật hoặc tắt.