This documentation provides instructions on how to use the Project Endings staticSearch Generator to provide a fully-functional search ‘engine’ to your website without any dependency on server-side code such as a database.

•  1 What does it do?
•  2 Why would I use it?
•  3 Text search features
•  4 Search facet features
•  5 Search page captions
•  6 How do I get it?
•  7 How do I use it?
  •  7.1 Configuring your site: search filters
    • 7.1.1 Description filters
      • 7.1.1.1 Sort order for description filters
    • 7.1.2 Date filters
    • 7.1.3 Number filters
    • 7.1.4 Boolean filters
    • 7.1.5 Feature filters
  •  7.2 Configuring your site: document titles
  •  7.3 Configuring your site: document sort keys
  •  7.4 Configuring your site: document thumbnails
  •  7.5 Creating a configuration file
    • 7.5.1 The config element
    • 7.5.2 Specifying parameters
      • 7.5.2.1 Required parameters
      • 7.5.2.2 Optional parameters
    • 7.5.3 Specifying rules (optional)
    • 7.5.4 Specifying contexts (optional)
    • 7.5.5 Specifying searchable contexts (search only in)
    • 7.5.6 Specifying exclusions (optional)
  •  7.6 Creating a search page
  •  7.7 Running the search build process
  •  7.8 Running staticSearch from Ant
  •  7.9 Generated report
  •  7.10 Advanced features
    • 7.10.1 Custom attributes
    • 7.10.2 Highlighting search hits on target pages
•  8 How does it work?
  •  8.1 Building the index
  •  8.2 The search page
  •  8.3 JavaScript compilation
  •  8.4 The JavaScript Initializer file
•  9 How do I...
• 10 What's new since version 1.0?
  • 10.1 Changes in version 1.4.6
  • 10.2 Changes in version 1.4.5
  • 10.3 Changes in version 1.4.4
  • 10.4 Changes in version 1.4.3
  • 10.5 Changes in version 1.4.2
  • 10.6 Changes in version 1.4.1
  • 10.7 Changes in version 1.4
  • 10.8 Changes in version 1.3
  • 10.9 Changes in version 1.1
• 11 Projects using staticSearch

• Appendix A Schema specification and tag documentation
  • Appendix A.1 Elements
    • Appendix A.1.1 <config>
    • Appendix A.1.2 <context>
    • Appendix A.1.3 <contexts>
    • Appendix A.1.4 <createContexts>
    • Appendix A.1.5 <dictionaryFile>
    • Appendix A.1.6 <exclude>
    • Appendix A.1.7 <excludes>
    • Appendix A.1.8 <indentJSON>
    • Appendix A.1.9 <kwicTruncateString>
    • Appendix A.1.10 <linkToFragmentId>
    • Appendix A.1.11 <maxKwicsToHarvest>
    • Appendix A.1.12 <maxKwicsToShow>
    • Appendix A.1.13 <minWordLength>
    • Appendix A.1.14 <outputFolder>
    • Appendix A.1.15 <params>
    • Appendix A.1.16 <phrasalSearch>
    • Appendix A.1.17 <recurse>
    • Appendix A.1.18 <resultsLimit>
    • Appendix A.1.19 <resultsPerPage>
    • Appendix A.1.20 <rule>
    • Appendix A.1.21 <rules>
    • Appendix A.1.22 <scoringAlgorithm>
    • Appendix A.1.23 <scrollToTextFragment>
    • Appendix A.1.24 <searchFile>
    • Appendix A.1.25 <stemmerFolder>
    • Appendix A.1.26 <stopwordsFile>
    • Appendix A.1.27 <totalKwicLength>
    • Appendix A.1.28 <verbose>
    • Appendix A.1.29 <versionFile>
    • Appendix A.1.30 <wildcardSearch>
  • Appendix A.2 Attribute classes
    • Appendix A.2.1 att.labelled
    • Appendix A.2.2 att.match