Extends email token documentation in emails.rst #194
Conversation
There was a problem hiding this comment.
Hi @putzwasser, quite a few changes here - I'm not sure why the linter isn't picking them up and I'm having some problems with my localhost but hopefully the feedback is sufficient!
Co-authored-by: Ruth Cheesley <[email protected]>
Co-authored-by: Ruth Cheesley <[email protected]>
Co-authored-by: Ruth Cheesley <[email protected]>
| You can replace a custom token using the events ``$event->addToken($token, $contentToReplaceToken)``. | ||
|
|
||
|
|
||
| Basic Token Replacement |
There was a problem hiding this comment.
| Basic Token Replacement | |
| Basic token replacement |
Please don't use camel case - we use sentence case in headings.
There was a problem hiding this comment.
Hey @putzwasser sorry it's taken us so long to get this over the line.
Do you think we can get the headings fixed in this file? I also fixed a camel case heading as well. Happy to make the commits myself if you haven't got the time to fix it.
| .. Note:: Extending generally works by hooking into events using event listeners or subscribers. Read more about :doc:`listeners and subscribers</plugins/event_listeners>`. | ||
|
|
||
| Email tokens | ||
| ------------ |
There was a problem hiding this comment.
| ------------ | |
| ************ |
Please use the correct headings:
H1 ###
H2 ***
H3 ===
H4 ---
H5 ~~~
This is a H2 so it should be *** not ---
| - ``$event->addToken($uniqueId, $htmlContent)`` allows you to show the Email token in the email builder, so that users can easily add the token to their emails. | ||
| - ``$event->getContent()`` and ``$event->setContent()`` are used for replacing the Email token with actual Dynamic Content once the Email gets send or viewed in the browser. | ||
| Registering custom tokens in builders | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
There was a problem hiding this comment.
See earlier comment about headings. This should be a H3 if you want it to be nested under the H2 above.
| You can either hard code your tokens textual description in ``$htmlContent`` or use a translatable string. | ||
|
|
||
| Rendering custom tokens | ||
| ~~~~~~~~~~~~~~~~~~~~~~~ |
|
|
||
|
|
||
| Basic Token Replacement | ||
| ^^^^^^^ |
There was a problem hiding this comment.
Heading also needs fixing here please.
|
|
||
|
|
||
| Email A/B testing | ||
| ----------------- |
There was a problem hiding this comment.
Heading nesting needs fixing here too, I think perhaps it should be an H2 heading?
|
|
||
| While Mautic supports :xref:`A/B testing` out of the box, you might have more complex needs to determine A/B test winner criteria. | ||
|
|
||
| - ``$event->addAbTestWinnerCriteria()`` allows you to do exactly that. Using your custom logic, you can decide the winner of such criteria. An example is shown below. | ||
| - ``$event->setAbTestResults()`` is where you set the actual A/B test results. More details are in the code example below. | ||
|
|
||
| A/B Testing Example | ||
| ^^^^^^^ |
There was a problem hiding this comment.
Heading nesting needs fixing, and it must reach the end of the text for the heading.
No description provided.