config.json

{
	"name": "FAQ Builder",

	"namespace": "Vanderbilt\\FaqMenuExternalModule",
	"framework-version": 5,
	"authors": [
		{
			"name": "Eva Bascompte Moragas",
			"email": "datacore@vumc.org",
			"institution": "Vanderbilt University Medical Center"
		}
	],

	"permissions": [],

	"links": {
		"project": [
			{
				"name": "FAQ Builder",
				"icon": "blog_blue",
				"target": "_blank",
				"url": "configure.php?NOAUTH"
			}
		]
	},

	"no-auth-pages":["configure","downloadFile","data_dictionary_upload","functions","download_PDF"],

	"description": "Creates a searchable single-page list of questions and their answers in the style of an FAQ (frequently asked questions) page. This module requires a specific data dictionary for the REDCap project (provided by module). Each question and answer pair is stored in a separate record within the project.",

	"project-settings": [
		{
			"key": "faq-btn",
			"name": "When setting up <strong>FAQ Builder</strong> for the first time,<br> click the button to install the required data dictionary",
			"type": "button",
			"url":
				{
					"name": "Install Data Dictionary",
					"value": "data_dictionary_upload.php?configure"
				}

		},
		{
			"key": "faq-favicon",
			"name": "Favicon for the page",
			"type": "file"
		},
		{
			"key": "faq-title-tab",
			"name": "Tab title",
			"type": "text"
		},
		{
			"key": "faq-logo",
			"name": "Logo for the page",
			"type": "file"
		},
		{
			"key": "faq-title",
			"name": "Title at the top of the page",
			"type": "text"
		},
		{
			"key": "faq-description",
			"name": "Descriptive text for the page",
			"type": "textarea"
		},
		{
			"key": "faq-search",
			"name": "Display the search bar?<div><em>*This will allow the user to search all questions but it will only display the results of the current tab.</em></div>",
			"choices": [
				{
					"name": "Yes",
					"value": "Y"
				},
				{
					"name": "No",
					"value": "N"
				}
			],
			"type":"radio"
		},
		{
			"key": "faq-pdf",
			"name": "Display the download PDF buttom?<div><em>*This will allow the user to all questions and answers in a PDF format.</em></div>",
			"choices": [
				{
					"name": "Yes",
					"value": "Y"
				},
				{
					"name": "No",
					"value": "N"
				}
			],
			"type":"radio"
		},
		{
			"key": "faq-privacy-description",
			"name": "<div>Select a privacy type for the FAQ builder:</div><br><div class='alert alert-info' style='border-color:#bce8f1 !important'><ul><li><strong>Public</strong> (no login required; anyone with the link can view/access the FAQ page)</li><li><strong>This Project's users only</strong> (REDCap login required; only users on this project can access the FAQ page)</li><li><strong>A different Project's users</strong> (REDCap login required; only users from another project can access the FAQ page)</li></ul></div>",
			"type": "descriptive"
		},
		{
			"key": "faq-privacy",
			"name": "Privacy type",
			"required": true,
			"choices": [
				{
					"name": "Public",
					"value": "public"
				},
				{
					"name": "This Project's users only",
					"value": "main"
				},
				{
					"name": "A different Project's users",
					"value": "other"
				}
			],
			"type":"radio"
		},
		{
			"key": "projects",
			"name": "Select the project/s whose people can access the FAQ",
			"type": "sub_settings",
			"repeatable":true,
			"branchingLogic": {
				"field": "faq-privacy",
				"op":"=",
				"value": "other"
			},
			"sub_settings":[
				{
					"key": "faq-project",
					"name": "Project",
					"type": "project-id"
				}
			]
		}

	],
	"compatibility": {
		"php-version-min": "7.3.29",
		"php-version-max": "",
		"redcap-version-min": "13.1.2",
		"redcap-version-max": ""
	}
}