projectEndings/staticSearch: v1.3.0 (Production Release)

Note that version 1.2 was withdrawn in favour of version 1.3, so the list below includes changes from the original version 1.2 and the current 1.3.

Deprecations requiring changes to existing projects:

All staticSearch classes with periods have been deprecated in favour of underscores as periods in class names conflict with the standard "." chaining selector in CSS and JavaScript. (See issue 149 for the full discussion.) This affects the majority of staticSearch meta classes, which should be changed from staticSearch. to staticSearch_; see the full list below:

For version 1.3, using the deprecated period syntax will result in WARNINGs; in all subsequent versions, using the period syntax will result in build failures.

The original parameters config and configFile have been renamed ssConfig and ssConfigFile to minimize the chances of naming collisions with parameters in other build processes. IF YOU HAVE SCRIPTED A staticSearch BUILD AS PART OF YOUR OWN BUILD PROCESS, YOU WILL NEED TO UPDATE THESE PARAMETER NAMES.

New features and enhancements:

• The JavaScript source code has now been split into several distinct source files, and is compiled and optimized using the Google Closure Compiler at build time. See JavaScript compilation for more information.
• Support for French in captions etc. in the search page has been improved.
• A French stemmer is now available, as well as a caption set for French search pages.
• Images can now be configured for specific parts of a document, as well as for the whole document, for display alongside KWICs in results. This is part of a new extension mechanism using custom attributes.
• The CSS for the search page by the indexing process is now more easily accessible in a separate file css/ssSearch.css, which is linked into the search page at build time.
• Links to target documents from keyword-in-context results now include a search string parameter that specifies the hit text, so that JavaScript running in the target page can highlight the search hit(s) and scroll to them. See Highlighting search hits on target pages for more information.
• Documentation has been significantly improved with additional explanatory remarks for many elements, and the staticSearch build of the documentation now includes hit highlighting (the feature described above).
• Only ancestor ids are indexed when <linkToFragmentId> is enabled; formerly, any preceding id value was used.
• Results can now optionally be viewed in batches by setting the new <resultsPerPage> configuration option.
• The maximum number of results that a search can return has been set to 2000 results by default and can be changed using the new <resultsLimit> element. If a search returns a set of results that exceeds this limit, staticSearch does not render the results and advises the user to try a more precise search.
• The minimum length of a word to be indexed is now configurable, so in unusual circumstances you can now enable searching for 1- or 2-letter words using the <minWordLength> parameter.
• The staticSearch report is now discussed in the documentation (see 7.8 Generated report) and the "Not in Dictionary" and "Foreign Words" reports have been improved.
• The filter creation process has been rationalized such that all filter processing happens in json.xsl, which has also improved the build performance slightly.

Bug fixes:

• The encoding structure for docImage, docSortKey, and docTitle has been constrained such that each doc* <meta> must include both a @name and @class value:

<meta name="docTitle" class="staticSearch_docTitle" content="My custom document title"/>

• Temporary XML files from dictionaries are now removed during the clean step of the build process.

• All HTML characters are properly escaped in context snippets.