sábado, 26 de septiembre de 2009

Joomla tutorial para crear una template

Además necesariamente se debe tener:

Índice

  • Estructura básica de una plantilla para Joomla! 1.5.x
    • Carpetas
    • Archivos
  • Creación de la carpeta para nuestro template
  • Creación de templateDetails.xml
    • Datos
    • Archivos
    • Posiciones
    • Parámetros
  • Creación de index.php
  • Edición de template.css
    • Clases pertenecientes a contenido
    • Clases pertenecientes a módulos
    • Otras clases CSS importantes
  • Manejo de parámetros en la plantilla
  • Creación de template_thumbnail.png
  • Apuntes finales

Estructura básica de una plantilla para Joomla! 1.5.x


Básicamente un template puede estar formado por las siguientes carpetas y archivos:

Estructura de una plantilla en Joomla!


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


Nombre de la carpeta que alojará nuestros archivosLo 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
  1. version="1.0" encoding="utf-8"?>
  2. version="1.5" type="template">
  3. >Nombre del template>
  4. >Fecha de creación>
  5. >Nombre del autor>
  6. >Licencia>
  7. >E-mail del autor>
  8. >Web del autor>
  9. >Versión>>
  10. >

  11. >

  • 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
  1. >
  2. >index.php>
  3. >templateDetails.xml>
  4. >template_thumbnail.png>
  5. >favicon.ico>
  6. >css/template.css>
  7. >images/imagen.png>
  8. >

  • Posiciones: Es importante saber con anticipación que posiciones usaremos y cuantas en nuestro sitio para planificar en donde mostrarlos en la plantilla.

XML
  1. >
  2. >left>
  3. >right>
  4. >user3>
  5. >

  • 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:

Parámetros para el template rhuk_milkyway


XML
  1. >

