Skip to content

Latest commit

 

History

History
27 lines (19 loc) · 1.44 KB

README.md

File metadata and controls

27 lines (19 loc) · 1.44 KB
Raw

REDCap Field Notes Display

Provides alternative display modes for field notes. A display mode can be specified by setting @FIELD-NOTES-DISPLAY action tag.

Prerequisites

Installation

  • Clone this repo into to <redcap-root>/modules/field_notes_display_v1.0.
  • Go to Control Center > Manage External Modules and enable Field Notes Display.
  • For each project you want to use this module, go to the project home page, click on Manage External Modules link, and then enable Field Notes Display for that project.

@FIELD-NOTES-DISPLAY action tag

This action tag accepts the following inputs:

  • hover: Displays the text when the field is hovered over.
  • tooltip: Places a help icon, which displays the text in a tooltip when hovered over.
  • popover: Places a help icon, which displays the text in a popover when clicked.

How to use

Instead of showing the entire field name next to the field, the field_note can be hovered over the field name.

Example:

Add the following syntax in the Action tags field, then the field_note is hidden from the view and it is shown on hover over the field name.

@FIELD-NOTES-DISPLAY="hover"

And similarly, if it is required to show the field_note only on the tooltip or popover, use @FIELD-NOTES-DISPLAY="tooltip" or @FILED-NOTES-DISPLAY="popover" respectively.