Skip to content

Commit 9edf246

Browse files
committed
email pattern doc (incomplete)
1 parent e7de444 commit 9edf246

File tree

4 files changed

+45
-2
lines changed

4 files changed

+45
-2
lines changed

_includes/nav_userdoc_emails.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,9 @@ <h4 {% if include.selected == 'emails' %}class="selected"{% endif %}>
3232
<li {% if include.selected == 'email_patterns' %}class="selected"{% endif %}>
3333
<a href="{{site.baseurl}}/userdoc/emails/email_patterns">Email Patterns</a>
3434
</li>
35+
<li {% if include.selected == 'displaying_files' %}class="selected"{% endif %}>
36+
<a href="{{site.baseurl}}/userdoc/emails/displaying_files/">Displaying files</a>
37+
</li>
3538
<li>
3639
<div {% if include.selected == 'swift_mailer_module' %}class="selected"{% endif %}>
3740
<a href="{{site.baseurl}}/userdoc/emails/swift_mailer_module">The Swift Mailer module</a>
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
layout: default
3+
navPage: docs
4+
heading: Email Patterns
5+
breadcrumbs:
6+
- User Documentation,/userdoc/
7+
- Emails,/userdoc/emails
8+
- Email Patterns
9+
prev: Email Patterns,/userdoc/emails/email_patterns/
10+
next: The Swift Mailer module,/userdoc/emails/swift_mailer_module/
11+
categories: userdoc
12+
tags: emails
13+
---
14+
15+
{% include open_section.html nav='nav_userdoc_emails.html' selected='displaying_files' %}
16+
17+
<p>
18+
If your form contains file upload fields, you may notice the email contain a line like this for the file
19+
upload field:
20+
</p>
21+
22+
{% codemirror smarty %}
23+
{display_files format="html" files=$FILENAMES_field1 folder=$FOLDERURL_field1}
24+
{% endcodemirror %}
25+
26+
<p>
27+
Here's what's going on. The <code>{display_files}</code> function handles displaying the contents of your file
28+
upload field. With the File Upload module v2.1 each field can contain multiple files, so that method
29+
</p>
30+
31+
<ul>
32+
<li><code>format</code>: this option governs how the file"html" or "text".</li>
33+
<li><code>files</code>: this is the list of </li>
34+
<li><code>folder</code>: this is the list of </li>
35+
<li><code>delim</code>: whatever you want to delimit the list of items with. For HTML, you'll probably want
36+
`, ` or `<br />`.
37+
</li>
38+
</ul>
39+
40+
{% include close_section.html %}

userdoc/emails/email_patterns.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
- Emails,/userdoc/emails
88
- Email Patterns
99
prev: Reference Tab,/userdoc/emails/emails_reference_tab/
10-
next: The Swift Mailer module,/userdoc/emails/swift_mailer_module/
10+
next: Displaying files,/userdoc/emails/displaying_files/
1111
categories: userdoc
1212
tags: emails
1313
---

userdoc/emails/swift_mailer_module.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
- User Documentation,/userdoc/
77
- Emails,/userdoc/emails
88
- Swift Mailer
9-
prev: Email Patterns,/userdoc/emails/email_patterns/
9+
prev: Displaying files,/userdoc/emails/displaying_files/
1010
next: File Attachments,/userdoc/emails/file_attachments/
1111
categories: userdoc,modules
1212
tags: emails

0 commit comments

Comments
 (0)