X-Git-Url: https://git.llucax.com/z.facultad/75.43/tp1.git/blobdiff_plain/5f2bfe8167f321ab21a0b746786c9b93cdab2350..HEAD:/docs/informe/informe.html diff --git a/docs/informe/informe.html b/docs/informe/informe.html index 5b7ee3e..ac1d567 100644 --- a/docs/informe/informe.html +++ b/docs/informe/informe.html @@ -32,8 +32,8 @@ Sebastián Arena - COMPLETAR - COMPLETAR + 80367 + Actualización de información de interés de otros sitios y comentarios

Índice

@@ -135,19 +135,12 @@ Captura de pantalla de admin.admin.php -

Modulo de FAQs

+

Modulo de FAQs

faq.listarPreguntas.php

- Esta página lista las preguntas ingresadas en el sistema. Para cada - pregunta, se muestra la fecha de creación, el nombre de autor, con su - correspondiente foto, la pregunta en si, la posibilidad de accederá a - todas las respuestas para dicha pregunta, así como también la posibilidad - de responder la pregunta ( solo en caso que quien esta logueado en el sistema - no sea el mismo usuario que formulo la pregunta ). El listado de preguntas - aparece paginado cada 2 ( se muestran dos preguntas por pantalla ). Debajo de - las preguntas aparece el navegador. En caso que el usuario logueado sea un - administrador, en la parte inferior de cada pantalla aparece un link que permite - acceder a la página de baja de preguntas. + Esta pagina muestra la lista de preguntas ingresadas al sistema. Permite acceder + a las respuestas, y en caso de ser posible, darlas de alta. A los administradores, + tambien les permite acceder a la baja de preguntas.

faq.listarRespuestas.php

- El listador de respuestas muestra ordenadas por ranking las respuestas a una - pregunta seleccionada. Utiliza el paginador, al igual que el listador de preguntas, - y también lo hace de a dos respuestas por pantalla. Muestra la información del usuario - que genero la respuesta ( foto y nombre ), la respuesta y el ranking de la misma. Si la - respuesta todavía no fue evaluada por el autor de la pregunta, muestra un mensaje que - indica que no hay ranking para esa pregunta. Si el usuario que esta accediendo a la lista - de respuestas es el mismo que formulo la pregunta y todavía no calificó a la misma, aparece - un botón que lo redirecciona a la página de calificación de preguntas. + Para cada una de las preguntas, se pueden ver desde esta pantalla las respuestas dadas + de alta. Las muestra por ranking. En caso de que la respuesta no haya sido calificada + aun y quien esta logueado es el autor de la pregunta, permite acceder a la pantalla de + calificaciones.

faq.ingresarPregunta.php

- Desde el menú de la aplicación se puede acceder a esta página. En caso de que el - usuario logueado tenga los créditos para hacerlo, podrá formular una pregunta que - se publicara en la lista de preguntas ( faq.listarPreguntas.php ). Si el usuario no - contara con los créditos suficientes, un warning lo alertara y le sugerirá que - pida créditos al administrador del sistema. El usuario podrá ingresas desde esta pantalla - tantas preguntas como créditos tenga. + Permite dar de alta una pregunta en el sistema. Es necesario que el usuario sea un asesor, o + tenga los creditos suficientes.

faq.responderPregunta.php

- Desde el listado de preguntas se puede acceder a la pantalla que permite responder - la pregunta. La misma muestra en el encabezado la pregunta que se esta respondiendo. - Al lograr un ingreso satisfactorio de una respuesta, aparece un mensaje que avisa al - usuario que su respuesta fue dada de alta en el sistema. Esta respuesta quedara pendiente - de calificar por parte del autor de la pregunta que se esta respondiendo. Cualquier usuario - logueado en el sistema puede acceder a responder preguntas. Únicamente no podrá responder una - pregunta el autor de la misma + La pantalla permite ingresar la respuesta a una pregunta seleccionada. Esta respuesta deberá + ser calificada por el autor de la pregunta posteriormente, y le permitirá al que responde, obtener + créditos.

faq.calificarRespuesta.php

- La pantalla de calificación de respuesta solo puede ser accedida por el autor de - la pregunta que tiene dicho ítem como respuesta. En esta pantalla, desde un combo, se - puede elegir alguna de las cuatro categorías de calificación ( a cada una le corresponde un - puntaje ). Inmediatamente se le acreditara a quien pregunta tantos créditos como puntos valgan la - calificación de la respuesta. La respuesta solo podrá ser calificada una vez, luego de ser calificada, - desaparecerá el botón que permite acceder a la pantalla para ese ítem. + A esta pantalla solo accede el autor de la pregunta. Desde la misma puede calificar la respuesta. + Dependiendo de la calidad de la respuesta, quien la formulo podra obtener mas o menos créditos, para + de esta manera poder efectuar nuevas preguntas.

faq.desactivarPregunta.php

- Desde esta pantalla, los administradores pueden dar de baja una pregunta. De todas formas la pregunta - seguirá existiendo, con sus respuestas, pero no sera mostrada mas por el listador. Para acceder a la pantalla - de baja de preguntas, se debe hacer click sobre el link que aparece en la página listarPreguntas.php. Este link - solo aparece en caso que el usuario logueado tenga privilegios de administrador. + La pantalla de baja de preguntas solo puede ser accedida por un administrador. Permite que la pregunta + y sus respuestas no sean listadas mas, pero queden logueadas en un historico.

Captura de pantalla de faq.desactivarPregunta.php

Modulo de Info

-

- El siguiente menu es el que se le presenta al asesor o socio para - interactuar con el modulo de info. -

-
- Captura de pantalla de info.menu.asesor.jpg -
-

- El siguiente menu es el que se le presenta al administrador para - interactuar con el modulo de info. -

-
- Captura de pantalla de info.menu.administrador.jpg -

info.ingresarTemas.php

- Desde aquí el usuario puede ingresar nuevos temas. (Solo pueden acceder - los usuarios administradores) - Los campos a completar son: - Tema: Nombre del Tema. - Icono: Cada Tema tiene un ícono asociado. - Descripción: Cada Tema tiene un descripción asociada. - Una vez completados se procede a "Guardar Tema". - Se mostrará un mensaje indicando si la operación fue exitosa o no. - Se mantienen los datos en los campos, y se permite la modificación de lo recien insertado. - De retirarse de la página, o presionar sobre "Nuevo Tema" se pierde la posibilidad de modificar. + Permite al usuario el ingreso/modificación de nuevos Temas.

info.listarTemas.php

- Desde aquí el usuario puede ver la lista de temas disponibles para ingresar informaciones. - La página se muestra paginada de a 5 temas por vez, se puede acceder a las diferentes - páginas navegando el menu superior. (La página actual queda marcada en negrita). + Permite ver la lista de temas disponibles para ingresar informaciones.

info.ingresarInfo.php

- Desde aquí el usuario puede ingresar nuevas informaciones. - Los campos a completar son: -

-
    -
  • Tema: se debe seleccionar el tema de la lista disponible.
  • -
  • URL: es la URL hacia la información que se está ingresando.
  • -
  • Comentario: una breve descripción de la información provista.
  • -
-

- Una vez completados se procede a "Guardar Información" - Se mostrará un mensaje indicando si la operación fue exitosa o no. - Se mantienen los datos en los campos, y se permite la modificación de lo recién insertado. - De retirarse de la página, o presionar sobre "Nuevo Información" se pierde la posibilidad de modificar. + Permite al usuario ingresar nuevas informaciones a los temas actuales.

info.listarInfo.php

