Change the help text for Message Templates and Scheduled Reminders to include link to CiviCRM Token Documentation page

[agileware-justin]

Overview

Change the help text for Message Templates and Scheduled Reminders to include link to CiviCRM Token Documentation page. Remove the in-line help which is superfluous.

Before

There is no link to the documentation for CiviCRM tokens. Instead end users are having to Google to find the CiviCRM documentation for tokens and hitting Stack Exchange, Forums and other sources which may not be correct.

After

There is now a link to the CiviCRM Token Documentation page, https://docs.civicrm.org/user/en/latest/common-workflows/tokens-and-mail-merge/
And this is available in multiple help contexts. Users can find the correct documentation easily.

This is what the help pop-up will look like now.

Technical Details

Added the link in the email help file which is used in Message Templates and Scheduled Reminders

Comments

Agileware Ref: CIVICRM-1734

[civibot]

(Standard links)

• If this is your first pull-request for CiviCRM, please browse CONTRIBUTING.md for information about the development and testing processes.
• If you are reviewing this pull-request, you may wish to consult the test sites and the Review Standards (long template, short template).

[demeritcowboy]

There's a known issue with {docUrl} and translation (https://lab.civicrm.org/dev/translation/-/issues/61) which makes this difficult, but in this line all translators will see is %1. There are some suggestions in that ticket for how to use docURL, although seems a bit of an open question still.

[agileware-justin]

@demeritcowboy thanks for the heads up on that core issue. Any advise on how to change this PR to be acceptable? By the way, this tokenDocs pattern was already in place, I just moved it to this help file so it could be re-used.

[demeritcowboy]

Agree it wasn't great before either. At the moment without other changes the only way to make it work I think is something like:

{capture assign=tokentext}{ts}View the CiviCRM Token Documentation{/ts}{/capture}

and then instead of <p>{ts 1=$tokenDocs}%1{/ts}</p> use <p>{docURL page="user/common-workflows/tokens-and-mail-merge" text=$tokentext}</p>

I haven't tested that - it's just thought-code.

[agileware-justin]

@demeritcowboy I'll give that a go

[agileware-justin]

@demeritcowboy tested and works fine, ready for review Mr. D.

[agileware-justin]

[demeritcowboy]

• General standards
  • [r-explain] PASS
  • [r-user] PASS
    • I'll leave this open for a few days to see if someone sees something.
  • [r-doc] PASS
  • [r-run] PASS
    • Works in all the spots.
    • To test the translation since the new text isn't translated yet I temporarily replaced the new text with the well-translated phrase "Tags (Categories)". 😁
    • There is the removal of some descriptive text but it's text that doesn't add much, like "Subject for email message" for a field already labelled "Message subject".
• Developer standards
  • [r-tech] PASS
    • Given the current issues with docURL I can't think of a better way without more changes.
  • [r-code] PASS
  • [r-maint] ?
  • [r-test] PASS

[agileware-justin]

@demeritcowboy thanks mate!