Sugerencia de temas al escribir

Flerex

Sugiere a tus usuarios temas relacionados cuando estén abriendo nuevos temas para evitar hilos repetidos. Este es el mismo código utilizado por el foro oficial de soporte de Foroactivo.

Hace tiempo preparé un plugin para el Foro de Soporte oficial de Foroactivo y lo compartí con la comunidad inglesa en uno de los foros más conocidos de la misma. Como este foro ha cerrado me gustaría que este código no se perdiese, por lo que lo comparto en el blog, aunque se separe un poco de la temática original.

¿Qué hace este plugin? Con este plugin harás que a la hora de abrir un nuevo tema, tus usuarios reciban sugerencias de posibles temas ya crados relacionados con el título del que está escribiendo. Este plugin está pensado principalmente para foros de soporte, evitando que los usuarios repitan preguntas ya hechas.

Una demo de como funciona el plugin

Instalación

En la plantilla viewtopic_body busca:

<script src="{JQUERY_PATH}" type="text/javascript"></script>

Añade después:

<script src="https://gitcdn.xyz/repo/Flerex/cdn/master/fm/similar-topics.js" type="text/javascript"></script>

Ahora añade el siguiente CSS a tu foro para obtener el diseño por defecto del plugin (igual que el del gif anterior):

#similarTopics {
	width: 500px;
	background: #E1EBF2;
	padding: 5px 10px;
	border-radius: 5px;
	margin: 5px 0 0 10em;
}
 
#similarTopics,
#similarTopics .spinner,
#similarTopics .topic-container,
#similarTopics .similarTopics-title {
	display: none;
}
 
#similarTopics.visible,
#similarTopics .spinner.visible,
#similarTopics .similarTopics-title.visible,
#similarTopics .topic-container.visible {
	display: block;
}
 
#similarTopics .topic {
	display: flex;
	border-bottom: 1px solid white;
	padding: 5px 0;
	margin: 5px 0;
}
 
#similarTopics .topic:last-child {
	border-bottom: none;
}
 
#similarTopics .topic-data {
	flex: 1;
}
 
#similarTopics .topic-flags {
	align-items: center;
	margin-right: 10px;
	position: relative;
}
 
#similarTopics .topic-icon {
	position: absolute;
	top: 0;
	left: 0;
	bottom: 0;
	right: 0;
	background: transparent 50% 50% no-repeat;
}
 
#similarTopics .similarTopics-title {
	border-bottom: 1px solid #0076b1;
	color: #0076b1;
	font-size: .9em;
	margin: .5em 0;
	text-transform: uppercase;
}
 
#similarTopics .topic-status {
	width: 27px;
	height: 27px;
	background: transparent 0 0 no-repeat;
}

Finalmente añade el siguiente JS desde la Gestión de JavaScript del PA y asegúrate de marcarlo para que se muestre en todas las páginas:

!function() {
 
	const settings = {
		forums : [1,2,3,4,5,6,7],
		searchIn : '-1',
		maxTopics : 5,
	};
 
 
	location.pathname == '/post' &&
	location.search.indexOf('&mode=newtopic') > -1 &&
	(settings.forums === true || settings.forums.some(id => location.search.indexOf(`?f=${id}`) > -1)) &&
	$(function() {
		FLRX.similarTopics.init(settings);
	});
 
}();

Si te has dado cuenta hay una constante settings que permite pasar distintos parámetros de configuración al plugin. Esos parámetros no son los únicos disponibles. Todas las posibles configuraciones están en la documentación.

Documentación

A continuación encontrarás todos los parámetros de configuración disponibles. Recuerda que los parámetros de configuración tienen la siguiente sintaxis:

setting: value,

Por lo que si tienes más de un parámetro de configuración, la constante del código debería verse tal que así:

const settings = {
	setting1: value,
	setting2: value,
	setting3: value,
};

Antes de empezar, ten en cuenta que poner un parámetro de configuración con el valor por defecto es lo mismo que no poner nada.

