Merge branch 'release/1.3.1'

CHANGELOG.md

@@ -3,6 +3,12 @@ All notable changes to the REDCap External Module Development Guide project will
 This project adheres to [Semantic Versioning](http://semver.org/).
 
 
+## [1.3.1] - 2020-09-22
+### Changed
+- Switch emd101 screenshots to markdown (Philip Chase, Kyle Chesney)
+- Switch emd102 screenshots to markdown and resize menu screenshots (Philip Chase, Kyle Chesney)
+
+
 ## [1.3.0] - 2020-09-22
 ### Added
 - Add release number to left-hand navigation (Philip Chase)

VERSION

@@ -1 +1 @@
-1.3.0
+1.3.1

docs/_config.yml

@@ -1,7 +1,7 @@
 title: REDCap External Module Development Guide
 description: REDCap External Module Development Guide
 repository: ctsit/redcap_external_module_development_guide
-release: 1.3.0
+release: 1.3.1
 
 repo_root: https://github.com/ctsit/redcap_external_module_development_guide/tree/master/
 

docs/_sass/em-guide.scss

@@ -12,9 +12,10 @@ p.authors {
   font-weight:bold;
 }
 
-img.screenshot {
+img[src*="#screenshot"] {
   padding-left: 35px;
-  padding-right: 35px;
+  padding-right: 25px;
   padding-top: 12px;
   padding-bottom: 12px;
+  max-width: 90%;
 }

docs/emd101.md

@@ -36,12 +36,12 @@ These tools are recommended for those with no experience in software development
 
 - Open the `redcap-docker-compose` directory in your editor
 
-<img class="screenshot" alt="VSCodium open folder" src="/assets/img/vscodium_1.png"/>
-<img class="screenshot" alt="VSCodium select redcap-docker-compose folder" src="/assets/img/vscodium_2.png"/>
+![VSCodium open folder](/assets/img/vscodium_1.png#screenshot)
+![VSCodium select redcap-docker-compose folder](/assets/img/vscodium_2.png#screenshot)
 
 - Open the file `.env` in the `rdc` directory (note that in Windows you can _not_ simply double click the `.env` file to open it)
 
-<img class="screenshot" alt="VSCodium select .env file" src="/assets/img/vscodium_3.png"/>
+![VSCodium select .env file](/assets/img/vscodium_3.png#screenshot)
 
 - Paste this block at the end of the file and save it. Make changes to reflect your timezone and REDCap version number. You can find a list of valid time zones at [List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)  
 The port numbers should reflect your REDCap version number in some way so you can keep your different REDCap installations from colliding and tell them apart. Each of these port numbers needs to be unique. The standard used here compresses the REDCap version number into 4 digits and prefixes it with 1 through 4. For example, 10.3.3 becomes 1033. With prefixes, that becomes 11033, 21033, 31033, and 41033. Any method that makes unique port numbers and works for you is fine, though be aware that the max allowed port number is 65535.
@@ -55,28 +55,28 @@ MAILHOG_PORT=41033
 ```
 
 You'll need a terminal that's in the `redcap-docker-compose` directory to start the Docker containers
-- If you used VSCode or another IDE with an integrated terminal for the previous steps, you already have a terminal attached and in the desired directory <img class="screenshot" alt="VSCodium terminal" src="/assets/img/vscodium_terminal.png"/>
+- If you used VSCode or another IDE with an integrated terminal for the previous steps, you already have a terminal attached and in the desired directory ![VSCodium terminal](/assets/img/vscodium_terminal.png#screenshot)
 
 - If you did not use VSCode, open a terminal or git-bash session and cd to the `redcap-docker-compose` directory
     - GitHub Desktop can open a terminal cd'd to the `redcap-docker-compose` folder with the shortcut \<ctrl\>\`
 - Change directories into the `rdc` folder with the command `cd rdc`
 - In the terminal start the containers with this command `docker-compose up -d`
 
-<img class="screenshot" alt="terminal nav and docker-compose up -d" src="/assets/img/terminal-dcup.png"/>
+![terminal nav and docker-compose up -d](/assets/img/terminal-dcup.png#screenshot)
 
 Your Docker containers are now downloading required software and initializing. This step will take some time, especially on the first run.
 - Once the containers are built, wait one more minute for the webpage to finish setting up.
 - Access web-based redcap installer at [http://localhost:1935](http://localhost:1935) You should see this:
 
-![REDCap Docker-Compose Installer](/assets/img/installer.png)
+![REDCap Docker-Compose Installer](/assets/img/installer.png#screenshot)
 
 - Select 'Use a local copy of the full zip installer...'. Click Browse, locate your redcap zip file (e.g. redcap10.3.3.zip), and upload it.
 - Select 'Prepopulate with table-based users and activate table authentication' and provide _your_ email address.
 - Click 'INSTALL REDCAP'
 - Wait a couple of minutes.
 - When you see the green dialog boxes, the installation is complete.
 
-![Successful installation](/assets/img/successful_installation.png)
+![Successful installation](/assets/img/successful_installation.png#screenshot)
 
 - **Ignore the website instructions** to access the REDCap installer and access your fully functional local REDCap at [http://localhost:1935](http://localhost:1935)
 - Login as admin. Your password is 'password'. Every user's account is 'password'.

docs/emd102.md

@@ -12,15 +12,15 @@ This document assumes some familiarity with REDCap and access to a REDCap system
 
 ## Access the Control Center > Browse Users. Look at the accounts that the installer made for you: 
 
-<img class="screenshot" width="286" alt="Browser Users Menu Entry" src="/assets/img/browser_users_menu.png">
+![Browser Users Menu Entry](/assets/img/browser_users_menu.png#screenshot)
 
 You can also use this to find any specific REDCap user:
 
-<img class="screenshot" width="769" alt="Search for User" src="/assets/img/browser_users_search.png">
+![Search for User](/assets/img/browser_users_search.png#screenshot)
 
 Click on the name /user to access their account, see which projects they have access to, and to suspend or delete their account:
 
-<img class="screenshot" width="690" alt="Users Edit Info" src="/assets/img/browser_users_edit.png">
+![Users Edit Info](/assets/img/browser_users_edit.png#screenshot)
 
 </details>
 <br />
@@ -35,13 +35,13 @@ Click on the name /user to access their account, see which projects they have ac
 
 ## Access the Control Center > General Configuration:
 
-<img class="screenshot" width="282" alt="General Configuration Menu" src="/assets/img/general_configuration_menu.png">
+![General Configuration Menu](/assets/img/general_configuration_menu.png#screenshot)
 
 The Other System Settings section is important for REDCap Admins:
 
-<img class="screenshot" width="726" alt="General Configuration 1 of 2" src="/assets/img/general_configuration_other.png">
+![General Configuration 1 of 2](/assets/img/general_configuration_other.png#screenshot)
 
-<img class="screenshot" width="598" alt="General Configuration 2 of 2" src="/assets/img/general_configuration_other_2.png">
+![General Configuration 2 of 2](/assets/img/general_configuration_other_2.png#screenshot)
 
 </details>
 <br />
@@ -56,11 +56,11 @@ The Other System Settings section is important for REDCap Admins:
 
 ## Access the Control Center > Configuration Check:
 
-<img class="screenshot" width="261" alt="Configuration Check Menu" src="/assets/img/configuration_check_menu.png">
+![Configuration Check Menu](/assets/img/configuration_check_menu.png#screenshot)
 
 If your installation is set up correctly, everything should be highlighted in green here. If there is an issue, the problem will be highlighted in red.
 
-<img class="screenshot" width="701" alt="Configuration Check" src="/assets/img/configuration_check.png">
+![Configuration Check](/assets/img/configuration_check.png#screenshot)
 
 
 </details>
@@ -76,13 +76,13 @@ If your installation is set up correctly, everything should be highlighted in gr
 
 ## Access the Control Center > User Settings:
 
-<img class="screenshot" width="267" alt="User Settings" src="/assets/img/user_settings_menu.png">
+![User Settings](/assets/img/user_settings_menu.png#screenshot)
 
 These user setting are important and apply to all users, except REDCap Admins. For example: can users create their own projects, or do they need to request a new project that the REDCap Admins have to approve? Can users move their own projects into production, or do the REDCap Admins have to approve their request? Should unused/inactive REDCap accounts be suspended after x number of days of inactivity? Should post-production change requests be automatically approved or should a REDCap Admin approve them first to ensure no data is lost or orphaned?
 
-<img class="screenshot" width="681" alt="User Settings System-Level 1 of 2" src="/assets/img/user_settings_menu_system_level_1.png">
+![User Settings System-Level 1 of 2](/assets/img/user_settings_menu_system_level_1.png#screenshot)
 
-<img class="screenshot" width="663" alt="User Settings System-Level 2 of 2" src="/assets/img/user_settings_menu_system_level_2.png">
+![User Settings System-Level 2 of 2](/assets/img/user_settings_menu_system_level_2.png#screenshot)
 
 </details>
 <br />
@@ -97,11 +97,11 @@ These user setting are important and apply to all users, except REDCap Admins. F
 
 ## Access the Control Center > File Upload Settings:
 
-<img class="screenshot" width="262" alt="File Upload Settings Menu" src="/assets/img/file_upload_settings_menu.png">
+![File Upload Settings Menu](/assets/img/file_upload_settings_menu.png#screenshot)
 
 This is where you enable the different File Upload settings/locations, such as maximum file size, including the Send-It module:
 
-<img class="screenshot" width="662" alt="File Upload Settings" src="/assets/img/file_upload_settings.png">
+![File Upload Settings](/assets/img/file_upload_settings.png#screenshot)
 
 </details>
 <br />
@@ -116,20 +116,20 @@ This is where you enable the different File Upload settings/locations, such as m
 
 ## Access the Control Center > External Modules:
 
-<img class="screenshot" width="259" alt="External Modules Menu" src="/assets/img/external_modules_menu.png">
+![External Modules Menu](/assets/img/external_modules_menu.png#screenshot)
 
  On this page, you can see modules that are already downloaded, which modules have updates available, which version of the module you are using, module configurations, and which projects are using these modules. You can also disable any modules here and set custom text for users on the External Modules page in their REDCap projects.
 
 To view modules available already downloaded in your instance: look at the section "Modules Currently Available on this System"
 
-<img class="screenshot" width="723" alt="External Modules - Module Manager" src="/assets/img/external_modules_module_manager.png">
+![External Modules - Module Manager](/assets/img/external_modules_module_manager.png#screenshot)
 
 
 Download a few modules by clicking on the blue "View modules available in the REDCap Repo" button.
 
 Try _Admin Dashboard, MySQL Simple Admin, Image Map_, and _Date Calculated Fields_. They are popular and easy to implement.  Click on the blue "Download" button next to the module's name to download it to your REDCap server:
 
-<img class="screenshot" width="1104" alt="External Modules - REDCap Repo" src="/assets/img/external_modules_redcap_repo.png">
+![External Modules - REDCap Repo](/assets/img/external_modules_redcap_repo.png#screenshot)
 
 Once downloaded, you return to this page to configure the module's global settings by clicking on "Configure" next to the module's name. Global settings include: _Enable module on all projects by default_, _Make module discoverable by users_, and _Module configuration permissions in projects_. 
 
@@ -148,11 +148,11 @@ Once downloaded, you return to this page to configure the module's global settin
 
 These "Modules" are not External Modules. They are big features in REDCap that are turned off by default.
 
-<img class="screenshot" width="255" alt="Modules/Services Configuration Menu" src="/assets/img/modules_services_configuration_menu.png">
+![Modules/Services Configuration Menu](/assets/img/modules_services_configuration_menu.png#screenshot)
 
 Here is where you enable the use of the survey features in REDCap (i.e., can projects use surveys), URL shortening feature (found on the Survey Distributions Tools page), the Randomization module, the REDCap Shared Library, REDCap API, the Mobile App, the biomedical ontology feature, and many others. 
 
-<img class="screenshot" width="689" alt="Modules/Services Configuration" src="/assets/img/modules_services_configuration.png">
+![Modules/Services Configuration](/assets/img/modules_services_configuration.png#screenshot)
 
 Note: enabling surveys, the Randomization module, the REDCap API and Mobile App does not mean projects/users have to use these features. They only make them available to the users. 
 
@@ -169,13 +169,13 @@ Note: enabling surveys, the Randomization module, the REDCap API and Mobile App
 
 ## Access the Control Center > Field Validation Types: 
 
-<img class="screenshot" width="272" alt="Field Validation Types Menu" src="/assets/img/field_validation_types_menu.png">
+![Field Validation Types Menu](/assets/img/field_validation_types_menu.png#screenshot)
 
 To make these field validations available, click on Enable next to the validation(s) you want to be available.
 
 Note: not all validations will be relevant to your institution/area.
 
-<img class="screenshot" width="463" alt="Field Validation Types" src="/assets/img/field_validation_types.png">
+![Field Validation Types](/assets/img/field_validation_types.png#screenshot)
 
 Do you know these are just rows in the MySQL table `redcap_validation_types`? Did you know you can add your own?
 
@@ -193,11 +193,11 @@ Do you know these are just rows in the MySQL table `redcap_validation_types`? Di
 
 ## Access the Control Center > Project Templates: 
 
-<img class="screenshot" width="260" alt="Project Templates Menu" src="/assets/img/project_templates_menu.png">
+![Project Templates Menu](/assets/img/project_templates_menu.png#screenshot)
 
 Project templates are form(s) that other users at your institution can download upon project creation. Some templates are provided by Vanderbilt by default, but you can add your own by clicking on _Add new template_ and choosing which project you want to become a template. Unlike the REDCap Shared Library, these templates are only available upon project creation. 
 
-<img class="screenshot" width="718" alt="Project Templates" src="/assets/img/project_templates.png">
+![Project Templates](/assets/img/project_templates.png#screenshot)
 
 </details>
 <br />
@@ -212,11 +212,11 @@ Project templates are form(s) that other users at your institution can download
 
 ## Access the Control Center > Email Users:
 
-<img class="screenshot" width="270" alt="Email Users Menu" src="/assets/img/email_users_menu.png">
+![Email Users Menu](/assets/img/email_users_menu.png#screenshot)
 
 You can use this page to email all users or users who meet a certain criteria, such as they have logged in during the past month.
 
-<img class="screenshot" width="682" alt="Email Users" src="/assets/img/email_users.png">
+![Email Users](/assets/img/email_users.png#screenshot)
 
 </details>
 <br />
@@ -231,11 +231,11 @@ You can use this page to email all users or users who meet a certain criteria, s
 
 ## Access the Control Center > To Do List:
 
-<img class="screenshot" width="272" alt="To Do List Menu" src="/assets/img/to_do_list_menu.png">
+![To Do List Menu](/assets/img/to_do_list_menu.png#screenshot)
 
 Here is where all pending Move to production requests, API requests and Post-production change requests can be found, that need admin approval. There are several options under _Actions_ to deal with these requests. REDCap will still send an email to the REDCap Admins, unless you uncheck the _Enable email notifications_ for administrators button.
 
-<img class="screenshot" width="744" alt="To Do List" src="/assets/img/to_do_list.png">
+![To Do List](/assets/img/to_do_list.png#screenshot)
 
 </details>
 <br />
@@ -250,11 +250,11 @@ Here is where all pending Move to production requests, API requests and Post-pro
 
 ## Access the Control Center > Administrators & Account Managers:
 
-<img class="screenshot" width="267" alt="Administrators & Account Managers Menu" src="/assets/img/administrators_and_account_managers_menu.png">
+![Administrators & Account Managers Menu](/assets/img/administrators_and_account_managers_menu.png#screenshot)
 
 Here you can see which users are REDCap Admins (have all rights and access to all projects and their settings) and who is an account manager, who cannot access all projects and only perform duties related to REDCap accounts (suspend users, delete users, create accounts, etc.)
 
- <img class="screenshot" width="693" alt="Administrators & Account Managers" src="/assets/img/administrators_and_account_managers.png">
+![Administrators & Account Managers](/assets/img/administrators_and_account_managers.png#screenshot)
 
 </details>
 <br />
@@ -269,13 +269,13 @@ Here you can see which users are REDCap Admins (have all rights and access to al
 
 ## Access the Control Center > Edit a Project's Settings:
 
-<img class="screenshot" width="274" alt="Edit a Project's Settings Menu" src="/assets/img/edit_a_projects_settings_menu.png">
+![Edit a Project's Settings Menu](/assets/img/edit_a_projects_settings_menu.png#screenshot)
 
 This is where you can change the settings for just one project, such as enabling the Double Data Entry module or taking the project off line.
 
-<img class="screenshot" width="680" alt="Edit a Project's Settings 1 of 2" src="/assets/img/edit_a_projects_settings_1.png">
+![Edit a Project's Settings 1 of 2](/assets/img/edit_a_projects_settings_1.png#screenshot)
 
-<img class="screenshot" width="660" alt="Edit a Project's Settings 2 of 2" src="/assets/img/edit_a_projects_settings_2.png">
+![Edit a Project's Settings 2 of 2](/assets/img/edit_a_projects_settings_2.png#screenshot)
 
 </details>
 <br />