Unverified Commit 4110953d authored by Rich Lott's avatar Rich Lott Committed by GitHub
Browse files

Update README.md

parent c56a062b
......@@ -41,11 +41,22 @@ it with the command-line tool [cv](https://github.com/civicrm/cv).
git clone https://github.com/civicrm/org.civicrm.mosaicomsgtpl.git
cv en mosaicomsgtpl
```
## Usage
## Normal Usage
Simply enable the module. All ordinary tasks should be handled automatically.
CiviCRM Message Templates have both a *name* and an email *subject*, but Mosaico templates do not have a subject. By default the name of the Mosaico template will be used for both the message template name and also its subject. This might or might not be appropriate to your use case.
As a work-around, you can use the format `title | subject` to specify your Mosaico template name. e.g.
| Mosaico Template Title | Message Template Title | Email subject |
| ----------------------------------------- |--------------------------| ------------------|
| Welcome supporter | Welcome supporter | Welcome supporter |
| Thanks - existing donors \| Well hi there | Thanks - existing donors | Well hi there |
## API Usage
System administrators and developers may wish to use the synchronization API:
* Synchronize all templates: `cv api Job.mosaico_msg_sync`
......@@ -56,3 +67,4 @@ System administrators and developers may wish to use the synchronization API:
* Synchronization is one-way. To make changes, you should only use the Mosaico template editor.
* When you load a Mosaico template into a richtext editor (such as CKEditor or TinyMCE), you should tred
carefully: only make small changes to the text. Changing the layout in a substantive way would be difficult.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment