Grav - planos

Blueprintsson información de metadatos sobre el recurso (fuente de información). Tiene dos propósitos:

Primero está la propia identidad del recurso.
El segundo tiene que ver con las formas.

Esta información completa se guarda en el archivo blueprints.yaml presente en cada complemento o tema.

Identidad de recurso

En blueprints.yaml , la identidad del archivo se define para cada tema y complemento. El recurso no se agregará en el repositorio de Grav hasta que los planos no estén formateados y compilados perfectamente.

Ejemplo de planos

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

Las siguientes propiedades son opcionales y algunas se utilizan para proporcionar su identidad y recurso.

No Señor.	Propiedades y descripción
1	name* Mencione el nombre del recurso.
2	version* Especifica la versión del recurso.
3	description* Da una breve descripción sobre el recurso. No debe superar los 200 caracteres.
4	icon* Especifica una biblioteca de iconos para desarrollar un nuevo tema o complemento.
5	author.name* Especifica el nombre del desarrollador.
6	author.email (optional) Especifica la dirección de correo electrónico del desarrollador.
7	author.url (optional) Especifica la URL de la página de inicio del desarrollador.
8	homepage (optional) Especifica la URL asignada para la página de inicio de su recurso.
9	docs (optional) Especifica el enlace de documentación que ha escrito para su recurso.
10	demo (optional) Especifica el enlace del recurso de demostración.
11	guide (optional) Especifica el enlace de cómo guiar o tutoriales para su recurso.
12	keywords (optional) Especifica la lista de palabras clave relacionadas con su recurso.
13	bugs (optional) Especifica la URL en la que se pueden informar problemas o errores.
14	license (optional) Especifica su licencia de recursos, es decir, MIT, GPL, etc.
15	dependencies (optional) Especifica el nombre de las dependencias necesarias para complementos o temas.

El siguiente es un ejemplo del modelo del complemento de inicio de sesión:

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

Formularios

Puede llenar el archivo blueprints.yaml con formularios si desea que los temas o complementos tengan opciones configurables directamente desde la interfaz de administración. La parte de este recurso se puede configurar a través delAdmin Plugin, que se define por el Forms metadatos.

El siguiente es un ejemplo del archivo 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

Estos son los ajustes predeterminados del complemento. Para configurarlos sin el uso del complemento Admin, el usuario debe copiar este archivo en el/user/config/plugins/archives.yamlcarpeta y realice los cambios. Puede proporcionar el archivo archives.yaml correctamente; puede optar por cambiar la configuración en la interfaz de administración de los usuarios.

Después de guardar los cambios, se escribirá automáticamente en <your_folder_name>/user/config/plugins/archives.yaml.

El archivo blueprint.yaml del complemento de archivos contiene la estructura que se muestra a continuación:

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

A continuación se muestran los elementos de formulario presentes en 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

El elemento raíz Enabled, date_display_format y limit son las opciones. El campo presente en este elemento raíz determina el tipo, tamaño, etiqueta, valor predeterminado y opciones. Dependiendo del tipo de campo, los otros campos pueden cambiar; por ejemplo, el campo de selección requiere una lista de opciones.

Order direction

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

Este campo consta de las opciones anidadas. Hay muchos tipos de campos que se pueden usar en complementos / admin / themes / Grav / templates / forms / fields . Como podemos ver en el archivo archive.yaml , la validación del formulario está configurada como estricta. Cuando la validación se establece como estricta, entonces, para todas las opciones, debe agregar el formulario de planos; de lo contrario, aparecerá un error al guardar. El formulario de validación se puede establecer como flojo cuando desee personalizar solo los dos campos de la interfaz de administración.

La siguiente tabla ofrece una breve explicación de los campos relacionados con los elementos de formulario anteriores.

No Señor.	Campo Descripción
1	Type Indica el tipo de campo.
2	Size Especifica el tamaño del campo.
3	Label Especifica la etiqueta del campo.
4	Validate Valida el tipo de campo y la longitud mínima ingresada en el campo.
5	Default Establece campos predeterminados.
6	Options Especifica la lista de opciones.
7	Classes Especifica la clase del campo.

Campos de formulario disponibles en el administrador

Hay muchos campos de formulario integrados disponibles que son utilizados por complementos y temas o pueden crear sus propios campos de formulario. La siguiente tabla enumera los campos de formulario disponibles:

Campos de formulario comunes

No Señor.	Campo Descripción
1	Checkbox Muestra una casilla de verificación única.
2	Checkboxes Muestra una lista de casillas de verificación.
3	Date Contiene campo de fecha.
4	Datetime Contiene campo de fecha y hora.
5	Email Contiene un campo de dirección de correo electrónico con validación.
6	Password Contiene un campo de contraseña que se muestra en formato de puntos.
7	Hidden Contiene un campo de entrada oculto.
8	Radio Permite seleccionar solo una opción de la lista.
9	Select Este campo contiene pocas opciones.
10	Spacer Agrega título, texto o línea horizontal al formulario.
11	Text Contiene un campo de texto normal.
12	Textarea Contiene entradas de texto de varias líneas.

Campos de formulario especiales

No Señor.	Campo Descripción
1	Array Agrega varias filas de valores clave.
2	Ignore Los campos no utilizados se eliminan.
3	Columns Divide el formulario en varias columnas.
4	Column Muestra una sola columna.
5	Dateformat Establece el formato de fecha y hora.
6	Display Muestra el valor de texto sin ningún valor de entrada.
7	Frontmatter La página se muestra en formato sin procesar.
8	List Muestra una lista de elementos sin clave.
9	Markdown Muestra el editor de rebajas.
10	Pages Muestra la lista de páginas.
11	Section La página de configuración está dividida en secciones y cada sección tiene un título.
12	Selectize Se utiliza para seleccionar cajas.
13	Tabs La configuración se divide en una lista de pestañas.
14	Tab El campo de pestañas se utiliza para proporcionar una pestaña.
15	Taxonomy Es una selección preconfigurada para seleccionar la taxonomía.
dieciséis	Toggle Representa el efecto de alternancia que especifica el tipo de entrada activada o desactivada.

↰ Previous page Next page ↱