Documentación :: cBB Blockgets v1.0.2


Guía Rápida • Requisitos

cBB Blockgets necesita muy pocos requisitos para funcionar correctamente.

Los requisitos básicos son:
  1. Un foro phpBB previamente instalado, cuya versión sea superior a 3.0.8 (3.0.11 es la recomendada).
  2. La función getimagesize() de php debe estar activada.
  3. El javascript debe estar activado en el explorador para poder administrar y usar el mod.

Guía Rápida • Instalación

Si ya tiene conocimientos básicos de FTP y está seguro de que su sistema ejecutará sin problemas cBB Blockgets solo tendrá que seguir estos sencillos pasos para instalarlo.

  1. Descomprimir el archivo de cBB Blockgets en un directorio local (En su ordenador).
  2. Subir todos los archivos contenidos en ese archivo (manteniendo la estructura de los directorios) a su servidor o cuenta de alojamiento.
  3. Realizar los cambios en los archivos de phpBB según se indica en el archivo "install.xml" que se encuentra dentro de ese paquete.
  4. Usando su explorador web, visite el directorio de su foro añadiendo "/blockgets/install/"
    Ejemplos:
    http://www.midominio.com/phpBB3/blockgets/install/
    http://www.midominio.com/foro/blockgets/install/
  5. Haga clic en la pestaña Instalar y siga los pasos que se indican. (es recomendable que previamente lea la licencia de la aplicación)
  6. cBB Blockgets estará disponible si ha realizado los pasos correctamente.

Si ha experimentado problemas o no sabe como proceder en alguno de los pasos puede exponer su problema en la sección correcta del foro de esta web, en donde se le ayudará en lo que nos sea posible.

Guía Rápida • Desinstalación

cBB Blockgets se puede desinstalar en pocos pasos:

  1. Usando su explorador web, visite el directorio de su foro añadiendo "/blockgets/install/",
    Ejemplos:
    http://www.midominio.com/phpBB3/blockgets/install/
    http://www.midominio.com/foro/blockgets/install/
  2. Haga clic en la opción "Desinstalar" y seguir los pasos que se indican.
  3. Una vez finalizado, tendrá que editar los archivos de phpBB siguiendo los pasos del archivo "install.xml" a la inversa para quitar el código del Mod. Esto no es imprescindible, el foro funcionará igual si esos códigos permanecen en él.

Guía Rápida • Cambiar directorio de trabajo

Es posible modificar el nombre y carpeta de trabajo del archivo "home.php" para ejecutar la página de inicio desde otro directorio.
Para conseguir esto, solo es necesario realizar unos sencillos pasos:
  1. Mueva el archivo "home.php" al directorio que desee (relativo al foro) y cambie el nombre del archivo si asi lo desea, Por ejemplo, por "index.php"
  2. Abra el archivo que acaba de mover, y busque esta línea:
    $phpbb_root_path = (defined('PHPBB_ROOT_PATH')) ? PHPBB_ROOT_PATH : './';
    y sustituya ./ por la ruta del foro, relativa al archivo.
  3. Abra el archivo "includes/hooks/hook_blockgets.php" y busque:
    //$blockgets->set_home('Home filename (home.php)', 'Directory relative to the forum path (./)');
    y sustituya "Home filename (home.php)" por el nombre del archivo que acaba de mover y "Directory relative to the forum path (./)" por la ruta en la que se encuentra (Relativa al foro)
    Después borre "//" del principio de la línea.

    Por ejemplo, si el foro se encuentra en http://midominio.com/foro/ y desea colocar el archivo "home.php" en http://midominio.com/index.php (http://midominio.com/) el resultado sería:

    Archivo que se mueve (home.php)
    $phpbb_root_path = (defined('PHPBB_ROOT_PATH')) ? PHPBB_ROOT_PATH : './foro/';
    Archivo "includes/hooks/hook_blockgets.php"
    $blockgets->set_home('index.php', '../');

Guía Rápida • Crear páginas independientes

cBB Blockgets por defecto carga todas las páginas personalizadas usando su archivo principal "home.php" pero usted puede crear un archivo independiente para cada página personalizada.
Para conseguir esto, solo es necesario realizar unos sencillos pasos:
  1. Cree una copia del archivo "home.php" renombrándolo con el nombre que desee.
  2. Abra el archivo que acaba de crear, y busque esta línea:
    //$blockgets->set_page('put here alias or id of the page');
    Sustituya 'put here alias or id of the page' por el ID númerico o el alias (si se ha establecido) de la página que desea mostrar.
    Después elimine "//" de esa línea.
