uccser/cs-field-guide

# Regular Expression Search Interactive

**Author:** Jack Morgan

This interactive allows the user to search text with a regular expression. The interactive highlights any matches that are found.

## Usage

The interactive has several optional parameters:

1. Starting regular expression - `regex=ca?t`
2. Starting text to search - `text=Hi there everyone!` (Use `%0A` for new line characters)
3. Start with the quick reference already opened - `reference=true`

The interactive opens by default with a blank regular expression, practice text (used for first example in textbook), with the quick reference closed.

## Third Party Libraries

- [CodeMirror](https://codemirror.net/)

The licence for CodeMirror is listed in `LICENCE-THIRD-PARTY` with a full copy available in the `third-party-licences` directory

The source file `static/js/codemirror-mode-regex.js` is based on [codemirror-mode-regex](https://gist.github.com/douglasduteil/5089187) by [douglasduteil](https://github.com/douglasduteil)

## Required Files

The interactive loads from a base website template which includes a JavaScript file containing jQuery, Bootstrap, and a few other utilities and polyfills.
See `static/js/website.js` for a full list.