Checkmk
to checkmk.com

Important

This is a machine translation based on the English version of the article. It might or might not have already been subject to text preparation. If you find errors, please file a GitHub issue that states the paragraph that has to be improved.

1. Introducción

Este sitio web - docs.checkmk.com - utiliza páginas HTML estáticas construidas con Asciidoctor, que se actualizan diariamente. Esta solución es eficaz y será la forma más eficiente de proporcionarle el Manual de usuario durante muchos años. Otra ventaja es que cada artículo está disponible como un único archivo, lo que significa que el índice para la búsqueda puede integrarse en el sistema de archivos sin necesidad de dar un rodeo por la red. Para aprovechar esta ventaja, la búsqueda se cambió de una solución de rastreo al programa JavaScript Lunr.js en septiembre de 2022.

Lunr utiliza un índice que se carga completamente como un objeto JavaScript en la primera carga de la página. Este objeto tiene un tamaño comprimido inferior a un megabyte y permanece en la caché del navegador, lo que hace que la búsqueda sea muy rápida. Sólo cuando hay un nuevo índice disponible -lo que ocurre una vez al día- se vuelve a cargar en la caché del navegador.

Construir el índice junto con las páginas HTML nos permite ocultar elementos de la página, como el índice de contenidos, para que el índice contenga sólo los términos relevantes.

2. Uso de la caja de búsqueda

En principio, la búsqueda funciona como cualquier otro motor de búsqueda: introduzca los términos de búsqueda en la caja de búsqueda de docs.checkmk.com. Estos se cotejan con el índice y recibirá una lista ponderada de resultados.

En una búsqueda simple, introduzca los términos de búsqueda uno tras otro en la caja de búsqueda. La lista resultante se ordenará de la siguiente manera:

  1. En la parte superior de la lista de resultados se encuentran las páginas que contienen todos los términos de búsqueda y que presentan la mayor coincidencia.

  2. A continuación aparecen las páginas que contienen todos los términos de búsqueda, pero cuya coincidencia es menor.

  3. Finalmente siguen las páginas que contienen menos de los términos y, por último, sólo uno de los términos de búsqueda introducidos.

Una aparición en el título de la página y en la meta descripción tiene más peso que una en el cuerpo del texto.

Debajo de la caja de búsqueda se enumeran los 5 mejores resultados. En la línea inferior puede visualizar todos los resultados en una nueva ventana superpuesta.

2.2. Incluir y excluir términos de búsqueda

Puede utilizar los operadores + y - para incluir o excluir explícitamente términos de búsqueda. Ejemplos:

+database -oracle

Busca todas las páginas que contienen database pero no oracle.

+database -oracle mysql

Encuentra las páginas que contienen database pero no oracle y muestra los resultados que también contienen mysql con una ponderación superior.

-database -oracle -mysql

Encuentra todas las páginas que no contienen ni database ni oracle ni mysql.

2.3. Términos combinados

Para encontrar cualquier término que se utilice junto, se pueden enmascarar los espacios o los signos de puntuación o los guiones utilizando dos barras invertidas seguidas de un espacio. Así, agent\\ controller encontrará todas las páginas que contengan Agente Controlador aunque se utilice una grafía con guiones incorrecta. Con +agent +controller, en cambio, se encuentran las páginas que contengan Agente y Controlador en cualquier orden y con cualquier espacio.

2.4. Comodín

El asterisco * sustituye cualquier cadena en cualquier posición de un término de búsqueda. Mientras escribe, en segundo plano se añade automáticamente un asterisco al final del texto escrito para generar la vista previa. Termine el texto de búsqueda con un espacio para encontrar el término de búsqueda exacto.

2.5. Ponderación

Añade un número entero con un circunflejo (^) a un término de búsqueda para ponderarlo más alto que el predeterminado para ese factor:

oracle^10 mysql^3 database

Pondera oracle diez veces más que database y pondera mysql tres veces más que database.

3. Enlace a la búsqueda

También puede pasar parámetros para una búsqueda en docs.checkmk.com a través de la URL. A continuación, JavaScript transfiere el término o términos de búsqueda a la caja de búsqueda e inicia la búsqueda. Los parámetros disponibles son los siguientes:

find=searchterm

Se requiere al menos un término de búsqueda. Puede separar varios términos de búsqueda con +. Utilice la codificación porcentual para todos los demás caracteres especiales y diéresis. Por ejemplo, + se sustituirá por %2B y - por %2D.

fulloverlay=1

No abre la vista previa con cinco resultados, sino la ventana superpuesta más grande con todos los resultados.

imlucky=1

Abre inmediatamente el artículo del primer resultado de la búsqueda.

origin=forum

Especifique este parámetro al origen si enlaza desde el foro, por ejemplo, o si crea la búsqueda en el Manual de usuario como motor de búsqueda. Nuestro servidor web escribe el parámetro de consulta en sus archivos de registro. Evaluamos este parámetro estadísticamente, actualmente para bookmarks, forum, support y checkmk.

En principio, la búsqueda funciona en cualquier página. Por ejemplo, puede acceder al artículo en inglés sobre el agente Linux con una búsqueda abierta del término linux de la siguiente manera:
https://docs.checkmk.com/latest/en/agent_linux.html?find=linux&origin=bookmarks

En esta página