Opciones básicas

  • forums: Todos los foros donde se sugerirán temas relacionados al abrir uno nuevo. Un foro es representado por su ID (la que aparece en la URL al mismo). Las IDs serán puestas entre corchetes, separadas por comas. Por ejemplo:
    forums: [1, 2, 3, 4, 5],

    Casos especiales:

    • []: Deshabilita el plugin en todos los foros (contraproducente).

    Valor por defecto:

    forums: [],
  • searchIn: El foro o categoría donde la búsqueda de temas se realizará. Para identificar el foro o categoría se utilizará su ID, precedido por la letra f en el caso de los foros o c en el caso de las categorías, todo entre comillas. Por ejemplo, para buscar en la categoría con ID 2 se usaría:
    searchIn: 'c2',

    Casos especiales:

    • false: Buscar en el mismo foro donde el tema se está creando.
    • -1: Buscar en todo el foro.

    Valor por defecto:

    searchIn: false,
  • maxTopics: Cantidad máxima de temas a mostrar. Debido a problemas de implementación, el número máximo de temas a mostrar será el número máximo de temas por página que Foroactivo muestra.

    Ejemplo:

    maxTopics : 10,

    Valor por defecto:

    maxTopics : 5,
  • triggerWhenWriting: Activa o desactiva la funcionalidad mientras se escriba. Desactivar esta opción significará que la lista será mostrada solamente cuando el foco salga del cuadro de escritura del título. Ejemplo:
    triggerWhenWriting : false,

    Valor por defecto:

    triggerWhenWriting : true,
  • hideAtFocusout: Oculta la lista de temas cuando el cuadro de escritura pierde el foco.

    Precondiciones:

    • La opción triggerWhenWriting debe tener el valor true.

    Ejemplo:

    hideAtFocusout : true,

    Valor por defecto:

    hideAtFocusout : false,
  • autocomplete: Desactiva o activa autofill (sugerencias del navegador) en el campo de texto del título, es decir, pone el atributo autocomplete a on u off.

    Ejemplo:

    autocomplete : true,

    Valor por defecto:

    autocomplete : false,
  • wordMinLength: El número mínimo de caracteres de una palabra para que sea tomada en cuenta en la búsqueda. Ten en cuenta que debido a limitaciones de Foroactivo, usar un valor menor que 4 no tendrá efecto.

    El valor deberá ser un entero entre el número 4 (incluído) e infinito (es decir, el número máximo de caracteres permitidos por Foroactivo en las búsquedas).

    Ejemplo:

    wordMinLength : 5,

    Valor por defecto:

    wordMinLength : 4,

Opciones avanzadas

Estas opciones están pensadas tan solo para usuarios avanzados.

  • excludedCharacters: Objeto RexExp que hace match con los caracteres ignorados del campo de texto:
    Valor por defecto:
    excludedCharacters : new RegExp(/[.,\/#!$%\^&\*¿?!¡;:{}\\=\-_`~"«“‘’”»()\[\]]/, 'g'),
  • dom: Objeto personalizable utilizado para modificar la forma en la que el DOM se lee. Muy útil encaso de que hayas modificado tus plantillas y estas teniendo problemas de incompatibilidad.

    Puedes ver todas las modificaciones posibles en la sección «Valor por defecto», que corresponde a la estructura por defecto de un foro con versión phpBB3. Adaptando estas opciones a cualquier otra versión debería ser sencillo. Para poder hacer la adaptación simple, todas las relaciones entre elemetnos son estrictamente parentales (es decir, no hay posibilidad de que ninguno de los identificadores del DOM de este objeto representen al mismo objeto, solo un padre, abuelo cercano o lejano, hijo o nieto cercano o lejano). Si hay cualquier problema entiendiendo esto no tendré problema en ayudar.

    Valor por defecto:

    dom : {
    
    	/* Search page */
    	topicscontainer		: '.forabg',
    	topic				: 'dd.dterm',
    	infocontainer		: '.span-tab',
    	titlelink			: '.topictitle',
    	userlink			: 'a[href^="/u"]',
    	forumlink			: 'a[href^="/f"]',
    	topicicon			: 'dl.icon',
    
    	/* structure */
    	visible				: 'visible',
    
    	/* posting page */
    	titleinput			: '#postingbox input[name="subject"]',
    	inputcontainer		: 'dl',
    
    	/* created elements */
    	maincontainer 		: $('<div />', { id : 'similarTopics' }),
    	similartopiccont	: $('<div />', { class : 'topic-container' }),
    	loadingelm			: $('<div />', { class : 'spinner' })
    							.append($('<div/>', { class:'double-bounce1' }))
    							.append($('<div/>', { class:'double-bounce2' })),
    	topicelmcont		: $('<div />', { class: 'topic' }),
    	topicelmtitle		: $('<div />', { class: 'topic-title' }),
    	topicdatacont		: $('<div />', { class: 'topic-data' }),
    	topicflags			: $('<div />', { class: 'topic-flags' }),
    	topiciconcont		: $('<div />', { class: 'topic-icon' }),
    	topicstatus			: $('<div />', { class: 'topic-status' }),
    	topicelminfo		: $('<div />', { class: 'topic-info' }),
    	topicauthor			: $('<span />', { class: 'topic-author', text: 'por ' }),
    	topicforum			: $('<span />', { class: 'topic-forum', text: ' en ' }),
    	similarstitle		: $('<h4 />', { class: 'similarTopics-title', text: 'Quizás te interese...' }),
    
    },

A tener en cuenta…

  • El soporte de navegadores de este plugin sigue mis reglas de soporte general: solo los principales navegadores (Chrome, Firefox, Safari, Edge y derivados) en su versión actual y versión actual – 1. No soportaré ninguna versión de Internet Explorer puesto que el navegador ya ha llegado al fin de su ciclo de vida. Esto no significa que el plugin no funcionará en los navegadores no soportados, podría funcionar. Esto tan solo significa que en caso de que no funcione, no corrigiré esta falla. También significa que si usas uno de estos navegadores deberías cambiarte.
  • Si encuentras algún error en los navegadores soportados anteriormente mencionados, agradecería que se me lo hiciese saber.
  • Además, si tienes algún tipo de sugerencia sobre características a añadir, tan solo dilo, no muerdo… mucho.

por Flerex

Estudiante de Ingienería del Software con experiencia en el desarrollo web y la plataforma Foroactivo desde hace más de 8 años. Me encanta todo lo relacionado con el diseño de UI/UX.

Deja un comentario

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *