Summary

Generates a JavaScript-based search index from the input documents.

Assembly

Wyam.SearchIndex.dll

Namespace

Wyam.SearchIndex

Interfaces

IModule

Base Types

Object

graph BT Type-->Base0["Object"] Type-.->Interface0["IModule"] click Interface0 "/api/Wyam.Common.Modules/IModule" Type["SearchIndex"] class Type type-node

Syntax

public class SearchIndex : IModule

Examples

The client-side JavaScript code for importing the search index should look something like this (assuming you have an HTML input with an ID of #search and a div with an ID of #search-results):

 function runSearch(query) {
     $("#search-results").empty();
     if (query.length < 2)
     {
         return;
     }
     var results = searchModule.search(query);
     var listHtml = "<ul>";
     listHtml += "<li><strong>Search Results</strong></li>";
     if (results.length == 0)
     {
         listHtml += "<li>No results found</li>";
     }
     else
     {
         for (var i = 0; i < results.length; ++i)
         {
             var res = results[i];
             listHtml += "<li><a href='" + res.url + "'>" + res.title + "</a></li>";
         }
     }
     listHtml += "</ul>";
     $("#search-results").append(listHtml);
 }

 $(document).ready(function() {
     $("#search").on('input propertychange paste', function() {
         runSearch($("#search").val());
     });
 });

Remarks

This module generates a search index that can be imported into the JavaScript Lunr.js search engine. Each input document should either specify the SearchIndexItem metadata key or a delegate that returns a SearchIndexItem instance.

Constructors

Name	Summary
SearchIndex(DocumentConfig, FilePath, bool)	Creates the search index by using a delegate that returns a `SearchIndexItem` instance for each input document.
SearchIndex(FilePath, bool)	Creates the search index by looking for a `SearchIndexItem` metadata key in each input document that contains a `SearchIndexItem` instance.
SearchIndex(string, FilePath, bool)	Creates the search index by looking for a specified metadata key in each input document that contains a `SearchIndexItem` instance.

Methods