Uso de módulos en plantillas

Los módulos son áreas editables de las páginas o correos electrónicos de HubSpot. Las instancias de los módulos pueden agregarse a las plantillas mediante HubL. Cuando un módulo se define en una plantilla, aparecerá de forma predeterminada en ese lugar de la plantilla. Si el módulo se encuentra en una región editable, como un área de arrastrar y soltar o en una columna flexible, se puede eliminar y mover y se pueden agregar otros módulos. Estas son instancias del módulo.

Las definiciones de los módulos: las etiquetas de los módulos que puedes agregar a las plantillas definen el estado predeterminado de las instancias de los módulos.

Después de definir un módulo, si es necesario, puedes obtener sus valores de campo a nivel de plantilla a través de content.widgets.

Las etiquetas de los módulos están formadas por los siguientes componentes:

• Un nombre único para ese módulo: le da al módulo una identidad única en el contexto de la plantilla
  
• Ruta: (depende de la etiqueta): define la ubicación del módulo en el administrador de diseño.
  • / significa la raíz de la unidad actual;
  • ./ significa el directorio actual;
  • ../ significa el elemento principal del directorio actual.
• Parámetros: ajustes adicionales para la instancia del módulo. Incluye valores predeterminados a nivel de plantilla para los campos del módulo.

Las etiquetas de los módulos de HubL están delimitadas por {% y requieren que se especifique el tipo de módulo y un nombre único. El nombre único debe ir entre comillas después del tipo de módulo. Los nombres de los módulos deben utilizar guiones bajos en lugar de espacios o guiones.

El nombre único se utiliza para hacer coincidir el contenido introducido con el editor de la página o el correo electrónico con la etiqueta del módulo de HubL correspondiente. Por ejemplo, si codificas una etiqueta de módulo de HubL con el mismo nombre en dos áreas diferentes de una plantilla, los usuarios solo tendrán un módulo para editar en el editor, pero los cambios en ese módulo se aplicarán en ambas ubicaciones. 

Además de los dos componentes necesarios de una etiqueta de módulo, los módulos de HubL admiten varios parámetros que especifican el comportamiento de un módulo, así como la forma como se mostrará. Los parámetros son pares clave-valor separados por comas. Los parámetros tienen diferentes tipos, como cadena, booleano, entero, enumeración y lista JSON. Los parámetros de cadena deben tener su valor entre comillas*, mientras que los parámetros booleanos no requieren comillas alrededor de sus valores True o False. A continuación, se muestra un ejemplo de un módulo de texto básico con una etiqueta y un parámetro de valor especificado.

En los módulos con campos que esperan diccionarios, puedes pasarlos como lo harías con otros parámetros. Si es más limpio para ti o planeas reutilizar los valores, puedes en cambio establecer el diccionario en una variable y pasar la variable al parámetro.

Aunque la mayoría de los módulos tienen parámetros que controlan el contenido predeterminado, puede haber situaciones en las que se necesite agregar grandes bloques de código al contenido predeterminado de un módulo. Por ejemplo, es conveniente que incluyas un gran bloque de HTML como contenido predeterminado en un módulo de texto enriquecido o HTML. En lugar de intentar escribir ese código en un parámetro de valor, puedes utilizar la sintaxis de bloque de HubL.

El parámetro que sigue inmediatamente a module_block o widget_block(obsoleto) es el parámetro type_of_module.

En casi toda nuestra documentación encontrarás que utilizamos module. Los módulos de HubSpot V2 son módulos normales, como los que puedes crear. Por lo tanto, ya no es necesario utilizar un type_of_module diferente.

Aunque que widget_block está obsoleto, deberías usar module_block. Si se hereda un sitio web de otro desarrollador, este puede contener código antiguo que usa widget_block y type_of_module.

El type_of_module admite nombres de módulos de HubSpot V1, por ejemplo: rich_text o raw_html. Se pueden agregar parámetros adicionales a la primera línea de HubL. La segunda línea define a qué parámetro se aplicará el contenido del bloque. Por ejemplo, para un módulo rich_text, este debería ser el parámetro html. En el caso de un módulo raw_html, éste sería el parámetro de valor (ve los dos ejemplos siguientes). 

Además de la sintaxis regular y de bloque, hay ciertos casos en los que es aconsejable que especifiques un gran bloque de contenido predeterminado para una variable de contenido predefinida. El ejemplo más común de esto resulta ser la variable content.email_body. Esta variable imprime un cuerpo de correo electrónico estándar que se puede modificar en el editor de contenido. Como este no es un módulo estándar de HubL, utilizamos la etiqueta content_attribute para especificar un bloque de contenido predeterminado. El ejemplo siguiente muestra la variable del cuerpo del correo electrónico rellenada con un bloque de código de contenido predeterminado.

Si bien ciertos módulos tienen determinados parámetros especiales, también hay parámetros que son compatibles con todos los módulos. A continuación, se encuentra una lista de los parámetros que son compatibles con todos los módulos.

faq_group_title en este caso no es uno de los parámetros que está disponible en todos los módulos. faq_group_title es específico de este módulo personalizado. Es el nombre de la variable de un campo del módulo.

Algunos campos son sencillos y el parámetro espera simplemente una cadena, entero, true/false. Otros pueden esperar un objeto. Proporcionar los valores en el formato correcto depende de ti, ya que no hay ninguna validación de valores en el editor basada en la configuración que estableces en la configuración de los campos del módulo personalizado. Ejemplo: Un módulo tiene un campo numérico que tiene un valor mínimo establecido en 1. Pasas en el parámetro un 0. No hay ninguna advertencia que indique que el valor no es válido.