Declaraciones Jdoc

From Joomla! Documentation

This page is a translated version of the page Jdoc statements and the translation is 100% complete.

Other languages:
English • ‎español • ‎فارسی • ‎français • ‎Bahasa Indonesia • ‎Nederlands • ‎русский • ‎中文(台灣)‎

Las declaraciones jdoc están incluidas en toda plantilla Joomla e indican dónde debería localizarse la salida de otras partes de Joomla o sus extensiones en la página web. Una declaración jdoc típica se parece a esto: <jdoc:include type="component" />

jdoc:include

La declaración <jdoc:include /> es un método de las plantillas Joomla! para mostrar contenido específico de la página que se está visualizando. Hay varias declaraciones <jdoc:include />, cada una de las cuales devuelve una parte diferente de una página Joomla. El reemplazo en sí mismo se lleva a cabo en DocumentHTML::_renderTemplate. Vea también _parseTemplate.

El atributo type

El atributo type especifica el tipo de contenido que será renderizado en lugar del elemento <jdoc:include />. Por ejemplo, la declaración <jdoc:include type="head" /> usa el atributo type concreto head (type="head").(Nota: las expresiones Jdoc requieren comillas dobles en torno a los atributos, y no funcionarán con comillas simples. El espacio delante del código de cierre /> también es obligatorio.)

Component

<jdoc:include type="component" />

Este elemento sólo debería aparecer una vez dentro del elemento <body> de la plantilla para mostrar el contenido principal de la página con respecto a la página que se está visualizando.

Head

<jdoc:include type="head" />

Este elemento sólo debería aparecer una vez dentro del elemento <head> de la plantilla para mostrar el contenido del estilo, los scripts y los meta elementos asociados a la página actual.

Installation

<jdoc:include type="installation" />

Este elemento sólo se usa en la plantilla del instalador de Joomla! para la versión Joomla 2.5 e inferiores, y no tiene ninguna utilidad concreta para las plantillas de la parte pública o administrativa. Viene a ser el equivalente del tipo 'component', en este caso mostrando el contenido principal de un paso de la instalación.

Message

<jdoc:include type="message" />

Este elemento sólo debería aparecer una vez dentro del elemento <body> de la plantilla para mostrar los mensajes de error y del sistema que se produjeron en la solicitud.

Los estillos CSS para los mensajes del sistema pueden encontrarse en templates\system\css\system.css

Module

<jdoc:include type="module" name="breadcrumbs" title="Breadcrumbs" />
<jdoc:include type="module" name="mainmenu" title="Main Menu" />

Este elemento muestra un único módulo dado por los atributos name y title: name debería coincidir con el tipo de módulo (mod_breadcrumbs y mod_menu en los ejemplos anteriores), mientras que title debería ser el nombre del módulo deseado. El módulo en cuestión deber estar publicado y ser accesible por el usuario actual para que sea visible. Se pueden proporcionar atributos adicionales para controlar el diseño y la apariencia del módulo, en caso de estar permitidos.

Modules

Los módulos se muestran en una página usando uno de los siguientes ejemplos de código. Los módulos son separados en distintas áreas de una plantilla usando posiciones de módulos establecidas en el archivo templatedetails.xml. Usando el atributo name="[template position name]" de jdoc:include, puede llamarse a los distintos módulos en sus posiciones respectivas, con estilos y diseños distintos. Se pueden proporcionar atributos adicionales para controlar el diseño y la apariencia de los módulos, si son soportados.

Los siguientes son algunos ejemplos de declaraciones de módulos con posiciones de módulos usadas habitualmente por los desarrolladores de plantillas Joomla!.

<jdoc:include type="modules" name="debug" />
<jdoc:include type="modules" name="icon" />
<jdoc:include type="modules" name="left" style="rounded" />
<jdoc:include type="modules" name="left" style="xhtml" />
<jdoc:include type="modules" name="right" style="xhtml" />
<jdoc:include type="modules" name="status"  />
<jdoc:include type="modules" name="syndicate" />
<jdoc:include type="modules" name="title" />
<jdoc:include type="modules" name="toolbar" />
<jdoc:include type="modules" name="top" />
<jdoc:include type="modules" name="top" style="xhtml" />
<jdoc:include type="modules" name="user1" style="xhtml" />
<jdoc:include type="modules" name="user2" style="xhtml" />
<jdoc:include type="modules" name="user3" />
<jdoc:include type="modules" name="user4" />

Nota: La posición de módulo name="user3" se usa normalmente (por defecto) para el menú superior.

El atributo style

El atributo opcional style="" está disponible para los tipos module y modules de las declaraciones <jdoc:include />. El valor del atributo se refiere al estilo del chrome usado para envolver la salida generada por el módulo. Si no se proporciona ningún estilo, el valor "none" se usará por defecto.

Los diseñadores de plantillas también pueden añadir nombres de chrome adicionales como se describe en el artículo aplicar chromes de módulo personalizados.

Ver también