Referencia Liquid - Ficheros

Ficheros

layout.liquid

Este fichero es un archivo HTML/XHTML con tags liquid. Consisten principalmente de 3 secciones:

• Un doctype
• Un header
• Un body

DocType: Indica el tipo de documento: transactional o strict

Header: Para esta sección disponemos de algunos drops útiles.

Body: Debe contener el tag {{content_for_layout}}

El contenido dinámico, tal como blogs, products, etc se mostrará donde se incluya este tag.

Variables

En este fichero están disponibles las siguientes variables:

• page_title

  Titulo de la pagina. Varia en función del recurso solicitado. Por ejemplo, si estamos visitando un artículo de un blog el titulo sera: "Nombre del articulo - Nombre de la web". Este comportamiento es automático, pero se puede cambiar usando la opción SEO.

• page_keywords

  Dependiendo del recurso solicitado mostrará contenido para el meta keywords.

• page_description

  Información de qué estamos visitando para el meta description.

• page_robots

  Contenido del meta robots. Por defecto "follow, index", pero puede ser cambiado desde la sección SEO.

• user

  Drop con el usuario con que estamos visitando la web. En caso de no estar logeado este drop se referirá a un usuario anónimo.

• good_notice

  Mensaje de la ultima acción si ha sido correctamente realizada.

• bad_notice

  Mensaje de la última acción si se ha producido algun error.

• analytics_code

  Código de Google Analytics para estadísticas. Este código se cambia desde la opción preferencias.

• images_route

  Devuelve la ruta al directorio público de imágenes.

• stylesheet_route

  Devuelve la ruta al directorio público de hojas de estilo.

• logo_route

  Devuelve la ruta del logo de tu web, configurado desde Look&Feel en el panel de administración.
  (Solo disponible si la plantilla tiene activada la opción “El usuario puede subir su propio logotipo”)

• data_route

  Devuelve la ruta del directorio público de archivos.

• env_request_path

  Devuelve la ruta de la url a la que se está accediendo.

• main_menu

  Devuelve una lista con los elementos del menu superior. Cada elemento de la lista es un drop de tipo Link.
  (Sólo disponible si la plantilla tiene activada la opción “Tiene menu principal”)

• active_menu_hrefs

  Devuelve una lista con los hrefs de la jerarquía de menús que estamos recorriendo
  (Sólo disponible si la plantilla tiene activada la opción “Tiene menu principal”)

• active_menu

  Devuelve el menu activo. El drop es del tipo Link.
  (Sólo disponible si la plantilla tiene activada la opción “Tiene menu principal”)

• categories

  Devuelve una lista con las categorías raíz, es decir, las de primer nivel. Cada elemento de la lista es un drop de tipo Category.
  (Sólo disponible si la plantilla tiene activada la opción “Tiene árbol de categorías”)

• store

  Devuelve el drop Store

• locale_name

  Devuelve el nombre del idioma activo

• locale_code

  Devuelve el código del idioma activo en formato ISO 639-1

• home_posts

  Devuelve una lista con los últimos posts del blog "home". Cada elemento de la lista es un drop de tipo Post.

• image_roll

  Devuelve una lista de imágenes principales. Cada elemento de la lista es un drop de tipo Link.

• side_links

  Devuelve una lista con los enlaces laterales. Cada elemento de la lista es un drop de tipo Link.
  
  (Sólo disponible si la plantilla tiene la activada la opción “Tiene en laces laterales”)

• main_links

  Devuelve una lista con los enlaces centrales. Cada elemento de la lista es un drop de tipo Link.
  
  (Sólo disponible si la plantilla tiene activada la opción “Tiene enlaces centrales”)

• cart

  Devuelve el carro de la compra actual. El elemento es un drop de tipo Cart.

• archives

  Devuelve una lista de archivos de artículos. Cada elemento consiste de un Hash de la forma: ['Mayo 2009' => 22, 'Abril 2009' => 12]
  (Sólo disponible si la plantilla tiene activada la opción “Tiene elementos comunes de blog”)

• latest_articles

  Devuelve una lista con los últimos artículos de todos los blogs. Cada elemento de la lista es un drop de tipo Post.
  (Sólo disponible si la plantilla tiene activada la opción “Tiene elementos comunes de blog”)

• more_viewed_articles

  Devuelve una lista con los artículos mas vistos. Cada elemento de la lista es un drop de tipo Post.
  (Sólo disponible si la plantilla tiene activada la opción “Tiene elementos comunes de blog”)

• latest_comments

  Devuelve una lista con los últimos comentarios. Cada elemento es un drop de tipo Comment.
  (Sólo disponible si la plantilla tiene activa la opción “Tiene elementos comunes de blog”)

• home_blogs

  Devuelve una lista de todos los blogs. Cada elemento de la lista es un drop de tipo Blog.
  (Sólo disponible si la plantilla tiene activada la opción “Blog central”)

• news

  Devuelve una lista de los artículos del blog “news”. Cada elemento es un drop de tipo Post. (Sólo disponible si la plantilla tiene activada la opción “Tiene noticias”)

