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 How do I get it?
•  6 How do I use it?
  •  6.1 Configuring your site: search filters
    • 6.1.1 Description filters
      • 6.1.1.1 Sort order for description filters
    • 6.1.2 Date filters
    • 6.1.3 Number filters
    • 6.1.4 Boolean filters
  •  6.2 Configuring your site: document titles
  •  6.3 Configuring your site: document sort keys
  •  6.4 Configuring your site: document thumbnails
  •  6.5 Creating a configuration file
    • 6.5.1 Specifying parameters
      • 6.5.1.1 Required parameters
      • 6.5.1.2 Optional parameters
    • 6.5.2 Specifying rules (optional)
    • 6.5.3 Specifying contexts (optional)
    • 6.5.4 Specifying exclusions (optional)
  •  6.6 Creating a search page
  •  6.7 Running the search build process
•  7 How does it work?
  •  7.1 Building the index
  •  7.2 The search page
•  8 How do I...
•  9 What's new since version 1.0?
  •  9.1 Changes in version 1.1
• 10 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 <outputFolder>
    • Appendix A.1.14 <params>
    • Appendix A.1.15 <phrasalSearch>
    • Appendix A.1.16 <recurse>
    • Appendix A.1.17 <rule>
    • Appendix A.1.18 <rules>
    • Appendix A.1.19 <scoringAlgorithm>
    • Appendix A.1.20 <scrollToTextFragment>
    • Appendix A.1.21 <searchFile>
    • Appendix A.1.22 <stemmerFolder>
    • Appendix A.1.23 <stopwordsFile>
    • Appendix A.1.24 <totalKwicLength>
    • Appendix A.1.25 <verbose>
    • Appendix A.1.26 <versionFile>
    • Appendix A.1.27 <wildcardSearch>
  • Appendix A.2 Attribute classes
    • Appendix A.2.1 att.labelled
    • Appendix A.2.2 att.match