 |
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. Introduzione
Questo sito web — docs.checkmk.com — utilizza pagine HTML statiche create con Asciidoctor, che vengono aggiornate quotidianamente. Una soluzione di questo tipo è performante e rappresenterà il modo più efficiente per fornirti il manuale per molti anni a venire. Un altro vantaggio è che ogni articolo è disponibile come singolo file. Ciò significa che l'indice per la ricerca può essere integrato nel file system senza richiedere una deviazione tramite la rete. Per sfruttare questo vantaggio, nel settembre 2022 la ricerca è stata switchata da una soluzione basata su crawler con il programma JavaScript Lunr.js.
Lunr utilizza un indice che viene caricato completamente come oggetto JavaScript al primo caricamento della pagina. Questo oggetto ha una dimensione compressa inferiore a un megabyte e rimane nella cache del browser, il che rende la ricerca molto veloce. Solo quando è disponibile un nuovo indice — ovvero una volta al giorno — verrà ricaricato nella cache del browser.
Creare l'indice insieme alle pagine HTML ci permette di nascondere elementi della pagina come l'indice, in modo che l'indice contenga solo termini rilevanti.
2. Come usare la box di ricerca
In linea di massima, la ricerca funziona come qualsiasi altro motore di ricerca: inserisci i termini di ricerca nella box di ricerca su docs.checkmk.com.
Questi corrispondono all'indice e riceverai un elenco ponderato di risultati.
2.1. La ricerca semplice
In una ricerca semplice, inserisci i termini di ricerca uno dopo l'altro nella box di ricerca. L'elenco dei risultati verrà ordinato come segue:
In cima all'elenco dei risultati ci sono le pagine che contengono tutti i termini di ricerca e che corrispondono maggiormente.
Seguono le pagine che contengono tutti i termini di ricerca, ma che corrispondono in misura minore.
Infine seguono le pagine che contengono un numero minore di termini e, per ultime, quelle che contengono solo uno dei termini di ricerca inseriti.
Un'occorrenza nel titolo della pagina e nella meta descrizione ha un peso maggiore rispetto a una nel corpo del testo.
Sotto la box di ricerca è riportato l'elenco dei 5 migliori risultati. Nella riga sottostante puoi visualizzare tutti i risultati in una nuova finestra a comparsa.
2.2. Includere ed escludere termini di ricerca
Puoi usare gli operatori + e - per includere o escludere esplicitamente i termini di ricerca. Esempi:
|
Trova tutte le pagine che contengono |
|
Trova le pagine che contengono |
|
Trova tutte le pagine che non contengono né |
2.3. Termini usati in combinazione
Per trovare termini usati insieme, puoi mascherare spazi, segni di punteggiatura o trattini usando due barre rovesciate seguite da uno spazio.
Quindi agent\\ controller troverà tutte le pagine con Agent Controller anche se viene usata una grafia errata con il trattino.
Con +agent +controller, invece, vengono trovate le pagine che contengono Agent e Controller in qualsiasi ordine e con qualsiasi spaziatura.
2.4. Carattere jolly
L'asterisco * sostituisce qualsiasi stringa in qualsiasi posizione di un termine di ricerca.
Mentre digiti, in background viene automaticamente aggiunto un asterisco alla fine del testo digitato per generare l'anteprima.
Termina il testo di ricerca con uno spazio per trovare il termine esatto.
2.5. Ponderazione
Aggiungi un numero intero con l'accento circonflesso (^) a un termine di ricerca per dargli un peso maggiore rispetto al valore predefinito per quel fattore:
|
Pesa |
3. Collegamento alla ricerca
Puoi anche passare i parametri per una ricerca in docs.checkmk.com tramite l'URL.
Il JavaScript trasferisce quindi i termini di ricerca nella box di ricerca e avvia la ricerca.
Sono disponibili i seguenti parametri:
|
È richiesto almeno un termine di ricerca. Puoi separare più termini di ricerca con |
|
Non apre l'anteprima con cinque risultati, ma la finestra sovrapposta più grande con tutti i risultati. |
|
Apre immediatamente l'articolo del primo risultato di ricerca. |
|
Specifica questo parametro all'origine se crei un link dal forum, ad esempio, o se crei la ricerca nel manuale come motore di ricerca.
Il nostro server web scrive il parametro di query nei suoi file di log.
Valutiamo questo parametro statisticamente, attualmente per |
In linea di principio, la ricerca funziona su qualsiasi pagina.
Ad esempio, puoi accedere all'articolo in inglese sull'agente Linux con una ricerca aperta per il terminelinux
come segue:
https://docs.checkmk.com/latest/en/agent_linux.html?find=linux&origin=bookmarks