Compartir a través de


Descripción de cómo funcionan las plantillas de presentación de elementos y el resaltado de pulsaciones en la experiencia de búsqueda clásica en SharePoint Server

SE APLICA A:yes-img-132013 yes-img-162016 yes-img-192019 yes-img-seSubscription Edition no-img-sopSharePoint en Microsoft 365

En este artículo, aprenderá lo siguiente:

Asignar una unidad de red

Cuando trabaje con plantillas para mostrar, facilitará mucho sus tareas si asigna una unidad de red. Al hacerlo, podrá trabajar con las plantillas para mostrar desde el Explorador de Windows. Para obtener instrucciones, vea Cómo asignar la unidad de red.

Por qué es importante saber los nombres de las propiedades administradas

En la sección Cómo funciona la búsqueda en pocas palabras del tema de introducción de esta serie se explicó cómo se "transforman" las columnas del sitio y los valores de las columnas del sitio en propiedades administradas y los valores de propiedades administradas durante un rastreo. Es importante que aprenda a buscar el nombre de la propiedad administrada que representa una columna del sitio, porque para agregar información nueva a los resultados de la búsqueda, deberá agregar el nombre de la propiedad administrada a una plantilla para mostrar elementos. Si no sabe cómo se llaman las propiedades administradas, vea From site column to managed property - What's up with that?.

¿Está confundido? No se desespere. Le mostraremos los pasos para encontrar y agregar un nombre de propiedad administrada a una plantilla para mostrar elementos más adelante en esta serie.

Acerca de elementos importantes en la plantilla para mostrar elementos

En el artículo Descripción de cómo se muestran los resultados de la búsqueda en SharePoint Server se explica que SharePoint Server incluye muchas plantillas de presentación de elementos. Si bien estas plantillas para mostrar no son 100 % idénticas, todas contienen ciertos elementos que controlan la forma en la que se muestran los resultados de la búsqueda.

Vamos a abrir una plantilla para mostrar elementos, por ejemplo: Item_Excel.

Nota:

Dado que hemos asignado una unidad de red, podemos abrir el archivo en nuestro editor HTML favorito, por ejemplo, Notepad++.

Plantilla para mostrar elemento abierto

Acerca de la etiqueta <title>

La parte superior de la plantilla para mostrar tiene una etiqueta <title>. El texto de esta etiqueta es el que se mostrará cuando realice configuraciones en la interfaz de usuario de SharePoint, por ejemplo, cuando configure un tipo de resultado.

En la siguiente captura de pantalla se presenta cómo se muestra el texto de la etiqueta <title> en la plantilla para mostrar elementos, Elemento de Excel, en la configuración del tipo de resultado de Microsoft Excel.

Título de elemento de Excel

Acerca del elemento ManagedPropertyMapping

Después de la etiqueta <title>, hay un conjunto de elementos en una etiqueta <mso:CustomDocumentProperties>, de la cual la más importante es <mso:ManagedPropertyMapping>.

El elemento ManagedPropertyMapping contiene las propiedades administradas que se pueden usar para mostrar los resultados de la búsqueda. La sintaxis siguiente se usa para almacenar estas propiedades en la plantilla para mostrar elementos:

'<Display template reference name>':<Managed property name>'

En la siguiente captura de pantalla se muestra el elemento ManagedPropertyMapping predeterminado para la plantilla para mostrar Elemento de Excel.

Asignación de propiedades administradas

Observe que el nombre de referencia de la plantilla para mostrar es el mismo que el nombre de la propiedad administrada, por ejemplo 'Title':'Title' or 'FileType':'FileType'. Aunque esto puede resultar un poco confuso al principio, el hecho de tener nombres idénticos facilita el mantenimiento del archivo.

De forma predeterminada, las propiedades administradas que se incluyen en este elemento varían ligeramente para las distintas plantillas de presentación de elementos. Sin embargo, hay dos propiedades administradas que se incluyen en todas las plantillas para mostrar: HitHighlightedProperties y HitHighlightedSummary. Exploraremos estas dos propiedades en la sección "How hit highlighting works - it is magic!" de este tema.