- Desde aquí el usuario puede ver la lista de informaciones disponibles. - La página se muestra paginada de a 5 informaciones por vez, se puede acceder a las diferentes - páginas navegando el menu superior. (La página actual queda marcada en negrita). - Se despliega el icono del tema al cual pertenece, así como la imagen del usuario que cargó - dicha información. A continuación se muestra la URL correspondiente, con su comentario. - Por último el ranking ( que es la cantidad de accesos que hubo a dicha URL ) y se puede - acceder finalmente a la sección de comentarios sobre la información haciendo click en - "Ver Comentarios". - Esta sección está disponible ordenada por ranking de acceso a la URL, o, eligiendo en "Ver Tema", - se listan las informaciones del tema, y luego dentro de ahi las mismas ordenadas por ranking. + Permite al usuario puede ver la lista de informaciones disponibles ordenadas por ranking, + o por tema y ranking.

info.listarComentarios.php

- Esta página es accedida desde "Ver Comentarios" que se encuentra disponible para cada información presente. - La misma muestra los comentarios agregados hasta el momento. - La página se muestra paginada de a 5 temas por vez, se puede acceder a las diferentes - páginas navegando el menu superior. (La página actual queda marcada en negrita). - Se presenta el ícono del tema al cual pertenece la información, y por supuesto el comentario en cuestión. - Luego se presenta el ícono y apellido del usuario que cargó el comentario (si el usuario que cargó el comentario - es el mismo que cargó la información entonces se muestra solamente el apellido), y finalmente se muestra el comentario. - Se puede acceder a cargar un nuevo comentario desde "Ingresar Comentario" (esto solo puede ser realizado por los asesores - o socios. + Permite ver los comentarios agregados hasta el momento.

info.ingresarComentario.php

- Desde aquí el usuario puede ingresar nuevos comentarios a informaciones existentes. - El campo a completar es: -

-
    -
  • Comentario
  • -
-

- Una vez completados se procede a "Guardar Comentario". - Se mostrará un mensaje indicando si la operacion fue exitosa o no. - Se mantienen los datos en los campos, y se permite la modificación de lo recién insertado. - De retirarse de la página, o presionar sobre "Nuevo Comentario" se pierde la posibilidad de modificar. + Permite al usuario ingresar nuevos comentarios a informaciones existentes.

info.mencionEspecial.php

- En esta pagina se lista el o los usuarios que hayan publicado informaciones con alto ranking. - Se suma para cada usuario los rankings de las páginas publicadas, y luego se muestran aquellos que con el - ranking mas alto ( se muestra mas de uno cuando el ranking es el mismo para varios usuarios ). + Permite ver la lista de el o los usuarios que hayan publicado informaciones con alto ranking.

Captura de pantalla de info.mencionEspecial.php
-

Desarrollo

- AGREGAR DESCRIPCION DE LO HECHO!!!! -

Formato de Archivos

+

Diseño del sistema

+

+ Los siguientes dos graficos describen como fue pensado el sistema a nivel + clases, y como se integrarian las diferentes partes, para que, pese a contar + con tres modulos separados, quede una unica aplicacion homogenea. Como punto de + partida entonces se realizaron estos dos graficos que sirvieron como guia, y + a lo largo del desarrollo fueron actualizandose. Se adjuntan aqui sus versiones + finales. +

+

Diagrama de Clases

+

+ El diagrama de clases se penso con el fin de poder reutilizar la mayor cantidad + de codigo posible, y de dividir de forma mas clara las tareas. La idea de estas + clases, principalmente, es que sean las entidades que son persistidas en los archivos + de texto, para tener un manejo mas sencillo y eficiente de la informacion. +

+
+ Diagrama de clases +
+

Gráfico de Navegación

+

+ Este esquema permite ver la interrelación entre las diferentes pantallas del sistema + y como se puede acceder de una a la otra. Ademas, da una idea a alto nivel de como funciona + y como aparecen integrados los diferentes elementos. +

+
+ Gráfico de Navegación +
+

Formato de Archivos

Todos los archivos del sistema se almacenan en el directorio data. Varios archivos son creados en tiempo de ejecución por el @@ -693,10 +630,232 @@ AddType application/x-httpd-php .php (si se instala con el usuario sisdis10, por supuesto).

Modo de uso

+

Modulo de Administración

+

+ Este módulo se compone escencialmente de las páginas descriptas en + la sección de desarrollo del módulo de + administración. A continuación se describe coloquialmente, en + orden lo más cronológico posible, como se usa el módulo. +

+

+ Al sistema siempre se accede por la página + index.php, la primera vez que se ejecuta, + muestra la página para asociarse, + que se ejecuta de un modo especial, haciendo a los usuarios que se + asocien administradores hasta que el sistema tenga 2 + administradores. Es decir, no se puede ingresar al sistema hasat que + no hayan 2 usuarios administradores y siempre los 2 primeros + usuarios que se asocien, serán administradores. +

+

+ Una vez especificados los 2 administradores, el sistema comienza su + ciclo de vida normal, mostrando la pantalla de + ingreso, en la cual hay un enlace a + la página para asociarse, para + que usuarios aún no asociados, puedan hacerlo (esta vez como + usuarios comunes, no como administradores). Para asociarse el + usuario debe ingresar el número de registro o código (si es asesor), + ingresar 2 veces (para evitar errores de tipeo) la contraseña que + desea usar, especificar su e-mail y foto que lo identifica. +

+

+ Una vez dentro del sistema, se muestra la + página con el log de actividades del + usuario, mostrando también la cantidad de créditos disponible (si no + es un asesor). Por omisión se muestran las actividades del día + actual, pero se puede elegir la fecha desde la cual mostrar las + actividades, o incluso mostrar todo. +

+

+ Si el usuario es administrador, se presenta el submenú + Admin, que posee 2 opciones: + Créditos y Cambio de Admin. + La primera presenta la página para + agregar créditos. Se presentan los usuarios no asesores en + una lista, un campo donde ingresar la cantidad de créditos a + agregarle y un campo para ingresar la contraseña, ya que es una + operación privilegiada que necesita una seguridad extra. La segunda + opción presenta página de cambio de + administrador. En esta página se muestra una lista de usuario + que no sean administradores, para elegir a quien ceder los + permisos de administrador. Al igual que la opción anterior, hay que + reingresar la contraseña, por ser una operación delicada. + Los permisos de administración se ceden al usuario + seleccionado, dejando de ser administrador el usuario actual, para + cumplir la restricción de que siempre hayan 2 y sólo 2 + administradores en el sistema. +

+

+ Finalmente está la opción Salir que permite al + usuario salir del sistema. Si el + usuario no sale del sistema pero está inactivo por más de media + hora, la sesión caduca y el usuario deberá volver a ingresar. Si + el usuario cierra el navegador o se va del sistema de otra forma, + y luego, antes de que se cumpla media hora de inactividad, retorna + al sistema, la página de inicio reconocerá + la sesión, y hará que el usuario continúe en la misma pantalla + donde había abandonado la sesión. +

+

Modulo de FAQs

+

+ El módulo se encarga de la administracion de el subsistema de preguntas y + respuestas. Maneja altas y bajas, asi como tambien ingreso de respuestas y + ranking de cada una. Mientras mejor es la respuesta de un usuario (que será + calificado por el autor de una pregunta), mejor será su puntuación. Esos puntos + son créditos para poder seguir efectuando preguntas. +

+

+ La página Listar Preguntas muestra + las preguntas ingresadas en el sistema. Para cada pregunta, se muestra la fecha + de creación, el nombre de autor, con su correspondiente foto, la pregunta en si, + la posibilidad de accederá a todas las respuestas para dicha pregunta, así como + también la posibilidad de responder la pregunta ( solo en caso que quien esta + logueado en el sistema no sea el mismo usuario que formulo la pregunta ). El listado + de preguntas aparece paginado cada 2 ( se muestran dos preguntas por pantalla ). + Debajo de las preguntas aparece el navegador. En caso que el usuario logueado sea un + administrador, en la parte inferior de cada pantalla aparece un link que permite + acceder a la página de Baja de Preguntas. +

+

+ El listador de respuestas muestra ordenadas por ranking + las respuestas a una pregunta seleccionada. Utiliza el paginador, al igual que el listador de preguntas, + y también lo hace de a dos respuestas por pantalla. Muestra la información del usuario + que genero la respuesta ( foto y nombre ), la respuesta y el ranking de la misma. Si la + respuesta todavía no fue evaluada por el autor de la pregunta, muestra un mensaje que + indica que no hay ranking para esa pregunta. Si el usuario que esta accediendo a la lista + de respuestas es el mismo que formulo la pregunta y todavía no calificó a la misma, aparece + un botón que lo redirecciona a la página de calificación de preguntas. +

+

+ Desde el menú de la aplicación se puede acceder a la página que permite + agregar una pregunta. En caso de que el usuario logueado tenga los créditos para hacerlo, podrá formular + una pregunta que se publicara en la lista de preguntas. Si el usuario no + contara con los créditos suficientes, un warning lo alertara y le sugerirá que pida créditos al administrador + del sistema. El usuario podrá ingresas desde esta pantalla tantas preguntas como créditos tenga. +

+

+ Desde el listado de preguntas se puede acceder a la pantalla que permite + responder la pregunta . La misma muestra en el encabezado la pregunta que se esta respondiendo. + Al lograr un ingreso satisfactorio de una respuesta, aparece un mensaje que avisa al + usuario que su respuesta fue dada de alta en el sistema. Esta respuesta quedara pendiente + de calificar por parte del autor de la pregunta que se esta respondiendo. Cualquier usuario + logueado en el sistema puede acceder a responder preguntas. Únicamente no podrá responder una + pregunta el autor de la misma. +

+

+ La pantalla de calificación de respuesta solo puede ser accedida + por el autor de la pregunta que tiene dicho ítem como respuesta. En esta pantalla, desde un combo, se + puede elegir alguna de las cuatro categorías de calificación ( a cada una le corresponde un + puntaje ). Inmediatamente se le acreditara a quien pregunta tantos créditos como puntos valgan la + calificación de la respuesta. La respuesta solo podrá ser calificada una vez, luego de ser calificada, + desaparecerá el botón que permite acceder a la pantalla para ese ítem. +

+

+ Si un administrador lo desea, desde la pantalla de listado de preguntas + es posible acceder a la pantalla de baja de preguntas y pasar una pregunta + a un log historico. De esta manera ni la pregunta ni sus respuestas seran mostradas mas por el listador. La lista de preguntas + a desactivar aparece para seleccionar de un combo. +

+

Modulo de Info

+

+ El módulo de info permite el ingreso de temas, informaciones y comentarios, + y para la interaccion con el mismo se definieron distintos menúes en base + a los roles presentes en la plataforma. + El siguiente menu es el que se le presenta al asesor o socio. +

+
+ Captura de pantalla de info.menu.asesor.jpg +

- COMPLETAR!!! Mucho de esto por ahora está en la descripción del - diseño... Habría que hacer una descripción de un circuito completo - que vaya por toas las páginas... + El siguiente menu es el que se le presenta al administrador. +

+
+ Captura de pantalla de info.menu.administrador.jpg +
+

+ Desde info.ingresarTemas.php el usuario puede ingresar nuevos temas. + (Solo pueden acceder los usuarios administradores).
Los campos a completar son: +

+
    +
  • Tema: Nombre del Tema.
  • +
  • Icono: Cada Tema tiene un ícono asociado.
  • +
  • Descripción: Cada Tema tiene un descripción asociada.
  • +
+

+ Una vez completados se procede a "Guardar Tema".
+ Se mostrará un mensaje indicando si la operación fue exitosa o no. + En cualquiera de los dos casos se mantienen los datos en los campos, y se + permite la modificación de lo recien insertado, a modo de correccion de posibles errores + del usuario al tipear.
De retirarse de la página, o presionar sobre "Nuevo Tema" + se pierde la posibilidad de modificar (al presionar sobre "Nuevo Tema" se pedirá la confirmación + antes de cambiar de contexto). +

+

+ Desde info.listarTemas.php el usuario puede ver la lista de temas disponibles + para ingresar informaciones. La página se muestra paginada de a 5 temas por vez, se puede acceder a + las diferentes páginas navegando el menu superior. (La página actual queda marcada en negrita). +

+

+ Desde info.ingresarInfo.php el usuario puede ingresar nuevas informaciones. + Los campos a completar son: +

+
    +
  • Tema: se debe seleccionar el tema de la lista disponible.
  • +
  • URL: es la URL hacia la información que se está ingresando.
  • +
  • Comentario: una breve descripción de la información provista.
  • +
+

+ Una vez completados se procede a "Guardar Información".
+ Se mostrará un mensaje indicando si la operación fue exitosa o no. + Se mantienen los datos en los campos, y se permite la modificación de lo recién insertado, + a modo de correccion de posibles errores del usuario al tipear.
De retirarse de la página, + o presionar sobre "Nueva Información" se pierde la posibilidad de modificar (al presionar sobre + "Nueva Información" se pedirá la confirmación antes de cambiar de contexto). +

+

+ Desde info.listarInfo.php el usuario puede ver la lista de informaciones disponibles. + La página se muestra paginada de a 5 informaciones por vez, se puede acceder a las diferentes + páginas navegando el menu superior. (La página actual queda marcada en negrita).
+ Se despliega el icono del tema al cual pertenece, así como la imagen del usuario que cargó + dicha información. A continuación se muestra la URL correspondiente, con su comentario. + Por último el ranking ( que es la cantidad de accesos que hubo a dicha URL ) y se puede + acceder finalmente a la sección de comentarios sobre la información haciendo click en + "Ver Comentarios".
+ Esta sección está disponible ordenada por ranking de acceso a la URL, o, eligiendo en "Ver Tema", + se listan las informaciones del tema, y luego dentro de ahi las mismas ordenadas por ranking. +

+

+ Esta página es accedida desde "Ver Comentarios" que se encuentra disponible para cada información presente. + La misma muestra los comentarios agregados hasta el momento. + La página se muestra paginada de a 5 temas por vez, se puede acceder a las diferentes + páginas navegando el menu superior. (La página actual queda marcada en negrita). + Se presenta el ícono del tema al cual pertenece la información, y por supuesto el comentario en cuestión. + Luego se presenta el ícono y apellido del usuario que cargó el comentario (si el usuario que cargó el comentario + es el mismo que cargó la información entonces se muestra solamente el apellido), y finalmente se muestra el comentario. + Se puede acceder a cargar un nuevo comentario desde "Ingresar Comentario" (esto solo puede ser realizado por los asesores + o socios. +

+

+ Desde info.ingresarComentario.php el usuario puede ingresar nuevos comentarios a informaciones existentes. + El campo a completar es: +

+
    +
  • Comentario
  • +
+

+ Una vez completados se procede a "Guardar Comentario".
+ Se mostrará un mensaje indicando si la operacion fue exitosa o no. + Se mantienen los datos en los campos, y se permite la modificación de lo recién insertado, + a modo de correccion de posibles errores del usuario al tipear.
De retirarse de la página, + o presionar sobre "Nuevo Comentario" se pierde la posibilidad de modificar (al presionar sobre "Nuevo Comentario" + se pedirá la confirmación antes de cambiar de contexto). +

+

+ En info.mencionEspecial.php se lista el o los usuarios que hayan publicado informaciones con alto ranking. + Se suma para cada usuario los rankings de las páginas publicadas, y luego se muestran aquellos que con el + ranking mas alto ( se muestra mas de uno cuando el ranking es el mismo para varios usuarios ).