• latest_products

  Devuelve los últimos 10 productos creados/editados.

• highlight_products

  Devuelve una lista con los productos destacados. Cada elemento de la lista es un drop de tipo Product. (Sólo disponible si la plantilla tiene activada la opción “Tiene productos destacados”)

• template

  Devuelve el nombre del fichero liquid que se está usando para generar el HTML. Por ejemplo, si abrimos la ficha de un producto, este drop contiene la cadena 'product', ya que el fichero liquid se llama 'product.liquid'.

  Este drop permite insertar HTML o Javascript sólo para ciertas páginas. Por ejemplo, si queremos insertar un javascript sólo en la página de la selección de la forma de pago, podemos insertar el siguiente código en el 'layout.liquid':

  
  {% if template == 'payment' %}
  <script>
  // Aquí el javascript que sólo se ejecutará en la página de la selección de la forma de pago en el proceso de la compra.
  </script>
  {% endif %}
  
  

Estas variables también estarán disponibles para cada archivo liquid.

home.liquid

Este fichero es el mostrado en {{ content_for_layout }} cuando accedemos a la web. Es el punto de entrada a la web o tienda.

blog.liquid

Fichero mostrado al acceder a cualquier blog. Normalmente es usado para mostrar un resumen de los últimos artículos, entre otras cosas.

Variables

• blog

  Devuelve el blog que estamos visitando. El elemento es un drop de tipo Blog.

• posts

  Devuelve una lista con los 10 últimos artículos del blog. Cada elemento de la lista es un drop de tipo Post.

post.liquid

Este fichero se muestra cuando estamos visitando un artículo. Se usa normalmente para mostrar el artículo completo con los comentarios y el formulario para enviar comentarios.

Variables

• post

  Devuelve el artículo que estamos visitando. El elemento es un drop de tipo Post.

• blog

  Devuelve el blog del artículo que estamos visitando. El elemento es un drop de tipo Blog.

list.liquid

Este fichero se muestra cuando se visita una categoría de productos. En ella podemos mostrar una lista de los productos que pertenecen a la categoría.

Variables

• category

  Devuelve la categoría que se visita. El elemento es un drop de tipo Category.

• categories_path

  Devuelve la ruta de categorías, desde la raíz, hasta la que se esta visitando.

• products

  Devuelve una lista paginada de los productos pertenecientes a la categoría que se visita.
  Esto puede cambiarse según los parámetros de paginación que utilicen, pero por defecto muestra 12 productos ordenados por relevancia y fecha de creación. Cada elemento de la lista es un drop de tipo Product.

• products_total_filtered

  Número de productos total después de ser filtrados por grupo o por tags.

• products_total

  Numero total de productos.

• filter_tag_ids_with_and

  Lista de tags que se están usando para filtrar. Estos tags son todos requeridos.

• filter_tag_ids_with_or

  Lista de tags que se están usando para filtrar. Estos tags son opcionales en la busqueda.

• first_product

  Índice de producto desde el cual se muestra.
  Ej: Mostrando la pagina 2, 4 elementos por página
  first_product => 5

• last_product

  Índice de productos hasta el cual se muestran.
  Ej: Mostrando la pagina 2, 4 elementos por página
  first_product => 8

• total_products

  Número total de productos después de haber sido filtrados

• next_page

  Página siguiente

• previous_page

  Pagina anterior

• last_page

  Última pagina

• order_link

  Enlace usado para la ordenación.

• limit

  Productos por página

• offset

  Página actual

• order_by

  Criterio de ordenación (relevancia, fecha de creación, unidades vendidas, precio, nombre)

group.liquid

Este fichero es usado cuando se muestran productos filtrados por grupo. Puede ser usado para seleccionar productos de una o varias categorías según nuestro propio criterio.

Variables

• group

  Devuelve el grupo que estamos visitando. El elemento es un drop de tipo ProductGroup

• products

  Igual que list.liquid, pero los productos mostrados son los pertenecientes al grupo.

• products_total_filtered

  Igual que list.liquid, pero los productos mostrados son los pertenecientes al grupo.

• products_total

  Igual que list.liquid, pero los productos mostrados son los pertenecientes al grupo.

• filter_tag_ids_with_and

  Igual que list.liquid, pero los productos mostrados son los pertenecientes al grupo.

• filter_tag_ids_with_or

  Igual que list.liquid, pero los productos mostrados son los pertenecientes al grupo.

• first_product

  Igual que list.liquid, pero los productos mostrados son los pertenecientes al grupo.

• last_product

  Igual que list.liquid, pero los productos mostrados son los pertenecientes al grupo.

• total_products

  Igual que list.liquid, pero los productos mostrados son los pertenecientes al grupo.

• next_page

  Igual que list.liquid, pero los productos mostrados son los pertenecientes al grupo.

• previous_page

  Igual que list.liquid, pero los productos mostrados son los pertenecientes al grupo.

• last_page

  Igual que list.liquid, pero los productos mostrados son los pertenecientes al grupo.

• order_link

  Igual que list.liquid, pero los productos mostrados son los pertenecientes al grupo.

