Grav - Cetak Biru

Blueprintsadalah informasi metadata tentang sumber daya (sumber informasi). Ini melayani dua tujuan -

Pertama adalah identitas sumber daya itu sendiri.
Kedua, tentang bentuk.

Informasi lengkap ini disimpan dalam file blueprints.yaml yang ada di setiap plugin atau tema.

Identitas Sumber Daya

Dalam blueprints.yaml identitas file didefinisikan untuk setiap tema dan plugin. Sumber daya tidak akan ditambahkan dalam repositori Grav sampai cetak biru tidak diformat dan dikompilasi dengan sempurna.

Contoh Cetak Biru

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

Beberapa properti berikut ini opsional dan beberapa digunakan untuk memberikan identitas dan sumber daya Anda.

Sr.No.	Properti & Deskripsi
1	name* Sebutkan nama sumber daya.
2	version* Menentukan versi sumber daya.
3	description* Memberikan deskripsi singkat tentang sumber daya. Ini tidak boleh lebih dari 200 karakter.
4	icon* Menentukan perpustakaan ikon untuk mengembangkan tema atau plugin baru.
5	author.name* Menentukan nama pengembang.
6	author.email (optional) Menentukan alamat email pengembang.
7	author.url (optional) Menentukan beranda URL pengembang.
8	homepage (optional) Menentukan Url yang dialokasikan untuk beranda sumber daya Anda.
9	docs (optional) Menentukan link dokumentasi yang telah Anda tulis untuk sumber daya Anda.
10	demo (optional) Menentukan link sumber daya demo.
11	guide (optional) Menentukan link tentang cara memandu atau tutorial untuk sumber daya Anda.
12	keywords (optional) Menentukan daftar kata kunci yang terkait dengan sumber daya Anda.
13	bugs (optional) Menentukan Url tempat masalah atau bug dapat dilaporkan.
14	license (optional) Menentukan lisensi sumber daya Anda yaitu MIT, GPL dll.
15	dependencies (optional) Menentukan nama dependensi yang diperlukan untuk plugin atau tema.

Berikut adalah contoh cetak biru plugin login -

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

Formulir

Anda dapat mengisi file blueprints.yaml dengan formulir jika Anda ingin tema atau plugin memiliki opsi yang dapat dikonfigurasi secara langsung dari antarmuka admin. Bagian dari sumber daya ini dapat dikonfigurasi melaluiAdmin Plugin, yang didefinisikan oleh Forms metadata.

Berikut ini adalah contoh file archives.yaml Plugin Arsip .

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

Ini adalah pengaturan default plugin. Untuk mengkonfigurasinya tanpa menggunakan plugin Admin, pengguna harus menyalin file ini di/user/config/plugins/archives.yamlfolder dan lakukan perubahan. Anda dapat memberikan file archives.yaml dengan benar; Anda dapat memilih untuk mengubah pengaturan di antarmuka admin dari pengguna.

Setelah menyimpan perubahan, secara otomatis akan ditulis ke <your_folder_name>/user/config/plugins/archives.yaml.

File blueprint.yaml dari Plugin Arsip berisi struktur seperti yang ditunjukkan di bawah ini -

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

Berikut adalah elemen formulir yang ada di 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

Elemen root Diaktifkan, date_display_format, dan batas adalah opsi. Bidang yang ada di elemen akar ini menentukan jenis, ukuran, label, default, dan opsi. Bergantung pada jenis bidang, bidang lain dapat berubah; misalnya, bidang pilih memerlukan daftar opsi.

Order direction

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

Bidang ini terdiri dari opsi bertingkat. Ada banyak jenis field yang bisa digunakan di plugins / admin / themes / Grav / templates / forms / fields . Seperti yang bisa kita lihat di file archive.yaml , validasi formulir disetel ke ketat. Ketika validasi disetel sebagai ketat, maka untuk semua opsi Anda harus menambahkan formulir cetak biru, jika tidak maka akan muncul kesalahan saat menyimpan. The form.validation dapat ditetapkan sebagai longgar ketika Anda ingin menyesuaikan hanya dua bidang antarmuka admin.

Tabel berikut memberikan penjelasan singkat tentang bidang yang berkaitan dengan elemen formulir di atas.

Sr.No.	Bidang & Deskripsi
1	Type Menunjukkan jenis bidang.
2	Size Menentukan ukuran lapangan.
3	Label Menentukan label ke bidang.
4	Validate Ini memvalidasi jenis bidang dan panjang minimum yang dimasukkan di lapangan.
5	Default Setel bidang default.
6	Options Menentukan daftar opsi.
7	Classes Menentukan kelas untuk lapangan.

Form Fields tersedia di admin

Ada banyak bidang formulir bawaan yang tersedia yang digunakan oleh plugin dan tema atau dapat membuat bidang formulirnya sendiri. Tabel berikut mencantumkan bidang formulir yang tersedia -

Bidang formulir umum

Sr.No.	Bidang & Deskripsi
1	Checkbox Menampilkan kotak centang tunggal.
2	Checkboxes Menampilkan daftar kotak centang.
3	Date Berisi bidang tanggal.
4	Datetime Berisi bidang tanggal dan waktu.
5	Email Berisi bidang alamat email dengan validasi.
6	Password Berisi bidang kata sandi yang ditampilkan dalam format titik.
7	Hidden Berisi bidang masukan tersembunyi.
8	Radio Mengizinkan memilih hanya satu opsi dari daftar.
9	Select Bidang ini berisi beberapa opsi.
10	Spacer Menambahkan judul, teks atau garis horizontal ke formulir.
11	Text Berisi bidang teks normal.
12	Textarea Berisi input teks multiline.

Bidang formulir khusus

Sr.No.	Bidang & Deskripsi
1	Array Menambahkan beberapa baris nilai kunci.
2	Ignore Bidang yang tidak digunakan dihapus.
3	Columns Membagi formulir menjadi beberapa kolom.
4	Column Menampilkan satu kolom.
5	Dateformat Mengatur format tanggal dan waktu.
6	Display Menampilkan nilai teks tanpa nilai input apa pun.
7	Frontmatter Halaman ditampilkan dalam format mentah.
8	List Menampilkan daftar item tanpa kunci.
9	Markdown Menampilkan editor penurunan harga.
10	Pages Menampilkan daftar halaman.
11	Section Halaman pengaturan dibagi menjadi beberapa bagian dan setiap bagian memiliki judul.
12	Selectize Ini digunakan untuk memilih kotak.
13	Tabs Pengaturan dibagi menjadi daftar tab.
14	Tab Bidang tab digunakan untuk menyediakan tab.
15	Taxonomy Ini adalah pilihan yang telah dikonfigurasi untuk memilih taksonomi.
16	Toggle Ini mewakili efek sakelar yang menentukan jenis input aktif atau nonaktif.