Viewing file:  anexo1.htm (31.11 KB) -rw-rw-rw-
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
Documento sin título
Anexo
Librería de Objetos Portel
Los objetos de la librería de Portel están divididos en dos grandes
grupos, los objetos formato y los objetos de contenido.
Los primeros no serán detallados, puesto que el texto de la guía
se ilustra su comportamiento, mientras que los segundos serán explicados
en mayor detalle, de acuerdo al grado de complejidad de cada uno de ellos.
Vale la pena recordar que este anexo solo documenta los objetos que se distribuyen
en Portel por defecto en una fecha específica, los objetos o librerías
de estos que sean adicionales, se entregarán documentados de la misma
forma en que se ha hecho con éstos.
Los Objetos de Contenido
Entre los objetos de contenido hay también una clasificación
que tiene que ver con cual es el escenario en el que se aplican, pues éstos
van desde lo general hasta lo más particular.
Las diferencias entre ellos se quedan en el plano de la organización
de esta guía, pues siempre es probable y además muy necesario
mezclar varios tipos de objetos de contenido en una misma plantilla.
Objetos Generales
Buscador
Archivo: buscador.php
Función: Es una interfaz completa que permite generar una página
de resultados del motor de búsqueda en un sitio Web.
Aplicación: Se usa específicamente en plantillas de despliegue
de resultados. No se usa tanto para poner casillas de búsqueda, como
si para desplegar dentro de un formato personal los resultados de una consulta.
Descripción: El objeto presenta una página completa de resultados,
que se enlazan a la plantilla de detalle de información o frame_detalle.php.
Además despliega nuevamente la casilla de búsqueda para cambiar
el criterio, totaliza los resultados y pagina los resultados por grupos.
Requisitos de la plantilla que lo contenga: La plantilla se debe llamar frame_buscar.php
Cómo se usa: Si usted está construyendo una página para
mostrar resultados de una búsqueda en su sitio, agregue en el lugar
en donde quiere que se desplieguen dichos resultados la siguiente sentencia:
Inicio PHP--> include("buscador.php"); <-- PHP Fin
Parámetros: NO
Buscar
Archivo: buscar.php
Función: Es una interfaz sencilla que trae el formato necesario para
incluir una opción de búsqueda desde cualquier página.
Aplicación: Habilitar la forma de búsqueda de texto.
Descripción: El objeto presenta un simple formato con una casilla y
un botón.
Requisitos de la plantilla que lo contenga: Ninguno.
Cómo se usa: En el lugar en el que usted desea que se despliegue una
forma de búsqueda ingrese la siguiente sentencia Inicio PHP--> include("buscador.php");
<-- PHP Fin
Parámetros: NO
Mapa del Sitio
Archivo: menumapa.php
Función: Es una interfaz completa que permite generar un mapa del sitio
automáticamente dentro de cualquier página.
Aplicación: Se usa específicamente para que una plantilla sirva
como directorio o mapa del sitio.
Descripción: El objeto presenta un listado organizado y enlazado de
todas las secciones presentes en su sitio Web.
Requisitos de la plantilla que lo contenga: Ninguno.
Cómo se usa: Si usted está construyendo una página para
mostrar su mapa del sitio, agregue en el lugar en donde quiere que se despliegue
dicho esquema la siguiente sentencia: Inicio PHP--> include("menumapa.php"); <-- PHP Fin
Parámetros: NO
Objetos Especiales (Plantillas Especiales)
Detalle
Archivo: frame_detalle.php
Función: Es una interfaz completa que permite traer todos los detalles
de un contenido a partir de su número de identificación única.
Aplicación: Mas que un objeto es una plantilla preconfigurada para
desplegar con la ayuda de otros múltiples objetos una información
o contenido en detalle. La idea no es incluir esta plantilla dentro de otra
como el resto de los objetos, sino por el contrario editarla para personalizarla
al diseño del sitio. Es una plantilla casi obligatoria y por eso se
incluye por defecto en el paquete de distribución de Portel.
Descripción: El contenido desplegado aparece completo, junto con todas
aquellas relaciones que tenga con otros contenidos, formatos o materiales
complementarios. La versión general incluye el despliegue del contenido,
la inclusión de imágenes, documentos y enlaces y la presentación
de formas atadas al contenido como encuestas o foros.
Requisitos de la plantilla que lo contenga: No aplica.
Cómo se usa: Simplemente por ser una plantilla, edítela y personalícela
de acuerdo con sus necesidades de interfase. Recuerde no debe borrar las sentencias
PHP que ésta incluye, pues de otra forma, éstas quedarán
inutilizadas.
Parámetros: NO
Objetos para aplicar a categorías
Se dice que son objetos para aplicar a categorías pues están
enfocados a mostrar contenidos relacionados con las mismas. A través
de un ejemplo vamos a ilustrar como funciona esto, suponga que usted está
trabajando una sección que se llama noticias de mi entidad, en la misma
usted publicará varias notas y a su vez ésta tendrá otras
secciones internas. Es evidente que la primera página de esta sección
no podrá mostrar todo el contenido que usted esta considerando para su
sección, así que la primera página se convertirá
en una especie de muestra de todo lo que ella contiene, tal y como sucede con
la portada de un periódico .
De esta forma, los objetos que usted incluirá en la plantilla deberían
ir de acuerdo con ello. En ese orden de ideas, no se esperaría que usted
pusiera en esta primera página un objeto que representara noticias completas,
sino por el contrario usted buscaría un objeto que le presentara la noticia
de forma breve y más bien si, un enlace para verla en detalle en otra
página. Este es el tipo de tales objetos, su función, presentación
y configuración están orientados a activar páginas que
muestren muchos contenidos pero breves y no pocos pero detallados.
El principal parámetro que usan es el famoso “patron”, pues
es este el que les dice qué sección están presentando.
Banners Promocionales
Archivo: promo.php
Función: Mostrar un grupo de banners enlazados a sus respectivos links.
Aplicación: Se usa para poner banners publicitarios que hayan sido
cargados como contenido promocional en el editor.
Descripción: Se presentan las imágenes seguidas o separadas
por cualquier operador.
Requisitos de la plantilla que lo contenga: No aplica.
Cómo se usa: En el lugar en el que desea ubicar uno o varios banners
promocionales incluya la sentencia: Inicio PHP--> $patron = "00."; $var_2
= 0; $var_1 = 1; include("promo.php"); <-- PHP Fin
Parámetros: SI
Patron: Si usted define un patrón antes de llamar el objeto, éste
recuperará los banners de la categoría referida en el “patron”.
Var_1: Se usa para determinar si los banners se muestran horizontal (0) o
verticalmente(1).
Var_2: Se usa para determinar a partir de cual banner se muestra en la pantalla.
Puede ser cualquier número entero. Una aplicación de ello es
por ejemplo traer a partir del segundo banner el material relacionado y no
necesariamente desde el primero.
Calendario
Archivo: calendar.php
Función: Mostrar un calendario enlazado con la categoría que
lo incluye, para hacer revisión de contenido por fechas.
Aplicación: Se usa en secciones de noticias o de información
temporal, para que los navegantes puedan ver versiones anteriores.
Descripción: Es un calendario en el día con vínculos
hacia cualquier fecha.
Requisitos de la plantilla que lo contenga: No aplica.
Cómo se usa: En el lugar en el que desea ubicar un calendario incluya
la sentencia: Inicio PHP--> include("calendar.php"); <-- PHP Fin
Parámetros: NO
Documentos por tema
Archivo: documentos.php
Función: Crea un listado de enlaces de documentos por tipos de acuerdo
con el tema.
Aplicación: Se usa para desplegar vínculos de los documentos
anexos que se relacionan con las categorías, filtrado por tipos y con
dos parámetros de presentación.
Descripción: Su presentación es la de un directorio de enlaces
que se refieren a la descarga de documentos.
Requisitos de la plantilla que lo contenga: No aplica.
Cómo se usa: En el lugar en el que desea ubicar un índice de
documentos incluya la sentencia: Inicio PHP--> $color="#333333"; $bold_i="";
$bold_e=""; $clase="new"; include("documentos.php"); <-- PHP Fin
Parámetros: SI
Color: Use esta variable para pasar al objeto el color del texto que desea
obtener. Para ello use el número que describe el color en HTML. Si
no conoce el número, intente en un editor de página Web seleccionar
dicho color de la paleta y éste le informará el número
que está compuesto del signo número y 6 caracteres más.
Para usar el parámetro, simplemente reemplace en la sentencia el color
#333333 por el que usted eligió.
Bold_i y bold_e: Estas variables permiten poner algún tipo de realce
al texto del menú de documentos. Si en la sentencia se dejan vacías,
es decir como vienen por defecto, el texto se presenta normal, por otro lado
si requiere aplicar por ejemplo negrilla use los siguientes valores $bold_i
= “<b>” y $bold_e=”</b>”.
Clase: Use este parámetro para ubicar el número del tipo de
documento que quiere publicar. En Portel, el editor de clases de documentos
le permite agregar muchos tipos de documentos. Una vez ingresado en dicho
editor, en la lista de selección salen los nombres de los tipos antecedidos
por un número que es el identificador del tipo. Así si usted
quiere que este objeto solo liste documentos de una clase, agregue en este
parámetro el número respectivo. Por último si usted quiere
usar el valor “new”, el traerá los documentos más
recientes que se han enlazado con esta categoría.
Enlaces 1
Archivo: links_1.php
Función: Crear un listado paginado de enlaces relacionados con una
categoría.
Aplicación: Se usa para desplegar vínculos que se relacionen
con una categoría y así poner a disposición del usuario
final más recursos de información complementarios al tema que
se está tocando.
Descripción: Su presentación es más la de un directorio
de grupos de 5 enlaces seguidos de su respectiva descripción.
Requisitos de la plantilla que lo contenga: No aplica.
Cómo se usa: En el lugar en el que desea ubicar un índice de
enlaces incluya la sentencia: Inicio PHP--> include("links_1.php"); <-- PHP Fin
Parámetros: NO
Imágenes en Galería
Archivo: slideshow_3rz.php
Función: Presenta en una tabla las posibles imágenes asociadas
a una sección a manera de galería, es decir que cada foto se
muestra pequeña como un contacto, que posteriormente se puede ampliar.
Aplicación: Se usa principalmente para mostrar pequeñas galerías
de imágenes asociadas a las secciones.
Descripción: En un visor que usted puede editar modificando el archivo
y muestra en una tabla las imágenes pequeñas (resampleadas)
y con un enlace para verlas en su tamaño original.
Requisitos de la plantilla que lo contenga: Mínimo 200 píxeles
de ancho y alto de espacio disponible.
Cómo se usa: En el lugar en el que desea ubicar un visor de imágenes
incluya la sentencia: Inicio PHP--> $var_s_4 = 100; $var_s_3 = 6; $var_s_2 = “”;
$var_s_1 = 3; include("slideshow_3rz.php"); <-- PHP Fin
Parámetros: SI
Var_s_4: Es un número y representa el tamaño máximo que
tenga el lado mayor de las imágenes pequeñas que se muestran
en la galería. Para el ejemplo de la sentencia, se dice que son 100,
que representan 100 píxeles de ancho o alto de la imagen, según
cual de los dos lados sea mayor.
Var_s_1: Es el número que indica cuantas columnas tendrá la
tabla con las imágenes.
Var_s_3: Es el número imágenes que saldrán por cada vista
de la galería.
Var_s_2: Es el nombre de la plantilla en la que se quiere que se muestre la
galería, generalmente es la misma que la incluye, es decir el nombre
de su propia plantilla.
Imágenes en Visor
Archivo: slideshow.php
Función: Presenta de una en una, las imágenes que tenga asociadas
a la categoría desplegada.
Aplicación: Se usa principalmente para mostrar imágenes de apoyo
a una sección.
Descripción: En un visor que usted puede editar modificando el archivo,
muestra una por una las imágenes en un tamaño máximo
de 300 píxeles en su medida mayor, seguidas de su pie de página,
fuente y enlace para ver al tamaño natural.
Requisitos de la plantilla que lo contenga: Mínimo 300 píxeles
de ancho y alto de espacio disponible.
Cómo se usa: En el lugar en el que desea ubicar un visor de imágenes
incluya la sentencia: Inicio PHP--> include("slideshow.php"); <-- PHP Fin
Parámetros: NO.
Índice Plano
Archivo: indice.php
Función: Muestra en una línea de enlaces separados por un tabulador,
los enlaces de las secciones que se subordinan a la actual. Es una forma de
navegación interna.
Aplicación: Su uso va ligado a servir como menú de navegación
al interior de secciones.
Descripción: El contenido desplegado aparece como una secuencia de
enlaces titulados con los nombres de las categorías y enlazados a las
mismas.
Requisitos de la plantilla que lo contenga: No aplica.
Cómo se usa: En el lugar en el que desea ubicar un índice incluya
la sentencia: Inicio PHP--> include("indice.php"); <-- PHP Fin
Parámetros: NO
Índice Vertical
Archivo: indice_interno.php
Función: Muestra en una lista de enlaces separados por un tabulador,
los enlaces de las secciones que se subordinan a la actual. Es una forma de
navegación interna.
Aplicación: Su uso va ligado a servir como menú de navegación
al interior de secciones.
Descripción: El contenido desplegado aparece como una lista de enlaces
titulados con los nombres de las categorías y enlazados a las mismas.
Requisitos de la plantilla que lo contenga: No aplica.
Cómo se usa: En el lugar en el que desea ubicar un índice incluya
la sentencia: Inicio PHP--> include("indice_interno.php"); <-- PHP Fin
Parámetros: NO
Lista de Noticias
Archivo: noticia_list.php
Función: Muestra en una lista los enlaces para ver el detalle de las
noticias pertenecientes a una categoría.
Aplicación: Se usa en secciones con mucha rotación para poder
acceder a noticias anteriores o para hacer un picadillo de las m,ismas.
Descripción: El contenido desplegado aparece como una lista de enlaces
titulados con los nombres de las noticias y enlazados a las mismas.
Requisitos de la plantilla que lo contenga: No aplica.
Cómo se usa: En el lugar en el que desea ubicar un listado de noticias
incluya la sentencia: Inicio PHP--> include("noticia_list.php"); <-- PHP Fin
Parámetros: SI
Var_1: Se usa para determinar a partir de qué noticia despliega los
resultados. Si tiene un 0, el objeto traerá desde la última
noticia disponible hasta la primera en grupos, pero si es 3, quiere decir
que mostrará a partir de la 4 los resultados en la página.
Var_2: Se usa para determinar cuantas noticias máximas salen en el
objeto.
Menú Interno
Archivo: menuinterno.php
Función: Es el principal objeto de la navegación dentro de las
secciones, su función primordial es la de brindar al usuario un menú
a manera de árbol, en donde éste pueda ubicar la sección
que quiere y a la vez pueda acceder a ella a través de un enlace.
Aplicación: Su uso es muy común en secciones con más
subcategorías.
Descripción: El menú a manera de árbol funciona desplegando
por nodos los ítems y subítems que componen la estructura de
navegación.
Requisitos de la plantilla que lo contenga: No aplica.
Cómo se usa: En el lugar en el que desea ubicar un menú interno
incluya la sentencia: Inicio PHP--> include("menuinterno.php"); <-- PHP Fin
Parámetros: NO
Noticia Completa
Archivo: noticia_3.php
Función: Es la forma de presentar todo lo que tiene una noticia.
Aplicación: Se usa principalmente para ubicar noticias junto con todas
sus adiciones posibles, es de mucha utilidad para secciones informativas generales
de alta rotación.
Descripción: Se despliega el título, la descripción del
texto, el texto, los complementos (documentos y enlaces) y la imagen asociada
al contenido si la hay.
Requisitos de la plantilla que lo contenga: No aplica.
Cómo se usa: En el lugar en el que desea ubicar un contenido directo
incluya la sentencia: Inicio PHP--> $var_1 = “r”; $var_2 = 5; $var_3
= 0; $patron = "00.07"; include("noticia_3.php"); <-- PHP Fin
Parámetros: SI.
Patron: Usted puede siempre filtrar sobre que sección quiere traer
el titular, agregando el número de la categoría como un patrón.
Size_img: Es el tamaño en píxeles de la imagen que puede acompañar
el titular.
Var_1: Es la alineación del texto con respecto a la imagen, pueden
ser “r” derecha, “l” izquierda y “”, que
equivale a ninguna.
Var_2: Es el número de resultado a partir del cual empieza a contar
para buscar el contenido.
Var_3: Si simplemente esta asignada, la noticia desplegará el texto
general, los enlaces a los que refiere dicho contenido y los documentos que
estén relacionados con ella.
Noticia Plana o Ayuda
Archivo: noticia_1_1.php
Función: Es la forma de presentar todo el contenido de un texto agregado
como ayuda
Aplicación: Se usa principalmente para desplegar textos de apoyo o
ayuda que se le quieran anexar a las categorías.
Descripción: Se despliega el título y el texto completo propiamente
dicho, sin ningún otro adorno que aquel que incluya el texto mismo.
Requisitos de la plantilla que lo contenga: No aplica.
Cómo se usa: En el lugar en el que desea ubicar un contenido de ayuda
incluya la sentencia: Inicio PHP--> include("noticia_1_1.php"); <-- PHP Fin
Parámetros: NO
Noticia Limpia o Contenido Directo
Archivo: noticia_1.php
Función: Es la forma de presentar todo el contenido de un texto agregado
como historia sin adornos.
Aplicación: Se usa principalmente para desplegar textos que no cambian
mucho o contenido directo de una sección.
Descripción: Se despliega el título, la descripción del
texto y el texto completo propiamente dicho, sin ningún otro adorno
que aquel que incluya el texto mismo.
Requisitos de la plantilla que lo contenga: No aplica.
Cómo se usa: En el lugar en el que desea ubicar un contenido directo
incluya la sentencia: Inicio PHP--> include("noticia_1.php"); <-- PHP Fin
Parámetros: NO
Noticia Preliminar
Archivo: noticia_3_1.php
Función: Es la forma de presentar lo básico que tiene una noticia,
con el fin de inducir a que sea desplegada en detalle.
Aplicación: Se usa principalmente para ubicar en una página
con poco espacio un ítem capaz de mostrar las noticias a manera de
titulares.
Descripción: Se despliega el título, la descripción del
texto y la imagen asociada al contenido si la hay.
Requisitos de la plantilla que lo contenga: No aplica.
Cómo se usa: En el lugar en el que desea ubicar un contenido directo
incluya la sentencia: Inicio PHP--> $size_img = 120; $var_1 = "r"; $patron
= "00.07"; include("noticia_3_1.php"); <-- PHP Fin
Parámetros: SI.
Patron: Usted puede siempre filtrar sobre que sección quiere traer
el titular, agregando el número de la categoría como un patrón.
Size_img: Es el tamaño en píxeles de la imagen que puede acompañar
el titular.
Var_1: Es la alineación del texto con respecto a la imagen, pueden
ser “r” derecha, “l” izquierda y “”, que
equivale a ninguna.
Películas
Archivo: movieshow.php
Función: Despliega un visor auto ajustable para películas flash.
Aplicación: Se usa principalmente para mostrar directamente en pantalla
películas flash relacionadas con una categoría o un contenido.
Descripción: La película se ve en su tamaño original
dentro de un marco que se puede editar modificando el archivo movieshow.php.
Requisitos de la plantilla que lo contenga: No aplica.
Cómo se usa: En el lugar en el que desea ubicar una película
incluya la sentencia: Inicio PHP--> include("movieshow.php"); <-- PHP Fin
Parámetros: NO
Título
Archivo: ninguno
Función: Muestra en un texto cualquiera el nombre de la sección
o categoría que se consulta.
Aplicación: Se usa para desplegar el título de la página
cuando es necesario dentro de su presentación.
Descripción: El nombre de sección desplegado aparece como un
nombre sobre cualquier texto que usted desee.
Requisitos de la plantilla que lo contenga: No aplica.
Cómo se usa: En el lugar que desea ubicar el título, escriba
una palabra de muestra y asígnele propiedades de color, fuente y tamaño.
Una vez elaborado el texto de muestra, en la vista de código reemplace
el texto de prueba por la siguiente instrucción: Inicio PHP--> echo $titulo;
<-- PHP Fin
Parámetros: NO
Objetos para aplicar a contenido
Los objetos para aplicar a contenido son lo contrario de los anteriores, su
función está orientada a desplegar una única información
pero detallada y su uso esta orientado a crear páginas como su nombre
lo indica de contenido o detalle y no tanto páginas intermedias o de
menú. La plantilla especial frame_detalle.php que se suministra con Portel
está compuesta de muchos de éstos objetos y es un ejemplo acerca
de cómo se debe incluir los objetos dentro de un formato para que desplieguen
detalles.
A diferencia de los anteriores, los objetos para aplicar a contenido usan primordialmente
el parámetro de identificación de los contenidos conocido como
links_id.
Documentos Generales
Archivo: documentos_2.php
Función: Sirve para mostrar a manera de directorio, un listado de enlaces
hacia los documentos que han sido asociados con un contenido. Despliega todos
los documentos asociados a un contenido sin distinción de tipos.
Aplicación: Listados cortos de documentos para descargar que apoyen
un contenido.
Descripción: Se muestra como una lista breve de documentos, en donde
cada uno de los títulos es un enlace para descargar los respectivos
medios.
Requisitos de la plantilla que lo contenga: No aplica.
Cómo se usa: En el lugar en el que desea ubicar un índice de
documentos generales incluya la sentencia: Inicio PHP--> include("documentos_2.php");
<-- PHP Fin
Parámetros: NO.
Enlaces Generales
Archivo: links_2.php
Función: Se usa para desplegar un listado de enlaces relacionados a
un contenido.
Aplicación: Cuando se espera que los contenidos se enlacen entre sí,
se debe contar con este objeto que despliega los enlaces creados entre ellos.
Descripción: Se muestra como una lista breve de vínculos, en
donde el título se ofrece como enlace y la descripción lo acompaña
para inducir acerca de su contenido.
Requisitos de la plantilla que lo contenga: No aplica.
Cómo se usa: En el lugar en el que desea ubicar un índice de
enlaces entre contenidos incluya la sentencia: Inicio PHP--> include("links_2.php");
<-- PHP Fin
Parámetros: NO.
Imágenes en Visor
Archivo: slideshow_2.php
Función: Presenta una a una, las imágenes que posiblemente tenga
asociado el contenido desplegado.
Aplicación: Se usa principalmente para mostrar imágenes de apoyo
a un texto, sin que éstas se involucren dentro del texto.
Descripción: En un visor que usted puede editar modificando el archivo,
muestra una por una las imágenes en un tamaño máximo
de 300 píxeles en su medida mayor, seguidas de su posible pie de página,
fuente y enlace para ver al tamaño natural.
Requisitos de la plantilla que lo contenga: Mínimo 300 píxeles
de ancho y alto de espacio disponible.
Cómo se usa: En el lugar en el que desea ubicar un visor de imágenes
incluya la sentencia: Inicio PHP--> include("slideshow_2.php"); <-- PHP Fin
Parámetros: NO, pero si usted desea cambiar el tamaño máximo
de la imagen dentro del visor, en el archivo slideshow_2.php busque “<300>rz_size”
y reemplace el número 300 por el que usted desee y guarde.
Noticia Completa o Contenido Detallado
Archivo: noticia_2.php
Función: Es la forma de presentar todo el contenido de un texto agregado
como historia con todos sus componentes.
Aplicación: Se usa principalmente para desplegar el detalle de un texto,
incluyendo sus posibles complementos, tales como foros, encuestas y formas.
Descripción: Se despliega el título, la descripción del
texto y el texto completo. Además del contenido se despliega una forma
de foro, los posibles comentarios añadidos a éste, el formato
de una encuesta, sus resultados y una forma de ingreso de datos si aplican.
Requisitos de la plantilla que lo contenga: No aplica.
Cómo se usa: En el lugar en el que desea ubicar un contenido directo
incluya la sentencia: Inicio PHP--> include("noticia_2.php"); <-- PHP Fin
Parámetros: NO.
|