name="color" type="list" default="blanco" label="Color de la tipografia" description="Color de la tipografia">
  • value="azul">Azul>
  • value="rojo">Rojo>
  • value="verde">Verde>
  • >
  • >
  • >
  • 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
    1. version="1.0" encoding="utf-8"?>
    2. version="1.5" type="template">
    3. >Nombre del template>
    4. >Fecha de creacion>
    5. >Nombre del autor>
    6. >Licencia>
    7. >E-mail del autor>
    8. >Web del autor>
    9. >Version>
    10. >

    11. >
    12. >
    13. >index.php>
    14. >templateDetails.xml>
    15. >template_thumbnail.png>
    16. >favicon.ico>
    17. >css/template.css>
    18. >images/imagen.png>
    19. >
    20. >
    21. >left>
    22. >right>
    23. >user3>
    24. >
    25. >

    name="color" type="list" default="azul" label="Color de la tipografia" description="Color de la tipografia">
  • value="azul">Azul>
  • value="rojo">Rojo>
  • value="verde">Verde>
  • >
  • >
  • >

  • 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:























  • Lo siguiente será ir incorporando las directivas que cargaran toda la información para que la plantilla funcione. Veamos las básicas:



    Con esto ya podemos crear la cabecera HTML de la plantilla:


    Por otro lado, para el cuerpo utilizaremos:


    Ejemplo:


    Queremos insertar en DIVs todos los módulos izquierdos en determinada parte del sitio, la directiva quedará conformada por:



    Ejemplo 2:


    Queremos cargar los módulos que se encuentran en la posición 'top' de manera horizontal:




    En caso de no especificar el estilo, por default el valor será 'table'.

    Aprendiendo esto ya estaremos resolviendo el 80% de index.php, quedando:




  • "izquierda">
  • include type="modules" name="left" style="xhtml" />




  • "contenido">
  • include type="component" />




  • "derecha">
  • include type="modules" name="right" style="xhtml" />




  • "footer">

  • include_once('includes/footer.php'); ?>








  • 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:


    Template sin editar estilos


    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:

    CSS
    1. * {
    2. padding: 0;
    3. margin: 0;
    4. }

    5. body {
    6. font-size: 62.5%;
    7. font-family: 'Lucida Grande', Verdana, Arial, Sans-Serif;
    8. color: #333;
    9. background-color:white;
    10. }

    11. #contenedor {
    12. margin: 0 auto;
    13. width: 922px;
    14. }

    15. #header {
    16. width: 900px;
    17. float: left;
    18. padding: 10px;
    19. margin: 10px 0px 5px 0px;
    20. }

    21. #navegacion {
    22. float: left;
    23. width: 900px;
    24. padding: 10px;
    25. margin: 0px 0px 5px 0px;
    26. }

    27. #izquierda {
    28. margin: 0px 5px 5px 0px;
    29. padding: 10px;
    30. width: 195px;
    31. float: left;
    32. }

    33. #contenido{
    34. float: left;
    35. margin: 0px 5px 5px 0px;
    36. padding: 10px;
    37. width: 456px;
    38. display: inline;
    39. }

    40. #derecha {
    41. color: #333;
    42. margin: 0px 0px 5px 0px;
    43. padding: 10px;
    44. width: 195px;
    45. float: left;
    46. }

    47. #footer {
    48. width: 900px;
    49. clear: both;
    50. margin: 0px 0px 10px 0px;
    51. padding: 10px;
    52. }

    Template sin estilos

    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:

    Clases dentro de 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 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ú:

    Clases en modulo de tipo menu

    • 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:
    Parámetros de un modulo
    • 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:

    CSS
    1. * {
    2. padding: 0;
    3. margin: 0;
    4. }

    5. body {
    6. font-size: 62.5%;
    7. font-family: 'Lucida Grande', Verdana, Arial, Sans-Serif;
    8. color: #333;
    9. }

    10. #contenedor {
    11. margin: 0 auto;
    12. width: 922px;
    13. }

    14. #header {
    15. width: 900px;
    16. float: left;
    17. padding: 10px;
    18. margin: 10px 0px 5px 0px;
    19. }

    20. #navegacion {
    21. float: left;
    22. width: 900px;
    23. padding: 10px;
    24. margin: 0px 0px 5px 0px;
    25. }

    26. #izquierda {
    27. margin: 0px 5px 5px 0px;
    28. padding: 10px;
    29. width: 195px;
    30. float: left;
    31. }

    32. #contenido {
    33. float: left;
    34. margin: 0px 5px 5px 0px;
    35. padding: 10px;
    36. width: 456px;
    37. display: inline;
    38. }

    39. #derecha {
    40. color: #333;
    41. margin: 0px 0px 5px 0px;
    42. padding: 10px;
    43. width: 195px;
    44. float: left;
    45. }

    46. #footer {
    47. width: 900px;
    48. clear: both;
    49. margin: 0px 0px 10px 0px;
    50. padding: 10px;
    51. }

    52. /* Color
    53. --------------------------------------------------------- */

    54. a{
    55. text-decoration:none;
    56. color:#3B6EA5;
    57. }

    58. #header a {
    59. font-size:1.8em;
    60. margin-left:230px;
    61. color:#3B6EA5;
    62. }

    63. /* Elementos
    64. --------------------------------------------------------- */

    65. a:hover {
    66. color: #147;
    67. text-decoration: underline;
    68. }

    69. a img{
    70. border:0px;
    71. }

    72. h1, h2, h3 {
    73. font-family: 'Trebuchet MS', 'Lucida Grande', Verdana, Arial, Sans-Serif;
    74. font-weight: bold;
    75. }

    76. h1 {
    77. font-size: 2em;
    78. }

    79. h2 {
    80. font-size: 1.6em;
    81. }

    82. h3 {
    83. font-size: 1.3em;
    84. }

    85. h1, h1 a, h1 a:hover, h1 a:visited, .description {
    86. text-decoration: none;
    87. }

    88. h2, h2 a, h2 a:visited, h3, h3 a, h3 a:visited {
    89. color: #333;
    90. }

    91. h2, h2 a, h2 a:hover, h2 a:visited, h3, h3 a, h3 a:hover, h3 a:visited{
    92. text-decoration: none;
    93. }

    94. /* Modulos
    95. --------------------------------------------------------- */

    96. #izquierda .moduletable_menu{
    97. text-align:right;
    98. margin-bottom:15px;
    99. }

    100. #derecha .moduletable_menu, #derecha .moduletable{
    101. text-align:left;
    102. margin-bottom:15px;
    103. }

    104. #izquierda .moduletable_menu li{
    105. margin:3px 0 0;
    106. padding:0;
    107. list-style-image:none;
    108. list-style-type:none;
    109. }

    110. #izquierda .moduletable_menu li:before{
    111. content: "\00BB \0020";
    112. }

    113. .moduletable_menu h3, .moduletable h3, .moduletable_text h3{
    114. margin:5px 0 0;
    115. padding:0;
    116. text-transform:uppercase;
    117. }

    118. /* Contenido
    119. --------------------------------------------------------- */

    120. .contentheading {
    121. font-size:1.4em;
    122. margin:0;
    123. color:#333333;
    124. font-weight:bold;
    125. }

    126. .contentheading:hover {
    127. color:#3B6EA5;
    128. }

    129. .componentheading{
    130. font-size:1.4em;
    131. margin:0;
    132. color:#777777;
    133. font-weight:bold;
    134. padding-left:10px;
    135. }

    136. .contentpaneopen{
    137. line-height:1.4em;
    138. font-size:1.2em;
    139. text-align:left;
    140. padding: 0px 10px 0px 10px;
    141. }

    142. .contentpaneopen img{
    143. padding: 5px 10px;
    144. }

    145. .readon{
    146. font-size:0.8em;
    147. text-align:left;
    148. }

    149. .contenttoc, .pagenavcounter{
    150. margin-bottom:10px;
    151. }

    152. .article_separator{
    153. display:block;
    154. background:#474747;
    155. height:1px;
    156. margin:10px 60px 10px 10px;
    157. }

    158. small , .createdate, .modifydate{
    159. font-family:Arial,Helvetica,Sans-Serif;
    160. font-size:0.9em;
    161. line-height:1.5em;
    162. color:#777777;
    163. padding-bottom:10px;
    164. }

    165. .banneritem_text, .bannerfooter_text{
    166. padding:5px;
    167. }

    168. /* Menu superior
    169. --------------------------------------------------------- */

    170. #navegacion #mainlevel-nav{
    171. list-style:none;
    172. position>:relative;
    173. padding:0px;
    174. float:left;
    175. padding-left:100px;
    176. }

    177. #navegacion #mainlevel-nav li {
    178. float:left;
    179. height:20px;
    180. }

    181. #navegacion #mainlevel-nav li a {
    182. float:left;
    183. text-decoration:none;
    184. margin:0px;
    185. padding-right:10px;
    186. }

    187. #navegacion #mainlevel-nav li a:hover {
    188. text-decoration:underline;
    189. }

    190. #navegacion #mainlevel-nav li a:before{
    191. content: "\00BB \0020";
    192. }

    Template con diseño

    El diseño está basado en White as Milk, template para Wordpress, creado por Azeem Azeez

    Manejo de parámetros en la plantilla:

    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
    1. color=azul

    En caso de tener más parámetros, estos deben ir uno por línea con su correspondiente valor:

    params.ini
    1. nombre_del_parametro_1=valor
    2. nombre_del_parametro_2=valor
    3. 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 agregamos:

    PHP
    1. "params->get('color'); ?>">

    De esta forma, dependiendo del valor que tenga el parámetro podremos tener:

    Si seleccionamos como valor azul:

    HTML
    1. id="azul">

    Si seleccionamos como valor verde:

    HTML
    1. id="verde">

    Si seleccionamos como valor rojo:

    HTML
    1. id="rojo">


    Nos quedaría modificar el CSS del template para que dependiendo del identificador, se cambien los colores. En el apartado Color podemos poner:

    CSS
    1. /* Color
    2. --------------------------------------------------------- */

    3. #header a {
    4. font-size:1.8em;
    5. margin-left:230px;
    6. }

    7. a{
    8. text-decoration:none;
    9. }

    10. #azul a{
    11. color:#3B6EA5;
    12. }

    13. #azul #header a {
    14. color:#3B6EA5;
    15. }

    16. #verde a{
    17. color:#59AC03;
    18. }

    19. #verde #header a {
    20. color:#59AC03;
    21. }

    22. #rojo a{
    23. color:#FF3131;
    24. }

    25. #rojo #header a {
    26. color:#FF3131;
    27. }

    Entrando a la configuración del template podremos cambiar el color de la tipografía.

    Colores en el template

    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.

    Descargar los archivos fuentes y la versión en PDF del manual desde Comunidad Joomla!

    FUENTE

    No hay comentarios:

    Publicar un comentario