Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Proofread documentation #7

Merged
merged 2 commits into from
Feb 4, 2020
Merged

Proofread documentation #7

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c621b26
Amend spelling in documentation
mmonfils Nov 6, 2018
a55001c
Remove "s" in instances of "informations"
mmonfils Nov 6, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions DOCUMENTATION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Argument | Description

## Data format for `email`, `cc` and `bcc`

You can use any email notation an email client would understand, you can even use multiple addresses seperated by comma.
You can use any email notation an email client would understand, you can even use multiple addresses separated by comma.

```
{{ mailto_link email="[email protected]" display="Get in Touch" }}
Expand Down Expand Up @@ -51,10 +51,10 @@ contact: "[email protected]"

### Multiple email addresses

If you have a list of email addresses you can loop over them like you would normaly do.
If you have a list of email addresses you can loop over them like you would normally do.

```.language-yaml
contacts:
contacts:
- "[email protected]"
- "[email protected]"
```
Expand Down Expand Up @@ -162,7 +162,7 @@ contact:
cc: "John Bacon <[email protected]>"
bcc: "Eliah Bacon <[email protected]>"
subject: "Interest in Bacon"
body: "Don't forget to add your contact informations :)"
body: "Don't forget to add your contact information :)"
display: "Get in Touch"
```

Expand All @@ -172,7 +172,7 @@ contact:
```

```.language-output
<a href="mailto:Jane Bacon <[email protected]>?cc=John Bacon <[email protected]>&bcc=Eliah Bacon <[email protected]>&subject=Interest in Bacon&body=Don't forget to add your contact informations :)" class="link email-link">Get in Touch</a>
<a href="mailto:Jane Bacon <[email protected]>?cc=John Bacon <[email protected]>&bcc=Eliah Bacon <[email protected]>&subject=Interest in Bacon&body=Don't forget to add your contact information :)" class="link email-link">Get in Touch</a>
```

## The modifier
Expand Down Expand Up @@ -202,7 +202,7 @@ contact:
cc: "John Bacon <[email protected]>"
bcc: "Eliah Bacon <[email protected]>"
subject: "Interest in Bacon"
body: "Don't forget to add your contact informations :)"
body: "Don't forget to add your contact information :)"
display: "Get in Touch"
```

Expand All @@ -212,7 +212,7 @@ contact:
```

```.language-output
<a href="mailto:Jane Bacon <[email protected]>?cc=John Bacon <[email protected]>&bcc=Eliah Bacon <[email protected]>&subject=Interest in Bacon&body=Don't forget to add your contact informations :)">Get in Touch</a>
<a href="mailto:Jane Bacon <[email protected]>?cc=John Bacon <[email protected]>&bcc=Eliah Bacon <[email protected]>&subject=Interest in Bacon&body=Don't forget to add your contact information :)">Get in Touch</a>
```

## The API
Expand All @@ -224,7 +224,7 @@ In another addon, you may do `$this->api('MailtoLink')->create()` to get a `Mail

/**
* MailtoLinkModel constructor.
*
*
* @param array $parameters
*/
$mailto = $this->api('MailtoLink')->create()
Expand All @@ -236,7 +236,7 @@ $mailto->email = "Jane Bacon <[email protected]>";
$mailto->cc = "John Bacon <[email protected]>";
$mailto->bcc = "Eliah Bacon <[email protected]>";
$mailto->subject = "Interest in Bacon";
$mailto->body = "Don't forget to add your contact informations :)";
$mailto->body = "Don't forget to add your contact information :)";
$mailto->display = "Get in Touch";

/**
Expand All @@ -253,7 +253,7 @@ echo $mailto->html();
```

```.language-output
<a href="mailto:Jane Bacon <[email protected]>?cc=John Bacon <[email protected]>&bcc=Eliah Bacon <[email protected]>&subject=Interest in Bacon&body=Don't forget to add your contact informations :)">Get in Touch</a>
<a href="mailto:Jane Bacon <[email protected]>?cc=John Bacon <[email protected]>&bcc=Eliah Bacon <[email protected]>&subject=Interest in Bacon&body=Don't forget to add your contact information :)">Get in Touch</a>
```

## Migrating from Version 1
Expand Down