Recursos web, diseño, joomla!, tutoriales, opinión, algunas noticias...
Realizar una búsqueda
Tutorial: Crear un template para Joomla! 1.5 desde cero
miércoles, 01 de octubre de 2008
Junto a Comunidad Joomla! , tengo el agrado de presentarles el Manual de desarrollo de plantillas para Joomla! 1.5: Guía paso a paso, una completa ayuda para crear un template funcional, con ejemplos 100% reales y prácticos.
Estructura básica de una plantilla para Joomla! 1.5.x
Básicamente un template puede estar formado por las siguientes carpetas y archivos:
Carpetas:
css: Es la carpeta que contiene los estilos en cascada del template.
html: Esta carpeta posee los archivos que funcionaran como plantilla especifica para módulos y componentes. Su uso no es prioritario pero es una funcionalidad a explotar si deseamos un código personalizado para componentes/módulos.
images: Contendrá las imágenes usadas para el diseño.
Archivos:
index.php: El archivo principal, contendrá todo el HTML y directivas PHP de Joomla! para cargar el contenido (artículos, componentes, módulos, etc.)
templateDetails.xml: Determinante para que la plantilla sea reconocida en el back-end del CMS. Posee diversos datos como licencia, autor, e-mail, etc. En Joomla! 1.5 la plantilla podrá tener parámetros manejables desde el back-end para cambiar la visualización del template. En este archivo se agregaran los parámetros y las posiciones de disponibles para mostrar los módulos.
template_thumbnail.png: Es la imagen que actuará como previsualización del template en la administración.
params.ini: Contendrá los valores para configurar los parámetros del template. Si la plantilla no posee parámetros para configurar, este archivo no será necesario.
template.css: Es el estilo en cascada principal que se encuentra dentro de la carpeta 'css'. En la rama de Joomla! 1.0.x este archivo tenía el nombre de template_css.css
favicon.ico: Es el favicon que usaremos en nuestro sitio.
imagenes varias: Conformaran el diseño de la plantilla.
Dentro de la carpeta 'html', como decía más arriba, estarán archivos y carpetas específicos para los módulos y componentes del sitio. Con esto podremos manejar a nuestro gusto la apariencia y el output de dichos componentes y módulos. La idea es que la plantilla prevalezca por encima del output HTML que genera Joomla! De esta forma, por ejemplo, podremos reemplazar todas las tablas que genera tal componente y reemplazarlas por DIVs.
Creación de la carpeta para nuestro template
Lo primero que haremos será crear la carpeta en donde se alojaran los archivos de nuestra plantilla. Para eso vamos al directorio 'templates' de Joomla! y creamos una carpeta con el nombre que queramos, en minúscula, y en caso de ser varias palabras, sin espacios. Luego podemos crear las subcarpetas necesarias: css, images y/o HTML
Creación de templateDetails.xml
Podemos dividir en cuatro partes el contenido de templateDetails.xml: Datos, Archivos, Posiciones y Parámetros.
Datos: Aquí, entre cada etiqueta pondremos los datos específicos de la plantilla como su versión, autor, email, página web, año, licencia y descripción:
XML
<?xmlversion="1.0"encoding="utf-8"?>
<installversion="1.5"type="template">
<name>Nombre del template</name>
<creationDate>Fecha de creación</creationDate>
<author>Nombre del autor</author>
<copyright>Licencia</copyright>
<authorEmail>E-mail del autor</authorEmail>
<authorUrl>Web del autor</authorUrl>
<version>Versión</version>
<description>
<![CDATA[
Aqui va la descripción, puede usarse HTML o texto plano.
]]>
</description>
Archivos: Cuando hayamos terminado nuestro trabajo, aquí deberemos especificar todos los archivos que hemos utilizado para el diseño, para luego comprimir todo en ZIP y tener un instalador de la plantilla. Como ahora no necesitamos un instalador (ya que estamos creando el template dentro del mismo Joomla!) podemos dejar estos campos incompletos, pero es muy recomendable que al terminar el trabajo lo completemos debidamente:
XML
<files>
<filename>index.php</filename>
<filename>templateDetails.xml</filename>
<filename>template_thumbnail.png</filename>
<filename>favicon.ico</filename>
<filename>css/template.css</filename>
<filename>images/imagen.png</filename>
</files>
Posiciones: Es importante saber con anticipación que posiciones usaremos y cuantas en nuestro sitio para planificar en donde mostrarlos en la plantilla.
XML
<positions>
<position>left</position>
<position>right</position>
<position>user3</position>
</positions>
Parámetros: Si deseamos realizar una plantilla más versátil, podemos agregarle parámetros para ser manejados desde el Back-end. Por ejemplo, si nuestra plantilla cuenta con la posibilidad de configurar los colores de fondo, esta opción estará habilitada para ser activada desde la administración de Joomla!. En Joomla! 1.0.x, si añadíamos un parámetro, este solo podía ser modificado tocando el index.php de la plantilla. Podemos encontrar un ejemplo de parámetros de template accediendo a Extensiones --> Gestor de plantillas -->rhuk_milkyway. En la columna derecha veremos los parámetros para dicho template:
XML
<params>
<paramname="color"type="list"default="blanco"label="Color de la tipografia"description="Color de la tipografia">
<optionvalue="azul">Azul</option>
<optionvalue="rojo">Rojo</option>
<optionvalue="verde">Verde</option>
</param>
</params>
</install>
Los valores por default y cada vez que modificamos un parámetro desde el back-end, son guardados en el archivo params.ini. Corre por nuestra cuenta si nosotros queremos o no añadir este tipo de posibilidad a nuestro diseño. Por lo general son las plantillas comerciales las que lo implementan, ya que le otorga mucha flexibilidad al producto. Más adelante veremos un ejemplo de utilización de parámetros.
Entonces templateDetails.xml puede tener la siguiente apariencia:
XML
<?xmlversion="1.0"encoding="utf-8"?>
<installversion="1.5"type="template">
<name>Nombre del template</name>
<creationDate>Fecha de creacion</creationDate>
<author>Nombre del autor</author>
<copyright>Licencia</copyright>
<authorEmail>E-mail del autor</authorEmail>
<authorUrl>Web del autor</authorUrl>
<version>Version</version>
<description>
<![CDATA[
Aqui va la descripcion, puede usarse HTML o texto plano.
]]>
</description>
<files>
<filename>index.php</filename>
<filename>templateDetails.xml</filename>
<filename>template_thumbnail.png</filename>
<filename>favicon.ico</filename>
<filename>css/template.css</filename>
<filename>images/imagen.png</filename>
</files>
<positions>
<position>left</position>
<position>right</position>
<position>user3</position>
</positions>
<params>
<paramname="color"type="list"default="azul"label="Color de la tipografia"description="Color de la tipografia">
<optionvalue="azul">Azul</option>
<optionvalue="rojo">Rojo</option>
<optionvalue="verde">Verde</option>
</param>
</params>
</install>
Creación de index.php
Para la creación del index.php, lo primero que haremos será insertar el HTML que formará la maquetación de la plantilla. Para eso partiremos desde un layout básico de tres columnas, barra de navegación, header y footer. Entonces en index.php creamos el HTML:
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
Lo siguiente será ir incorporando las directivas que cargaran toda la información para que la plantilla funcione. Veamos las básicas:
<jdoc:include type="head" />: Esta directiva irá dentro de la cabecera HTML. Cargará el título de la página en cuestión, metatags, feed, y framework javascript. Joomla! a partir de la versión 1.5 decide usar como framework javascript a Mootools. Y esto lo hace de forma nativa, es decir que no nos dá la posibilidad de elegir entre cargarlo o no (a menos que editemos algún archivo fuente). Obviamente no hay que tomarlo para mal, sino al revés, entre líneas el equipo de Joomla! nos esta diciendo que echemos rienda suelta a nuestra imaginación y utilicemos a Mootools para añadir efectos, nuevas propiedades o lo que queramos a la plantilla. En otras palabras, que explotemos todo su potencial.
Otro hecho es que para mostrar nuestro favicon, tendremos que añadir las líneas manualmente para mostrarlo.
$this->template:Obtendremos el nombre de la carpeta contenedora de nuestra plantilla. Se puede utilizar para cargar el estilo en cascada, favicon y cualquier archivo que queramos y se encuentre dentro de esta carpeta.
Con esto ya podemos crear la cabecera HTML de la plantilla:
$mainframe->getCfg('sitename'): Obtendremos el nombre del sitio en cuestión.
<jdoc:include type="modules" name="posición" style="estilo" />: Con esta directiva estamos indicando la carga de un módulo en particular y de una manera especifica.
Esto se establecerá a partir de los parámetros 'name' y 'style'. En el caso del primero, escribiremos la posición de módulo que queremos cargar. Por ejemplo, si deseamos todos los módulos derechos, el parámetro será 'name="right"'. El segundo parámetro posee algunas variantes, el uso de cada una va a depender de nuestras necesidades. Las variedades de estilo pueden ser 'table', 'horz', 'xhtml', 'rounded' y 'raw'. Tanto con 'table' como con 'horz' el contenido del módulo será cargado a través de tablas, la diferencia es que el primer parámetro lo hará de forma vertical (a través de una columna) y el segundo lo hará de forma horizontal (a través de una fila). Si utilizamos 'xhtml' el contenido en vez de ser cargado en tablas será insertado en DIVs. El parámetro 'rounded' es similar a 'xhtml' con la diferencia que carga el contenido en varios DIVs anidados. Este último se suele utilizar para realizar bordes redondeados a través de imágenes. Finalmente el parámetro 'raw' cargará el contenido neto, sin contenedores ni título.
Ejemplo:
Queremos insertar en DIVs todos los módulos izquierdos en determinada parte del sitio, la directiva quedará conformada por:
En caso de no especificar el estilo, por default el valor será 'table'.
<jdoc:include type="component" />: Con ella cargaremos el contenido principal del sitio (artículos, secciones, categorías, etc.). A diferencia de la inclusión de módulos, esta directiva no posee parámetros para manejar en donde cargar el contenido.
Aprendiendo esto ya estaremos resolviendo el 80% de index.php, quedando:
PHP
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN""http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
En el DIV 'header' se cargó una etiqueta H1 que muestra el nombre del sitio. Por otro lado, en el footer se carga el archivo footer.php que trae un texto predeterminado para mostrar. Este se encuentra en includes/footer.php
Si en el backend, configuramos para que nuestro template sea el predeterminado, al ingresar al sitio veremos:
Lo cual no está mal, ya que aún no hemos editado el CSS, por el contrario está muy bien, porque hemos podido cargar el contenido del sitio en nuestra plantilla.
Edición de template.css
Vamos a la carpeta 'css' y creamos el archivo template.css. Lo primero que haremos será insertar los estilos para la maquetación de la plantilla:
Ahora somos libres de añadir los estilos que queramos, pero para eso primero debemos conocer algunas de las clases que Joomla! carga por default en sus elementos.
Clases pertenecientes a contenido:
componentheading: Nuestra el título del componente en cuestion. La página de inicio, al ser un componente (com_frontpage) tiene posibilidad de mostrar un título.
contentheading: Es la clase perteneciente a la celda que muestra el título de los artículos
buttonheading: Pertece a las celdas que muestran los iconos de PDF, Imprimir y Enviar a un amigo
small: Es usado por varios elementos, entre ellos el que muestra el autor de un artículo
createdate: Es usado por la celda que muestra la fecha de creación de un artículo
readon: Utilizada por el link "Leer más..."
article_separator: Utilizada por la etiqueta <span> que separa a los artículos entre sí
Clases pertenecientes a módulos:
Por lo general, las clases asociadas a módulos dependen de varias cosas, desde la forma en que nosotros seleccionamos el estilo de carga del módulo, hasta si esta posee un sufijo de la clase de módulo. Además muchos módulos creados por terceros poseen sus propias clases propias.
Tomemos como ejemplo, un módulo del tipo menú:
moduletable: Arriba contábamos que los módulos pueden cargarse de diferentes formas, dentro de tablas ó en DIVs. Para nuestro template nosotros hemos especificado que los módulos se carguen en un solo DIV a través del parámetro style="xhtml". Para este caso, el DIV contenedor posee la clase CSS asociada moduletable
Si nosotros entramos a la edición del módulo, podremos añadir un sufijo especifico para moduletable:
h3: Los títulos de los módulos se cargan con la etiqueta H3
active: Para el caso del menú, cuando nos encontramos dentro de una página existente como item, se agrega la clase active
item: A su vez cada elemento del menú posee una clase unica, la cual es item más el ID que posea dicho elemento
parent: Si hemos creado un elemento que a su vez posee sub-items, al elemento padre se le añade la clase parent
Otras clases CSS importantes:
button: Es una clase asociada a elementos del tipo botón
inputbox: Suele estar asociada a elementos text-input
pagenav: Clase asociada a la paginación de artículos
modifydate: Clase asociada ala fecha demodificación de un artículo
sectiontableentry1/sectiontableentry2: Suele estar asociada cuando se muestran datos en tablas
Ahora que conocemos las clases mas importantes, podemos ir aplicando un poco de estilo al template y acomodar los módulos que vamos a usar:
Como vimos al principio, los parámetros de un template se deben especificar en templateDetails.xml. Allí se debe poner el tipo de parámetro, las opciones que posee y cual es el parámetro por default. A su vez, los valores de los parámetros son guardados en el archivo params.ini que como vimos, se encuentra en la carpeta de la plantilla.
Veamos por ejemplo, la utilización de parámetros para cambiar el color de la tipografía del template. En templateDetails.xml nosotros ya hemos especificado la opción. Lo siguiente será crear un archivo params.ini con el valor por default que debe tener el parámetro, en este caso queremos que el color predeterminado de la tipografía sea azul:
params.ini
color=azul
En caso de tener más parámetros, estos deben ir uno por línea con su correspondiente valor:
params.ini
nombre_del_parametro_1=valor
nombre_del_parametro_2=valor
nombre_del_parametro_3=valor
Lo siguiente será ir al index.php y agregar la directiva que llamará al valor del parámetro. Este valor lo utilizaremos para crear un identificador CSS y así especificar cuando cargar un color y cuando otro. Entonces en el index.php, en la etiqueta <body> agregamos:
Entrando a la configuración del template podremos cambiar el color de la tipografía.
Creación de template_thumbnail.png
Lo último que nos quedaría para terminar nuestro template básico, es la creación template_thumbnail.png, la imagen que actuará a modo de previsualización del template en el back-end del sitio. No está establecido el tamaño estándar de la imagen, pero por lo general es de 200px de ancho y 150px de alto.
Apuntes finales
Si deseamos crear un instalador de nuestro template, recordemos de especificar en templateDetails.xml todos los archivos que se utilizaron. Esto es importante ya que si no lo hacemos, al momento de subir el instalador Joomla! nos entregará un mensaje de error.
Una forma fácil para descubrir las diferentes clases asociadas que genera el output de Joomla! es utilizando Firebug , una extensión para Firefox que permite inspeccionar el DOM de un sitio y visualizar como está conformado.
En la web podemos encontrar varios recursos para continuar con el aprendizaje de la creación de templates para Joomla!, el más importante se encuentra en la documentación oficial del proyecto: Template reference material
No nos olvidemos de Mootools! En su página oficial se puede encontrar documentación y ejemplos para añadir efectos a la plantilla.
Por seguridad, es conveniente crear un archivo index.html sin contenido y alojarlo en la carpeta de nuestro template y subcarpetas.
¿Te interesó este artículo?Puedes suscribirte al feed RSS ó dejar tu email para recibir las últimas noticias, tal como lo hacen actualmente las 2513 personas que siguen al blog