Manual Tecnico Web

manual_tecnico_web

User Manual:

Open the PDF directly: View PDF PDF.
Page Count: 5

Manual técnico – Proyecto WEB del centro V.20061122 Página 1 de 5
Informe técnico
Mantenimiento de la web del centro
Este documento contiene información de tipo técnico sobre cómo se instala,
configura y programa la web del centro.
1. Identificación
La web a la que nos referimos tiene la dirección http://www.iescesarmanrique.es.
Se contrató el alojamiento y la reserva del nombre con la empresa Abansys, en la fecha de marzo 2006. Los
datos registrados en el contrato de la persona de contacto son los del director (Maximino).
Tenemos contratados una capacidad de 300 GB.
2. Recursos
Se ha intentado usar herramientas estándar y flexibles a la hora de construir la web, dentro de las
posibilidades ofrecidas por el proveedor web.
La versión actual del sitio web utiliza: html estático, PHP (versión 4) y base de datos PostgreSQL /
MySQL. Estamos usando una base de datos MySQL (Nombre de la base de datos mysqlMoodle, nombre del
usuario usrMoodle).
3. Diseño
La web se ha construido teniendo en cuenta los siguientes criterios / valores:
Desde el punto de vista del usuario
Usabilidad : Este es el criterio que más se ha trabajado en la interfaz y diseño de la web. Las páginas deben
ser muy claras, fáciles de ententer y el usuario debe ser capaz de navegar con comodidad y llegar con
facilidad a los contenidos buscados.
Accesibilidad : La web está diseñada para facilitar la accesibilidad a las personas con discapacidad.
Actualmente el sitio web supera el nivel 1 de accesibilidad TAW.
Coherencia : Todas las páginas del sitio web deben mostrar el mismo estilo.
Manual técnico – Proyecto WEB del centro V.20061122 Página 2 de 5
Navegación : En todo momento se muestra un índice de navegación que informa al usuario del sitio en el que
se encuentra en cada momento.
Secciones : Para facilitar el acceso a los contenidos se han creado seis secciones principales. Estas son:
Alumn@s, Padres, Secretaría, Dirección, Centro y Profesorado.
Desde el punto de vista del diseñador
Plantillas : Para facilitar el cambio rápido del diseño de las páginas de la web, éstas hacen uso de plantillas.
Las plantillas son páginas web que presentan todo el diseño estético que queremos dar a nuestras páginas.
Estás elaboradas principalmente con html, css y php. Se encuentran ubicadas en el directorio rec/pln/.
Ejemplos de plantillas : Existen varias plantillas dentro del proyecto que son:
rec/pln/plantilla_tipo1.php
rec/pln/plantilla_tipo2.php
rec/pln/plantilla_tipo3.php
rec/pln/plantilla_tipo4.php
rec/pln/plantilla_tipo5.php
Se pueden crear nuevas plantillas pero deben estar todas en este directorio.
Para definir nuevo aspecto a una página Es como especificar una nueva plantilla para dicha página. No
tenemos nada más que guardar el fichero plantilla php en este directorio de plantillas. Si queremos que una
página de contenidos cambie su aspecto. Esto es, que cambie de plantillas sólo debemos modificar el registro
de dicha página en el fichero mapping.php. Este fichero contiene un registro de todas las páginas de la
web, indeicando entre otras cosas el fichero de plantilla que se va a usar con dicha página.
Desde el punto de vista del programador/administrador
Tecnologías empleadas : El sitio web está construido usando html, css, php y bases de datos.
Diseño : Se ha diseñado como una aplicación PHP con funciones similares a las de un sistema de gestión de
contenidos, pero a pequeña escala.
CMS : Se podría haber usado un CMS (Sistema de Gestión de Contenidos) estándar para la implementación
del sitio web y tampoco se descarta la posibilidad de realizar una migración de este tipo en próximas
versiones del sitio web.
En estudio : De momento estamos analizando distintos CMS's y valorando la flexibilidad que ofrecen a la
hora de establecer diseños personalizados y facilidades de navegación dentro de la web. Entre los CMS's más
conocidos tenemos: Joomla!, Drupal, Xoops, MediaWiki, PHP-Nuke, Typo3, SPIP y CivicSpace. Todos
ellos permiten un servidor web Apache, lenguaje PHP/MySQL, y tienen licencia GPL.
4. Estructura física y lógica
4.1 Principal
El contenido del proyecto se estructura en tres directorios principales (cnt, html y rec). Se explican a
Manual técnico – Proyecto WEB del centro V.20061122 Página 3 de 5
continuación:
/cesarmanrique/ cnt/ Directorio donde se almacenan los contenidos de la web.
dwn/ Directorio donde se guardan los archivos que se pueden descargar
directamente desde este sitio, tales como: pdf, jpg, mpeg, mp3, doc, odf, etc.
rec/ Directorio donde se guardan todos los recursos estáticos y de diseño del
proyecto, tales como: hojas de estilo css, plantillas html/php, secciones html,
funciones php, imágenes del diseño, etc.
index.php Ésta es la página index, la cual se inicia al entrar al sitio web. Dentro de esta
página lo que se hace es llamar a cargador.php?pagina=index.
cargador.php Realmente la página cargador.php es la que hace todo el trabajo de
localizar las páginas solicitadas por el usuario, las procesa y las envía al
navegador del usuario.
El fichero index.php, es el primer archivo solicitado cuando se accede al sitio web
http://www.iescesarmanrique.org. Como podemos apreciar, aquí lo único que se hace es llamar a
cargador.php.
<? include ("cargador.php"); ?>
Éste es el fichero cargador.php. Éste hace uso de las funciones php definidas en el fichero
rec/php/funciones.php. Además requiere que se la pase por paŕametros la variable pagina con el
código del fichero de contenidos que se desea mostrar. Si este código no se pasa, entonces asumimos
pagina=index. Esto quiere decir que mostraremos la página de contenidos con el código index, que según
nuestro fichero rec/php/mapping.php corresponde con la página principal del proyecto web.
<?
//--------------------------------------------------
//Definiciones de funciones
include('rec/php/funciones.php');
//---------------------------------------------------
//Si no tenemos la variable página nos la inventamos
//por defecto usaremos la principal estos es pagina=index
if (isset($_GET["pagina"])) $pagina = $_GET["pagina"];
else $pagina = "index";
//---------------------------------------------------
//Definiciones de mapeo de todas las páginas
//Cada página de la web tiene un registro dentro de mapping
include('rec/php/mapping.php');
//Si el mapeo falla, entonces no existe el código
//y redirimos a pagina=error
if (!isset($mapping[$pagina])) $pagina = "error";
//----------------------------------------------------
//Preparamos las variables para confeccionar la página
$contenido = "cnt/" . $mapping[$pagina][0];
$template = "rec/pln/" . $mapping[$pagina][1];
$descripcion = $mapping[$pagina][2];
Manual técnico – Proyecto WEB del centro V.20061122 Página 4 de 5
$nombre = $descripcion;
$navegacion = $mapping[$pagina][3];
//-----------------------------------
//Confeccionamos la página solicitada
include($template);
?>
Los directorios principales del proyecto (cnt, dwn y rec) se explican en los siguiente apartados.
4.2 Contenidos
El directorio cnt/ guarda los ficheros de contenidos. Los contenidos son realmente la información de
interés que se muestra al usuario, y está clasificada en secciones. Las secciones son: Padres, Alumnos,
Secretaría, Dirección, Centro y Profesorado, tal y como aparece en la web.
/cesarmanrique/cnt/ alumnos/ Directorio que contiene los ficheros de contenidos de la sección
de alumn@s.
centro/ Directorio que contiene los ficheros de contenidos de la sección
de información del centro.
direccion/ Directorio que contiene los ficheros de contenidos de la sección
de dirección.
noticias/ Ficheros de contenidos de la sección de noticias.
padres/ Directorio que contiene los ficheros de contenidos de la sección
de padres.
piedepagina/ Ficheros de contenidos de la sección de pie de página.
profesorado/ Directorio que contiene los ficheros de contenidos de la sección
del profesorado.
secretaria/ Directorio que contiene los ficheros de contenidos de la sección
de secretaría.
index.cnt Fichero de contenidos de la página principal del sitio web
(pagina=index).
A su vez dentro de cada sección podemos crear subdirectorios para organizar los ficheros de contenidos.
La definición de secciones y subdirectorios dentro de cada sección es arbitraria, de modo que la decisión
depende del constructor del sitio web y de las necesidades de éste.
Los ficheros de contenidos son ficheros de texto plano, con extensión cnt, y en su versión más sencilla
pueden ser ficheros de texto normal. Ejemplos:
Ejemplo fichero cnt/centro/index.cnt en modo texto plano:
CENTRO
---------------------------------------
Manual técnico – Proyecto WEB del centro V.20061122 Página 5 de 5
Información general
*Contacto: ¿Cómo contactar con nosotros?
*Consultar la Oferta de estudios.
O también podemos introducir etiquetas de html dentro del fichero de contenidos para establecer un
diseño concreto. Ejemplo fichero cnt/centro/index.cnt con texto plano y etiquetas html:
<!--PLANTILLA.BEGIN-->
<h2><? echo $nombre; ?></h2>
<hr>
<h3>Informaci&oacute;n general</h3>
<ul>
<li>Contacto: &iquest;C&oacute;mo contactar con nosotros?</li>
<li>Consultar la Oferta de estudios</li>
</ul>
Incluso podemos también introducir funciones php predefinidas dentro del fichero de contenidos para
crear enlaces. Ejemplo fichero cnt/centro/index.cnt con texto plano, etiquetas html y llamadas a funciones php
establecidas:
<!--PLANTILLA.BEGIN-->
<h2><? echo $nombre; ?></h2>
<hr>
<h3>Informaci&oacute;n general</h3>
<ul>
<li><a href="<? getPagina("piedepagina.contacto"); ?>"> Contacto </a>:
&iquest;C&oacute;mo contactar con nosotros?</li>
<li>Consultar la <a href="<? getPagina('secretaria.oferta.index'); ?>">
Oferta de estudios </a> (Secretar&iacute;a)</li>
</ul>
En este ejemplo la función PHP getPagina(pagina), recibe por paŕametros el código de la página
de contenidos que se quiere vincular y la función devuelve el url asociado a dicha página de contenidos.
La función getPagina(), como todas las funciones del proyecto, se encuentra definida en
rec/php/funciones.php. Este fichero se explicará más adelante.
Todos los ficheros de contenidos tienen una clave o código identificativo, y están registrados en en
fichero rec/php/mapping.php que se verá más adelante. Cada vez que creemos un nuevo fichero de
contenidos debemos registrarlo en este fichero rec/php/mapping.php para activarlo. Los contenidos
accesibles son los que estén activos.

Navigation menu