config.json

{
    "name": "Record Home Tweaks",
    "description": "Tweaks for the display and organization of events and instruments on the record home page",
    "namespace": "UWMadison\\RecordHomeTweaks",
    "authors": [
        {
            "name": "Adam Nunez",
            "email": "Adam.Nunez@ctri.wisc.edu",
            "institution": "UW Madison - Center for Tobacco Research and Intervention"
        }
    ],
    "framework-version": 14,
    "project-settings": [
        {
            "key": "record-alert",
            "name": "<b>Record Home Alert</b><br>Displays at the top of the record home. Useful for FYIs on new instruments or recent changes",
            "type": "textarea"
        },
        {
            "key": "align-th-top",
            "name": "Align table headers to top of cell",
            "type": "checkbox"
        },
        {
            "key": "align-th-center",
            "name": "Align table headers to center of cell",
            "type": "checkbox"
        },
        {
            "key": "th-nowrap",
            "name": "Prevent wrapping of event names in table headers",
            "type": "checkbox"
        },
        {
            "key": "remove-collapse",
            "name": "Remove the table collapse button",
            "type": "checkbox"
        },
        {
            "key": "align-img-center",
            "name": "Always align instrument buttons to center",
            "type": "checkbox"
        },
        {
            "key": "system-management-event",
            "name": "<b>Move event to seperate table:</b><br>Useful to denote a \"System Managment\" event that doesn't represent a visit",
            "type": "event-list"
        },
        {
            "key": "hide-form-row",
            "name": "<b>Form to hide</b>",
            "type": "form-list",
            "repeatable": true
        },
        {
            "key": "hide-event",
            "name": "<b>Event to Hide</b>",
            "type": "event-list",
            "repeatable": true
        },
        {
            "key": "stop-nav-instrument",
            "name": "<b>Form to Block Navigation to</b><br>and redirect to record home",
            "type": "form-list",
            "repeatable": true
        },
        {
            "key": "hide-repeating-table",
            "name": "<b>Repeating instrument table to hide</b>",
            "type": "form-list",
            "repeatable": true
        },
        {
            "key": "full-size-repeating-table",
            "name": "<b>Repeating instrument table to show at full width</b><br>Prevents wrapping of text to next line",
            "type": "form-list",
            "repeatable": true
        },
        {
            "key": "scheduled-description",
            "name": "<b>Scheduled Event Highlighting</b><br>Below you may define a scheduled date field that contains the day an event is scheduled for. On that day the event will be highlighted to draw attention to it and direct end users to enter data on the correct event.",
            "type": "descriptive"
        },
        {
            "key": "scheduled-date",
            "name": "<b>Scheduled Date</b>",
            "type": "field-list"
        },
        {
            "key": "scheduled-date-event",
            "name": "<b>Event</b>",
            "type": "event-list",
            "repeatable": true
        },
        {
            "key": "window-description",
            "name": "<b>In-Window Event Highlighting</b><br>Similar to the above, you may define a start date field and end date field that that describe the valiid 'within window' period for an event. On those days the event will be highlighted to draw attention to it and direct end users to enter data on the correct event.",
            "type": "descriptive"
        },
        {
            "key": "scheduled-range-start",
            "name": "<b>Start Range Date</b>",
            "type": "field-list"
        },
        {
            "key": "scheduled-range-end",
            "name": "<b>End Range Date</b>",
            "type": "field-list"
        },
        {
            "key": "scheduled-range-event",
            "name": "<b>Event</b>",
            "type": "event-list",
            "repeatable": true
        },
        {
            "key": "event-tabs-description",
            "name": "<b>Event Group Tabs</b><br>Below you may define any number of tabs that group events together. The first tab will be the default shown when navigating to the Record Home page. If you'd like to ensure that data is only entered sequentially on tabs (e.g. each tab represents an opt-in trial by the subject) you can hide a group of tabs by specifing a text to use on the \"Add tab\" button (e.g. Start New Trial). You only should specify this text on the first tab of the group.",
            "type": "descriptive"
        },
        {
            "key": "event-tabs",
            "name": "<b>Event Group Tab</b>",
            "type": "sub_settings",
            "repeatable": true,
            "sub_settings": [
                {
                    "key": "tab-name",
                    "name": "<b>Tab Name</b>",
                    "type": "text"
                },
                {
                    "key": "tab-button",
                    "name": "<b>Hide by default?</b><br>Specify the \"Add tab\" button text",
                    "type": "text"
                },
                {
                    "key": "tab-logic",
                    "name": "<b>Branching Logic</b><br>Show this tab, or it's associted button, only if truthy",
                    "type": "text"
                },
                {
                    "key": "tab-event",
                    "name": "<b>Include Event</b>",
                    "type": "event-list",
                    "repeatable": true
                }
            ]
        }
    ],
    "compatibility": {
        "redcap-version-min": "13.7.0"
    }
}