Por ejemplo, si desea mostrar una página cuyo alias es "pagina_1" el resultado sería:
$blockgets->set_page('pagina_1');

Guía Rápida • Adaptar cBB Blockgets a otras páginas del foro

cBB Blockgets ofrece la posibilidad de incluir bloques en todas las páginas del foro.
Por defecto, las únicas páginas adaptadas para esto son "index", "viewforum" y "viewtopic".

Para añadir otras páginas es necesario seguir unos sencillos pasos:
  1. Acceder a Panel de Administración >> Blockgets >> Administrar páginas >> Nueva página y crear la página seleccionando el archivo que se quiera usar.
  2. Abrir la plantilla del estilo que esté relacionada con el archivo escogido. Por ejemplo, si se escoge index.php como archivo, la plantilla a modificar seria styles/{tu estilo}/template/index_body.html
  3. Añadir este código antes del contenido principal, donde se quiera que empiecen los bloques.
    <!-- IF BLG_ON_BOARD --><!-- INCLUDE blockgets/board_top_body.html --><!-- ENDIF -->
    <!-- IF not BLG_ON_BOARD or DISPLAY_FORUM_BLOCK -->
  4. Añadir este código después del contenido principal, donde se quiera que acaben los bloques.
    <!-- ENDIF -->
    <!-- IF BLG_ON_BOARD --><!-- INCLUDE blockgets/board_bottom_body.html --><!-- ENDIF -->
  5. Acceder a Panel de Administración >> General y limpiar el caché.
Nota: El contenido que quede entre los códigos de los pasos 3 y 4 aparecerá en la columna central. El resto del contenido aparecerá encima o debajo (de todas las columnas).

Manejar cBB Blockgets • Preferencias del MOD

cBB Blockgets dispone de preferencias globales con las que se puede configurar el comportamiento del mod con respecto al foro.

Para manejar estas opciones y las demás del mod, es necesario poseer los permisos necesarios.
El fundador del foro tendrá establecidos esos permisos al instalar el mod y podrá establecerlo para otros grupos desde la sección "Permisos" del Panel de Administración.

Las principales opciones se encuentran en Panel de Administración >> Blockgets >> General y son:

  1. Mod activado.
    Con esta opción se establece si el mod y todas sus funciones estarán activas o no.
  2. Bloques dentro del foro.
    Activando esta opción es posible añadir bloques a las páginas del foro.
  3. Página de Inicio como página principal.
    Esta opción establece la página de inicio como página por defecto al entrar en el dominio, sobreescribiendo al Índice General que normalmente es la página por defecto.
  4. Permitir colapsar los bloques.
    Esta opción muestra u oculta la opción de colapsar en los bloques, impidiendo así que los usuarios los colapsen. Esta opción prevalece sobre la configuración individual de cada bloque.
  5. Adaptar bloques automáticamente.
    Con esta opción se puede establecer si los bloques se presentarán igual independientemente de la columna en la que se encuentren, o si por el contrario, su contenido se adaptará según el tipo de columna.
  6. Contador de visitas.
    Desde aquí se pueden establecer las opciones generales para el contador de visitas del mod.
    1. Intervalo del contador.
      Tiempo mínimo (en segundos) que debe transcurrir para que el contador considere al usuario como "nueva visita", y lo contabilice.
    2. Resetear contador de visitas.
      Con esta opcion se resetea el contador globalmente. Estableciendo el número de visitas en 0 y la fecha de inicio del contador en la fecha actual.
  7. Redimensionado de imágenes.
    Desde aquí se puede configurar el tamaño máximo de las imágenes mostradas dentro de las páginas con bloques. Util para evitar el descuadre de los bloques. (Haciendo clic en las imágenes se podrán ver a tamaño real)
    1. Redimensionado activado.
      Esta opción permite activar o desactivar el límite de tamaño para las etiquetas "img", los adjuntos y los avatares de los bloques.
    2. Redimensionar imágenes de mensajes.
      Esta opción permite decidir si el redimensionado afectará a los mensajes del foro. (Util si se posee otro mod de redimensionado y no se desea usar el de este mod)
    3. Tamaño de las imágenes.
      El tamaño máximo permitido para las imágenes. Todas las que sobrepasen este tamaño serán encogidas.

Manejar cBB Blockgets • Administrar calendario y eventos

Esta versión de cBB Blockgets incluye un bloque "calendario" al que se le puede añadir eventos que se mostrarán en los días del calendario.
Para más información sobre Administrar los bloques vea Manejar cBB Blockgets • Administrar Bloques.

