Skip to content

Commit

Permalink
Include in the README.md file the action tag configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
marlycormar committed Jan 16, 2018
1 parent fb34224 commit 1871cfa
Showing 1 changed file with 18 additions and 4 deletions.
22 changes: 18 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,26 @@ A REDCap Module that allows for the addition of valid options outside of the min


## How to use
Once the module is activated on a project, you may include values outside the predefined min-max range by adding `<span>` tag with class `valid` on the *Field Note*.
Once the module is activated on a project, you may include values outside the predefined min-max range either by
1. adding a `<span>` tag with class `valid` on the *Field Note*, or by
2. adding the action tag `@EXTRA-VALID-RANGES` on the *Action Tags / Field Annotation*.

For example, if the question were something like "In which month was the subject born?" The field note could read "1-12, or 88 if unknown." Simply use the 1-12 range and decorate additional valid options in the Note like this:
For example, if the question were something like "In which month was the subject born?," simply use the 1-12 range and decorate additional valid options either in the 'Field Note' like this:

1-12, or <span class="valid">88</span> if unknown.

or in the 'Action Tags / Field Annotation':

You may include as many additional values as you need. As an illustration, the configuration below will allow the user to enter either 95 or 96 although both values are not in the preestablished range of 1-12.
@EXTRA-VALID-RANGES = "88"

1-12, or (<span class="valid">95</span> if unknown, <span class="valid">96</span> if prefer not to answer)
You may include as many additional values as you need. As an illustration, the configuration below will allow the user to add the new valid values 88, 95, 96, and 97, although none of these values are in the preestablished range of 1-12.

1-12, or (<span class="valid">88</span>,<span class="valid">95</span>, <span class="valid">96</span>, <span class="valid">97</span>)

To use the action tag instead (or in addition), you can include the following in the 'Action Tags / Field Annotation' field

@EXTRA-VALID-RANGES = "88,95-97"

Notice that you can combine ranges and fixed values as such `@EXTRA-VALID-RANGES = "88,95-97,13,15-17,24"`.

These two ways of including values outside the predefined min-max range can be used simultaneously.

0 comments on commit 1871cfa

Please sign in to comment.