Merge pull request #332 from coding-for-reproducible-research/accessibility_submit_button

Accessibility Submit Button for Search Bar

Author: liamjberrisford

.github/workflows/accessibility.yml

@@ -90,7 +90,7 @@ jobs:
 
       - name: Run Pa11y CI on changed pages only and save output
         id: run_pa11y
-        shell: bash  # <-- this fixes the mapfile error
+        shell: bash
         run: |
           num_files=$(jq length pa11y_targets.json)
           touch pa11y_output.md
@@ -101,24 +101,33 @@ jobs:
             echo "### 🚦 Pa11y Accessibility Report" > pa11y_output.md
             echo "" >> pa11y_output.md
 
-            # Deduplicate HTML targets and read into array
             mapfile -t html_files < <(jq -r '.[]' pa11y_targets.json | sort -u)
+            total_files=${#html_files[@]}
+
+            for i in "${!html_files[@]}"; do
+              file="${html_files[$i]}"
+              current_index=$((i + 1))
+              echo "🔎 Checking $current_index of $total_files: $file"
 
-            for file in "${html_files[@]}"; do
               echo "#### 📄 $file" >> pa11y_output.md
               echo '```' >> pa11y_output.md
+
               result=$(npx pa11y-ci --reporter cli --config pa11yci.js "file://$(pwd)/$file" 2>&1 || true)
               echo "$result" >> pa11y_output.md
               echo '```' >> pa11y_output.md
 
-              # Attribution line for accessibility error source
               base=$(basename "$file" .html)
-              echo "_⚠️ This issue likely originates from \`${base}.md\` or \`${base}.ipynb\`, which is used to generate this HTML file._" >> pa11y_output.md
+              echo "_⚠️ Any errors likely originates from the source file (e.g., \`filename.md\`, \`filename.ipynb\`) used to generate the HTML._" >> pa11y_output.md
               echo "" >> pa11y_output.md
             done
           fi
 
 
+      - name: 🔍 Debug comment body
+        run: |
+          echo "------- BEGIN COMMENT BODY -------"
+          cat pa11y_output.md
+          echo "-------- END COMMENT BODY --------"
 
       - name: Debug GitHub context
         run: |

_config.yml

@@ -31,6 +31,7 @@ html:
       - _static/remove_prev_next_bottom_buttons.css
   extra_js:
       - _static/overlay-label-accessibility.js
+      - _static/search_bar_submit_button.js
 
 
 launch_buttons:

_static/search_bar_submit_button.js

@@ -0,0 +1,11 @@
+// Add a submit button to the search form for accessibility
+document.addEventListener("DOMContentLoaded", function () {
+  const searchForm = document.querySelector('form.bd-search');
+  if (searchForm) {
+    const submitBtn = document.createElement('button');
+    submitBtn.type = 'submit';
+    submitBtn.className = 'visually-hidden';  // Keeps it hidden visually but accessible to screen readers
+    submitBtn.textContent = 'Submit Search';
+    searchForm.appendChild(submitBtn);
+  }
+});

home_page.md

@@ -13,4 +13,4 @@ You can contact the CfRR team at the following email: [codingforreproduciblerese
 
 Please register your interest in a particular course by completing the relevant form on the Workshop Schedule and Signup page available [here](cfrr_program_details/courses_overview.ipynb).
 
-For more details on the use of this website, please go to ['How to use this website'](cfrr_program_details/how_to_use_CfRR.ipynb).
+For more details on the structure and use of this website, please go to ['How to use this website'](cfrr_program_details/how_to_use_CfRR.ipynb).