Because the documentation for Omni can be viewed both online and on your local disk, we wanted it to be searchable through various means while still keeping the documentation similar across mediums. To achieve this, the search functionality included with this documentation is a basic JavaScript search engine that scans the help files for the terms specified.

The search is a basic case-insensitive OR search, so if you did a search for Omni delegate, any text found that contains either Omni or delegate will be considered a match. If you wish to do an AND type search, simply enclose the term in quotes, e.g. "Omni delegate" would match only text that contains Omni followed by a space then followed by delegate (again, case does not matter). You can mix these patterns as well, so a search for "Omni library" delegate constructor will find text that matches the whole Omni library string OR text that matches delegate OR constructor.

The search is a simple engine to help keep documentation maintenance down, as well, if you are viewing this online, it is more efficient to use your preferred search engine and append its site specific tag to do the search. For example, if you used Google or DuckDuckGo, you could enter the following search term: Omni delegate site:zeriph.com/omni/ to use their engine and semantics to search the documentation. Similarly, if you are viewing this documentation on disk and have access to the .html files themselves (or you have JavaScript disabled for file:// acccess), you could use a tool like FIND or grep to search through the files more precisely and efficiently than an offline JavaScript-based search.

The maximum number of results returned is 50 by default. This value can be changed in the search.js file if you wish to see more by changing the global variable maxResults (at the top of the file) to whatever you wish. This number is hard coded to reduce the time taken to display results by updating the HTML DOM via the JavaScript search.

If you might have any questions or concerns about searching or using the documentation, feel free to contact the Omni Q&A email.