Para tener acceso a esta opción es necesario poseer los permisos necesarios (Por defecto solo posee este permiso el rol de "usuario completo")
Para añadir/editar los distintos eventos puede hacerlo desde las opciones Administrar Eventos y Añadir Evento que se encuentran en el diálogo de eventos, al hacer clic en un día del calendario.
También puede acceder a esa pantalla en la dirección /blockgets/calendar.php. Por ejemplo: http://midominio.com/foro/blockgets/calendar.php.

Manejar cBB Blockgets • Administrar Banners

Los banners, que posteriormente estarán disponibles para usarlos en todos los bloques que los usen, se administran desde Panel de Administración >> Blockgets >> Administrar Listas >> Administrar Banners.

Los banners se agrupan en listas para un una mejor organización.
Se pueden crear tantas listas como se necesiten así como integrar en ellas los banners necesarios.

Para crear una nueva lista solo se necesita introducir el nombre de la lista y hacer clic en "Nueva lista".
Una vez creada, ya se podrán añadir los banners, haciendo clic en el icono de "editar" de la lista.

Desde la página de edición se puede modificar el nombre de la lista y además, añadir los banners que formarán parte de ella.
Para agregar un nuevo banner, lo primero es hacer clic en "Añadir banner", lo que nos llevará a una nueva sección, en donde deberemos introducir una serie de datos:

  1. Descripción del banner.
    Texto, generalmente reducido, que describe el banner o la página asociada a este.
  2. URL del banner.
    Define la dirección que se abrirá al hacer clic en el banner. Se debe especificar una dirección (url) completa, incluyendo http://
  3. Imagen actual.
    La imagen actual que tiene el banner, si se ha definido.
  4. Imagen nueva.
    Establece la imagen del banner o la sustituye si el banner ya tiene una.

Una vez creados todos los banners, desde la página de edición de la lista, se podrá modificar su orden, simplemente arrastrándolos a la posición correcta y haciendo clic en "Guardar posición de banners".

Manejar cBB Blockgets • Administrar Bloques

cBB Blockgets permite establecer infinitos bloques tanto en las páginas predefinidas como en las personalizas, que se podrán establecer en el lugar que se desee.

Cada bloque cuenta con su configuración personalizada, por lo que podrá repetir un mismo tipo de bloque pero con otras opciones dentro de la misma página.

Los bloques se administran desde Panel de Administración >> Blockgets >> Administrar Bloques.
Para añadir un nuevo bloque solo se necesita hacer clic en Añadir bloque y seleccionar el bloque que se desee.
En la página que se muestra, se podrán establecer las opciones generales del bloque, así como las opciones adicionales que cada bloque pueda tener.

Las opciones generales son:
  1. Título del bloque.
    El título del bloque, que se mostrarán en la cabecera de este.
  2. Imagen actual.
    El icono actual que tiene el bloque, si se ha definido.
  3. Imagen nueva.
    Establece el icono del bloque o lo sustituye si el bloque ya tiene uno.
  4. Grupos.
    Define que grupos podrán ver el bloque. Puede seleccionar tantos como desee usando la tecla Ctrl de su teclado.
    Con esta opción se pueden generar páginas dinámicas, con distinto contenido según el grupo en el que se encuentre el usuario que la visualiza.
  5. Bloque activado.
    Define si el bloque está o no activado. Es posible desactivar un bloque sin eliminarlo completamente, para que no sea visible pero no perder su configuración.
  6. Permitir colapsar el bloque.Permite decidir si los usuarios podrán ocultar el contenido de este bloque o no. Esta opción se sobreescribe con la opción general Permitir colapsar bloques del mod.
  7. Aspecto del bloque.Esta opción permite definir un estilo diferente para cada bloque. Puede usarse el estilo por defecto, el estilo alternativo (si el estilo instalado en el foro lo permite), mostrar solo el contenido y el título, o mostrar solo el contenido.
  8. Posición del bloque.
    Define la columna en la que se posicionará el bloque, añadiéndose al final de la misma, después de los bloques de esa columna.
    Esta opción solo está disponible al añadir un nuevo bloque.

Una vez están creados todos los bloques, desde la página de administración de bloques, se puede observar como quedarán situados y cambiar su orden y/o la columna en la que se encuentran simplemente arrastrándolos a la posición deseada y haciendo clic en "Guardar posición de bloques".

Algunas funciones de los bloques, como son "Activar", "Desactivar" y "Eliminar", se pueden hacer de forma masiva marcando los bloques deseados.

Los bloques pueden moverse entre las páginas. Solo es necesario marcar los bloques deseados, hacer clic en la opción "Mover" y seleccionar la página de destino.
Los bloques movidos se situarán cada uno en su respectiva columna, al final de la misma.