Acerca de la etiqueta <body>

Dentro de la etiqueta <body>, hay una etiqueta <div> con un identificador. De forma predeterminada, el identificador para esta etiqueta <div> coincide con el nombre del archivo. En nuestro caso, es Item_Excel.

ID de div

Cualquier archivo HTML o código que debe usar la plantilla para mostrar para presentar los resultados de la búsqueda se incluyen dentro de esta etiqueta <div>.

En esta etiqueta <div> hay uno o más bloques que empiezan con <!--#_ y terminan con _#-->. El código de JavaScript se usa dentro de estos bloques y HTML se usa fuera de estos bloques. También puede usar estos bloques para controlar el HTML con instrucciones condicionales. Le mostraremos cómo llevar a cabo esta tarea más adelante en otro artículo.

Acerca de la variable de la plantilla para mostrar paneles activables

Debemos contemplar una variable que se usa dentro de este bloque: var hoverUrl. En Descripción de cómo se muestran los resultados de la búsqueda en SharePoint Server, se ha explicado cómo cada plantilla de presentación de elementos contiene una referencia a una plantilla para mostrar del panel flotante. La variable var hoverUrl contiene esta referencia.

En la siguiente captura de pantalla se muestra de qué manera var hoverUrl apunta a la plantilla para mostrar paneles activables Item_Excel_HoverPanel.

Url de activación var

Acerca del icono que se muestra en los resultados de la búsqueda

También quiero mencionar el valor ctx.CurrentItem.csr_Icon. Este valor apunta al icono que debe mostrarse junto con cada resultado de la búsqueda, por ejemplo el icono Excel.

En la siguiente captura de pantalla se muestra cómo el valor ctx.CurrentItem.csr_Icon apunta a un icono.

Valor de icono

Más adelante en esta serie, analizaremos cómo modificar este valor para que apunte a un icono personalizado.

Acerca de la referencia a la plantilla para mostrar elementos comunes

Hacia el final de <div>, se incluye una línea de código muy importante: #=ctx.RenderBody(ctx)=#. En Descripción de cómo se muestran los resultados de la búsqueda en SharePoint Server, hemos visto cómo se trata de una referencia a la plantilla de presentación de elementos que usan todos los tipos de resultados.

En la siguiente captura de pantalla se muestra cómo se usa #=ctx.RenderBody(ctx)=# en la plantilla para mostrar Item_Excel.

Referencia de elementos comunes

Acerca del resaltado

Aunque nunca haya escuchado sobre el resaltado de referencias antes, seguramente ha visto la característica en acción aunque no haya reparado en ella.

La característica de resaltado de referencias toma las palabras que ha escrito un usuario en un cuadro de búsqueda y las muestra en negrita en los resultados de la búsqueda. De esta forma, los usuarios pueden examinar los resultados de la búsqueda fácilmente para ver el contexto en el que se encuentran las palabras. Por ejemplo, en la pantalla siguiente se muestra que se escribió "tipo de resultado" en el cuadro de búsqueda. En los resultados, las palabras "resultado" y "tipo" aparecen en negrita.

Resaltado de referencias

Cómo funciona el resaltado de aciertos: ¡es magia!

De forma predeterminada, el resaltado de referencias está habilitado para ciertas propiedades administradas. Para ver estas propiedades administradas, en una página de resultados de la búsqueda, edite el elemento web de resultados de la búsqueda. En el panel de herramientas del elemento web expanda la sección Plantillas para mostrar. Las propiedades que están habilitadas para el resaltado de referencias se enumeran en la sección Propiedades destacadas de los resultados (JSON).

Elemento web Propiedades destacadas de los resultados

El tema no termina aquí, pero por ahora es importante que sepa dónde se encuentran enumeradas estas propiedades administradas.

Volvamos a nuestra búsqueda de "tipo de resultado" y echemos un vistazo más de cerca al primer resultado de la búsqueda, que. se devolvió porque los valores de las columnas Title y Project/File Name contenían las palabras que estábamos buscando.

