WebWorks Help 5.0 Favorites Persistence
If you would like additional control over how favorites are persisted in WebWorks Help 5.0 output generated with ePublisher 9.2.2, then you will want this override (to be made a standard part of the next release).
Overview
This override creates 2 additional "Format Settings" called:
- wwhelp-cookies-id
- Settable unique id that allows content to be republished from scratch without concern about existing "Favorites" entries getting lost in your current user's browsers. Set this id to a unique value using the following recommended rules:
- any combination of the characters [A-Z], [0-9], [._-]
- cookie names are case-insensitive, so don't mix case
cookie names starting with "$" are reservered
- limit number of characters to 32, although there is no published size limit.
- use a naming/versioning scheme to handle cases where significant content changes have occurred. Here are a few examples:
- epublisher-help-9.2
- epublisher-help-10.0
<product name>-<manual name>-<version number>
- wwhelp-cookies-daystoexpire
- Settable parameter for the allowed number of days until the stored Favorites of your users is automatically cleared. You can set this to a really large value, if you never want it to expire.
Usage
Important
To prevent your Favorites from ever getting lost in your user's browsers, make sure to set the wwhelp-cookies-id to a specific value (not Automatic), especially if you are not using an Express project to make your publication.
Note: Localized versions will be made available in the next release and this override can then be retired.
Files to Override
Formats/WebWorks Help 5.0/Transforms/wwhelp_settings.fti Formats/WebWorks Help 5.0/Transforms/wwhelp_settings.xsl
Diff Reports