Manual Weblib.php

Este manual es una ayuda para que los desarrolladores del DFWikiTeam puedan utilizar el weblib.php. Este fichero complementa al weblib de moodle y actúa como capa de presentación. Contiene una serie de funciones para crear las diferentes etiquetas de HTML que utilizamos.

Puntos importantes para la utilización de weblib.php:

• CUMPLE XHTML STRICT

Todas las funciones tienen como parámetros únicamente aquellos atributos de los tags que se utilizan para el desarrollo de la nwiki y siguen el XHTML Strict. De este modo conseguimos que las etiquetas creadas con la utilización de este fichero cumplan el estándar.

La mayoría de atributos que no cumplan el estándar se pueden definir en el atributo class o style. Estos atributos están contenidos en todas las etiquetas. Su función es la de asignar al tag un formato o estilo, cumpliendo las normas de XHTML Strict. Este formato puede estar definido en una hoja de estilo (css), y por lo tanto utilizaríamos el atributo class para asignarle la clase ya definida, o mediante el style, en caso de que no este declarado.

Ejemplo:
wiki_change_column('', 'top', '', '', '', 'width:1%;white-space:nowrap');
sería
</td><td valign="top" style="width:1%;white-space:nowrap">

• PARÁMETRO RETURN

Todas las funciones tienen como último parámetro la variable $return, inicializada por defecto a false.

En caso de ser false, la función escribiría el tag directamente. Y si lo cambiásemos a true, la función retornaría una variable con la etiqueta.

• CREACIÓN DE TAGS

Todas las funciones siguen un mismo patrón para el orden de sus parámetros.

Si la etiqueta tiene información entre la apertura y cierre de ésta, la función tendrá un primer parámetro ($info), que contendrá dicha información. A excepción de las tablas y listas, que se explicarán más adenate.

Los parámetros estilo y clase siempre se ubican en la penúltima y antepenúlima posición. A excepción de la etiqueta
que no tiene formato.

Como hemos dicho anteriormente, la variable $return está ubicada como último parámetro.

El resto de parámetros dependerá de los diferentes atributos que puedan tener las etiquetas.

• Creación de tablas

Para la creación de tablas tenemos varias funciones:

wiki_table_start($border=0, $width='', $padding='', $spacing='', $class='', $style='',
$aligntd='', $valigntd='', $colspantd='', $rowspantd='', $classtd='', $styletd='', $return=false)
Inicia tabla, fila y columna, con las respectivas propiedades. Los seis primeros parámetros son atributos de la tabla y los seis siguientes de la primera columna.

wiki_table_end($return=false)
Cierra una columna, fila y tabla.

wiki_change_column($align='', $valign='', $colspan='', $rowspan='', $class='', $style='', $return=false)
Cierra columna e inicia una nueva con las propiedades correspondientes.

wiki_change_row($align='', $valign='', $colspan='', $rowspan='', $class='', $style='', $return=false)
Cierra columna y fila e inicia una nueva fila y una columna con las propiedades correspondientes.

Ejemplo:
wiki_table_start('0','100%','','','','','right');
echo '1';
wiki_change_row();
echo '2';
wiki_table_end();
sería
<table width="100%" border="0">
<tr><td align="right">
1
</td></tr><tr><td>
2
</td></tr>
</table>

• Creación de listas

Para crear las listas tenemos varias funciones que siguen la misma mecánica que las utilizadas para la creación de tablas.

wiki_start_ul($class='', $style='', $classli='', $styleli='', $return=false)
Inicia una lista no ordenada y el primer ítem

wiki_end_ul($return=false)
Cierra el último ítem y la lista no ordenada

wiki_change_li($class='', $style='', $return=false)
Cambio de ítem

Para las listas ordenadas las funciones son iguales.