diff --git a/modules/consent/docs/consent.md b/modules/consent/docs/consent.md
index b5b71f9f14809d20a1a12675dd18f95be93b9164..886d6fcbd197b12c04c5b23975f73fcf920ae145 100644
--- a/modules/consent/docs/consent.md
+++ b/modules/consent/docs/consent.md
@@ -9,7 +9,7 @@ means it can be configured in the global config.php file or the SP remote or
IdP hosted metadata.
It is recommended to run the consent module at the IdP, and configure the
-filter to run after all attribute mangling filters is completed, to show the
+filter to run after all attribute mangling filters have completed, to show the
user the exact same attributes that are sent to the SP.
* [Read more about processing filters in SimpleSAMLphp](simplesamlphp-authproc)
@@ -19,7 +19,7 @@ How to setup the consent module
-------------------------------
In order to generate the privacy preserving hashes in the consent module, you
-need to name one attribute that always is available and that is unique to all
+need to name one attribute that is always available and that is unique to all
users. An example of such an attribute is eduPersonPrincipalName.
In your `saml20-idp-hosted.php` add the name of the user ID attribute:
@@ -30,7 +30,7 @@ If the attribute defined above is not available for a user, an error message
will be shown, and the user will not be allowed through the filter. So make
sure that you select an attribute that is available to all users.
-Next you need to enable the consent module, touch an `enable` file, in the
+Next you need to enable the consent module; touch an `enable` file, in the
consent module:
touch modules/consent/enable
@@ -80,7 +80,7 @@ Here is the initialization SQL script:
UNIQUE (hashed_user_id, service_id)
);
-The `consent:Database` backend storage has the following options
+The `consent:Database` backend storage has the following options:
`class`
: Must be set to `consent:Database`.
@@ -129,16 +129,16 @@ Example config using MySQL database:
Options
-------
-The following options can be used when configuring the Consent module
+The following options can be used when configuring the Consent module:
`includeValues`
-: Boolean value that indicate whether the values of the attributes should be
+: Boolean value that indicates whether the values of the attributes should be
used in calculating the unique hashes that identifies the consent. If
includeValues is set and the value of an attribute changes, then the
- consent becomes invalid. This option is optional and defaults to FALSE.
+ consent becomes invalid. This option is optional and defaults to FALSE.
`checked`
-: Boolean value that indicate whether the "Remember" consent checkbox is
+: Boolean value that indicates whether the "Remember" consent checkbox is
checked by default. This option is optional and defaults to FALSE.
`focus`
@@ -150,15 +150,15 @@ The following options can be used when configuring the Consent module
: Configuration of the Consent storage backend. The store option is given in
the format <module>:<class> and refers to the class
sspmod_<module>_Consent_Store_<class>. The consent module comes with two
- build in storages backends 'consent:Cookie' and 'consent:Database'. See
- separate section on setting up consent using different storage methods.
- This option is optional. If option is not set, then the user is asked to
+ built in storage backends: 'consent:Cookie' and 'consent:Database'. See
+ the separate section on setting up consent using different storage methods.
+ This option is optional. If the option is not set, then the user is asked to
consent, but the consent is not saved.
`hiddenAttributes`
: Whether the value of the attributes should be hidden. Set to an array of
- the attributes that should have it value hidden. Default behaviour is that
- all attribute values are shown
+ the attributes that should have their value hidden. Default behaviour is that
+ all attribute values are shown.
`showNoConsentAboutService`
: Whether we will show a link to more information about the service from the
@@ -167,10 +167,10 @@ The following options can be used when configuring the Consent module
External options
----------------
-The following options can be set in other places in SimpleSAMLphp
+The following options can be set in other places in SimpleSAMLphp:
`privacypolicy`
-: This is an absolute URL for where an user can find a privacy policy for SP.
+: This is an absolute URL for where a user can find a privacy policy for the SP.
If set, this will be shown on the consent page. %SPENTITYID% in the URL
will be replaced with the entityID of the service provider.
@@ -180,7 +180,7 @@ The following options can be set in other places in SimpleSAMLphp
the SP-remote metadata overrides the option in the IdP-hosted metadata.
`consent.disable`
-: Disable consent for a set of services. See section `Disabling consent`
+: Disable consent for a set of services. See section `Disabling consent`.
`userid.attribute`
: Unique identifier that is released for all users. See section `Configure
@@ -258,7 +258,7 @@ To create this function, you have to create a file named
hook_attributepresentation.php
-and place it under
+and place it under the
<module_name>/hooks
@@ -266,12 +266,12 @@ directory. To be found and called, the function must be named
<module_name>_hook_attributepresentation(&$para).
-The parameter $para is an reference to the attribute array. By manipulating
-this array you can change the way the attribute are presented to the user on
+The parameter `$para` is a reference to the attribute array. By manipulating
+this array you can change the way the attributes are presented to the user on
the consent and status page.
If you want the attributes to be listed in more than one level, you can make
-the function add a child_ prefix to the root node attribute name in a recursive
+the function add a `child_` prefix to the root node attribute name in a recursive
attribute tree.