Manejar cBB Blockgets • Administrar Menús

Los menús, que posteriormente estarán disponibles para usarlos en todos los bloques que los usen, se administran desde Panel de Administración >> Blockgets >> Administrar Listas >> Administrar Menús.

Los menús se agrupan en listas para un una mejor organización.
Se pueden crear tantas listas como se necesiten así como integrar en ellas los menús necesarios.

Para crear una nueva lista solo se necesita introducir el nombre de la lista y hacer clic en "Nueva lista".
Una vez creada, ya se podrán añadir los elementos de los menús, haciendo clic en el icono de "editar" de la lista.

Desde la página de edición se puede modificar el nombre de la lista y además, añadir los enlaces que formarán parte de ella.
Para agregar un enlace, lo primero es hacer clic en "Añadir enlace", lo que nos llevará a una nueva sección, en donde deberemos introducir una serie de datos:

  1. Tipo de enlace.
    Se puede escoger entre Categoría y enlace. Una categoría es como la cabecera de una serie de enlaces, se pueden usar para separar en distintos "bloques" un menú.
  2. Título del enlace.
    El texto que se mostrará a modo de título.
  3. URL del enlace.
    Define la dirección que se abrirá al hacer clic en el enlace. Se debe especificar una dirección (url) completa, incluyendo http://
  4. Imagen actual.
    La imagen actual que tiene el enlace, si se ha definido.
  5. Imagen nueva.
    Establece la imagen del enlace o la sustituye si el enlace ya tiene una. Esta imagen se mostrará donde el enlace, dependiendo del tipo de bloque al que se destine el menú.
  6. Grupos.
    Define los grupos que podrán ver este enlace. Se pueden seleccionar varios usando la tecla Ctrl del teclado.
    Esto sirve para crear menús dinámicos, con distintas opciones dependiendo del grupo al que pertenezca el usuario que lo visualiza.
  7. Abrir en ventana nueva.
    Permite definir si el enlace se abrirá en la misma página o en una nueva.

Una vez creados todos los enlaces, desde la página de edición de la lista, se podrá ver como quedarán y modificar su orden, simplemente arrastrándolos a la posición correcta y haciendo clic en "Guardar posición de enlaces".

Manejar cBB Blockgets • Administrar Páginas

cBB Blockgets permite administrar una Página de Inicio, pero además, permite establecer también opciones para las páginas pertenecientes al foro, asi como crear páginas personalizadas (desde cero).

Todas las páginas se administran desde Panel de Administración >> Blockgets >> Administrar Páginas.
Para crear una nueva página solo se necesita hacer clic en Nueva Página. En la pantalla que se muestra, se podrán establecer las opciones generales de la página.

Las opciones generales son:
  1. Administrar página
    1. Página activada. Activa o desactiva las funciones de la página por completo. Esta opción sobreescribe todas las demás.
    2. Archivo de la página. Define el archivo del foro que cargará la configuración de esta página. Si se selecciona Página Personalizada se creará una página independiente al foro.
      Para adaptar el mod a nuevas páginas del foro debe leer esta guía.
      Esta opción solo está disponible al crear una nueva página.
    3. Alias de la página. Establece el nombre interno de la página. Este nombre es usado como identificador en la URL en lugar del ID de la página. En este campo solo se permiten letras, números y guiones.
      Esta opción solo está disponible para páginas personalizadas.
    4. Título de la página. Establece el título que se mostrará en el navegador.
      Esta opción solo está disponible para páginas personalizadas.
    5. Grupos. Define los grupos de usuarios que podrán ver está página. Se pueden seleccionar varios grupos usando la tecla Ctrl del teclado.
    6. Mostrar cabecera. Permite definir si se mostrará o no la cabecera del foro en la página.
    7. Fondo de la página. Cada página se puede configurar con un fondo distinto. En este campo se puede establecer un color (Ej: white, #FFFFFF) o una imagen (Ej: http://midominio.com/imagen.jpg).
    8. Permitir ocultar columnas lateralesSi se habilita, los usuarios podrán mostrar u ocultar las columnas laterales de esta página al completo. Las columnas se ocultan hacia los lados ajustando el ancho del contenido central.
  2. Administrar columnas
    1. Columna Izquierda.Ancho de la columna izquierda, en píxeles. Si se especifica 0, la columna se deshabilitará. El valor recomendado es 180.
    2. Columna Derecha.Ancho de la columna derecha, en píxeles. Si se especifica 0, la columna se deshabilitará. El valor recomendado es 180.