 |
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. はじめに
この web サイト（docs.checkmk.com）は、Asciidoctor で構築された静的な HTML ページを使用しており、毎日更新されています。 このようなソリューションはパフォーマンスに優れ、今後長年にわたりユーザーガイドを提供する上で最も効率的な方法となります。 もう 1 つの利点は、各記事が 1 つのファイルとして入手できることです。 つまり、ネットワークを経由することなく、ファイルシステムに検索用インデックスを組み込むことができます。 この利点を活用するため、2022 年 9 月、検索はクローラーソリューションからLunr.jsJavaScript プログラムにスイッチされました。
Lunr は、最初のページロード時に JavaScript オブジェクトとして完全にロードされるインデックスを使用しています。 このオブジェクトは圧縮サイズが 1 メガバイト未満で、ブラウザのキャッシュに保存されるため、検索が非常に高速です。 新しいインデックスが利用可能になった場合（1 日 1 回）にのみ、ブラウザのキャッシュに再ロードされます。
インデックスを HTML ページと一緒に構築することで、目次などのページエレメントを非表示にし、インデックスには関連用語のみを含めることができます。
2. 検索ボックスの使用
原則として、検索は他の検索エンジンと同様です。docs.checkmk.com の検索ボックスに検索語を入力してください。
検索語はインデックスと照合され、結果のリストが優先順位順に表示されます。
2.1. シンプル検索
単純検索では、検索ボックスに検索語を順番に入力します。 検索結果は、次のようにソートされます。
検索結果リストの上部には、すべての検索語が含まれており、最も一致度の高いページが表示されます。
その次に、すべての検索語を含むが、一致度が低いページが表示されます。
最後に、検索語の含まれる数が少ないページ、そして最後に、入力した検索語の1つだけを含むページが表示されます。
ページタイトルおよびメタディスクリプションに含まれる検索語は、本文に含まれる検索語よりも優先度が高くなります。
検索ボックスの下には、5 件の最適な結果がリスト表示されます。 その下の行では、すべての結果を新しいオーバーレイウィンドウに表示することができます。
2.2. 検索用語の包含および除外
+ および- オペレーターを使用すると、検索用語を明示的に含めたり除外したりすることができます。例：
|
「 |
|
|
|
|
2.3. 組み合わせて使用される用語
一緒に使用されている用語を検索するには、2 つのバックスラッシュとそれに続くスペースを使用して、スペース、句読点、ハイフンをマスクします。
したがって、agent\\ controller は、間違ったハイフン付きスペルが使用されている場合でも、Agent Controllerを含むすべてのページを検索します。
一方、+agent +controller では、AgentとControllerが任意の順序で、任意の間隔で含まれているページが検索されます。
2.4. ワイルドカード
アスタリスク「* 」は、検索語の任意の位置にある任意の文字列を置き換えます。
入力中に、背景でアスタリスクが自動的に入力したテキストの末尾に追加され、プレビューが生成されます。
検索語を正確に検索するには、検索語の末尾にスペースを入力してください。
2.5. ウェイト
検索語に、デフォルトよりも重み付けを高くする整数を、サーカムフレックス (^) で付け加えます。
|
|
3. 検索へのリンク
docs.checkmk.com では、URL 経由で検索のパラメータを渡すこともできます。
JavaScript は、検索用語を検索ボックスに転送し、検索を開始します。
以下のパラメータを使用できます。
|
検索用語は 1 つ以上指定する必要があります。複数の検索用語は、 |
|
5件の結果を表示するプレビューを開かず、すべての検索結果を表示する大きなオーバーレイウィンドウを開きます。 |
|
最初の検索結果の記事をすぐに開きます。 |
|
たとえば、フォーラムからリンクする場合や、ユーザーガイドで検索エンジンとして検索を作成する場合など、このパラメータを元のページに指定してください。
当社の web サーバーは、クエリパラメータをログファイルに書き込みます。
このパラメータは、現在 |
原則として、検索はどのページでも機能します。
たとえば、Linux エージェントに関する英語の記事にアクセスするには、linux という用語で検索をオープンにして、次のように入力します。
https://docs.checkmk.com/latest/en/agent_linux.html?find=linux&origin=bookmarks