# Instructions on applying the feed patch for WET-BOEW and related themes

This patch updates the WET feed plugin to read JSON ATOM like feed instead of reading jsonp by default.

Skip to the instructions on how to apply this fix/patch

After this patch is applied following the instructions bellow, it might break existing jsonp WET feed implementations, since it's been changed to JSON format by default. We have estimated that there is only a few or no existing implementation of WET feed plugin that are using jsonp format. Also, it was only documented if someone has reverse engineered the WET feed plugin Javascript code.

This applies for all WET-BOEW implementations, including released themes between version 4.0.21 and 4.0.29. Consult the full list.

## This fix formalizes the following versions:

- v4.0.29.1 - Web Experience Toolkit (WET)
- v4.0.29.1 - Canada.ca (GCWeb)
- v4.0.28.2 - Web Experience Toolkit (WET)
- v4.0.28.2 - Canada.ca (GCWeb)
- v4.0.27.1 - Web Experience Toolkit (WET)
- v4.0.27.1 - Base
- v4.0.27.1 - Canada.ca
- v4.0.27.1 - Government of Canada Web Usability
- v4.0.27.1 - Government of Canada Intranet
- v4.0.27.1 - Open Government Platform (OGPL)
- v4.0.26.1 - Web Experience Toolkit (WET)
- v4.0.26.1 - Base
- v4.0.26.1 - Canada.ca
- v4.0.26.1 - Government of Canada Web Usability
- v4.0.26.1 - Government of Canada Intranet
- v4.0.26.1 - Open Government Platform (OGPL)
- v4.0.25.1 - Web Experience Toolkit (WET)
- v4.0.25.1 - Base
- v4.0.25.1 - Canada.ca
- v4.0.25.1 - Government of Canada Web Usability
- v4.0.25.1 - Government of Canada Intranet
- v4.0.25.1 - Open Government Platform (OGPL)
- v4.0.24.1 - Web Experience Toolkit (WET)
- v4.0.24.1 - Base
- v4.0.24.1 - Canada.ca
- v4.0.24.1 - Government of Canada Web Usability
- v4.0.24.1 - Government of Canada Intranet
- v4.0.24.1 - Open Government Platform (OGPL)
- v4.0.23.1 - Web Experience Toolkit (WET)
- v4.0.23.1 - Base
- v4.0.23.1 - Canada.ca
- v4.0.23.1 - Government of Canada Web Usability
- v4.0.23.1 - Government of Canada Intranet
- v4.0.23.1 - Open Government Platform (OGPL)
- v4.0.22.1 - Web Experience Toolkit (WET)
- v4.0.22.1 - Base
- v4.0.22.1 - Canada.ca
- v4.0.22.1 - Government of Canada Web Usability
- v4.0.22.1 - Government of Canada Intranet
- v4.0.22.1 - Open Government Platform (OGPL)
- v4.0.21.1 - Web Experience Toolkit (WET)
- v4.0.21.1 - Base
- v4.0.21.1 - Canada.ca
- v4.0.21.1 - Government of Canada Web Usability
- v4.0.21.1 - Government of Canada Intranet
- v4.0.21.1 - Open Government Platform (OGPL)

## Patch instructions

To apply the patch, you need to update the following files:

- wet-boew/js/wet-boew.js
- wet-boew/js/wet-boew.min.js
- js/wet-boew.js
- js/wet-boew.min.js

Note: Depending on your implementation, you may only have two files to change. For technical reasons, the build of WET-BOEW contains duplicate build files in two different locations.

### Steps

1. Download the .zip file with all the patched WET-BOEW versions.
2. Extract the .zip file.
3. Choose the WET-BOEW version applicable to your implementation.
4. Replace the corresponding `wet-boew.js` and `wet-boew.min.js` files.
5. Modify your page's code to use the JSON Atom-like feed version.

### Markup changes

In order to use the JSON Atom-like feeds, you need to specify the URL of the JSON Atom-like feeds.

1. Add an attribute `data-ajax` to your feed link.
2. Set the value to an URL where you can retrieve the JSON Atom-like feed.
3. Test your page.

The JSON feed specified by the attribute `data-ajax` would be used before the URL specified in the `href` attribute.

#### Code before

    <li>
    	<a href="demo/manitoba-en.atom.xml">Canada News Centre - Manitoba</a>
    </li>

#### Code after

    <li>
    	<a data-ajax="demo/manitoba-en.atom.json" href="demo/manitoba-en.atom.xml">Canada News Centre - Manitoba</a>
    </li>

### Apply the patch manually

1. Edit the `wet-boew.js`.
2. Apply changes as described for `feed.js` file in the commit 8eb8c25d.
3. Minify the `wet-boew.js` and replace the file `wet-boew.min.js`.
4. Modify your page's code to use the JSON Atom-like feed version.

## Patch the following release:

- v4.0.29 - Web Experience Toolkit (WET)
- v4.0.29 - Canada.ca (GCWeb)
- v4.0.28.1 - Web Experience Toolkit (WET)
- v4.0.28.1 - Canada.ca (GCWeb)
- v4.0.27 - Web Experience Toolkit (WET)
- v4.0.27 - Base
- v4.0.27 - Canada.ca
- v4.0.27 - Government of Canada Web Usability
- v4.0.27 - Government of Canada Intranet
- v4.0.27 - Open Government Platform (OGPL)
- v4.0.26 - Web Experience Toolkit (WET)
- v4.0.26 - Base
- v4.0.26 - Canada.ca
- v4.0.26 - Government of Canada Web Usability
- v4.0.26 - Government of Canada Intranet
- v4.0.26 - Open Government Platform (OGPL)
- v4.0.25 - Web Experience Toolkit (WET)
- v4.0.25 - Base
- v4.0.25 - Canada.ca
- v4.0.25 - Government of Canada Web Usability
- v4.0.25 - Government of Canada Intranet
- v4.0.25 - Open Government Platform (OGPL)
- v4.0.24 - Web Experience Toolkit (WET)
- v4.0.24 - Base
- v4.0.24 - Canada.ca
- v4.0.24 - Government of Canada Web Usability
- v4.0.24 - Government of Canada Intranet
- v4.0.24 - Open Government Platform (OGPL)
- v4.0.23 - Web Experience Toolkit (WET)
- v4.0.23 - Base
- v4.0.23 - Canada.ca
- v4.0.23 - Government of Canada Web Usability
- v4.0.23 - Government of Canada Intranet
- v4.0.23 - Open Government Platform (OGPL)
- v4.0.22 - Web Experience Toolkit (WET)
- v4.0.22 - Base
- v4.0.22 - Canada.ca
- v4.0.22 - Government of Canada Web Usability
- v4.0.22 - Government of Canada Intranet
- v4.0.22 - Open Government Platform (OGPL)
- v4.0.21 - Web Experience Toolkit (WET)
- v4.0.21 - Base
- v4.0.21 - Canada.ca
- v4.0.21 - Government of Canada Web Usability
- v4.0.21 - Government of Canada Intranet
- v4.0.21 - Open Government Platform (OGPL)

Date modified:
  2019-01-15