From ad72bf961ebac40e586a2fbfcf1cf89c3720d410 Mon Sep 17 00:00:00 2001 From: Neil van Beinum Date: Thu, 1 Dec 2016 11:40:14 +0000 Subject: [PATCH] Add note to survey readme about taxonomy detection --- doc/surveys.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/doc/surveys.md b/doc/surveys.md index 6de9d4e57..6aff0ebf9 100644 --- a/doc/surveys.md +++ b/doc/surveys.md @@ -56,7 +56,22 @@ A callback function returning true or false allowing further scoping of when the In the example above, the survey will only be considered "active" on pages with a section of "education and learning", and will not display on pages where this function evaluates to false. -Not providing this argument has the same effect as setting it to `return true`. The survey will therefore apply to all pages on GOV.UK between `startTime` and `endTime`. +Additional examples of functions which control when a survey should be active based on the current path and organisation: + +```javascript +function pathMatches() { + var pathMatchingExpr = /\/foreign-travel-advice|\/government\/world/; + return pathMatchingExpr.test(currentPath()); +} + +function organisationMatches() { + var orgMatchingExpr = /|||/; + var metaText = $('meta[name="govuk:analytics:organisations"]').attr('content') || ""; + return orgMatchingExpr.test(metaText); +} +``` + +Not providing the `activeWhen` argument has the same effect as setting it to `return true`. The survey will therefore apply to all pages on GOV.UK between `startTime` and `endTime`. ### `startTime` and `endTime` The survey will only be considered "active" between these dates and times. Where an explicit time is not provided (e.g. startTime) note that JavaScript will assume 00:00:00.000 i.e. just after midnight.