Elemento en resultados de búsqueda

Tal como explicamos previamente en la sección "Acerca del elemento ManagedPropertyMapping" de este tema, el elemento ManagedPropertyMapping de la plantilla para mostrar elementos contiene las propiedades administradas que se pueden usar para mostrar los resultados de la búsqueda. Basándose en esto, puede comprender por qué se muestra "Acerca de la configuración de tipos de resultados ". Esto se debe a que "Acerca de la configuración de tipos de resultados" es el valor de Título en el elemento de lista y Título es una de las propiedades administradas encontradas en el elemento ManagedPropertyMapping en la plantilla para mostrar. Las palabras "tipo de resultado" se muestran en negrita (resaltado de referencia) porque el Título es una de las referencias resaltadas en la lista en el elemento web de resultados de la búsqueda.

Pero por qué es " CSH_Configure_ result_types" que se muestran en los resultados de la búsqueda? En el elemento de la lista podemos ver que este es el valor de Nombre de archivo/proyecto, pero la propiedad administrada para esa columna del sitio no está incluida en el elemento ManagedPropertyMapping en la plantilla para mostrar. Ninguno aparece como una de las propiedades resaltadas de referencia en el elemento web de resultados de la búsqueda. Entonces, ¿por qué se muestra este valor?

Acerca de la propiedad de "resumen mágico"

Si adivinó el resaltado de referencias, está en lo cierto. Además de las propiedades predeterminadas que vio en la sección Propiedades destacadas de los resultados (JSON) del elemento web de resultados de la búsqueda, hay una propiedad que contiene un resumen para cada elemento. Es prácticamente como una propiedad mágica, porque almacena un resumen de cada elemento en el índice de búsqueda. Este resumen se crea bajo el espectro de SharePoint, por lo que no debe preocuparse. Lo importante aquí es que cuando busqué "tipo de resultado", se encontró una coincidencia tanto en el título como en esta propiedad de "resumen mágico".

Si se quedó pensado, aguarde. Comprendo que el valor de Título se muestra porque Título es una de las propiedades administradas encontradas en la plantilla para mostrar elementos ManagedPropertyMapping. No obstante, no veo ninguna propiedad de "resumen mágico" en el elemento ManagedPropertyMapping de la plantilla para mostrar. Entonces, ¿cómo se puede ver el valor?

Bueno, ahí es donde las dos propiedades HitHighlightedProperties y HitHighlightedSummary son útiles. El siguiente diagrama no representa la forma en la que realmente SharePoint controla estas propiedades. Sin embargo, imagíneselo de la siguiente manera:

Diagrama de flujo Resaltado de referencias

  1. Las propiedades administradas que se enumeran en la sección Propiedades destacadas de los resultados (JSON) del elemento web de resultados de búsqueda y la propiedad de "resumen mágico" se pasan a la propiedad HitHighlightedProperties.

  2. Todos los valores de la propiedad HitHighlightedProperties se pasan a la propiedad HitHighlightedSummary.

  3. Se muestra una versión truncada de los valores en HitHighlightedSummary en el elemento web de resultados de la búsqueda.

Si mira atentamente los resultados de la búsqueda, podrá observar que muchos resultados aparecen con tres puntos al final.

Puntos de resultado

Estos puntos indican que estos son los valores de la propiedad HitHighlightedSummary.

Si solo quiere que se muestre una cantidad mínima de datos para cada resultado de la búsqueda, puede confiar en la magia del resaltado de referencias y probablemente quede conforme con la manera en la que se muestran los resultados de la búsqueda de forma predeterminada. Sin embargo, si quiere que se muestre información personalizada para cada resultado, deberá personalizar algunas opciones.

En el siguiente artículo aprenderá el primer paso para personalizar los resultados de la búsqueda: crear un nuevo tipo de resultado.

Próximo artículo de esta serie

Cómo mostrar valores de propiedades administradas personalizadas en los resultados de búsqueda: opción 1 en SharePoint Server