Grav - Taslaklar

Blueprintskaynakla ilgili meta veri bilgileridir (bilgi kaynağı). İki amaca hizmet eder -

Birincisi, kaynak kimliğinin kendisidir.
İkincisi formlarla ilgili.

Bu eksiksiz bilgiler, her eklenti veya temada bulunan blueprints.yaml dosyasına kaydedilir .

Kaynak Kimliği

Gelen blueprints.yaml dosya kimliği her temalar ve eklentiler için tanımlanır. Taslaklar mükemmel şekilde biçimlendirilip derlenene kadar kaynak Grav deposunda eklenmeyecektir.

Taslak Örneği

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

Aşağıdaki birkaç özellik isteğe bağlıdır ve bazıları kimliğinizi ve kaynağınızı vermek için kullanılır.

Sr.No.	Özellikler ve Açıklama
1	name* Kaynağın adını belirtin.
2	version* Kaynağın sürümünü belirtir.
3	description* Kaynak hakkında kısa açıklama verir. 200 karakteri geçmemelidir.
4	icon* Yeni bir tema veya eklenti geliştirmek için bir simge kitaplığı belirtir.
5	author.name* Geliştiricinin adını belirtir.
6	author.email (optional) Geliştiricinin e-posta adresini belirtir.
7	author.url (optional) Geliştiricinin URL ana sayfasını belirtir.
8	homepage (optional) Kaynağınız için ana sayfa için ayrılan URL'yi belirtir.
9	docs (optional) Kaynağınız için yazmış olduğunuz dokümantasyon bağlantısını belirtir.
10	demo (optional) Demo kaynağının bağlantısını belirtir.
11	guide (optional) Kaynağınız için nasıl rehberlik edeceğinizin veya öğreticilerin bağlantısını belirtir.
12	keywords (optional) Kaynağınızla ilgili anahtar kelimelerin listesini belirtir.
13	bugs (optional) Sorunların veya hataların bildirilebileceği URL'yi belirtir.
14	license (optional) Kaynak lisansınızı, yani MIT, GPL vb. Belirtir.
15	dependencies (optional) Eklentiler veya temalar için gerekli olan bağımlılıkların adını belirtir.

Aşağıda, giriş eklentisi planına bir örnek verilmiştir -

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

Formlar

Temaların veya eklentilerin doğrudan yönetici arayüzünden yapılandırılabilen seçeneklere sahip olmasını istiyorsanız , blueprints.yaml dosyasını formlarla doldurabilirsiniz . Bu kaynağın parçası,Admin Plugintarafından tanımlanan Forms meta veriler.

Aşağıda, Arşiv Eklentisi arşivleri.yaml dosyası örneği verilmiştir .

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

Bunlar eklentinin varsayılan ayarlarıdır. Yönetici eklentisi kullanmadan bunları yapılandırmak için kullanıcının bu dosyayı/user/config/plugins/archives.yamlklasörüne gidin ve değişiklikleri yapın. Archives.yaml dosyasını doğru şekilde sağlayabilirsiniz ; yönetici arayüzündeki ayarları kullanıcılardan değiştirmeyi seçebilirsiniz.

Değişiklikleri kaydettikten sonra, otomatik olarak <your_folder_name>/user/config/plugins/archives.yaml.

Blueprint.yaml aşağıda gösterildiği gibi Arşiv tapa dosya yapısını içerir -

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

Archive.yaml'de bulunan form öğeleri aşağıdadır .

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 kök öğesi , date_display_format ve limit seçeneklerdir. Bu kök öğede bulunan alan, türü, boyutu, etiketi, varsayılanı ve seçenekleri belirler. Alan türüne bağlı olarak diğer alanlar değişebilir; örneğin, seçim alanı seçenekler listesi gerektirir.

Order direction

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

Bu alan iç içe geçmiş seçeneklerden oluşur. Eklentiler / admin / temalar / Grav / şablonlar / formlar / alanlarda kullanılabilecek birçok alan türü vardır . Archive.yaml dosyasında görebileceğimiz gibi , form doğrulama katı olarak ayarlanmıştır. Doğrulama katı olarak ayarlandığında, tüm seçenekler için plan formunu eklemeniz gerekir, aksi takdirde kaydederken bir hata ortaya çıkar. Form.validation yönetici arayüzüne sadece iki alan özelleştirmek istediğinizde gevşek olarak ayarlanabilir.

Aşağıdaki tablo, yukarıdaki form öğeleriyle ilgili alanların kısa bir açıklamasını verir.

Sr.No.	Alan tasviri
1	Type Alan türünü gösterir.
2	Size Alanın boyutunu belirtir.
3	Label Alanın etiketini belirtir.
4	Validate Alanın türünü ve alana girilen minimum uzunluğu doğrular.
5	Default Varsayılan alanları ayarlar.
6	Options Seçeneklerin listesini belirtir.
7	Classes Alanın sınıfını belirtir.

Yöneticide bulunan Form Alanları

Eklentiler ve temalar tarafından kullanılan veya kendi form alanlarını oluşturabilen birçok yerleşik form alanı vardır. Aşağıdaki tablo, mevcut form alanlarını listeler -

Ortak form alanları

Sr.No.	Alan tasviri
1	Checkbox Tek onay kutusunu görüntüler.
2	Checkboxes Onay kutularının bir listesini görüntüler.
3	Date Tarih alanını içerir.
4	Datetime Tarih ve saat alanını içerir.
5	Email Doğrulamalı bir e-posta adresi alanı içerir.
6	Password Nokta biçiminde görüntülenen bir parola alanı içerir.
7	Hidden Gizli giriş alanı içerir.
8	Radio Listeden yalnızca bir seçeneği seçmeye izin verir.
9	Select Bu alan birkaç seçenek içerir.
10	Spacer Forma başlık, metin veya yatay çizgi ekler.
11	Text Normal metin alanı içerir.
12	Textarea Çok satırlı metin girişleri içerir.

Özel form alanları

Sr.No.	Alan tasviri
1	Array Birden çok anahtar değeri satırı ekler.
2	Ignore Kullanılmayan alanlar kaldırılır.
3	Columns Formu birden çok sütuna böler.
4	Column Tek bir sütun görüntüler.
5	Dateformat Tarih ve saat formatını ayarlar.
6	Display Herhangi bir giriş değeri olmadan metin değerini görüntüler.
7	Frontmatter Sayfa, ham formatta görüntülenir.
8	List Anahtarsız bir öğe listesi görüntüler.
9	Markdown Markdown düzenleyicisini görüntüler.
10	Pages Sayfaların listesini görüntüler.
11	Section Ayar sayfası bölümlere ayrılmıştır ve her bölümün bir başlığı vardır.
12	Selectize Kutuları seçmek için kullanılır.
13	Tabs Ayarlar, sekme listesine bölünmüştür.
14	Tab Sekmeler alanı, bir sekme sağlamak için kullanılır.
15	Taxonomy Sınıflandırmayı seçmek için önceden yapılandırılmış bir seçmedir.
16	Toggle Girişin açık veya kapalı türünü belirten geçiş efektini temsil eder.