Skip to content

Commit a3feb7d

Browse files
committed
Fix README file.
1 parent d9ecf23 commit a3feb7d

File tree

2 files changed

+19
-12
lines changed

2 files changed

+19
-12
lines changed

CHANGES.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ Changelog
44
3.3.1 (unreleased)
55
------------------
66

7+
- Fix README file.
8+
[macagua]
9+
710
- Updated Spanish translation.
811
[macagua]
912

README.rst

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -122,22 +122,22 @@ If there is an ``attachments`` field in the POST data, these files will be attac
122122
XML attachments
123123
^^^^^^^^^^^^^^^
124124

125-
An XML copy of the data can be optionally attached to the sent email by configuring the volto block's `attachXml` option.
125+
An XML copy of the data can be optionally attached to the sent email by configuring the Volto block's `attachXml` option.
126126

127-
The sent XML follows the same format as the feature in [collective.easyform](https://github.com/collective/collective.easyform). An example is shown below:
127+
The sent XML follows the same format as the feature in `collective.easyform <https://github.com/collective/collective.easyform>`_. An example is shown below:
128128

129129
```xml
130130
<?xml version='1.0' encoding='utf-8'?><form><field name="Custom field label">My value</field></form>
131131
```
132132

133-
The field names in the XML will utilise the Data ID Mapping feature if it is used. Read more about this feature in the following Store section of the documentation.
133+
The field names in the XML will use the Data ID Mapping feature if it is used. Read more about this feature in the following Store section of the documentation.
134134

135135
Acknowledgement email
136136
^^^^^^^^^^^^^^^^^^^^^
137137

138138
It is possible to also send an email to the user who filled in the form.
139139

140-
Set the 'Send to' value to include `acknowledgement` to enable this behaviour. The additional block field `acknowledgementMessage` can then be used to write the message being sent to the user and the `acknowledgementFields` block field used to choose the field that will contain the email address the acknowledgement will be sent to.
140+
Set the 'Send to' value to include `acknowledgement` to enable this behavior. The additional block field `acknowledgementMessage` can then be used to write the message being sent to the user and the `acknowledgementFields` block field used to choose the field that will contain the email address the acknowledgement will be sent to.
141141

142142
Store
143143
-----
@@ -197,10 +197,10 @@ Captcha support
197197
Captcha support requires a specific name adapter that implements ``ICaptchaSupport``.
198198
This product contains implementations for:
199199

200-
- HCaptcha (plone.formwidget.hcaptcha)
201-
- Google ReCaptcha (plone.formwidget.recaptcha)
202-
- Custom questions and answers (collective.z3cform.norobots)
203-
- Honeypot (collective.honeypot)
200+
- HCaptcha (`plone.formwidget.hcaptcha <https://github.com/plone/plone.formwidget.hcaptcha>`_)
201+
- Google ReCaptcha (`plone.formwidget.recaptcha <https://github.com/plone/plone.formwidget.recaptcha>`_).
202+
- Custom questions and answers (`collective.z3cform.norobots <https://github.com/collective/collective.z3cform.norobots>`_).
203+
- Honeypot (`collective.honeypot <https://github.com/collective/collective.honeypot>`_).
204204

205205

206206
Each implementation must be included, installed and configured separately.
@@ -229,7 +229,7 @@ Attachments upload limits
229229
Forms can have one or more attachment field to allow users to upload some files.
230230

231231
These files will be sent via mail, so it could be a good idea setting a limit to them.
232-
For example if you use Gmail as mail server, you can't send messages with attachments > 25MB.
232+
For example if you use GMail as mail server, you can't send messages with attachments > 25MB.
233233

234234
There is an environment variable that you can use to set that limit (in MB)::
235235

@@ -263,9 +263,9 @@ You can also interpolate the form values to the email subject using the field id
263263

264264

265265
Header forwarding
266-
=========================
266+
=================
267267

268-
It is possible to configure some headers from the form POST request to be included in the email's headers by configuring the `httpHeaders` field in your volto block.
268+
It is possible to configure some headers from the form POST request to be included in the email's headers by configuring the `httpHeaders` field in your Volto block.
269269

270270
[volto-formblock](https://github.com/collective/volto-form-block) allows the following headers to be forwarded:
271271

@@ -313,11 +313,15 @@ This product has been translated into
313313

314314
- Spanish
315315

316+
- Brazilian Portuguese
317+
318+
- German
319+
316320

317321
Installation
318322
============
319323

320-
Install collective.volto.formsupport by adding it to your buildout::
324+
Install ``collective.volto.formsupport`` by adding it to your buildout::
321325

322326
[buildout]
323327

0 commit comments

Comments
 (0)