tags.liquid

Este fichero muestra cuando filtramos productos por tag.

Variables

• tag

  Devuelve el tag que se visita. El elemento es un drop de tipo Tag.

• products

  Igual que list.liquid, pero los productos mostrados son los pertenecientes al tag.

• products_total_filtered

  Igual que list.liquid, pero los productos mostrados son los pertenecientes al tag.

• products_total

  Igual que list.liquid, pero los productos mostrados son los pertenecientes al tag.

• filter_tag_ids_with_and

  Igual que list.liquid, pero los productos mostrados son los pertenecientes al tag.

• filter_tag_ids_with_or

  Igual que list.liquid, pero los productos mostrados son los pertenecientes al tag.

• first_product

  Igual que list.liquid, pero los productos mostrados son los pertenecientes al tag.

• last_product

  Igual que list.liquid, pero los productos mostrados son los pertenecientes al tag.

• total_product

  Igual que list.liquid, pero los productos mostrados son los pertenecientes al tag.

• next_page

  Igual que list.liquid, pero los productos mostrados son los pertenecientes al tag.

• previous_page

  Igual que list.liquid, pero los productos mostrados son los pertenecientes al tag.

• last_page

  Igual que list.liquid, pero los productos mostrados son los pertenecientes al tag.

• order_link

  Igual que list.liquid, pero los productos mostrados son los pertenecientes al tag.

• offset

  Igual que list.liquid, pero los productos mostrados son los pertenecientes al tag.

search.liquid

Fichero que se muestra cuando estamos buscando productos, páginas o artículos por nombre.

Variables

• query_string

  Cadena por la cual se realiza la búsqueda.

• products

  Devuelve la lista de productos encontrados y paginados. Cada elemento es un drop de tipo Product.

• filter_tag_ids_with_and

  Igual que list.liquid, pero los productos mostrados son los pertenecientes al a la busqueda.

• filter_tag_ids_with_or

  Igual que list.liquid, pero los productos mostrados son los pertenecientes al a la busqueda.

• products_total

  Lista de productos encontrados sin filtrar. Cada elemento es un drop de tipo Product.

• pages

  Lista de páginas encontradas. Cada elemento es un drop de tipo Page.

• posts

  Lista de articulos encontrados. Cada elemento es un drop de tipo Post.

product.liquid

Este fichero se muestra cuando se visita un producto. Se usa normalmente para mostrar su descripción, sus comentarios y ofrecer una forma de añadirlo al carro de la compra.

Variables

• product

  Devuelve el producto que se visita. El elemento es un drop de tipo Product.

• categories_path

  Lista con la ruta de categorías a la cual pertenece el producto

• sell_options

  Devuelve una lista con las opciones de venta del producto. Cada elemento de la lista es un drop de tipo SellOptions.

page.liquid

Este fichero se muestra cuando se visita una página.

Variables

• page

  Devuelve la página. El elemento es un drop de tipo Page.

cart.liquid

Este fichero se muestra cuando se accede al carro de la compra. Se utiliza normalmente para mostrar los productos añadidos y el total de la compra.

Variables

• cart

  Devuelve el carro de la compra. El elemento es un drop de tipo Cart.

• shipping_time

  Devuelve el tiempo de entrega de los productos añadidos al carro, en numero de días.

archives.liquid

Este fichero muestra los artículos publicados de un mes y año especificos. También puede mostrar todos los posts de de un cierto día.

Variables

• date_archives

  Fecha de los archivos que se muestran.

• posts

  Devuelve la lista de los artículos de una determinada fecha. Cada elemento de la lista es un drop de tipo Post.

• byday

  Está presente en caso de querer mostrar los artículos de cierto día. Entonces esta variable contendrá el día.

map.liquid

Este fichero sirve para mostrar todos los elementos que contiene la web. Normalmente se usa para que el usuario pueda ver rápidamente todo el contenido de la web.

Variables

• blogs

  Devuelve una lista de todos los blogs públicos. Cada elemento de la lista es un drop de tipo Blog.

• posts

  Devuelve una lista de todos los artículos públicos. Cada elemento de la lista es un drop de tipo Post.

• pages

  Devuelve una lista de todas las páginas. Cada elemento es un drop de tipo Page.

• categories_map

  Devuelve una lista de todas las categorías de productos. Cada elemento es un drop de tipo Category.

custom_error_page.liquid

Cuando se produce un error, de liquid, de ruta o elemento no encontrados se muestra este fichero.

Variables

• error_message

  Devuelve el mensaje de error. En caso de elemento no encontrado es simplemente "404" (el código de error oficial de HTTP para elemento no encontrado). Si es un error de plantilla, contiene una pequeña descripción del error.

• error_type

  Devuelve el código de error. Es una de las siguientes cadenas:

  • "404_error" en el caso de no encontrar el elemento buscado.
  • "template_error" en el caso de un fallo en la plantilla Liquid

Páginas desconocidas

Se pueden crear más ficheros liquid a parte de los listados a los que se podrá acceder por medio de la url: /store/page/nombre_de_fichero