Search Quick Reference
Search OpenForum pages, JavaScript files, and raw file content
Key Features
- Content search across all pages
- JavaScript-specific search
- Raw file search
- Full-text search capabilities
- Search result ranking
- Link to search results
- Multiple search modes
Server-Side Usage:
<![CDATA[
// Get the Search API
var Search = js.getObject("/OpenForum/AddOn/Search","Search.sjs");
// Content search
var results = Search.contentSearch("search query");
// JavaScript search
var jsResults = Search.jsSearch("function name");
// Raw file search
var fileResults = Search.rawSearch("text in files");
// Search with options
var results = Search.search("query", {
searchType: "content",
maxResults: 50,
pageName: "/StartPage"
});
]]>
Client-Side Usage:
<![CDATA[
// Content search
JSON.get('/OpenForum/AddOn/Search/Content', null,
'query=' encodeURIComponent('search terms'))
.onSuccess(function(results) {
console.log('Search results:', results);
}).go();
// JavaScript search
JSON.get('/OpenForum/AddOn/Search/JS', null,
'query=' encodeURIComponent('function name'))
.onSuccess(function(results) {
console.log('JS search results:', results);
}).go();
// File search
JSON.get('/OpenForum/AddOn/Search/Raw', null,
'query=' encodeURIComponent('file content'))
.onSuccess(function(results) {
console.log('File results:', results);
}).go();
]]>
Search Types
- Content Search - Searches page content and rendered text
- JS Search - Searches JavaScript files (.js, .sjs)
- File Search - Searches raw file content across all attachments
Result Format
<![CDATA[
{
title: "Page Title",
link: "/PageName",
snippet: "...matching text...",
score: 0.95
}
]]>
Configuration
- Search index settings
- Maximum results per query
- Search scope (specific pages or entire wiki)
- File type filters